Directional icon you rotate and translate by dragging with the mouse. More...

#include <Inventor/draggers/SoDirectionalLightDragger.h>

Inheritance diagram for SoDirectionalLightDragger:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

virtual const SoNodekitCatalog *	getNodekitCatalog () const
	Returns the SoNodekitCatalog for this instance.

	SoDirectionalLightDragger ()
	Constructor.

Public Member Functions inherited from SoDragger
void	addStartCallback (SoDraggerCB f, void userData=NULL)
	Adds start callback.

void	removeStartCallback (SoDraggerCB f, void userData=NULL)
	Removes start callback.

void	addMotionCallback (SoDraggerCB f, void userData=NULL)
	Adds motion callback.

void	removeMotionCallback (SoDraggerCB f, void userData=NULL)
	Removes motion callback.

void	addFinishCallback (SoDraggerCB f, void userData=NULL)
	Adds finish callback.

void	removeFinishCallback (SoDraggerCB f, void userData=NULL)
	Removes finish callback.

void	addValueChangedCallback (SoDraggerCB f, void userData=NULL)
	Adds value-changed callback.

void	removeValueChangedCallback (SoDraggerCB f, void userData=NULL)
	Removes value-changed callback.

void	setMinGesture (int pixels)
	Sets the number of pixels of movement required to initiate a constraint gesture.

void	setMinGesture (float pixels)
	Float version of setMinGesture.

int	getMinGesture () const
	Gets the number of pixels of movement required to initiate a constraint gesture.

float	getMinGestureFloat () const
	Float version of getMinGesture.

SbBool	enableValueChangedCallbacks (SbBool newVal)
	You can temporarily disable a dragger's valueChangedCallbacks.

void	setTrackerDirectMode (TrackerDirectMode mode=DEFAULT)
	Sets the tracker direct mode for this dragger (see description above).

TrackerDirectMode	getTrackerDirectMode () const
	Get the current tracker direct mode for this dragger.

void	setMotionMatrix (const SbMatrix &newMatrix)
	Set the motion matrix.

const SbMatrix &	getMotionMatrix ()
	Get the motion matrix.

Public Member Functions inherited from SoInteractionKit
virtual SbBool	setPartAsPath (const SbName &partName, SoPath *surrogatePath)
	Sets any public part in the interaction kit as a "surrogate" path instead.

virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.

Public Member Functions inherited from SoBaseKit
	SoBaseKit ()
	Constructor.

virtual SoNode *	getPart (const SbName &partName, SbBool makeIfNeeded)
	Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.

template<typename PartType >
PartType *	getPart (const SbName &partName)
	Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to TRUE.

template<typename PartType >
PartType *	checkPart (const SbName &partName)
	Like getPart(const SbName&,SbBool) but casts the returned part to the specified type and sets the makeIfNeeded parameter to FALSE.

SbString	getPartString (const SoBase *part)
	Given a node or a path to a node, checks if the part exists in the nodekit, in a nested nodekit, or an element of a list part.

virtual SoNodeKitPath *	createPathToPart (const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend=NULL)
	Returns a path that begins at this nodekit and ends at partName.

virtual SbBool	setPart (const SbName &partName, SoNode *newPart)
	Inserts the given node (not a copy) as the new part specified by partName.

SoNONUNICODE SbBool	set (char *nameValuePairListString)
	This function allows field values of parts (nodes) to be set in several different parts simultaneously.

SbBool	set (const SbString &nameValuePairListString)
	This function allows field values of parts (nodes) to be set in several different parts simultaneously.

SoNONUNICODE SbBool	set (const char partNameString, const char parameterString)
	This function allows field values of parts (nodes) to be set.

SbBool	set (const SbString &partNameString, const SbString &parameterString)
	This function allows field values of parts (nodes) to be set.

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

Public Member Functions inherited from SoGetView
	SoGetView ()
	Default constructor.

virtual	~SoGetView ()

virtual SbBool	getViewportIsEnabled () const
	Returns TRUE if SoGetView functionalities are enabled, FALSE otherwise.

virtual const SbVec2f	getViewportOrigin () const
	Returns SbViewportRegion origin.

virtual const SbVec2f	getViewportSize () const
	Returns SbViewportRegion size.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.

Static Public Member Functions inherited from SoDragger
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.

static void	setMinScale (float newMinScale)
	Sets the smallest scale that any dragger will write.

static float	getMinScale ()
	Gets the smallest scale that any dragger will write.

static void	setInitialTrackerDirectMode (TrackerDirectMode mode=DEFAULT)
	Set the initial tracker direct mode for draggers not yet created.

static TrackerDirectMode	getInitialTrackerDirectMode ()
	Get the initial tracker direct mode.

Static Public Member Functions inherited from SoInteractionKit
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for this class.

Static Public Member Functions inherited from SoBaseKit
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for the class SoBaseKit.

