Point light node with 3D interface for editing location. More...
#include <Inventor/manips/SoPointLightManip.h>
Public Member Functions | |
| SoPointLightManip () | |
| Constructor. | |
| SoDragger * | getDragger () |
| Returns a pointer to the dragger being used by this manipulator. | |
| SbBool | replaceNode (SoPath *p) |
| Replaces the tail of the path with this manipulator. | |
| SbBool | 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. | |
Static Public Member Functions | |
| static void | initClass () |
| initialize the class | |
Protected Member Functions | |
| virtual void | copyContents (const SoFieldContainer *fromFC, SbBool copyConnections) |
| Redefines this to also copy the dragger. | |
| void | setDragger (SoDragger *newDragger) |
| virtual | ~SoPointLightManip () |
Static Protected Member Functions | |
| static void | transferFieldValues (const SoPointLight *from, SoPointLight *to) |
| static void | valueChangedCB (void *, SoDragger *) |
| static void | fieldSensorCB (void *, SoSensor *) |
Protected Attributes | |
| SoFieldSensor * | locationFieldSensor |
| SoFieldSensor * | colorFieldSensor |
| SoChildList * | children |
Detailed Description
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
Definition at line 149 of file SoPointLightManip.h.
Constructor & Destructor Documentation
| SoPointLightManip::SoPointLightManip | ( | ) |
| virtual SoPointLightManip::~SoPointLightManip | ( | ) | [protected, virtual] |
Member Function Documentation
| virtual void SoPointLightManip::callback | ( | SoCallbackAction * | action | ) | [virtual] |
Reimplemented from SoNode.
| virtual void SoPointLightManip::copyContents | ( | const SoFieldContainer * | fromFC, |
| SbBool | copyConnections | ||
| ) | [protected, virtual] |
Reimplemented from SoNode.
| virtual void SoPointLightManip::doAction | ( | SoAction * | action | ) | [virtual] |
They first traverse the children, then use the SoPointLight version of the actions. They traverse first so that the light will affect objects which follow it in the tree, but not the dragger-child.
Reimplemented from SoNode.
| static void SoPointLightManip::fieldSensorCB | ( | void * | , |
| SoSensor * | |||
| ) | [static, protected] |
| virtual void SoPointLightManip::getBoundingBox | ( | SoGetBoundingBoxAction * | action | ) | [virtual] |
Reimplemented from SoNode.
| virtual SoChildList* SoPointLightManip::getChildren | ( | ) | const [virtual] |
Reimplemented from SoNode.
| SoDragger* SoPointLightManip::getDragger | ( | ) |
Given this pointer, you can customize the dragger just like you would any other dragger. You can change geometry using the setPart() method, or add callbacks using the methods found in the SoDragger reference page.
| virtual void SoPointLightManip::getMatrix | ( | SoGetMatrixAction * | action | ) | [virtual] |
Reimplemented from SoNode.
| virtual void SoPointLightManip::GLRender | ( | SoGLRenderAction * | action | ) | [virtual] |
Reimplemented from SoPointLight.
| virtual void SoPointLightManip::handleEvent | ( | SoHandleEventAction * | action | ) | [virtual] |
Reimplemented from SoNode.
| static void SoPointLightManip::initClass | ( | ) | [static] |
Reimplemented from SoPointLight.
| virtual void SoPointLightManip::pick | ( | SoPickAction * | action | ) | [virtual] |
Reimplemented from SoNode.
| SbBool SoPointLightManip::replaceManip | ( | SoPath * | p, |
| SoPointLight * | newOne | ||
| ) | const |
If the path has a nodekit, this will try to use setPart() 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 point light node, and the manipulator will be replaced.
The manipulator will not call ref() or unref() 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.
The tail of the path must be an SoPointLight node (or subclass thereof). If the path has a nodekit, this will try to use setPart() 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 point light node will be copied to this manipulator, and the light node will be replaced.
The manipulator will not call ref() 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.
| virtual void SoPointLightManip::search | ( | SoSearchAction * | action | ) | [virtual] |
Reimplemented from SoNode.
| void SoPointLightManip::setDragger | ( | SoDragger * | newDragger | ) | [protected] |
| static void SoPointLightManip::transferFieldValues | ( | const SoPointLight * | from, |
| SoPointLight * | to | ||
| ) | [static, protected] |
| static void SoPointLightManip::valueChangedCB | ( | void * | , |
| SoDragger * | |||
| ) | [static, protected] |
Member Data Documentation
SoChildList* SoPointLightManip::children [protected] |
Definition at line 244 of file SoPointLightManip.h.
SoFieldSensor* SoPointLightManip::colorFieldSensor [protected] |
Definition at line 239 of file SoPointLightManip.h.
SoFieldSensor* SoPointLightManip::locationFieldSensor [protected] |
Definition at line 238 of file SoPointLightManip.h.
The documentation for this class was generated from the following file:
- MeVis/ThirdParty/Sources/Inventor/inventor/lib/interaction/include/Inventor/manips/SoPointLightManip.h
