The SoSpotLightDragger class provides interactive geometry for manipulating a spotlight. More...

#include <Inventor/draggers/SoSpotLightDragger.h>

Inheritance diagram for SoSpotLightDragger:

Public Member Functions
	SoSpotLightDragger (void)

const SoNodekitCatalog *	getNodekitCatalog (void) const override

SoType	getTypeId (void) const override

Public Member Functions inherited from SoDragger
void	addFinishCallback (SoDraggerCB func, void data=NULL)

void	addMotionCallback (SoDraggerCB func, void data=NULL)

void	addOtherEventCallback (SoDraggerCB func, void data=NULL)

void	addStartCallback (SoDraggerCB func, void data=NULL)

void	addValueChangedCallback (SoDraggerCB func, void data=NULL)

void	callback (SoCallbackAction *action) override

SoPath *	createPathToThis (void)

SbBool	enableValueChangedCallbacks (SbBool newval)

const SoEvent *	getEvent (void) const

ProjectorFrontSetting	getFrontOnProjector (void) const

SoHandleEventAction *	getHandleEventAction (void) const

SbVec3f	getLocalStartingPoint (void)

SbMatrix	getLocalToWorldMatrix (void)

void	getMatrix (SoGetMatrixAction *action) override

int	getMinGesture (void) const

const SbMatrix &	getMotionMatrix (void)

void	getPartToLocalMatrix (const SbName &partname, SbMatrix &parttolocalmatrix, SbMatrix &localtopartmatrix)

const SoPath *	getPickPath (void) const

void	getPrimitiveCount (SoGetPrimitiveCountAction *action) override

float	getProjectorEpsilon (void) const

const SbMatrix &	getStartMotionMatrix (void)

const SbName &	getSurrogatePartPickedName (void) const

const SoPath *	getSurrogatePartPickedOwner (void) const

const SoPath *	getSurrogatePartPickedPath (void) const

const SbViewportRegion &	getViewportRegion (void)

const SbViewVolume &	getViewVolume (void)

SbVec3f	getWorldStartingPoint (void)

SbMatrix	getWorldToLocalMatrix (void)

void	GLRender (SoGLRenderAction *action) override

void	grabEventsCleanup (void) override

void	grabEventsSetup (void) override

void	rayPick (SoRayPickAction *action) override

void	registerChildDragger (SoDragger *child)

void	registerChildDraggerMovingIndependently (SoDragger *child)

void	removeFinishCallback (SoDraggerCB func, void data=NULL)

void	removeMotionCallback (SoDraggerCB func, void data=NULL)

void	removeOtherEventCallback (SoDraggerCB func, void data=NULL)

void	removeStartCallback (SoDraggerCB func, void data=NULL)

void	removeValueChangedCallback (SoDraggerCB func, void data=NULL)

virtual void	saveStartParameters (void)

void	search (SoSearchAction *action) override

void	setFrontOnProjector (ProjectorFrontSetting newval)

void	setHandleEventAction (SoHandleEventAction *newAction)

void	setMinGesture (int pixels)

virtual void	setMotionMatrix (const SbMatrix &newmatrix)

void	setProjectorEpsilon (const float epsilon)

void	setStartingPoint (const SbVec3f &newpoint)

void	setStartingPoint (const SoPickedPoint *newpoint)

void	setTempPathToThis (const SoPath *somethingclose)

void	setViewportRegion (const SbViewportRegion &reg)

void	setViewVolume (const SbViewVolume &vol)

void	transformMatrixLocalToWorld (const SbMatrix &frommatrix, SbMatrix &tomatrix)

void	transformMatrixToLocalSpace (const SbMatrix &frommatrix, SbMatrix &tomatrix, const SbName &fromspacepartname)

void	transformMatrixWorldToLocal (const SbMatrix &frommatrix, SbMatrix &tomatrix)

void	unregisterChildDragger (SoDragger *child)

void	unregisterChildDraggerMovingIndependently (SoDragger *child)

void	valueChanged (void)

void	workFieldsIntoTransform (SbMatrix &mtx)

void	write (SoWriteAction *action) override

Public Member Functions inherited from SoInteractionKit
	SoInteractionKit (void)

