SoSpotLightManip Class Reference

Spotlight node with 3D interface for editing location, direction, and beam width. More...

#include <Inventor/manips/SoSpotLightManip.h>

Inheritance diagram for SoSpotLightManip:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoSpotLightManip ()
	Constructor.
SoDragger *	getDragger ()
	Returns the dragger being used by this manipulator.
SbBool	replaceNode (SoPath *p)
	Replaces the tail of the path with this manipulator.
SbBool	replaceManip (SoPath *p, SoSpotLight *newOne) const
	Replaces the tail of the path, which must be this manipulator, with the given SoSpotLight node.
Public Member Functions inherited from SoSpotLight
	SoSpotLight ()
	Creates a spotlight source node with default settings.
Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.
virtual SbBool	isOverride () const
	Returns the state of the override flag.
virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.
virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.
virtual void	touch ()
	Marks an instance as modified, simulating a change to it.
Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.
SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.
SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.
void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.
SoNONUNICODE SbBool	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 Open Inventor file format.
SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.
virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.
virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.
virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.
virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.
SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.
SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.
virtual void	setUserData (void *data)
	Sets application data.
void *	getUserData (void) const
	Gets user application data.
Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.
virtual void	setName (const SbName &name)
	Sets the name of an instance.
void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.
bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.
Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.
void	unref () const
	Removes a reference from an instance.
void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
int	getRefCount () const
	Returns current reference count.
void	lock () const
	lock this instance.
void	unlock () const
	unlock this instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoSpotLight
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoLight
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().
static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().
Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.
Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Additional Inherited Members
Public Attributes inherited from SoSpotLight
SoSFVec3f	location
	Location of the source.
SoSFVec3f	direction
	Principal direction of illumination (center axis of cone).
SoSFFloat	dropOffRate
	Rate of intensity drop-off per change in angle from primary direction: 0 = constant intensity, 1 = very sharp drop-off.
SoSFFloat	cutOffAngle
	Angle (in radians) outside of which intensity is zero, measured from the center axis of the cone to an edge.
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.

Detailed Description

Spotlight node with 3D interface for editing location, direction, and beam width.

SoSpotLightManip is the base class for all SoSpotLight nodes that have a built-in 3D user interface (this is the only such class provided with the Open Inventor toolkit). Since it is derived from SoSpotLight, 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 , direction , and cutOffAngle fields. 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 SoSpotLight with an SoSpotLightManip (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 SoSpotLightManip utilizes an SoSpotLightDragger to provide a 3D interface. However, the manipulator differs from the dragger; it lights other objects in the scene because, as an SoSpotLight, 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 SoSpotLightDragger. The interfaces of the dragger and the manipulator are identical.

The SoSpotLightManip 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 <B> help </B> 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 widen the cone of the dragger . Callbacks insure that the cutOffAngle 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 cutOffAngle field of the SoSpotLightManip, the manipulator will widen the beam of 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).

You can get this dragger 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

SpotLightManip {

on	TRUE
intensity	1
color	1 1 1
location	0 0 1
direction	0 0 -1
dropOffRate	0
cutOffAngle	0.785398

}

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 SoSpotLightManip adds a spotlight to the state, just like its base class, SoSpotLight.

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

SoWriteAction
Writes out just like an SoSpotLight. 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, SoSpotLight, SoSpotLightDragger, SoDirectionalLightManip, SoPointLightManip

Definition at line 161 of file SoSpotLightManip.h.

Constructor & Destructor Documentation

SoSpotLightManip()

SoSpotLightManip::SoSpotLightManip

(

)

Constructor.

Member Function Documentation

getClassTypeId()

static SoType SoSpotLightManip::getClassTypeId ( )

static

Returns the type identifier for this class.

getDragger()

SoDragger * SoSpotLightManip::getDragger

(

)

Returns the dragger being used by this manipulator.

You can customize this dragger just like you would with any other dragger. You can change geometry using the setPart() method, or add callbacks using the methods found in the SoDragger reference page.

getTypeId()

virtual SoType SoSpotLightManip::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoSpotLight.

replaceManip()

SbBool SoSpotLightManip::replaceManip	(	SoPath *	p,
		SoSpotLight *	newOne
	)		const

Replaces the tail of the path, which must be this manipulator, with the given SoSpotLight node.

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 spotlight node, and the manipulator will be replaced.

The manipulator will not call ref() or unref() on the node which is replacing it. The manipulator will not make any changes to field connections. The calling process is thus responsible for keeping track of its own nodes and field connections.

replaceNode()

SbBool SoSpotLightManip::replaceNode

(

SoPath *

p

)

Replaces the tail of the path with this manipulator.

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

---

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

• Inventor/manips/SoSpotLightManip.h