SoSpotLightDragger Class Reference

Spotlight shaped dragger that allows you to change position, direction, and width of the beam. More...

#include <Inventor/draggers/SoSpotLightDragger.h>

Inheritance diagram for SoSpotLightDragger:

Public Member Functions
	SoSpotLightDragger ()
	Constructor.
Public Member Functions inherited from SoDragger
void	addStartCallback (SoDraggerCB *f, void *userData=NULL)
	Start callbacks are made after the mouse button 1 goes down and the dragger determines that it has been picked.
void	removeStartCallback (SoDraggerCB *f, void *userData=NULL)
void	addMotionCallback (SoDraggerCB *f, void *userData=NULL)
	Motion callbacks are called after each movement of the mouse during dragging.
void	removeMotionCallback (SoDraggerCB *f, void *userData=NULL)
	Motion callbacks are called after each movement of the mouse during dragging.
void	addFinishCallback (SoDraggerCB *f, void *userData=NULL)
	Finish callbacks are made after dragging ends and the dragger has stopped grabbing events.
void	removeFinishCallback (SoDraggerCB *f, void *userData=NULL)
	Finish callbacks are made after dragging ends and the dragger has stopped grabbing events.
void	addValueChangedCallback (SoDraggerCB *f, void *userData=NULL)
	Value-changed callbacks are made after a dragger changes any of its fields.
void	removeValueChangedCallback (SoDraggerCB *f, void *userData=NULL)
void	setMinGesture (int pixels)
	Set and get the number of pixels of movement required to initiate a constraint gesture.
int	getMinGesture () const
	Set and get the number of pixels of movement required to initiate a constraint gesture.
bool	enableValueChangedCallbacks (bool newVal)
	You can temporarily disable a dragger's valueChangedCallbacks.
const SbMatrix &	getMotionMatrix ()
	Get the motion matrix.
void	addOtherEventCallback (SoDraggerCB *f, void *userData=NULL)
	In addition to the public callback functions, these callback functions can also be used by subclasses to find out when things have happened.
void	removeOtherEventCallback (SoDraggerCB *f, void *userData=NULL)
void	registerChildDragger (SoDragger *child)
	Compound draggers should call this for each child dragger so that user callbacks (valueChanged, start, motion, finish, other event) registered with the parent dragger will be invoked based on the child dragger.
void	unregisterChildDragger (SoDragger *child)
void	registerChildDraggerMovingIndependently (SoDragger *child)
	These two routines tie the child to the parent, but WITHOUT the transferMotion callback.
void	unregisterChildDraggerMovingIndependently (SoDragger *child)
SbMatrix	getLocalToWorldMatrix ()
	Get the matrix which converts from one dragger space to another.
SbMatrix	getWorldToLocalMatrix ()
SbVec3f	getLocalStartingPoint ()
	Returns the starting point in local coordinates.
SbVec3f	getWorldStartingPoint ()
	Returns the starting point in world coordinates.
void	getPartToLocalMatrix (const SbName &partName, SbMatrix &partToLocalMatrix, SbMatrix &localToPartMatrix)
	Get the matrix which converts from the space of one part into local space.
void	transformMatrixLocalToWorld (const SbMatrix &fromMatrix, SbMatrix &toMatrix)
	Transforms a given matrix from one space into another space.
void	transformMatrixWorldToLocal (const SbMatrix &fromMatrix, SbMatrix &toMatrix)
void	transformMatrixToLocalSpace (const SbMatrix &fromMatrix, SbMatrix &toMatrix, const SbName &fromSpacePartName)
void	setMotionMatrix (const SbMatrix &newMatrix)
	Set the motion matrix.
void	valueChanged ()
	Invokes the valueChangedCallbacks.
const SbMatrix &	getStartMotionMatrix ()
	Used to calculate motion relative to the dragger's position at the beginning of the dragging.
virtual void	saveStartParameters ()
	By default, saves the motionMatrix as the startMotionMatrix.
const SoPath *	getPickPath () const
	Information that's good to have during a valueChanged callback.
const SoEvent *	getEvent () const
SoPath *	createPathToThis ()
	Creates a new path leading to this dragger, if the last path given by setTempPathToThis() is still valid.
const SoPath *	getSurrogatePartPickedOwner () const
	Surrogate Pick Information.
