Coin Logo http://www.sim.no
http://www.coin3d.org

Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
SoDirectionalLightManip Class Reference

The SoDirectionalLightManip class is used to manipulate SoDirectionalLight nodes.

More...

#include <Inventor/manips/SoDirectionalLightManip.h>

Inheritance diagram for SoDirectionalLightManip:
SoDirectionalLight SoLight SoNode SoFieldContainer SoBase

List of all members.

Public Member Functions

virtual SoType getTypeId (void) const
 SoDirectionalLightManip (void)
SoDraggergetDragger (void)
SbBool replaceNode (SoPath *path)
SbBool replaceManip (SoPath *path, SoDirectionalLight *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 SoChildListgetChildren (void) const
- Public Member Functions inherited from SoDirectionalLight
 SoDirectionalLight (void)

Static Public Member Functions

static SoType getClassTypeId (void)
static void initClass (void)

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
 ~SoDirectionalLightManip ()
void setDragger (SoDragger *newdragger)
virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections)
- Protected Member Functions inherited from SoDirectionalLight
virtual ~SoDirectionalLight ()
- Protected Member Functions inherited from SoLight
 SoLight (void)
virtual ~SoLight ()
- Protected Member Functions inherited from SoNode
 SoNode (void)
virtual ~SoNode ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)
- Protected Member Functions inherited from SoFieldContainer
 SoFieldContainer (void)
 ~SoFieldContainer ()
- Protected Member Functions inherited from SoBase
 SoBase (void)
virtual ~SoBase ()
virtual void destroy (void)
SbBool hasMultipleWriteRefs (void) const
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
void writeFooter (SoOutput *out) const
virtual const char * getFileFormatName (void) const

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)
static void transferFieldValues (const SoDirectionalLight *from, SoDirectionalLight *to)
static void valueChangedCB (void *f, SoDragger *d)
static void fieldSensorCB (void *f, SoSensor *d)

Protected Attributes

SoFieldSensordirectionFieldSensor
SoFieldSensorcolorFieldSensor
SoChildListchildren

Additional Inherited Members

- Public Attributes inherited from SoDirectionalLight
SoSFVec3f direction
- Public Attributes inherited from SoLight
SoSFBool on
SoSFFloat intensity
SoSFColor color

Detailed Description

The SoDirectionalLightManip class is used to manipulate SoDirectionalLight nodes.

A manipulator is used by replacing the node you want to edit in the graph with the manipulator. Draggers are used to manipulate the node. When manipulation is finished, the node is put back into the graph, replacing the manipulator.


Constructor & Destructor Documentation

SoDirectionalLightManip::SoDirectionalLightManip ( void  )

The constructor sets up the internal SoDiretionalLightDragger used by the manipulator.

References children, colorFieldSensor, directionFieldSensor, fieldSensorCB(), setDragger(), and SoDelayQueueSensor::setPriority().

SoDirectionalLightManip::~SoDirectionalLightManip ( )
protected

Destructor. Clean up resources used by manipulator.

References children, colorFieldSensor, directionFieldSensor, and setDragger().


Member Function Documentation

SoType SoDirectionalLightManip::getClassTypeId ( void  )
static

This static method returns the SoType object associated with objects of this class.

Reimplemented from SoDirectionalLight.

Referenced by copyContents(), and SoIntersectionDetectionAction::isTypeEnabled().

SoType SoDirectionalLightManip::getTypeId ( void  ) const
virtual

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting.

Usage example:

void foo(SoNode * node)
{
if (node->getTypeId() == SoFile::getClassTypeId()) {
SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type
}
else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
SoGroup * group = (SoGroup *)node; // safe downward cast, knows the type
}
}

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Reimplemented from SoDirectionalLight.

const SoFieldData ** SoDirectionalLightManip::getFieldDataPtr ( void  )
staticprotected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Reimplemented from SoDirectionalLight.