SbBool	isPathSurrogateInMySubgraph (const SoPath *path)

SbBool	isPathSurrogateInMySubgraph (const SoPath path, SoPath &pathToOwner, SbName &surrogatename, SoPath *&surrogatepath, SbBool fillargs=TRUE)

SbBool	setPart (const SbName &partname, SoNode *from) override

virtual SbBool	setPartAsDefault (const SbName &partname, const SbName &nodename, SbBool onlyifdefault=TRUE)

virtual SbBool	setPartAsDefault (const SbName &partname, SoNode *node, SbBool onlyifdefault=TRUE)

virtual SbBool	setPartAsPath (const SbName &partname, SoPath *path)

Public Member Functions inherited from SoBaseKit
	SoBaseKit (void)

void	addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) override

virtual SoNodeKitPath *	createPathToPart (const SbName &partname, SbBool makeifneeded, const SoPath *pathtoextend=NULL)

void	doAction (SoAction *action) override

SbBool	forceChildDrivenWriteRefs (SoOutput *out)

SoChildList *	getChildren (void) const override

virtual SoNode *	getPart (const SbName &partname, SbBool makeifneeded)

SbString	getPartString (const SoBase *part)

void	printDiagram (void)

void	printSubDiagram (const SbName &rootname, int level)

void	printTable (void)

SbBool	set (const char *namevaluepairliststring)

SbBool	set (const char partnamestring, const char parameterstring)

Public Member Functions inherited from SoNode
virtual SbBool	affectsState (void) const

virtual void	audioRender (SoAudioRenderAction *action)

virtual SoNode *	copy (SbBool copyconnections=FALSE) const

void	copyContents (const SoFieldContainer *from, SbBool copyconnections) override

SoFieldContainer *	copyThroughConnection (void) const override

SbUniqueId	getNodeId (void) const

NodeType	getNodeType (void) const

virtual void	GLRenderBelowPath (SoGLRenderAction *action)

virtual void	GLRenderInPath (SoGLRenderAction *action)

virtual void	GLRenderOffPath (SoGLRenderAction *action)

SbBool	isOverride (void) const

void	notify (SoNotList *l) override

virtual void	pick (SoPickAction *action)

void	setNodeType (const NodeType type)

void	setOverride (const SbBool state)

void	startNotify (void) override

void	writeInstance (SoOutput *out) override

Public Member Functions inherited from SoFieldContainer
void	addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) override

void	copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)

SbBool	enableNotify (const SbBool flag)

SbBool	fieldsAreEqual (const SoFieldContainer *container) const

void	get (SbString &fielddata)

void	get (SbString &fielddata, SoOutput *out)

virtual int	getAllFields (SoFieldList &l) const

virtual SoField *	getEventIn (const SbName &name) const

virtual SoField *	getEventOut (const SbName &name) const

virtual SoField *	getField (const SbName &name) const

SbBool	getFieldName (const SoField *const field, SbName &name) const

virtual int	getFields (SoFieldList &l) const

virtual void	getFieldsMemorySize (size_t &managed, size_t &unmanaged) const

SbBool	getIsBuiltIn (void) const

void *	getUserData (void) const

SbBool	hasDefaultValues (void) const

SbBool	isNotifyEnabled (void) const

SbBool	set (const char *const fielddata)

SbBool	set (const char fielddata, SoInput input)

void	setToDefaults (void)

void	setUserData (void *userdata) const

virtual SbBool	validateNewFieldValue (SoField field, void newval)

Public Member Functions inherited from SoBase
void	addAuditor (void *const auditor, const SoNotRec::Type type)

void	assertAlive (void) const

const SoAuditorList &	getAuditors (void) const

virtual SbName	getName (void) const

int32_t	getRefCount (void) const

SbBool	isOfType (SoType type) const
	Returns `TRUE` if the type of this object is either of the same type or inherited from type.

void	ref (void) const

void	removeAuditor (void *const auditor, const SoNotRec::Type type)

virtual void	setName (const SbName &newname)

SbBool	shouldWrite (void)

void	touch (void)

void	unref (void) const

void	unrefNoDelete (void) const

Static Public Member Functions
static const SoNodekitCatalog *	getClassNodekitCatalog (void)

