|
| | SoPointLightManip () |
| | Constructor.
|
| |
| SoDragger * | getDragger () |
| | Returns a pointer to the dragger being used by this manipulator.
|
| |
| bool | replaceNode (SoPath *p) |
| | Replaces the tail of the path with this manipulator.
|
| |
| bool | replaceManip (SoPath *p, SoPointLight *newOne) const |
| | Replaces the tail of the path, which must be this manipulator, with the given SoPointLight node.
|
| |
| virtual void | doAction (SoAction *action) |
| | These functions implement all actions for nodekits.
|
| |
| virtual void | callback (SoCallbackAction *action) |
| |
| virtual void | GLRender (SoGLRenderAction *action) |
| | Creates a light source during rendering.
|
| |
| virtual void | getBoundingBox (SoGetBoundingBoxAction *action) |
| |
| virtual void | getMatrix (SoGetMatrixAction *action) |
| |
| virtual void | handleEvent (SoHandleEventAction *action) |
| |
| virtual void | pick (SoPickAction *action) |
| |
| virtual void | search (SoSearchAction *action) |
| |
| virtual SoChildList * | getChildren () const |
| | Returns pointer to children, or NULL if none.
|
| |
| | SoPointLight () |
| | Creates a point light source node with default settings.
|
| |
| void | setOverride (bool state) |
| | Turns override flag on or off.
|
| |
| bool | isOverride () const |
| | Returns the state of the override flag.
|
| |
| SoNode * | copy (bool copyConnections=FALSE) const |
| | Creates and returns an exact copy of the node.
|
| |
| virtual bool | affectsState () const |
| | Returns TRUE if a node has an effect on the state during traversal.
|
| |
| virtual void | doAction (SoAction *action) |
| | This method performs the "typical" operation of a node for any action.
|
| |
| virtual void | GLRender (SoGLRenderAction *action) |
| | These virtual functions implement all of the actions for nodes, Most of the default implementations do nothing.
|
| |
| virtual void | callback (SoCallbackAction *action) |
| |
| virtual void | getBoundingBox (SoGetBoundingBoxAction *action) |
| |
| virtual void | getMatrix (SoGetMatrixAction *action) |
| |
| virtual void | handleEvent (SoHandleEventAction *action) |
| |
| virtual void | pick (SoPickAction *action) |
| |
| virtual void | rayPick (SoRayPickAction *action) |
| |
| virtual void | search (SoSearchAction *action) |
| |
| virtual void | write (SoWriteAction *action) |
| |
| virtual void | GLRenderBelowPath (SoGLRenderAction *action) |
| | These methods make render traversal faster by implementing different rendering paths corresponding to different action path codes.
|
| |
| virtual void | GLRenderInPath (SoGLRenderAction *action) |
| |
| virtual void | GLRenderOffPath (SoGLRenderAction *action) |
| |
| virtual void | grabEventsSetup () |
| | These virtual functions are called when a node gains or loses status as "grabber" of events (see HandleEventAction::setGrabber()).
|
| |
| virtual void | grabEventsCleanup () |
| |
| virtual void | startNotify () |
| | Initiates notification from an instance.
|
| |
| virtual void | notify (SoNotList *list) |
| | Propagates modification notification through an instance.
|
| |
| SbNodeIdType | getNodeId () const |
| | Returns the unique id for a node.
|
| |
| virtual SoChildList * | getChildren () const |
| | Returns pointer to children, or NULL if none.
|
| |
| virtual void | writeInstance (SoOutput *out) |
| | Writes instance to SoOutput. (Used for either stage of writing.)
|
| |
| virtual SoNode * | addToCopyDict () const |
| | Recursively adds this node and all nodes under it to the copy dictionary.
|
| |
| virtual void | copyContents (const SoFieldContainer *fromFC, bool copyConnections) |
| | Copies the contents of the given node into this instance.
|
| |
| virtual SoFieldContainer * | copyThroughConnection () const |
| | Copies an instance that is encountered through a field connection.
|
| |
| void | setToDefaults () |
| | Sets all fields in this object to their default values.
|
| |
| bool | hasDefaultValues () const |
| | Returns TRUE if all of the object's fields have their default values.
|
| |
| bool | fieldsAreEqual (const SoFieldContainer *fc) const |
| | Returns TRUE if this object's fields are exactly equal to fc's fields.
|
| |
| void | copyFieldValues (const SoFieldContainer *fc, bool copyConnections=FALSE) |
| | Copies the contents of fc's fields into this object's fields.
|
| |
| bool | set (const char *fieldDataString) |
| | Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format.
|
| |
| void | get (SbString &fieldDataString) |
| | Returns the values of the fields of this object in the Inventor ASCII file format in the given string.
|
| |
| virtual int | getFields (SoFieldList &list) const |
| | Appends pointers to all of this object's fields to resultList, and returns the number of fields appended.
|
| |
| virtual SoField * | getField (const SbName &fieldName) const |
| | Returns a pointer to the field with the given name.
|
| |
| bool | getFieldName (const SoField *field, SbName &fieldName) const |
| | Returns the name of the given field in the fieldName argument.
|
| |
| bool | enableNotify (bool flag) |
| | Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
|
| |
| bool | isNotifyEnabled () const |
| | Notification is the process of telling interested objects that this object has changed.
|
| |
| bool | set (const char *fieldDataString, SoInput *dictIn) |
| | Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format.
|
| |
| void | get (SbString &fieldDataString, SoOutput *dictOut) |
| | Returns the values of the fields of this object in the Inventor ASCII file format in the given string.
|
| |
| virtual void | notify (SoNotList *) |
| | Propagates modification notification through an instance.
|
| |
| virtual void | addWriteReference (SoOutput *out, bool isFromField=FALSE) |
| | Adds a reference to the instance when writing.
|
| |
| virtual void | writeInstance (SoOutput *out) |
| | Writes instance to SoOutput. (Used only for last stage of writing)
|
| |
| bool | getIsBuiltIn () const |
| | Returns whether or not instance is considered 'built-in' to the library.
|
| |
| virtual const SoFieldData * | getFieldData () const |
| | Returns an SoFieldData structure for the node.
|
| |
| virtual void | copyContents (const SoFieldContainer *fromFC, bool copyConnections) |
| | Copies the contents of the given node into this instance.
|
| |
| virtual SoFieldContainer * | copyThroughConnection () const |
| | During a copy operation, this copies an instance that is encountered through a field connection.
|
| |
| void | addManagedSensor (SoSensor *sensor) |
| | Adds a sensor which is managed by the field container.
|
| |
| void | ref () const |
| | Adds and removes a reference to an instance.
|
| |
| void | unref () const |
| |
| void | unrefNoDelete () const |
| |
| void | touch () |
| | Marks an instance as modified, simulating a change to it.
|
| |
| virtual SoType | getTypeId () const =0 |
| | Returns the type identifier for a specific instance.
|
| |
| bool | isOfType (SoType type) const |
| | Returns TRUE if this object is of the type specified in type or is derived from that type.
|
| |
| virtual SbName | getName () const |
| | Returns the name of an instance.
|
| |
| virtual void | setName (const SbName &name) |
| | Sets the name of an instance.
|
| |
| virtual void | startNotify () |
| | Initiates notification from an instance.
|
| |
| virtual void | notify (SoNotList *list) |
| | Propagates modification notification through an instance.
|
| |
| void | addAuditor (void *auditor, SoNotRec::Type type) |
| | Adds/removes an auditor to/from list.
|
| |
| void | removeAuditor (void *auditor, SoNotRec::Type type) |
| |
| const SoAuditorList & | getAuditors () |
| | Returns auditor list– used by SoField and SoEngineOutput to trace forward connections.
|
| |
| int | getRefCount () const |
| | Returns current reference count.
|
| |
| virtual void | addWriteReference (SoOutput *out, bool isFromField=FALSE) |
| | Adds a reference to the instance when writing.
|
| |
| bool | shouldWrite () |
| | Returns TRUE if the instance should be written, based on the write-reference info already accumulated.
|
| |
|
| static void | initClass () |
| | initialize the class
|
| |
| static void | initClass () |
| |
| static void | initClass () |
| |
| static SoType | getClassTypeId () |
| | Returns type identifier for the SoNode class.
|
| |
| static SoNode * | getByName (const SbName &name) |
| | Returns the last node given the specified name.
|
| |
| static int | getByName (const SbName &name, SoNodeList &list) |
| | Returns the number of nodes with the given name, and adds to list pointers to those nodes.
|
| |
| static void | initClass () |
| | Initializes base node class.
|
| |
| static void | initClasses () |
| | Initialize ALL Inventor node classes.
|
| |
| static SbNodeIdType | getNextNodeId () |
| | Returns the next available unique id.
|
| |
| static int | getActionMethodIndex (SoType t) |
| | Returns the index of this node in the action/method table, given its type.
|
| |
| static SoType | getClassTypeId () |
| | Returns the type of this class.
|
| |
| static void | initClass () |
| | Setup type information.
|
| |
| static void | initCopyDict () |
| | During a copy operation, copies of nodes and engines are stored in a dictionary, keyed by the original node or engine pointer, so that copies can be re-used.
|
| |
| static void | addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) |
| | Adds an instance to the dictionary.
|
| |
| static SoFieldContainer * | checkCopy (const SoFieldContainer *orig) |
| | If a copy of the given instance is in the dictionary, this returns it.
|
| |
| static SoFieldContainer * | findCopy (const SoFieldContainer *orig, bool copyConnections) |
| | If a copy of the given instance is not in the dictionary, this returns NULL.
|
| |
| static void | copyDone () |
| | Cleans up the dictionary when done.
|
| |
| static SoType | getClassTypeId () |
| | Returns type identifier for this class.
|
| |
| static void | initClass () |
| | Setup type information.
|
| |
| static void | incrementCurrentWriteCounter () |
| | Increments the current write counter at the start of a write operation.
|
| |
| static void | decrementCurrentWriteCounter () |
| | Decrements the current write counter after a write operation, in some rare cases.
|
| |
| static void | addName (SoBase *, const char *) |
| | Internal methods used to maintain the global name dictionary.
|
| |
| static void | removeName (SoBase *, const char *) |
| |
| static SoBase * | getNamedBase (const SbName &, SoType) |
| | Helper routines used to get stuff out of nameDict.
|
| |
| static int | getNamedBases (const SbName &, SoBaseList &, SoType) |
| |
| static bool | read (SoInput *in, SoBase *&base, SoType expectedType) |
| | Reads one instance of some subclass of SoBase.
|
| |
| static void | setInstancePrefix (const SbString &c) |
| | This defaults to "+" and is used when naming nodes that are DEF's and USE'd.
|
| |
SoPointLightManip is the base class for all SoPointLight 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 SoPointLight, 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 field. 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 SoPointLight with an SoPointLightManip (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 replaceNode() method to insert a manipulator into a scene graph, and the replaceManip() method to remove it when done.
The SoPointLightManip utilizes an SoPointLightDragger to provide a 3D interface. However, the manipulator differs from the dragger; it lights other objects in the scene because, as an SoPointLight, 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 SoPointLightDragger. The interfaces of the dragger and the manipulator are identical.
The SoPointLightManip 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 <em>help</em> 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 translate the dragger. Callbacks insure that the location 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 location field of the SoPointLightManip, the manipulator will place 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 getDragger() 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.
- 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 SoPointLightManip adds a point light into the state, just like its base class, SoPointLight.
- SoSearchAction
Searches just like an SoPointLight. Does not search the dragger, which is a hidden child.
- SoWriteAction
Writes out just like an SoPointLight. 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 getDragger() method and then write it out separately.
- See Also
- SoDragger, SoPointLight, SoPointLightDragger, SoDirectionalLightManip, SoSpotLightManip
Definition at line 149 of file SoPointLightManip.h.
Public Member Functions inherited from SoPointLight