SoDirectionalLightManip Class Reference

Directional light node with 3D interface for editing direction. More...

#include <Inventor/manips/SoDirectionalLightManip.h>

Inheritance diagram for SoDirectionalLightManip:

Public Member Functions
	SoDirectionalLightManip ()
	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, SoDirectionalLight *newOne) const
	Replaces the tail of the path, which must be this manipulator, with the given SoDirectionalLight 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.
Public Member Functions inherited from SoDirectionalLight
	SoDirectionalLight ()
	Creates a directional light source node with default settings.
Public Member Functions inherited from SoNode
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.
Public Member Functions inherited from SoFieldContainer
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.
Public Member Functions inherited from SoBase
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 Public Member Functions
static void	initClass ()
	initialize the class
Static Public Member Functions inherited from SoDirectionalLight
static void	initClass ()
Static Public Member Functions inherited from SoLight
static void	initClass ()
Static Public Member Functions inherited from SoNode
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 Public Member Functions inherited from SoFieldContainer
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 Public Member Functions inherited from SoBase
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.

Protected Member Functions
virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Redefines this to also copy the dragger.
void	setDragger (SoDragger *newDragger)
virtual	~SoDirectionalLightManip ()
Protected Member Functions inherited from SoDirectionalLight
virtual	~SoDirectionalLight ()
Protected Member Functions inherited from SoLight
	SoLight ()
	Makes this abstract.
virtual	~SoLight ()
Protected Member Functions inherited from SoNode
	SoNode ()
	Constructor, destructor.
virtual	~SoNode ()
Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer ()
	~SoFieldContainer ()
virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads stuff into instance. Returns FALSE on error.
Protected Member Functions inherited from SoBase
	SoBase ()
	Constructor is protected - this is an abstract class.
virtual	~SoBase ()
	Virtual destructor so that subclasses are deleted properly.
virtual void	destroy ()
	Actually deletes an instance.
bool	hasMultipleWriteRefs () const
	Returns TRUE if the instance has multiple write references.
bool	writeHeader (SoOutput *out, bool isGroup, bool isEngine) const
	Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput.
void	writeFooter (SoOutput *out) const
virtual const char *	getFileFormatName () const
	Unknown nodes and engines write a different name for themselves than their typeId; this virtual method lets them do that (by default the typeId name is returned)
virtual bool	readInstance (SoInput *in, unsigned short flags)=0
	Reads stuff into instance of subclass.

Static Protected Member Functions
static void	transferFieldValues (const SoDirectionalLight *from, SoDirectionalLight *to)
static void	valueChangedCB (void *, SoDragger *)
static void	fieldSensorCB (void *, SoSensor *)
Static Protected Member Functions inherited from SoNode
static const SoFieldData **	getFieldDataPtr ()
	This is used by the field-inheritence mechanism, hidden in the SoSubNode macros.
Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter ()
	Returns current write counter.

Protected Attributes
SoFieldSensor *	directionFieldSensor
SoFieldSensor *	colorFieldSensor
SoChildList *	children
Protected Attributes inherited from SoNode
SbNodeIdType	uniqueId
	Unique id for this node.
Protected Attributes inherited from SoFieldContainer
bool	isBuiltIn
	Is the subclass a built-in Inventor subclass or an extender subclass? This is used to determine whether to read/write field type information.

Additional Inherited Members
Public Types inherited from SoNode
enum	Stage { FIRST_INSTANCE , PROTO_INSTANCE , OTHER_INSTANCE }
Public Attributes inherited from SoDirectionalLight
SoSFVec3f	direction
	Illumination direction vector.
Public Attributes inherited from SoLight
SoSFBool	on
	Determines whether the source is active or inactive.
SoSFFloat	intensity
	Illumination intensity of light source.
SoSFColor	color
	Light source illumination color.
Static Public Attributes inherited from SoBase
static bool	traceRefs
	Turns on/off reference count tracing (for debugging)
Protected Types inherited from SoBase
enum	BaseFlags { IS_ENGINE = 1 , IS_GROUP = 2 }
	This set of enums is used when reading and writing the base. More...
Static Protected Attributes inherited from SoNode
static SbNodeIdType	nextUniqueId
	Next available unique id.
static int	nextActionMethodIndex
	Next index into the action method table.

Detailed Description

SoDirectionalLightManip is the base class for all SoDirectionalLight 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 SoDirectionalLight, 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 direction field. Also, the color of the manipulator's geometry will reflect the color of the light (but you cannot edit the color using this manipulator).