static SoType	getClassTypeId (void)

static void	initClass (void)

Static Public Member Functions inherited from SoDragger
static SbMatrix	appendRotation (const SbMatrix &mtx, const SbRotation &rot, const SbVec3f &rotcenter, const SbMatrix *conversion=NULL)

static SbMatrix	appendScale (const SbMatrix &mtx, const SbVec3f &scale, const SbVec3f &scalecenter, const SbMatrix *conversion=NULL)

static SbMatrix	appendTranslation (const SbMatrix &mtx, const SbVec3f &translation, const SbMatrix *conversion=NULL)

static const SoNodekitCatalog *	getClassNodekitCatalog (void)

static SoType	getClassTypeId (void)

static float	getMinScale (void)

static void	getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scalefactor, SbRotation &scaleorientation)

static void	getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scalefactor, SbRotation &scaleorientation, const SbVec3f &center)

static void	initClass (void)

static void	initClasses (void)

static void	setMinScale (float newminscale)

static void	workValuesIntoTransform (SbMatrix &mtx, const SbVec3f translationptr, const SbRotation rotationptr, const SbVec3f scalefactorptr, const SbRotation scaleorientationptr, const SbVec3f *centerptr)

Static Public Member Functions inherited from SoInteractionKit
static const SoNodekitCatalog *	getClassNodekitCatalog (void)

static SoType	getClassTypeId (void)

static void	initClass (void)
	Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

static void	setSwitchValue (SoNode *node, const int newVal)

Static Public Member Functions inherited from SoBaseKit
static const SoNodekitCatalog *	getClassNodekitCatalog (void)

static SoType	getClassTypeId (void)

static void	initClass (void)

static SbBool	isSearchingChildren (void)

static void	setSearchingChildren (const SbBool newval)

Static Public Member Functions inherited from SoNode
static void	audioRenderS (SoAction action, SoNode node)

static void	callbackS (SoAction action, SoNode node)

static int	getActionMethodIndex (const SoType type)

static void	getBoundingBoxS (SoAction action, SoNode node)

static SoNode *	getByName (const SbName &name)

static int	getByName (const SbName &name, SoNodeList &l)

static SoType	getClassTypeId (void)

static uint32_t	getCompatibilityTypes (const SoType &nodetype)

static void	getMatrixS (SoAction action, SoNode node)

static SbUniqueId	getNextNodeId (void)

static void	getPrimitiveCountS (SoAction action, SoNode node)

static void	GLRenderS (SoAction action, SoNode node)

static void	handleEventS (SoAction action, SoNode node)

static void	initClass (void)
	Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

static void	initClasses (void)

static void	pickS (SoAction action, SoNode node)

static void	rayPickS (SoAction action, SoNode node)

static void	searchS (SoAction action, SoNode node)

static void	writeS (SoAction action, SoNode node)

Static Public Member Functions inherited from SoFieldContainer
static void	addCopy (const SoFieldContainer orig, const SoFieldContainer copy)

static SoFieldContainer *	checkCopy (const SoFieldContainer *orig)

static void	cleanupClass (void)

static void	copyDone (void)

static SoFieldContainer *	findCopy (const SoFieldContainer *orig, const SbBool copyconnections)

static SoType	getClassTypeId (void)
	This static method returns the SoType object associated with objects of this class.

static void	initClass (void)
	Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

static void	initCopyDict (void)

Static Public Member Functions inherited from SoBase
static void	addName (SoBase const base, const char const name)

static SbBool	connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)

static void	decrementCurrentWriteCounter (void)

static SoType	getClassTypeId (void)
	This static method returns the SoType object associated with objects of this class.

static SoBase *	getNamedBase (const SbName &name, SoType type)

static int	getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)

static SbBool	getTraceRefs (void)

static void	incrementCurrentWriteCounter (void)

static void	initClass (void)
	Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

static SbBool	read (SoInput input, SoBase &base, SoType expectedtype)

static SbBool	readRoute (SoInput *input)

static void	removeName (SoBase const base, const char const name)

static void	setInstancePrefix (const SbString &c)

static void	setTraceRefs (SbBool trace)

Public Attributes
SoSFFloat	angle

SoSFRotation	rotation

SoSFVec3f	translation