const SbName &	getSurrogatePartPickedName () const
	Name: Name of the surrogate part within the owners list.
const SoPath *	getSurrogatePartPickedPath () const
	SurrogatePath: The owner's surrogate path for this name.
void	setStartingPoint (const SoPickedPoint *newPoint)
	Set the point where the drag begins.
void	setStartingPoint (const SbVec3f &newPoint)
	The SbVec3f version would usually be a point saved from the end of another gesture.
const SbViewVolume &	getViewVolume ()
	Information about the window an event occurred in.
void	setViewVolume (const SbViewVolume &vol)
const SbViewportRegion &	getViewportRegion ()
void	setViewportRegion (const SbViewportRegion &reg)
SoHandleEventAction *	getHandleEventAction () const
	Get the most recent handleEventAction.
void	setHandleEventAction (SoHandleEventAction *newAction)
void	setTempPathToThis (const SoPath *somethingClose)
	A path leading to 'this.
virtual void	grabEventsSetup ()
	Called when the dragger gains or loses status as "grabber" of events.
virtual void	grabEventsCleanup ()
void	workFieldsIntoTransform (SbMatrix &mtx)
	Changes only that part of the matrix for which this dragger has fields.
void	setFrontOnProjector (ProjectorFrontSetting newVal)
ProjectorFrontSetting	getFrontOnProjector () const
Public Member Functions inherited from SoInteractionKit
virtual bool	setPartAsPath (const SbName &partName, SoPath *surrogatePath)
	Sets any public part in the interaction kit as a "surrogate" path instead.
virtual bool	affectsState () const
	Override the default behavior of SoNode.
virtual bool	setPartAsDefault (const SbName &partName, SoNode *newNode, bool onlyIfAlready=TRUE)
	Sets the part, then sets the field for that part to default using partField.setDefault(TRUE).
virtual bool	setPartAsDefault (const SbName &partName, const SbName &newNodeName, bool onlyIfAlready=TRUE)
bool	isPathSurrogateInMySubgraph (const SoPath *pathToCheck)
	Is the 'inPath' valid as a surrogate path anywhere in this node's subgraph? Examines the surrogate paths of all InteractionKits from this node down.
bool	isPathSurrogateInMySubgraph (const SoPath *pathToCheck, SoPath *&pathToOwner, SbName &surrogateNameInOwner, SoPath *&surrogatePathInOwner, bool fillArgs=TRUE)
Public Member Functions inherited from SoBaseKit
virtual const SoNodekitCatalog *	getNodekitCatalog () const
	Returns the SoNodekitCatalog for this instance of SoBaseKit.
	SoBaseKit ()
	Constructor.
virtual SoNode *	getPart (const SbName &partName, bool makeIfNeeded)
	Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.
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, bool makeIfNeeded, const SoPath *pathToExtend=NULL)
	Returns a path that begins at this nodekit and ends at partName.
virtual bool	setPart (const SbName &partName, SoNode *from)
	Inserts the given node (not a copy) as the new part specified by partName.
bool	set (char *nameValuePairListString)
	SETTING FIELDS OF PARTS.
bool	set (char *partNameString, char *parameterString)
virtual void	doAction (SoAction *action)
	This method performs the "typical" operation of a node for any action.
virtual void	callback (SoCallbackAction *action)
	These functions implement all actions for nodekits.
virtual void	GLRender (SoGLRenderAction *action)
	These virtual functions implement all of the actions for nodes, Most of the default implementations do nothing.
virtual void	getBoundingBox (SoGetBoundingBoxAction *action)
virtual void	getMatrix (SoGetMatrixAction *action)
virtual void	handleEvent (SoHandleEventAction *action)
virtual void	rayPick (SoRayPickAction *action)
virtual void	search (SoSearchAction *action)
virtual void	write (SoWriteAction *action)
virtual SoChildList *	getChildren () const
	Returns pointer to children.
void	printDiagram ()
void	printSubDiagram (const SbName &rootName, int level)
void	printTable ()
virtual void	addWriteReference (SoOutput *out, bool isFromField=FALSE)
	Overrides the default method to use countMyFields() instead of the regular SoFieldData writing mechanism.