static void	setSearchingChildren (SbBool newVal)
	Sets if nodekit children are searched during SoSearchAction traversal.

static SbBool	isSearchingChildren ()
	Returns TRUE if nodekit children are searched during SoSearchAction traversal.

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.

Public Attributes
SoSFRotation	rotation
	Orientation of the rotating part (an arrow by default).

SoSFVec3f	translation
	Position of the origin of the directional light dragger.

Public Attributes inherited from SoDragger
SoSFBool	isActive
	TRUE when mouse is down and dragging, else FALSE.

SoSFBool	enableCallbacks
	If set to FALSE, motion, start and finish callbacks are disabled.

Public Attributes inherited from SoInteractionKit
SoSFEnum	boundingBoxCaching
	Set bounding box caching mode.

SoSFEnum	renderCulling
	Set render culling mode.

SoSFEnum	pickCulling
	Set pick caching mode.

SoDEPRECATED SoSFEnum	renderCaching
	Set render caching mode.

Public Attributes inherited from SoBaseKit
SoSFBool	boundingBoxIgnoring
	Whether to ignore this node during bounding box traversal.

Additional Inherited Members
Public Types inherited from SoDragger
enum	TrackerDirectMode { NONE , MOVE , ROTATE , FREE , DEFAULT }
	Tracker direct mode. More...

typedef void	SoDraggerCB(void userData, SoDragger dragger)
	Used in defining the callback function lists.

Public Types inherited from SoInteractionKit
enum	CacheEnabled { OFF , ON , AUTO }
	Possible values for caching. More...

Detailed Description

Directional icon you rotate and translate by dragging with the mouse.

SoDirectionalLightDragger is a composite dragger. It looks like a sun with a large arrow coming out of it. The arrow can be rotated about the sun by dragging with the mouse; its orientation is given by the rotation field. You can also drag the sun (and the arrow with it) through 3-space. The location is stored in the translation field.

The dragger uses an SoRotateSphericalDragger for changing the rotation. Instead of using the default spherical geometry, this dragger uses an arrow shape.

The sun is an SoDragPointDragger. Dragging it edits the translation field; conversely, if you change the translation field the sun will move to that new location, bringing the arrow with it. The sun looks and behaves just like the sun in an SoPointLightDragger, as does the material part. See the SoPointLightDragger reference page for details.

Remember: This is not a light source! It just looks like one. If you want to move a light with this dragger, you can either:

Use an SoDirectionalLightManip, which is subclassed from SoLight. It creates an SoDirectionalLightDragger and uses it as the interface to change the direction of its light source (see the SoDirectionalLightManip reference page). The manipulator also edits the material part of this dragger to match the color of light the manipulator is producing. However, the directional light manipulator will ignore the translation field, because a directional light has no location or translation field. So in this case the translation dragger merely allows you to move the physical arrow to wherever you'd like it to be.
Put an SoTransform under an SoTransformSeparator. Add the SoDirectionalLight as the next child. Use a field-to-field connection between the rotation fields of this dragger and the transform node to synchronize the light with this dragger.
Use engines to connect the rotation field of this dragger to the direction field of an SoDirectionalLight. Use the rotation as input to an SoComposeMatrix engine. Then, use an SoTransformVec3f engine to apply that matrix to (0,0,-1), the default light direction.

You can change the parts in any instance of this dragger using setPart(). The default part geometries are defined as resources for this SoDirectionalLightDragger class. They are detailed in the Dragger Resources section of the online reference page for this class. You can make your program use different default resources for the parts by copying the file $OIVHOME/data/draggerDefaults/directionalLightDragger.iv into your own directory, editing the file, and then setting the environment variable SO_DRAGGER_DIR to be a path to that directory.

See SoDragger for more information about using and customizing draggers, including code examples, using draggers in an immersive VR environment and using WYSIWYG draggers.

FILE FORMAT/DEFAULT

boundingBoxCaching	AUTO
renderCulling	AUTO
pickCulling	AUTO
isActive	FALSE
translation	0 0 0
rotation	0 0 1 0
callbackList	NULL
material	<directionalLightOverallMaterial resource>
translatorRotInv	NULL
translator	DragPointDragger {
	}
rotator	RotateSphericalDragger {
	}