Public Attributes inherited from SoDragger
SoSFBool	isActive

Public Attributes inherited from SoInteractionKit
SoSFEnum	boundingBoxCaching

SoSFEnum	pickCulling

SoSFEnum	renderCaching

SoSFEnum	renderCulling

Protected Member Functions
virtual	~SoSpotLightDragger (void)

void	drag (void)

void	dragFinish (void)

void	dragStart (void)

const SoFieldData *	getFieldData (void) const override

void	setBeamScaleFromAngle (float beamangle)

void	setDefaultOnNonWritingFields (void) override

SbBool	setUpConnections (SbBool onoff, SbBool doitalways=FALSE) override

Protected Member Functions inherited from SoDragger
	SoDragger (void)

virtual	~SoDragger (void)

SoDragger *	getActiveChildDragger (void) const

void	getBoundingBox (SoGetBoundingBoxAction *action) override

SbVec2s	getLocaterPosition (void)

SbVec2f	getNormalizedLocaterPosition (void)

virtual const SoPickedPoint *	getPickedPointForStart (SoHandleEventAction *action)

SbVec2s	getStartLocaterPosition (void) const

void	handleEvent (SoHandleEventAction *ha) override

SbBool	isAdequateConstraintMotion (void)

SbBool	isIgnoreInBbox (void)

void	setActiveChildDragger (SoDragger *newchilddragger)

void	setCameraInfo (SoAction *action)

void	setIgnoreInBbox (SbBool newval)

void	setStartLocaterPosition (SbVec2s p)

virtual SbBool	shouldGrabBasedOnSurrogate (const SoPath pickpath, const SoPath surrogatepath)

void	transferMotion (SoDragger *child)

void	updateDraggerCache (const SoPath *path)

Protected Member Functions inherited from SoInteractionKit
virtual	~SoInteractionKit ()

void	connectSeparatorFields (SoSeparator *dest, SbBool onOff)

void	copyContents (const SoFieldContainer *fromFC, SbBool copyConnections) override

SbBool	readInstance (SoInput *in, unsigned short flags) override

virtual SbBool	setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE)

virtual SbBool	setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE)

SbBool	setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE)

SbBool	setPart (const int partNum, SoNode *node) override

Protected Member Functions inherited from SoBaseKit
virtual	~SoBaseKit ()

SoNode *	addToCopyDict (void) const override

void	catalogError (void)

void	countMyFields (SoOutput *out)

virtual void	createDefaultParts (void)

void	createFieldList (void)

void	createNodekitPartsList (void)

virtual SoNodeKitPath *	createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL)

virtual SoNode *	getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE)

const SbList< SoSFNode * > &	getCatalogInstances (void) const

SoGroup *	getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE)

const SoNodekitParts *	getNodekitPartsList (void) const

virtual SbBool	setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE)

Protected Member Functions inherited from SoNode
	SoNode (void)

virtual	~SoNode ()

SbBool	readInstance (SoInput *in, unsigned short flags) override

Protected Member Functions inherited from SoFieldContainer
	SoFieldContainer (void)

virtual	~SoFieldContainer ()

Protected Member Functions inherited from SoBase
	SoBase (void)

virtual	~SoBase ()

virtual SoNotRec	createNotRec (void)

virtual void	destroy (void)

virtual const char *	getFileFormatName (void) const

SbBool	hasMultipleWriteRefs (void) const

void	writeFooter (SoOutput *out) const

SbBool	writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const

Static Protected Member Functions
static void	doneCB (void f, SoDragger d)

static void	fieldSensorCB (void f, SoSensor s)

static const SoNodekitCatalog **	getClassNodekitCatalogPtr (void)

static const SoFieldData **	getFieldDataPtr (void)

static void	motionCB (void f, SoDragger d)

static void	startCB (void f, SoDragger d)

static void	valueChangedCB (void f, SoDragger d)

Static Protected Member Functions inherited from SoDragger
static void	childFinishCB (void , SoDragger )

static void	childMotionCB (void , SoDragger )

static void	childOtherEventCB (void , SoDragger )

static void	childStartCB (void , SoDragger )

static void	childTransferMotionAndValueChangedCB (void , SoDragger )