bool	forceChildDrivenWriteRefs (SoOutput *out)
	This returns TRUE if the nodekit intends to write out.
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 SoDragger
static void	setMinScale (float newMinScale)
	The smallest scale that any dragger will write.
static float	getMinScale ()
	Get min scale.
static void	workValuesIntoTransform (SbMatrix &mtx, const SbVec3f *translationPtr, const SbRotation *rotationPtr, const SbVec3f *scaleFactorPtr, const SbRotation *scaleOrientationPtr, const SbVec3f *centerPtr)
	Same as above, but values are given explicitly as pointers.
static void	getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scaleFactor, SbRotation &scaleOrientation, const SbVec3f &center)
	Faster versions of getTransform() and factor() that take advantage of the case where there is no scaleOrientation.
static void	getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scaleFactor, SbRotation &scaleOrientation)
static SbMatrix	appendTranslation (const SbMatrix &mtx, const SbVec3f &translation, const SbMatrix *conversion=NULL)
	Appends the given motion to the end of 'mtx'.
static SbMatrix	appendScale (const SbMatrix &mtx, const SbVec3f &scale, const SbVec3f &scaleCenter, const SbMatrix *conversion=NULL)
static SbMatrix	appendRotation (const SbMatrix &mtx, const SbRotation &rot, const SbVec3f &rotCenter, const SbMatrix *conversion=NULL)
static void	initClass ()
static void	initClasses ()
	Initialize ALL Inventor detail classes.
Static Public Member Functions inherited from SoInteractionKit
static void	setSwitchValue (SoNode *n, int newVal)
static void	initClass ()
	initialize the class
Static Public Member Functions inherited from SoBaseKit
static const SoNodekitCatalog *	getClassNodekitCatalog ()
	Returns the SoNodekitCatalog for the class SoBaseKit.
static bool	isSearchingChildren ()
	Sets and queries if nodekit children are searched during SoSearchAction traversal.
static void	setSearchingChildren (bool newVal)
	Sets and queries if nodekit children are searched during SoSearchAction traversal.
static void	initClass ()
static SoNode *	typeCheck (const SbName &partName, const SoType &partType, SoNode *node)
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.

Public Attributes
SoSFRotation	rotation
SoSFVec3f	translation
SoSFFloat	angle
Public Attributes inherited from SoDragger
SoSFBool	enable
	This field is a boolean that enables / disables interaction.
SoSFBool	isActive
	This field is a boolean that is TRUE when the mouse is down and we are dragging, FALSE otherwise.
Public Attributes inherited from SoInteractionKit
SoSFEnum	renderCaching
	Set render caching mode. Default is AUTO.
SoSFEnum	boundingBoxCaching
	Set bounding box caching mode.
SoSFEnum	renderCulling
	Set render culling mode.
SoSFEnum	pickCulling
	Set pick caching mode. Default is AUTO.

Protected Member Functions
void	dragStart ()
void	drag ()
void	dragFinish ()
void	setBeamScaleFromAngle (float beamAngle)
	Returns scaleFactor for beamScale part to display beamAngle.
virtual bool	setUpConnections (bool onOff, bool doItAlways=FALSE)
	detach/attach any sensors, callbacks, and/or field connections.
virtual void	setDefaultOnNonWritingFields ()
	Called by the SoBaseKit::write() method.
virtual	~SoSpotLightDragger ()
Protected Member Functions inherited from SoDragger
	SoDragger ()
	Constructor.
SbVec2f	getNormalizedLocaterPosition ()
	Get the last known position of the locator (mouse).
SbVec2s	getLocaterPosition ()
SbVec2s	getStartLocaterPosition () const
	Get the position of the locater when dragging started.
void	setStartLocaterPosition (SbVec2s p)
	The start locater position is automatically set when button 1 goes down over the dragger.
bool	isAdequateConstraintMotion ()
	Has the locater moved far enough from where it started to choose a constraint gesture.
virtual bool	shouldGrabBasedOnSurrogate (const SoPath *pickPath, const SoPath *surrogatePath)
	Given a pickPath and a surrogatePath, decides whether it should grab based on the surrogate.
void	setCameraInfo (SoAction *action)
	The dragger looks in this action to get information about the camera and the viewport.
virtual void	handleEvent (SoHandleEventAction *ha)
	This is called during traversal by a HandleEventAction.
