---

SoDirectionalLightManip Class Reference

The SoDirectionalLightManip class is used to manipulate SoDirectionalLight nodes. More...

#include <Inventor/manips/SoDirectionalLightManip.h>

Inheritance diagram for SoDirectionalLightManip::

List of all members.

Public Methods
	SoDirectionalLightManip (void)
SoDragger *	getDragger (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 SoChildList *	getChildren (void) const
Static Public Methods
void	initClass (void)
Protected Methods
	~SoDirectionalLightManip ()
void	setDragger (SoDragger *newdragger)
virtual void	copyContents (const SoFieldContainer *fromfc, SbBool copyconnections)
Static Protected Methods
void	transferFieldValues (const SoDirectionalLight *from, SoDirectionalLight *to)
void	valueChangedCB (void *f, SoDragger *d)
void	fieldSensorCB (void *f, SoSensor *d)
Protected Attributes
SoFieldSensor *	directionFieldSensor
SoFieldSensor *	colorFieldSensor
SoChildList *	children

---

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.

SoDirectionalLightManip::~SoDirectionalLightManip (  )  [protected]

Destructor. Clean up resources used by manipulator.

---

Member Function Documentation

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.

SoDragger * SoDirectionalLightManip::getDragger (  void )

Return pointer to internal SoDirectionalLightDragger dragger.

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

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.

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.

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.

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.

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.

void SoDirectionalLightManip::pick (  SoPickAction * action )  [virtual]

Action method for SoPickAction. Does common processing for SoPickAction action instances. Reimplemented from SoNode.

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.

SoChildList * SoDirectionalLightManip::getChildren (  void )  const [virtual]

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

void SoDirectionalLightManip::setDragger (  SoDragger * newdragger )  [protected]

Set dragger to be used by this manipulator.

void SoDirectionalLightManip::copyContents (  const SoFieldContainer * fromfc, 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 method that should be overridden by subclasses which needs to account for internal data that are not handled automatically. 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 SoDirectionalLightManip::transferFieldValues (  const SoDirectionalLight * from, SoDirectionalLight * to )  [static, protected]

Copies field values.

void SoDirectionalLightManip::valueChangedCB (  void * m, SoDragger * dragger )  [static, protected]

For internal use only.

void SoDirectionalLightManip::fieldSensorCB (  void * m, SoSensor * d )  [static, protected]

For internal use only.

---

Member Data Documentation

SoFieldSensor * SoDirectionalLightManip::directionFieldSensor [protected]

For internal use only.

SoFieldSensor * SoDirectionalLightManip::colorFieldSensor [protected]

For internal use only.

SoChildList * SoDirectionalLightManip::children [protected]

For internal use only.

---

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

• SoDirectionalLightManip.cpp
• SoDirectionalLightManip.h
• commoncode.cpp

---