const SoFieldData * SoDirectionalLightManip::getFieldData ( void  ) const
protectedvirtual

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoDirectionalLight.

void SoDirectionalLightManip::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 SoDirectionalLight.

Referenced by SoInteraction::init().

SoDragger * SoDirectionalLightManip::getDragger ( void  )
SbBool SoDirectionalLightManip::replaceNode ( SoPath path)
SbBool SoDirectionalLightManip::replaceManip ( SoPath path,
SoDirectionalLight newone 
) const

Replaces this manipulator from the position specified by path with newnode. If newnode is NULL, an SoDirectionalLight will be created for you.

void SoDirectionalLightManip::doAction ( SoAction action)
virtual

This function performs the typical operation of a node for any action.

Reimplemented from SoNode.

References children, SoAction::getPathCode(), SoChildList::traverse(), and SoChildList::traverseInPath().

Referenced by callback(), GLRender(), handleEvent(), pick(), and search().

void SoDirectionalLightManip::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.

References doAction().

void SoDirectionalLightManip::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 SoDirectionalLight.

References doAction().

void SoDirectionalLightManip::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.

References children, SoGetBoundingBoxAction::getCenter(), SbPList::getLength(), SoAction::getPathCode(), SoGetBoundingBoxAction::isCenterSet(), SoGetBoundingBoxAction::resetCenter(), SoGetBoundingBoxAction::setCenter(), and SoChildList::traverse().

void SoDirectionalLightManip::getMatrix ( SoGetMatrixAction action)
virtual

Action method for SoGetMatrixAction.

Updates action by accumulating with the transformation matrix of this node (if any).

Reimplemented from SoNode.

References children, SoAction::getPathCode(), SoChildList::traverse(), and SoChildList::traverseInPath().

void SoDirectionalLightManip::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.

References doAction().

void SoDirectionalLightManip::pick ( SoPickAction action)
virtual

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoNode.

References doAction().

void SoDirectionalLightManip::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.

References doAction(), SoSearchAction::isFound(), and SoNode::search().

SoChildList * SoDirectionalLightManip::getChildren ( void  ) const
virtual

Returns the children of this node. This node only has the dragger as a child.

Reimplemented from SoNode.

References children.

void SoDirectionalLightManip::setDragger ( SoDragger newdragger)
protected
void SoDirectionalLightManip::copyContents ( const SoFieldContainer from,
SbBool  copyconnections 
)
protectedvirtual

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
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.

References SoNode::copyContents(), getClassTypeId(), getDragger(), SoBase::isOfType(), and setDragger().

void SoDirectionalLightManip::transferFieldValues ( const SoDirectionalLight from,
SoDirectionalLight to 
)
staticprotected

Copies field values.

References SoLight::color, and SoDirectionalLight::direction.

Referenced by replaceNode().

void SoDirectionalLightManip::valueChangedCB ( void *  m,
SoDragger dragger 
)
staticprotected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Convert from matrix to direction.

References SoDirectionalLight::direction, SoDragger::getMotionMatrix(), SbMatrix::multDirMatrix(), SbVec3f::normalize(), and SoDebugError::post().

Referenced by setDragger().

void SoDirectionalLightManip::fieldSensorCB ( void *  m,
SoSensor d 
)
staticprotected

Member Data Documentation

SoFieldSensor * SoDirectionalLightManip::directionFieldSensor
protected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Referenced by SoDirectionalLightManip(), and ~SoDirectionalLightManip().

SoFieldSensor * SoDirectionalLightManip::colorFieldSensor
protected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Referenced by SoDirectionalLightManip(), and ~SoDirectionalLightManip().

SoChildList * SoDirectionalLightManip::children
protected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Referenced by doAction(), getBoundingBox(), getChildren(), getDragger(), getMatrix(), setDragger(), SoDirectionalLightManip(), and ~SoDirectionalLightManip().


The documentation for this class was generated from the following files:

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Wed Jul 18 2012 for Coin by Doxygen. 1.8.1.1