virtual bool	mouseButtonPressed (const SoEvent *ev)
	This is called during handleEvent.
virtual bool	mouseButtonReleased (const SoEvent *ev)
	This is called during handleEvent.
void	transferMotion (SoDragger *child)
	This should be called by every child dragger of a compound dragger as a result of compoundDragger->registerChildDragger( childDragger ); Called on the compoundDragger when childDragger's value changes.
void	setIgnoreInBbox (bool newVal)
	Set/get whether the dragger should be ignored during bounding box calculations.
bool	isIgnoreInBbox ()
virtual void	getBoundingBox (SoGetBoundingBoxAction *action)
	Implements getBoundingBox action.
void	setActiveChildDragger (SoDragger *newChildDragger)
	Called by the above child callbacks.
SoDragger *	getActiveChildDragger () const
virtual void	setDefaultOnNonWritingFields ()
	Called by the SoBaseKit::write() method.
virtual	~SoDragger ()
Protected Member Functions inherited from SoInteractionKit
	SoInteractionKit ()
	~SoInteractionKit ()
virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Copies the contents of the given instance into this instance This copies the surrogatePartPathList and the surrogatePartNameList.
virtual SoNode *	getAnyPart (const SbName &partName, bool makeIfNeeded, bool leafCheck=FALSE, bool publicCheck=FALSE)
	These are overloaded to set the surrogate path to NULL after completing their work.
virtual SoNodeKitPath *	createPathToAnyPart (const SbName &partName, bool makeIfNeeded, bool leafCheck=FALSE, bool publicCheck=FALSE, const SoPath *pathToExtend=NULL)
virtual bool	setAnyPart (const SbName &partName, SoNode *from, bool anyPart=TRUE)
virtual bool	setAnyPartAsPath (const SbName &partName, SoPath *surrogatePath, bool leafCheck=FALSE, bool publicCheck=FALSE)
	This allows you to set any part in the nodekit as a surrogate path.
virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads in from file.
virtual bool	setAnyPartAsDefault (const SbName &partName, SoNode *newNode, bool anyPart=TRUE, bool onlyIfAlready=TRUE)
	Protected versions of these methods that allow you to set non-leaf and/or private parts.
virtual bool	setAnyPartAsDefault (const SbName &partName, const SbName &newNodeName, bool anyPart=TRUE, bool onlyIfAlready=TRUE)
bool	setAnySurrogatePath (const SbName &inName, SoPath *inPath, bool leafCheck=FALSE, bool publicCheck=FALSE)
void	connectSeparatorFields (SoSeparator *dest, bool onOff)
Protected Member Functions inherited from SoBaseKit
	SO_KIT_CATALOG_ENTRY_HEADER (callbackList)
	Define fields for the new parts of the kit...
virtual SoNode *	addToCopyDict () const
	Redefines this to add this node and all part nodes to the dictionary.
virtual void	copyContents (const SoFieldContainer *fromFC, bool copyConnections)
	Copies the contents of the given nodekit into this instance.
SoGroup *	getContainerNode (const SbName &listName, bool makeIfNeeded=TRUE)
	Returns the containerNode within the SoNodeKitListPart given by listName.
virtual SoNode *	getAnyPart (const SbName &partName, bool makeIfNeeded, bool leafCheck=FALSE, bool publicCheck=FALSE)
	like their public versions, but are allowed access to non-leaf and private parts.
virtual SoNodeKitPath *	createPathToAnyPart (const SbName &partName, bool makeIfNeeded, bool leafCheck=FALSE, bool publicCheck=FALSE, const SoPath *pathToExtend=NULL)
virtual bool	setAnyPart (const SbName &partName, SoNode *from, bool anyPart=TRUE)
void	createNodekitPartsList ()
	called during construction to create parts list
virtual void	createDefaultParts ()
	called during construction to create any parts that are created by default (such as the cube in the SoCubeKit)
const SoNodekitParts *	getNodekitPartsList () const
	Return the node's partsList.
void	catalogError ()
	Prints an Error when there's trouble building a catalog.
virtual bool	setUpConnections (bool onOff, bool doItAlways=FALSE)
	detach/attach any sensors, callbacks, and/or field connections.