static void	childValueChangedCB (void , SoDragger )

static const SoNodekitCatalog **	getClassNodekitCatalogPtr (void)

static const SoFieldData **	getFieldDataPtr (void)

Static Protected Member Functions inherited from SoInteractionKit
static void	fieldSensorCB (void , SoSensor )

static const SoNodekitCatalog **	getClassNodekitCatalogPtr (void)

static const SoFieldData **	getFieldDataPtr (void)

static void	readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize)

Static Protected Member Functions inherited from SoBaseKit
static const SoNodekitCatalog **	getClassNodekitCatalogPtr (void)

static const SoFieldData **	getFieldDataPtr (void)

Static Protected Member Functions inherited from SoNode
static const SoFieldData **	getFieldDataPtr (void)

static int	getNextActionMethodIndex (void)

static void	incNextActionMethodIndex (void)

static void	setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)

static void	setNextActionMethodIndex (int index)

Static Protected Member Functions inherited from SoBase
static uint32_t	getCurrentWriteCounter (void)

static void	staticDataLock (void)

static void	staticDataUnlock (void)

Protected Attributes
SoFieldSensor *	angleFieldSensor

SoSFNode	beam

SoSFNode	beamActive

SoSFNode	beamPlacement

SoSFNode	beamScale

SoSFNode	beamSep

SoSFNode	beamSwitch

SoSFNode	material

SbPlaneProjector *	planeProj

SoSFNode	rotator

SoFieldSensor *	rotFieldSensor

SoSFNode	translator

SoSFNode	translatorRotInv

SoSFNode	translatorSep

SoFieldSensor *	translFieldSensor

Protected Attributes inherited from SoDragger
SoSFNode	motionMatrix

Protected Attributes inherited from SoInteractionKit
SoFieldSensor *	fieldSensor

SoSFNode	geomSeparator

SoSeparator *	oldTopSep

SoSFNode	topSeparator

Protected Attributes inherited from SoBaseKit
SoSFNode	callbackList

SoChildList *	children

SbBool	connectionsSetUp

Protected Attributes inherited from SoNode
SbUniqueId	uniqueId

Protected Attributes inherited from SoFieldContainer
SbBool	isBuiltIn

Additional Inherited Members
Public Types inherited from SoDragger
enum	ProjectorFrontSetting { FRONT , BACK , USE_PICK }

Public Types inherited from SoInteractionKit
enum	CacheEnabled { OFF , ON , AUTO }

Public Types inherited from SoNode
enum	NodeType { INVENTOR = 0x0000 , VRML1 = 0x0001 , VRML2 = 0x0002 , INVENTOR_1 = 0x0004 , INVENTOR_2_0 = 0x0008 , INVENTOR_2_1 = 0x0010 , INVENTOR_2_5 = 0x0020 , INVENTOR_2_6 = 0x0040 , COIN_1_0 = 0x0080 , COIN_2_0 = 0x0100 , EXTENSION = 0x0200 , COIN_2_2 = 0x0400 , COIN_2_3 = 0x0800 , COIN_2_4 = 0x1000 , INVENTOR_5_0 = 0x2000 , COIN_2_5 = 0x4000 , COIN_3_0 = 0x8000 , INVENTOR_6_0 = 0x10000 , COIN_4_0 = 0x20000 }

Protected Types inherited from SoBase
enum	BaseFlags { IS_ENGINE = 0x01 , IS_GROUP = 0x02 }

Static Protected Attributes inherited from SoNode
static int	nextActionMethodIndex = 0

static SbUniqueId	nextUniqueId = 1

Detailed Description

The SoSpotLightDragger class provides interactive geometry for manipulating a spotlight.

Here's how the dragger looks with its default geometry in the inactive state:

Screen Shot of Default Dragger

This dragger is well suited for setting up the fields of a SoSpotLight node, as it provides geometry for the end-user to interact with a directional vector for the spotlight, to set up its position and to control the cut-off angle for the "lampshade" around the light source.

Note that there is one aspect of SoSpotLight nodes that cannot be controlled with this dragger: the SoSpotLight::dropOffRate field.

The Coin library includes a manipulator class, SoSpotLightManip, which wraps the functionality provided by this class inside the necessary mechanisms for connecting it to SoSpotLight node instances in a scene graph.