rotator.rotator	<directionalLightRotatorRotator resource>
rotator.rotatorActive	<directionalLightRotatorRotatorActive resource>
rotator.feedback	<directionalLightRotatorFeedback resource>
rotator.feedbackActive	<directionalLightRotatorFeedbackActive resource>
translator.yzTranslator.translator	<directionalLightTranslatorPlaneTranslator resource>
translator.xzTranslator.translator	<directionalLightTranslatorPlaneTranslator resource>
translator.xyTranslator.translator	<directionalLightTranslatorPlaneTranslator resource>
translator.yzTranslator.translatorActive	<directionalLightTranslatorPlaneTranslatorActive resource>
translator.xzTranslator.translatorActive	<directionalLightTranslatorPlaneTranslatorActive resource>
translator.xyTranslator.translatorActive	<directionalLightTranslatorPlaneTranslatorActive resource>
translator.xTranslator.translator	<directionalLightTranslatorLineTranslator resource>
translator.yTranslator.translator	<directionalLightTranslatorLineTranslator resource>
translator.zTranslator.translator	<directionalLightTranslatorLineTranslator resource>
translator.xTranslator.translatorActive	<directionalLightTranslatorLineTranslatorActive resource>
translator.yTranslator.translatorActive	<directionalLightTranslatorLineTranslatorActive resource>
translator.zTranslator.translatorActive	<directionalLightTranslatorLineTranslatorActive resource>

DRAGGER RESOURCES

Resource:	directionalLightRotatorRotator
Part:	rotator.rotator
Appearance:	white arrow that goes through the sun
Description:	picking this begins rotation of the arrow about the sun-shape
Resource:	directionalLightRotatorRotatorActive
Part:	rotator.rotatorActive
Appearance:	yellow arrow that goes through the sun
Description:	displayed while the arrow is being rotated
Resource:	directionalLightRotatorFeedback
Part:	rotator.feedback
Appearance:	empty Separator
Description:	this disables display of the axes that a rotateSpherical dragger uses by default
Resource:	directionalLightRotatorFeedbackActive
Part:	rotator.feedbackActive
Appearance:	empty Separator
Description:	this disables display of the axes that a rotateSpherical dragger uses by default
Resource:	directionalLightOverallMaterial
Part:	material
Appearance:	white. half strength emissive, half strength diffuse
Description:	sets material for the sun shape when stationary. Resource for the moving sun, directionalLightTranslatorPlaneTranslatorActive, contains a yellow material for highlighting.
Resource:	directionalLightTranslatorPlaneTranslator
Parts:	translator.yzTranslator.translator<BR> translator.xzTranslator.translator<BR> translator.xyTranslator.translator
Appearance:	sun shape with no material
Description:	picking these parts initiates dragging by the yz, xz, and xy planar draggers respectively.
Resource:	directionalLightTranslatorPlaneTranslatorActive
Parts:	translator.yzTranslator.translatorActive<BR> translator.xzTranslator.translatorActive<BR> translator.xyTranslator.translatorActive
Appearance:	yellow sun shape
Description:	shown during planar dragging in the yz, xz, and xy planes respectively.
Resource:	directionalLightTranslatorLineTranslator
Parts:	translator.xTranslator.translator<BR> translator.yTranslator.translator<BR> translator.zTranslator.translator
Appearance:	white cylinder
Description:	picking these parts initiates dragging in the x, y, and z linear draggers respectively.
Resource:	directionalLightTranslatorLineTranslatorActive
Parts:	translator.xTranslator.translatorActive<BR> translator.yTranslator.translatorActive<BR> translator.zTranslator.translatorActive
Appearance:	yellow cylinder
Description:	shown during linear dragging in the x, y, and z directions respectively.

CATALOG PARTS

Part Name	Part Type	Default Type	NULL Default
callbackList	NodeKitListPart	–	yes
material	Material	–	yes
translatorRotInv	Rotation	–	yes
translator	DragPointDragger	–	yes
rotator	RotateSphericalDragger	–	yes

Extra Information for List Parts from Above Table

Part Name	Container Type	Possible Types
callbackList	Separator	Callback; EventCallback

Constructor & Destructor Documentation

◆ SoDirectionalLightDragger()

SoDirectionalLightDragger::SoDirectionalLightDragger ( )

Constructor.

Member Function Documentation

◆ getClassNodekitCatalog()

static const SoNodekitCatalog * SoDirectionalLightDragger::getClassNodekitCatalog ( )

static

Returns the SoNodekitCatalog for this class.

◆ getClassTypeId()

static SoType SoDirectionalLightDragger::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getNodekitCatalog()

virtual const SoNodekitCatalog * SoDirectionalLightDragger::getNodekitCatalog ( ) const

virtual

Returns the SoNodekitCatalog for this instance.

Reimplemented from SoDragger.

◆ getTypeId()

virtual SoType SoDirectionalLightDragger::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoDragger.

Member Data Documentation

◆ rotation

SoSFRotation SoDirectionalLightDragger::rotation

Orientation of the rotating part (an arrow by default).

Definition at line 294 of file SoDirectionalLightDragger.h.

◆ translation

SoSFVec3f SoDirectionalLightDragger::translation

Position of the origin of the directional light dragger.

Definition at line 299 of file SoDirectionalLightDragger.h.

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

Inventor/draggers/SoDirectionalLightDragger.h

Open Inventor Release 2024.2.1

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members