virtual bool	readInstance (SoInput *in, unsigned short flags)
	Reads in from file. Takes care of setting parts and stuff.
virtual void	setDefaultOnNonWritingFields ()
	This is called during countMyFields() method.
void	countMyFields (SoOutput *out)
	This is called during addWriteReference() to write the fields.
virtual	~SoBaseKit ()
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	startCB (void *, SoDragger *)
static void	motionCB (void *, SoDragger *)
static void	doneCB (void *, SoDragger *)
static void	fieldSensorCB (void *, SoSensor *)
static void	valueChangedCB (void *, SoDragger *)
Static Protected Member Functions inherited from SoDragger
static void	childTransferMotionAndValueChangedCB (void *, SoDragger *)
	Stubs used by compound draggers to get user callbacks from the child dragger.
static void	childValueChangedCB (void *, SoDragger *)
static void	childStartCB (void *, SoDragger *)
static void	childMotionCB (void *, SoDragger *)
static void	childFinishCB (void *, SoDragger *)
static void	childOtherEventCB (void *, SoDragger *)
Static Protected Member Functions inherited from SoInteractionKit
static void	readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize)
	read from buffer
static void	fieldSensorCB (void *, SoSensor *)
Static Protected Member Functions inherited from SoBaseKit
static const SoNodekitCatalog **	getClassNodekitCatalogPtr ()
	...end of contents of SO_KIT_HEADER
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
SbPlaneProjector *	planeProj
	used during interaciton with beam
SoFieldSensor *	rotFieldSensor
SoFieldSensor *	translFieldSensor
SoFieldSensor *	angleFieldSensor
Protected Attributes inherited from SoInteractionKit
SoFieldSensor *	fieldSensor
	This sensor will watch the topSeparator part.
SoSeparator *	oldTopSep
Protected Attributes inherited from SoBaseKit
SoChildList *	children
SoNodekitParts *	nodekitPartsList
	parts list.
bool	connectionsSetUp
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 SoDragger
enum	ProjectorFrontSetting { FRONT , BACK , USE_PICK }
	These control behavior of the rotational parts. More...
Public Types inherited from SoInteractionKit
enum	CacheEnabled { OFF , ON , AUTO }
	Possible values for caching. More...
Public Types inherited from SoNode
enum	Stage { FIRST_INSTANCE , PROTO_INSTANCE , OTHER_INSTANCE }
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

SoSpotLightDragger is a composite dragger. It is shaped like a beam of light emanating from a sun-like ball. An arrow runs along the axis of the beam and extends past the end of the beam.

When you click and drag the beam, it opens and closes with an umbrella-like motion. The angle between the center and edge of the beam is stored in the angle field of this dragger; setting the angle field causes the beam to widen or narrow in response. The spotlight dragger does not use a standard dragger class to execute this motion. More details are given later in this section.

Dragging the arrow rotates it arount the sun, and the beam moves with it. The arrow is an SoRotateSphericalDragger that controls the rotation field. See the reference page for SoDirectionalLightDragger, which works the same way, for details.

The sun-shape can be dragged to translate all three pieces together through 3-space. Its movement controls the translation field and works exactly as described in the reference pages for SoDirectionalLightDragger and SoPointLightDragger (which goes into more detail).

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

[a] Use an SoSpotLightManip, which is subclassed from SoLight. It creates an SoSpotLightDragger and uses it as the interface to change the location , direction , and cutOffAngle of its light source (see the SoSpotLightManip man page). The manip also edits the material part of this dragger to match the color of light the manip is producing.

[b] Connect the angle field of this dragger to the cutOffAngle field of an SoSpotLight with a field-to-field connection.

See the SoPointLightDragger and SoDirectionalLightDragger man pages for other ways to control light parameters with the rotation and translation fields.

This class creates its own projector and handles mouse events to do it's own dragging of the beam angle. When the mouse picks a point on the beam, that point is dragged in a circle just like in an SoRotateDiscDragger, but the plane of the disc is re-defined every time a drag is initiated. Imagine placing the metal tip of a compass at the apex of the cone and the pencil tip at the picked point. If you swing an arc through the central axis of the cone, you will be drawing the arc used to drag the beam open and closed.