Typically, you will want to replace a regular SoDirectionalLight with an SoDirectionalLightManip (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 SoDirectionalLightManip utilizes an SoDirectionalLightDragger to provide a 3D interface. However, the manipulator differs from the dragger; it lights other objects in the scene because, as an SoDirectionalLight, it alters the state. The field 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 SoDirectionalLightDragger. The interfaces of the dragger and the manipulator are identical.

The SoDirectionalLightManip 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 rotate the dragger. Callbacks ensure that the direction 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 direction field of the SoDirectionalLightManip, the manipulator will orient 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.

File Format/Default

DirectionalLightManip {
  on TRUE
  intensity 1
  color 1 1 1
  direction 0 0 -1
}

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 SoDirectionalLightManip adds a directional light to the state just like its base class, SoDirectionalLight.

SoSearchAction
Searches just like an SoDirectionalLight. Does not search the dragger, which is a hidden child.

SoWriteAction
Writes out just like an SoDirectionalLight. 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, SoDirectionalLight, SoDirectionalLightDragger, SoPointLightManip, SoSpotLightManip

Definition at line 166 of file SoDirectionalLightManip.h.

Constructor & Destructor Documentation

SoDirectionalLightManip()

SoDirectionalLightManip::SoDirectionalLightManip

(

)

~SoDirectionalLightManip()

virtual SoDirectionalLightManip::~SoDirectionalLightManip ( )

protectedvirtual

Member Function Documentation

callback()

virtual void SoDirectionalLightManip::callback ( SoCallbackAction *  action )

virtual

Reimplemented from SoNode.

copyContents()

virtual void SoDirectionalLightManip::copyContents ( const SoFieldContainer *  fromFC, bool  copyConnections  )

protectedvirtual

Reimplemented from SoNode.

doAction()

virtual void SoDirectionalLightManip::doAction ( SoAction *  action )

virtual

They first traverse the children, then use the SoDirectionalLight 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.

fieldSensorCB()

static void SoDirectionalLightManip::fieldSensorCB ( void *  , SoSensor *    )

staticprotected

getBoundingBox()

virtual void SoDirectionalLightManip::getBoundingBox ( SoGetBoundingBoxAction *  action )

virtual

Reimplemented from SoNode.

getChildren()

virtual SoChildList * SoDirectionalLightManip::getChildren ( ) const

virtual

Reimplemented from SoNode.

getDragger()

SoDragger * SoDirectionalLightManip::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.

getMatrix()

virtual void SoDirectionalLightManip::getMatrix ( SoGetMatrixAction *  action )

virtual

Reimplemented from SoNode.

GLRender()

virtual void SoDirectionalLightManip::GLRender ( SoGLRenderAction *  action )

virtual

Reimplemented from SoDirectionalLight.

handleEvent()

virtual void SoDirectionalLightManip::handleEvent ( SoHandleEventAction *  action )

virtual

Reimplemented from SoNode.

initClass()

static void SoDirectionalLightManip::initClass ( )

static

pick()

virtual void SoDirectionalLightManip::pick ( SoPickAction *  action )

virtual

Reimplemented from SoNode.

replaceManip()

bool SoDirectionalLightManip::replaceManip	(	SoPath *	p,
		SoDirectionalLight *	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 directional 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.

replaceNode()

bool SoDirectionalLightManip::replaceNode

(

SoPath *

p

)

The tail of the path must be an SoDirectionalLight 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 directional 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.

search()

virtual void SoDirectionalLightManip::search ( SoSearchAction *  action )

virtual

Reimplemented from SoNode.

setDragger()

void SoDirectionalLightManip::setDragger ( SoDragger *  newDragger )

protected

transferFieldValues()

static void SoDirectionalLightManip::transferFieldValues ( const SoDirectionalLight *  from, SoDirectionalLight *  to  )

staticprotected

valueChangedCB()

static void SoDirectionalLightManip::valueChangedCB ( void *  , SoDragger *    )

staticprotected

Member Data Documentation

children

SoChildList* SoDirectionalLightManip::children

protected

Definition at line 262 of file SoDirectionalLightManip.h.

colorFieldSensor

SoFieldSensor* SoDirectionalLightManip::colorFieldSensor

protected

Definition at line 257 of file SoDirectionalLightManip.h.

directionFieldSensor

SoFieldSensor* SoDirectionalLightManip::directionFieldSensor

protected

Definition at line 256 of file SoDirectionalLightManip.h.

---

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

• C:/jh/mevislab/4.0.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/manips/SoDirectionalLightManip.h