See also: SoSpotLightManip, SoSpotLight; SoDirectionalLightDragger, SoPointLightDragger

Constructor & Destructor Documentation

◆ SoSpotLightDragger()

SoSpotLightDragger::SoSpotLightDragger ( void )

Default constructor, sets up the dragger nodekit catalog with the interaction and feedback geometry.

Nodekit structure (new entries versus parent class marked with arrow prefix):

CLASS SoSpotLightDragger
-->"this"
      "callbackList"
      "topSeparator"
         "motionMatrix"
-->      "material"
-->      "translatorSep"
-->         "translatorRotInv"
-->         "translator"
-->      "rotator"
-->      "beamSep"
-->         "beamPlacement"
-->         "beamScale"
-->         "beamSwitch"
-->            "beam"
-->            "beamActive"
         "geomSeparator"

(See SoBaseKit::printDiagram() for information about the output formatting.)

Detailed information on catalog parts:

CLASS SoSpotLightDragger
PVT   "this",  SoSpotLightDragger  --- 
      "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ] 
PVT   "topSeparator",  SoSeparator  --- 
PVT   "motionMatrix",  SoMatrixTransform  --- 
      "material",  SoMaterial  --- 
PVT   "translatorSep",  SoSeparator  --- 
PVT   "translatorRotInv",  SoRotation  --- 
      "translator",  SoDragPointDragger  --- 
      "rotator",  SoRotateSphericalDragger  --- 
PVT   "beamSep",  SoSeparator  --- 
      "beamPlacement",  SoTranslation  --- 
      "beamScale",  SoScale  --- 
PVT   "beamSwitch",  SoSwitch  --- 
      "beam",  SoSeparator  --- 
      "beamActive",  SoSeparator  --- 
PVT   "geomSeparator",  SoSeparator  ---

(See SoBaseKit::printTable() for information about the output formatting.)

◆ ~SoSpotLightDragger()

SoSpotLightDragger::~SoSpotLightDragger ( void )

protectedvirtual

Protected destructor.

(Dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0.)

Member Function Documentation

◆ doneCB()

void SoSpotLightDragger::doneCB	(	void *	f,
		SoDragger *	d )

staticprotected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

◆ drag()

void SoSpotLightDragger::drag ( void )

protected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Called when user drags the mouse after picking the dragger.

◆ dragFinish()

void SoSpotLightDragger::dragFinish ( void )

protected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Called when mouse button is released after picking and interacting with the dragger.

◆ dragStart()

void SoSpotLightDragger::dragStart ( void )

protected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Called when dragger is selected (picked) by the user.

◆ fieldSensorCB()

void SoSpotLightDragger::fieldSensorCB	(	void *	d,
		SoSensor *	s )

staticprotected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

◆ getClassNodekitCatalog()

const SoNodekitCatalog * SoSpotLightDragger::getClassNodekitCatalog ( void )

static

Returns the nodekit catalog which defines the layout of this class' kit.

◆ getClassNodekitCatalogPtr()

const SoNodekitCatalog ** SoSpotLightDragger::getClassNodekitCatalogPtr ( void )

staticprotected

Returns the pointer to the pointer of the nodekit catalog for this class.

◆ getClassTypeId()

SoType SoSpotLightDragger::getClassTypeId ( void )

static

This static method returns the SoType object associated with objects of this class.

◆ getFieldData()

const SoFieldData * SoSpotLightDragger::getFieldData ( void ) const

overrideprotectedvirtual

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoDragger.

◆ getFieldDataPtr()

const SoFieldData ** SoSpotLightDragger::getFieldDataPtr ( void )

staticprotected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Returns the SoFieldData class which holds information about fields in this node.

◆ getNodekitCatalog()

const SoNodekitCatalog * SoSpotLightDragger::getNodekitCatalog ( void ) const

overridevirtual

Returns the nodekit catalog which defines the layout of this class' kit.

Reimplemented from SoDragger.

◆ getTypeId()

SoType SoSpotLightDragger::getTypeId ( void ) const

overridevirtual

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

Reimplemented from SoDragger.

◆ initClass()

void SoSpotLightDragger::initClass ( void )

