SoSpotLightManip(3IV)
SoSpotLightManip (SoSpotLtManip) - spotlight node with 3D interface for editing location, direction, and beam width
As shipped in IRIX 6.5.22. Added in IRIX 6.5.22.
NAME SoSpotLightManip (SoSpotLtManip) - spotlight node with 3D interface for editing location, direction, and beam width INHERITS FROM SoBase > SoFieldContainer > SoNode > SoLight > SoSpotLight > SoSpotLightManip SYNOPSIS #include <Inventor_c/manips/SoSpotLightManip.h> typedef SoSpotLightManip SoSpotLtManip Fields from class SoSpotLight: SoSFVec3f location SoSFVec3f direction SoSFFloat dropOffRate SoSFFloat cutOffAngle Fields from class SoLight: SoSFBool on SoSFFloat intensity SoSFColor color Functions from class SoSpotLightManip: SoSpotLightManip * SoSpotLtManipCreate() SoDragger * SoSpotLtManipGetDrag(SoSpotLtManip *this) SbBool SoSpotLtManipReplaceNode(SoSpotLtManip *this, SoPath *p ) SbBool SoSpotLtManipReplaceManip(const SoSpotLtManip *this, SoPath *p, SoSpotLight *newOne ) SoType SoSpotLtManipGetClassTypeId() Functions from class SoNode: void SoSpotLtManipSetOverride(SoSpotLtManip *this, SbBool state) SbBool SoSpotLtManipIsOverride(const SoSpotLtManip *this) SoNode * SoSpotLtManipCopy(const SoSpotLtManip *this, SbBool copyConnections = FALSE) SbBool SoSpotLtManipAffectsState(const SoSpotLtManip *this) SoNode * SoSpotLtManipGetByName(const char *name) int SoSpotLtManipGetByNameList(const char *name, SoNodeList *list) Functions from class SoFieldContainer: void SoSpotLtManipSetToDflts(SoSpotLtManip *this) SbBool SoSpotLtManipHasDfltVals(const SoSpotLtManip *this) SbBool SoSpotLtManipFldsAreEq(const SoSpotLtManip *this, const SoFieldContainer *fc) void SoSpotLtManipCopyFieldVals(SoSpotLtManip *this, const SoFieldContainer *fc, SbBool copyConnections = FALSE) SbBool SoSpotLtManipSet(SoSpotLtManip *this, const char *fieldDataString) void SoSpotLtManipGet(SoSpotLtManip *this, SbString *fieldDataString) int SoSpotLtManipGetFields(const SoSpotLtManip *this, SoFieldList *resultList) SoField * SoSpotLtManipGetField(const SoSpotLtManip *this, const char *fieldName) SbBool SoSpotLtManipGetFieldName(const SoSpotLtManip *this, const SoField *field, SbName *fieldName) SbBool SoSpotLtManipIsNotifyEnabled(const SoSpotLtManip *this) SbBool SoSpotLtManipEnableNotify(SoSpotLtManip *this, SbBool flag) Functions from class SoBase: void SoSpotLtManipRef(SoSpotLtManip *this) void SoSpotLtManipUnref(const SoSpotLtManip *this) void SoSpotLtManipUnrefNoDelete(const SoSpotLtManip *this) void SoSpotLtManipTouch(SoSpotLtManip *this) SoType SoSpotLtManipGetTypeId(const SoSpotLtManip *this) SbBool SoSpotLtManipIsOfType(const SoSpotLtManip *this, SoType type) void SoSpotLtManipSetName(SoSpotLtManip *this, const char *name) SbName SoSpotLtManipGetName(const SoSpotLtManip *this) DESCRIPTION SoSpotLightManip is the base class for all SoSpotLight nodes that have a built-in 3D user interface (this is the only such class provided with the Inventor toolkit). Since it is derived from SoSpotLight, any changes to its fields result in a change of lighting for nodes that follow it in the scene graph. In this case, the interface edits the location, direction, and cutOffAngle fields. Also, the color of the manipulator's geometry will reflect the color of the light (but you can not edit the color using this manipulator). Typically, you will want to replace a regular SoSpotLight with an SoSpotLightManip (as when the user selects a light to be edited), or vice versa (as when the user is done moving the light and the interface should go away). Use the SoSpotLtManipReplaceNode() function to insert a manipulator into a scene graph, and the SoSpotLtManipReplaceManip() function to remove it when done. The SoSpotLightManip utilizes an SoSpotLightDragger to provide a 3D interface. However, the manipulator differs from the dragger; it lights other objects in the scene because, as an SoSpotLight, it alters the state. The fields values and movement of the dragger, on the other hand, affect only the dragger itself. To find out more about how the interface works and what each part will do, see the reference page for SoSpotLightDragger. The interfaces of the dragger and the manipulator are identical. The SoSpotLightManip utilizes its dragger by adding it as a hidden child. When an action is applied to the manipulator, such as rendering or handling events, the manipulator first traverses the dragger, and then the manipulator adds its lighting parameters to the state. When you click-drag-release over the manipulator, it passes these events down to the dragger, which moves as a result ("I can't help it, I'm a dragger!"). The manipulator maintains consistency between the fields of the dragger and its own fields. Let's say you use the mouse to widen the cone of the dragger. Callbacks insure that the cutOffAngle field of the manipulator will change by the same amount, thus changing the lighting of nodes which follow in the scene graph. Similarly, if you set the cutOffAngle field of the SoSpotLightManip, the manipulator will widen the beam of the dragger accordingly. Because the dragger is a hidden child, you can see the dragger on screen and interact with it, but the dragger does not show up when you write the manipulator to file. Also, any SoPath will end at the manipulator. (See the Actions section of this reference page for a complete description of when the dragger is traversed). If you want to get a pointer to the dragger you can get it from the manipulator using the SoSpotLtManipGetDragger() method. You will need to do this if you want to change the geometry of a manipulator, since the geometry actually belongs to the dragger. FUNCTIONS SoSpotLightManip * SoSpotLtManipCreate() Constructor. SoDragger * SoSpotLtManipGetDrag(SoSpotLtManip *this) Returns a pointer to the dragger being used by this manipulator. Given this pointer, you can customize the dragger just like you would any other dragger. You can change geometry using the SoDragSetPart() method, or add callbacks using the methods found in the SoDragger reference page. SbBool SoSpotLtManipReplaceNode(SoSpotLtManip *this, SoPath *p ) Replaces the tail of the path with this manipulator. The tail of the path must be an SoSpotLight node (or subclass thereof). If the path has a nodekit, this will try to use SoBaseKitSetPart() to insert the manipulator. Otherwise, the manipulator requires that the next to last node in the path chain be a group. The field values from the spotlight node will be copied to this manipulator, and the light node will be replaced. The manipulator will not call SoSpotLtRef() on the node it is replacing. The old node will disappear if it has no references other than from the input path p and its parent, since this manipulator will be replacing it in both of those places. Nor will the manipulator make any changes to field connections of the old node. The calling process is thus responsible for keeping track of its own nodes and field connections. SbBool SoSpotLtManipReplaceManip(const SoSpotLtManip *this, SoPath *p, SoSpotLight *newOne ) Replaces the tail of the path, which must be this manipulator, with the given SoSpotLight node. If the path has a nodekit, this will try to use SoBaseKitSetPart() to insert the new node. Otherwise, the manipulator requires that the next to last node in the path chain be a group. The field values from the manipulator will be copied to the spotlight node, and the manipulator will be replaced. The manipulator will not call SoSpotLtRef() or SoSpotLtUnref() on the node which is replacing it, nor will it make any changes to field connections. The calling process is thus responsible for keeping track of its own nodes and field connections. SoType SoSpotLtManipGetClassTypeId() Returns type identifier for this class. ACTION BEHAVIOR SoGLRenderAction, SoCallbackAction, SoGetBoundingBoxAction, SoGetMatrixAction, SoHandleEventAction, SoRayPickAction First, traverses the dragger the way an SoGroup would. All draggers place themselves in space, but leave the current transformation unchanged when finished. Then the SoSpotLightManip adds a spotlight to the state, just like its base class, SoSpotLight. SoSearchAction Searches just like an SoSpotLight. Does not search the dragger, which is a hidden child. SoWriteAction Writes out just like an SoSpotLight. Does not write the dragger, which is a hidden child. If you really need to write valuable information about the dragger, such as customized geometry, you can retrieve the dragger with the SoSpotLtManipGetDragger() method and then write it out separately. FILE FORMAT/DEFAULTS SpotLightManip { on TRUE intensity 1 color 1 1 1 location 0 0 1 direction 0 0 -1 dropOffRate 0 cutOffAngle 0.785398 } SEE ALSO SoDragger, SoSpotLight, SoSpotLightDragger, SoDirectionalLightManip, SoPointLightManip