NAME
SoPointLightManip -
The SoPointLightManip class is used to manipulate point light nodes.
SYNOPSIS
#include <Inventor/manips/SoPointLightManip.h>
Inherits SoPointLight.
Public Member Functions
SoPointLightManip (void)
SoDragger * getDragger (void)
SbBool replaceNode (SoPath *path)
SbBool replaceManip (SoPath *path, SoPointLight *newone) const
virtual void doAction (SoAction *action)
virtual void callback (SoCallbackAction *action)
virtual void GLRender (SoGLRenderAction *action)
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 (void) const
Static Public Member Functions
static void initClass (void)
Protected Member Functions
virtual ~SoPointLightManip (void)
void setDragger (SoDragger *newdragger)
virtual void copyContents (const SoFieldContainer *fromfc, SbBool
copyconnections)
Static Protected Member Functions
static void transferFieldValues (const SoPointLight *from, SoPointLight
*to)
static void valueChangedCB (void *f, SoDragger *d)
static void fieldSensorCB (void *f, SoSensor *d)
Protected Attributes
SoFieldSensor * locationFieldSensor
SoFieldSensor * colorFieldSensor
SoChildList * children
Detailed Description
The SoPointLightManip class is used to manipulate point light nodes.
A manipulator is used by replacing the node you want to edit in the
graph with the manipulator. Draggers are used to to manipulate the
node. When manipulation is finished, the node is put back into the
graph, replacing the manipulator.
Constructor & Destructor Documentation
SoPointLightManip::SoPointLightManip (void) The constructor. Creates a
default dragger.
SoPointLightManip::~SoPointLightManip (void) [protected, virtual] The
destructor.
Member Function Documentation
void SoPointLightManip::initClass (void) [static] Sets up initialization
for data common to all instances of this class, like submitting
necessary information to the Coin type system.
Reimplemented from SoPointLight.
SoDragger * SoPointLightManip::getDragger (void) Returns the current
dragger.
See also:
setDragger()
SbBool SoPointLightManip::replaceNode (SoPath * path) Replaces the node
specified by path with this manipulator. The manipulator will copy the
field data from the node, to make it affect the state in the same way
as the node.
SbBool SoPointLightManip::replaceManip (SoPath * path, SoPointLight *
newone) const Replaces this manipulator from the position specified by
path with newnode. If newnode is NULL, an SoPointLight will be created
for you.
void SoPointLightManip::doAction (SoAction * action) [virtual] This
function performs the typical operation of a node for any action.
Reimplemented from SoNode.
void SoPointLightManip::callback (SoCallbackAction * action) [virtual]
Action method for SoCallbackAction.
Simply updates the state according to how the node behaves for the
render action, so the application programmer can use the
SoCallbackAction for extracting information about the scene graph.
Reimplemented from SoLight.
void SoPointLightManip::GLRender (SoGLRenderAction * action) [virtual]
Action method for the SoGLRenderAction.
This is called during rendering traversals. Nodes influencing the
rendering state in any way or who wants to throw geometry primitives at
OpenGL overrides this method.
Reimplemented from SoPointLight.
void SoPointLightManip::getBoundingBox (SoGetBoundingBoxAction * action)
[virtual] Action method for the SoGetBoundingBoxAction.
Calculates bounding box and center coordinates for node and modifies
the values of the action to encompass the bounding box for this node
and to shift the center point for the scene more towards the one for
this node.
Nodes influencing how geometry nodes calculates their bounding box also
overrides this method to change the relevant state variables.
Reimplemented from SoNode.
void SoPointLightManip::getMatrix (SoGetMatrixAction * action) [virtual]
Action method for SoGetMatrixAction.
Updates action by accumulating with the transformation matrix of this
node (if any).
Reimplemented from SoNode.
void SoPointLightManip::handleEvent (SoHandleEventAction * action)
[virtual] Action method for SoHandleEventAction.
Inspects the event data from action, and processes it if it is
something which this node should react to.
Nodes influencing relevant state variables for how event handling is
done also overrides this method.
Reimplemented from SoNode.
void SoPointLightManip::pick (SoPickAction * action) [virtual] Action
method for SoPickAction.
Does common processing for SoPickAction action instances.
Reimplemented from SoNode.
void SoPointLightManip::search (SoSearchAction * action) [virtual] Action
method for SoSearchAction.
Compares the search criteria from the action to see if this node is a
match. Searching is done by matching up all criteria set up in the
SoSearchAction -- if any of the requested criteria is a miss, the
search is not deemed successful for the node.
See also:
SoSearchAction
Reimplemented from SoNode.
SoChildList * SoPointLightManip::getChildren (void) const [virtual] Returns
the children of this node. This node only has the dragger as a child.
Reimplemented from SoNode.
void SoPointLightManip::setDragger (SoDragger * newdragger) [protected] The
method can be used to replace the dragger with your own dragger.
void SoPointLightManip::copyContents (const SoFieldContainer * from, SbBool
copyconnections) [protected, virtual] Makes a deep copy of all data of
from into this instance, except external scenegraph references if
copyconnections is FALSE.
This is the protected method that should be overridden by extension
node / engine / dragger / whatever subclasses which needs to account
for internal data that are not handled automatically.
For copying nodes from application code, you should not invoke this
function directly, but rather call the SoNode::copy() function:
SoNode * mynewnode = templatenode->copy();
The same also goes for engines.
Make sure that when you override the copyContents() method in your
extension class that you also make it call upwards to it’s parent
superclass in the inheritance hierarchy, as copyContents() in for
instance SoNode and SoFieldContainer does important work. It should go
something like this:
void
MyCoinExtensionNode::copyContents(const SoFieldContainer * from,
SbBool copyconnections)
{
// let parent superclasses do their thing (copy fields, copy
// instance name, etc etc)
SoNode::copyContents(from, copyconnections);
// [..then copy internal data..]
}
Reimplemented from SoNode.
void SoPointLightManip::transferFieldValues (const SoPointLight * from,
SoPointLight * to) [static, protected] This API member is considered
internal to the library, as it is not likely to be of interest to the
application programmer.
Copies field values.
void SoPointLightManip::valueChangedCB (void * m, SoDragger * dragger)
[static, protected] This API member is considered internal to the
library, as it is not likely to be of interest to the application
programmer.
void SoPointLightManip::fieldSensorCB (void * m, SoSensor * d) [static,
protected] This API member is considered internal to the library, as it
is not likely to be of interest to the application programmer.
Member Data Documentation
SoFieldSensor * SoPointLightManip::locationFieldSensor [protected] This API
member is considered internal to the library, as it is not likely to be
of interest to the application programmer.
SoFieldSensor * SoPointLightManip::colorFieldSensor [protected] This API
member is considered internal to the library, as it is not likely to be
of interest to the application programmer.
SoChildList * SoPointLightManip::children [protected] This API member is
considered internal to the library, as it is not likely to be of
interest to the application programmer.
Author
Generated automatically by Doxygen for Coin from the source code.