static

Initializes type system for this dragger class.

Application programmers should usually not have to invoke this method, see documentation of SoInteraction::init().

◆ motionCB()

void SoSpotLightDragger::motionCB	(	void *	f,
		SoDragger *	d )

staticprotected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

◆ setBeamScaleFromAngle()

void SoSpotLightDragger::setBeamScaleFromAngle ( float beamangle )

protected

Scales the geometry representing the "lampshade" around the light source to represent the given beamangle.

◆ setDefaultOnNonWritingFields()

void SoSpotLightDragger::setDefaultOnNonWritingFields ( void )

overrideprotectedvirtual

(Be aware that this method is unlikely to be of interest to the application programmer who does not want to extend the library with new custom nodekits or draggers. If you indeed are writing extensions, see the information in the SoBaseKit class documentation.)

This is a virtual method, and the code in it should call SoField::setDefault() with argument TRUE on part fields that should not be written upon scene graph export operations.

This is typically done when:

field value is NULL and part is NULL by default
it is a leaf SoGroup or SoSeparator node with no children
it is a leaf listpart with no children and an SoGroup or SoSeparator container
it is a non-leaf part and it is of SoGroup type and all fields are at their default values

Subclasses should usually override this to do additional settings for new member fields. From the subclass, do remember to call "upwards" to your superclass' setDefaultOnNonWritingFields() method.

Reimplemented from SoDragger.

◆ setUpConnections()

SbBool SoSpotLightDragger::setUpConnections	(	SbBool	onoff,
		SbBool	doitalways = FALSE )

overrideprotectedvirtual

Sets up all internal connections for instances of this class.

(This method will usually not be of interest to the application programmer, unless you want to extend the library with new custom nodekits or dragger classes. If so, see the SoBaseKit class documentation.)

Reimplemented from SoInteractionKit.

◆ startCB()

void SoSpotLightDragger::startCB	(	void *	f,
		SoDragger *	d )

staticprotected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

◆ valueChangedCB()

void SoSpotLightDragger::valueChangedCB	(	void *	f,
		SoDragger *	d )

staticprotected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Member Data Documentation

◆ angle

SoSFFloat SoSpotLightDragger::angle

The cut-off angle for the "lampshade" around the light source.

Typically connected to a SoSpotLight::cutOffAngle field.

◆ angleFieldSensor

SoFieldSensor * SoSpotLightDragger::angleFieldSensor

protected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

◆ planeProj

SbPlaneProjector * SoSpotLightDragger::planeProj

protected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

◆ rotation

SoSFRotation SoSpotLightDragger::rotation

This field is continuously updated to contain the rotation of the current direction vector. The application programmer will typically connect this to the rotation field of a SoSpotLight node (unless using the SoSpotLightManip class, where this is taken care of automatically).

It may also of course be connected to any other rotation field controlling the direction of scene graph geometry, it does not have to part of a SoSpotLight node specifically.

◆ rotFieldSensor

SoFieldSensor * SoSpotLightDragger::rotFieldSensor

protected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

◆ translation

SoSFVec3f SoSpotLightDragger::translation

Continuously updated to contain the current translation from the dragger's local origo position.

◆ translFieldSensor

SoFieldSensor * SoSpotLightDragger::translFieldSensor

protected

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

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

SoSpotLightDragger.h
SoSpotLightDragger.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SoSpotLightDragger()

◆ ~SoSpotLightDragger()

Member Function Documentation

◆ doneCB()

◆ drag()

◆ dragFinish()

◆ dragStart()

◆ fieldSensorCB()

◆ getClassNodekitCatalog()

◆ getClassNodekitCatalogPtr()

◆ getClassTypeId()

◆ getFieldData()

◆ getFieldDataPtr()

◆ getNodekitCatalog()

◆ getTypeId()

◆ initClass()

◆ motionCB()

◆ setBeamScaleFromAngle()

◆ setDefaultOnNonWritingFields()

◆ setUpConnections()

◆ startCB()

◆ valueChangedCB()

Member Data Documentation

◆ angle

◆ angleFieldSensor

◆ planeProj

◆ rotation

◆ rotFieldSensor

◆ translation

◆ translFieldSensor