The beam is opened and closed not by rotating, but by scaling.
The dragger scales the beam-cone so that the height and radius change to move the picked point along the circle. Then the angle field is calculated from the height and radius.

You can change the geometry of parts in any instance of this dragger using setPart(). The default part geometries are defined as resources for this SoSpotLightDragger class. They are detailed below in the DRAGGER RESOURCE section. You can make your program use different default resources for the parts by copying the file /usr/share/data/draggerDefaults/spotLightDragger.iv into your own directory, editing the file, and then setting the environment variable SO_DRAGGER_DIR to be a path to that directory.

File Format/Default

SpotLightDragger {
  renderCaching AUTO
  boundingBoxCaching AUTO
  renderCulling AUTO
  pickCulling AUTO
  isActive FALSE
  rotation 0 0 1 0
  translation 0 0 0
  angle 1
}

See Also

SoInteractionKit, SoDragger, SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, SoTranslate2Dragger

Definition at line 225 of file SoSpotLightDragger.h.

Constructor & Destructor Documentation

SoSpotLightDragger()

SoSpotLightDragger::SoSpotLightDragger

(

)

~SoSpotLightDragger()

virtual SoSpotLightDragger::~SoSpotLightDragger ( )

protectedvirtual

Member Function Documentation

doneCB()

static void SoSpotLightDragger::doneCB ( void *  , SoDragger *    )

staticprotected

drag()

void SoSpotLightDragger::drag ( )

protected

dragFinish()

void SoSpotLightDragger::dragFinish ( )

protected

dragStart()

void SoSpotLightDragger::dragStart ( )

protected

fieldSensorCB()

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

staticprotected

initClass()

static void SoSpotLightDragger::initClass ( )

static

motionCB()

static void SoSpotLightDragger::motionCB ( void *  , SoDragger *    )

staticprotected

setBeamScaleFromAngle()

void SoSpotLightDragger::setBeamScaleFromAngle ( float  beamAngle )

protected

setDefaultOnNonWritingFields()

virtual void SoSpotLightDragger::setDefaultOnNonWritingFields ( )

protectedvirtual

Draggers don't want to write out fields if they have default vals.

sets isActive to default if default and not connected.

Looks for fields named: 'rotation' with value SbRotation::identity() 'translation' with value (0,0,0) 'center' with value (0,0,0) 'scaleFactor' with value (1,1,1) and sets them to default if they are not connected from a field. (most draggers are missing at least some of these, but thats okay)

Then calls the method for SoInteractionKit.

NOTE: Parts which are set to default may still wind up writing to file if, for example, they lie on a path.

Reimplemented from SoDragger.

setUpConnections()

virtual bool SoSpotLightDragger::setUpConnections ( bool  onOff, bool  doItAlways = FALSE  )

protectedvirtual

Also set geometry of childDraggers to be our default instead of their regular default, using our resources. Called by: start/end of SoBaseKit::readInstance and on new copy by: start/end of SoBaseKit::copy. Classes that redefine must call setUpConnections(TRUE,TRUE) at end of constructor. Returns the state of the node when this was called.

Reimplemented from SoInteractionKit.

startCB()

static void SoSpotLightDragger::startCB ( void *  , SoDragger *    )

staticprotected

valueChangedCB()

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

staticprotected

Member Data Documentation

angle

SoSFFloat SoSpotLightDragger::angle

Definition at line 259 of file SoSpotLightDragger.h.

angleFieldSensor

SoFieldSensor* SoSpotLightDragger::angleFieldSensor

protected

Definition at line 278 of file SoSpotLightDragger.h.

planeProj

SbPlaneProjector* SoSpotLightDragger::planeProj

protected

Definition at line 266 of file SoSpotLightDragger.h.

rotation

SoSFRotation SoSpotLightDragger::rotation

Definition at line 257 of file SoSpotLightDragger.h.

rotFieldSensor

SoFieldSensor* SoSpotLightDragger::rotFieldSensor

protected

Definition at line 276 of file SoSpotLightDragger.h.

translation

SoSFVec3f SoSpotLightDragger::translation

Definition at line 258 of file SoSpotLightDragger.h.

translFieldSensor

SoFieldSensor* SoSpotLightDragger::translFieldSensor

protected

Definition at line 277 of file SoSpotLightDragger.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/draggers/SoSpotLightDragger.h