Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
SoSpotLightDragger Class Reference

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

#include <Inventor/draggers/SoSpotLightDragger.h>

Inheritance diagram for SoSpotLightDragger:
SoDragger SoInteractionKit SoBaseKit SoNode SoFieldContainer SoBase

Public Member Functions

virtual SoType getTypeId (void) const
 Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting. More...
 
virtual const SoNodekitCataloggetNodekitCatalog (void) const
 
 SoSpotLightDragger (void)
 
- Public Member Functions inherited from SoDragger
virtual void callback (SoCallbackAction *action)
 
virtual void GLRender (SoGLRenderAction *action)
 
virtual void getMatrix (SoGetMatrixAction *action)
 
virtual void rayPick (SoRayPickAction *action)
 
virtual void search (SoSearchAction *action)
 
virtual void write (SoWriteAction *action)
 
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
 
void setProjectorEpsilon (const float epsilon)
 
float getProjectorEpsilon (void) const
 
void addStartCallback (SoDraggerCB *func, void *data=NULL)
 
void removeStartCallback (SoDraggerCB *func, void *data=NULL)
 
void addMotionCallback (SoDraggerCB *func, void *data=NULL)
 
void removeMotionCallback (SoDraggerCB *func, void *data=NULL)
 
void addFinishCallback (SoDraggerCB *func, void *data=NULL)
 
void removeFinishCallback (SoDraggerCB *func, void *data=NULL)
 
void addValueChangedCallback (SoDraggerCB *func, void *data=NULL)
 
void removeValueChangedCallback (SoDraggerCB *func, void *data=NULL)
 
void setMinGesture (int pixels)
 
int getMinGesture (void) const
 
SbBool enableValueChangedCallbacks (SbBool newval)
 
const SbMatrixgetMotionMatrix (void)
 
void addOtherEventCallback (SoDraggerCB *func, void *data=NULL)
 
void removeOtherEventCallback (SoDraggerCB *func, void *data=NULL)
 
void registerChildDragger (SoDragger *child)
 
void unregisterChildDragger (SoDragger *child)
 
void registerChildDraggerMovingIndependently (SoDragger *child)
 
void unregisterChildDraggerMovingIndependently (SoDragger *child)
 
SbMatrix getLocalToWorldMatrix (void)
 
SbMatrix getWorldToLocalMatrix (void)
 
SbVec3f getLocalStartingPoint (void)
 
SbVec3f getWorldStartingPoint (void)
 
void getPartToLocalMatrix (const SbName &partname, SbMatrix &parttolocalmatrix, SbMatrix &localtopartmatrix)
 
void transformMatrixLocalToWorld (const SbMatrix &frommatrix, SbMatrix &tomatrix)
 
void transformMatrixWorldToLocal (const SbMatrix &frommatrix, SbMatrix &tomatrix)
 
void transformMatrixToLocalSpace (const SbMatrix &frommatrix, SbMatrix &tomatrix, const SbName &fromspacepartname)
 
virtual void setMotionMatrix (const SbMatrix &newmatrix)
 
void valueChanged (void)
 
const SbMatrixgetStartMotionMatrix (void)
 
virtual void saveStartParameters (void)
 
const SoPathgetPickPath (void) const
 
const SoEventgetEvent (void) const
 
SoPathcreatePathToThis (void)
 
const SoPathgetSurrogatePartPickedOwner (void) const
 
const SbNamegetSurrogatePartPickedName (void) const
 
const SoPathgetSurrogatePartPickedPath (void) const
 
void setStartingPoint (const SoPickedPoint *newpoint)
 
void setStartingPoint (const SbVec3f &newpoint)
 
const SbViewVolumegetViewVolume (void)
 
void setViewVolume (const SbViewVolume &vol)
 
const SbViewportRegiongetViewportRegion (void)
 
void setViewportRegion (const SbViewportRegion &reg)
 
SoHandleEventActiongetHandleEventAction (void) const
 
void setHandleEventAction (SoHandleEventAction *newAction)
 
void setTempPathToThis (const SoPath *somethingclose)
 
virtual void grabEventsSetup (void)
 
virtual void grabEventsCleanup (void)
 
void workFieldsIntoTransform (SbMatrix &mtx)
 
void setFrontOnProjector (ProjectorFrontSetting newval)
 
ProjectorFrontSetting getFrontOnProjector (void) const
 
- Public Member Functions inherited from SoInteractionKit
 SoInteractionKit (void)
 
virtual SbBool setPartAsPath (const SbName &partname, SoPath *path)
 
virtual SbBool setPartAsDefault (const SbName &partname, SoNode *node, SbBool onlyifdefault=TRUE)
 
virtual SbBool setPartAsDefault (const SbName &partname, const SbName &nodename, SbBool onlyifdefault=TRUE)
 
SbBool isPathSurrogateInMySubgraph (const SoPath *path, SoPath *&pathToOwner, SbName &surrogatename, SoPath *&surrogatepath, SbBool fillargs=TRUE)
 
SbBool isPathSurrogateInMySubgraph (const SoPath *path)
 
virtual SbBool setPart (const SbName &partname, SoNode *from)
 
- Public Member Functions inherited from SoBaseKit
 SoBaseKit (void)
 
virtual SoNodegetPart (const SbName &partname, SbBool makeifneeded)
 
SbString getPartString (const SoBase *part)
 
virtual SoNodeKitPathcreatePathToPart (const SbName &partname, SbBool makeifneeded, const SoPath *pathtoextend=NULL)
 
SbBool set (const char *namevaluepairliststring)
 
SbBool set (const char *partnamestring, const char *parameterstring)
 
virtual void doAction (SoAction *action)
 
virtual SoChildListgetChildren (void) const
 
void printDiagram (void)
 
void printSubDiagram (const SbName &rootname, int level)
 
void printTable (void)
 
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
 
SbBool forceChildDrivenWriteRefs (SoOutput *out)
 
- Public Member Functions inherited from SoNode
void setOverride (const SbBool state)
 
SbBool isOverride (void) const
 
void setNodeType (const NodeType type)
 
NodeType getNodeType (void) const
 
virtual SoNodecopy (SbBool copyconnections=FALSE) const
 
virtual SbBool affectsState (void) const
 
virtual void GLRenderBelowPath (SoGLRenderAction *action)
 
virtual void GLRenderInPath (SoGLRenderAction *action)
 
virtual void GLRenderOffPath (SoGLRenderAction *action)
 
virtual void pick (SoPickAction *action)
 
virtual void audioRender (SoAudioRenderAction *action)
 
virtual void startNotify (void)
 
virtual void notify (SoNotList *l)
 
SbUniqueId getNodeId (void) const
 
virtual void writeInstance (SoOutput *out)
 
virtual SoFieldContainercopyThroughConnection (void) const
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults (void)
 
SbBool hasDefaultValues (void) const
 
SbBool fieldsAreEqual (const SoFieldContainer *container) const
 
void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)
 
SbBool set (const char *const fielddata)
 
void get (SbString &fielddata)
 
virtual int getFields (SoFieldList &l) const
 
virtual int getAllFields (SoFieldList &l) const
 
virtual SoFieldgetField (const SbName &name) const
 
virtual SoFieldgetEventIn (const SbName &name) const
 
virtual SoFieldgetEventOut (const SbName &name) const
 
SbBool getFieldName (const SoField *const field, SbName &name) const
 
SbBool enableNotify (const SbBool flag)
 
SbBool isNotifyEnabled (void) const
 
SbBool set (const char *fielddata, SoInput *input)
 
void get (SbString &fielddata, SoOutput *out)
 
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
 
SbBool getIsBuiltIn (void) const
 
virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
 
void setUserData (void *userdata) const
 
void * getUserData (void) const
 
- Public Member Functions inherited from SoBase
void ref (void) const
 
void unref (void) const
 
void unrefNoDelete (void) const
 
int32_t getRefCount (void) const
 
void touch (void)
 
SbBool isOfType (SoType type) const
 Returns TRUE if the type of this object is either of the same type or inherited from type. More...
 
virtual SbName getName (void) const
 
virtual void setName (const SbName &newname)
 
void addAuditor (void *const auditor, const SoNotRec::Type type)
 
void removeAuditor (void *const auditor, const SoNotRec::Type type)
 
const SoAuditorListgetAuditors (void) const
 
SbBool shouldWrite (void)
 
void assertAlive (void) const
 

Static Public Member Functions

static SoType getClassTypeId (void)
 
static const SoNodekitCataloggetClassNodekitCatalog (void)
 
static void initClass (void)
 
- Static Public Member Functions inherited from SoDragger
static SoType getClassTypeId (void)
 
static const SoNodekitCataloggetClassNodekitCatalog (void)
 
static void setMinScale (float newminscale)
 
static float getMinScale (void)
 
static void workValuesIntoTransform (SbMatrix &mtx, const SbVec3f *translationptr, const SbRotation *rotationptr, const SbVec3f *scalefactorptr, const SbRotation *scaleorientationptr, const SbVec3f *centerptr)
 
static void getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scalefactor, SbRotation &scaleorientation, const SbVec3f &center)
 
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)
 
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 (void)
 
static void initClasses (void)
 
- Static Public Member Functions inherited from SoInteractionKit
static SoType getClassTypeId (void)
 
static const SoNodekitCataloggetClassNodekitCatalog (void)
 
static void initClass (void)
 
static void setSwitchValue (SoNode *node, const int newVal)
 
- Static Public Member Functions inherited from SoBaseKit
static SoType getClassTypeId (void)
 
static void initClass (void)
 
static const SoNodekitCataloggetClassNodekitCatalog (void)
 
static SbBool isSearchingChildren (void)
 
static void setSearchingChildren (const SbBool newval)
 
- Static Public Member Functions inherited from SoNode
static uint32_t getCompatibilityTypes (const SoType &nodetype)
 
static SoType getClassTypeId (void)
 
static SoNodegetByName (const SbName &name)
 
static int getByName (const SbName &name, SoNodeList &l)
 
static void initClass (void)
 
static void initClasses (void)
 
static SbUniqueId getNextNodeId (void)
 
static int getActionMethodIndex (const SoType type)
 
static void getBoundingBoxS (SoAction *action, SoNode *node)
 
static void GLRenderS (SoAction *action, SoNode *node)
 
static void callbackS (SoAction *action, SoNode *node)
 
static void getMatrixS (SoAction *action, SoNode *node)
 
static void handleEventS (SoAction *action, SoNode *node)
 
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 void audioRenderS (SoAction *action, SoNode *node)
 
static void getPrimitiveCountS (SoAction *action, SoNode *node)
 
- Static Public Member Functions inherited from SoFieldContainer
static void initClass (void)
 
static SoType getClassTypeId (void)
 
static void cleanupClass (void)
 
static void initCopyDict (void)
 
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
 
static SoFieldContainercheckCopy (const SoFieldContainer *orig)
 
static SoFieldContainerfindCopy (const SoFieldContainer *orig, const SbBool copyconnections)
 
static void copyDone (void)
 
- Static Public Member Functions inherited from SoBase
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 SoType getClassTypeId (void)
 This static method returns the SoType object associated with objects of this class.
 
static void addName (SoBase *const base, const char *const name)
 
static void removeName (SoBase *const base, const char *const name)
 
static void incrementCurrentWriteCounter (void)
 
static void decrementCurrentWriteCounter (void)
 
static SoBasegetNamedBase (const SbName &name, SoType type)
 
static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
 
static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype)
 
static void setInstancePrefix (const SbString &c)
 
static void setTraceRefs (SbBool trace)
 
static SbBool getTraceRefs (void)
 
static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
 
static SbBool readRoute (SoInput *input)
 

Public Attributes

SoSFRotation rotation
 
SoSFVec3f translation
 
SoSFFloat angle
 
- Public Attributes inherited from SoDragger
SoSFBool isActive
 
- Public Attributes inherited from SoInteractionKit
SoSFEnum renderCaching
 
SoSFEnum boundingBoxCaching
 
SoSFEnum renderCulling
 
SoSFEnum pickCulling
 

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
 
virtual ~SoSpotLightDragger (void)
 
virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE)
 
virtual void setDefaultOnNonWritingFields (void)
 
void dragStart (void)
 
void drag (void)
 
void dragFinish (void)
 
void setBeamScaleFromAngle (float beamangle)
 
- Protected Member Functions inherited from SoDragger
 SoDragger (void)
 
virtual ~SoDragger (void)
 
SbVec2f getNormalizedLocaterPosition (void)
 
SbVec2s getLocaterPosition (void)
 
SbVec2s getStartLocaterPosition (void) const
 
void setStartLocaterPosition (SbVec2s p)
 
SbBool isAdequateConstraintMotion (void)
 
virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath)
 
void setCameraInfo (SoAction *action)
 
virtual void handleEvent (SoHandleEventAction *ha)
 
void transferMotion (SoDragger *child)
 
void setIgnoreInBbox (SbBool newval)
 
SbBool isIgnoreInBbox (void)
 
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
 
void setActiveChildDragger (SoDragger *newchilddragger)
 
SoDraggergetActiveChildDragger (void) const
 
void updateDraggerCache (const SoPath *path)
 
virtual const SoPickedPointgetPickedPointForStart (SoHandleEventAction *action)
 
- Protected Member Functions inherited from SoInteractionKit
virtual ~SoInteractionKit ()
 
virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections)
 
virtual SbBool setPart (const int partNum, SoNode *node)
 
virtual SbBool readInstance (SoInput *in, unsigned short flags)
 
virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE)
 
virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE)
 
SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE)
 
void connectSeparatorFields (SoSeparator *dest, SbBool onOff)
 
- Protected Member Functions inherited from SoBaseKit
virtual ~SoBaseKit ()
 
virtual SoNodeaddToCopyDict (void) const
 
SoGroupgetContainerNode (const SbName &listname, SbBool makeifneeded=TRUE)
 
virtual SoNodegetAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE)
 
virtual SoNodeKitPathcreatePathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL)
 
virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE)
 
void createNodekitPartsList (void)
 
void createFieldList (void)
 
virtual void createDefaultParts (void)
 
const SoNodekitParts * getNodekitPartsList (void) const
 
const SbList< SoSFNode * > & getCatalogInstances (void) const
 
void catalogError (void)
 
void countMyFields (SoOutput *out)
 
- Protected Member Functions inherited from SoNode
 SoNode (void)
 
virtual ~SoNode ()
 
- Protected Member Functions inherited from SoFieldContainer
 SoFieldContainer (void)
 
virtual ~SoFieldContainer ()
 
- Protected Member Functions inherited from SoBase
 SoBase (void)
 
virtual ~SoBase ()
 
virtual void destroy (void)
 
SbBool hasMultipleWriteRefs (void) const
 
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
 
void writeFooter (SoOutput *out) const
 
virtual const char * getFileFormatName (void) const
 
virtual SoNotRec createNotRec (void)
 

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)
 
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
 
static void startCB (void *f, SoDragger *d)
 
static void motionCB (void *f, SoDragger *d)
 
static void doneCB (void *f, SoDragger *d)
 
static void fieldSensorCB (void *f, SoSensor *s)
 
static void valueChangedCB (void *f, SoDragger *d)
 
- Static Protected Member Functions inherited from SoDragger
static const SoFieldData ** getFieldDataPtr (void)
 
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
 
static void childTransferMotionAndValueChangedCB (void *, SoDragger *)
 
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 const SoFieldData ** getFieldDataPtr (void)
 
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
 
static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize)
 
static void fieldSensorCB (void *, SoSensor *)
 
- Static Protected Member Functions inherited from SoBaseKit
static const SoFieldData ** getFieldDataPtr (void)
 
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
 
- Static Protected Member Functions inherited from SoNode
static const SoFieldData ** getFieldDataPtr (void)
 
static void setNextActionMethodIndex (int index)
 
static int getNextActionMethodIndex (void)
 
static void incNextActionMethodIndex (void)
 
static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)
 
- Static Protected Member Functions inherited from SoBase
static uint32_t getCurrentWriteCounter (void)
 
static void staticDataLock (void)
 
static void staticDataUnlock (void)
 

Protected Attributes

SoSFNode beam
 
SoSFNode beamActive
 
SoSFNode beamPlacement
 
SoSFNode beamScale
 
SoSFNode beamSep
 
SoSFNode beamSwitch
 
SoSFNode material
 
SoSFNode rotator
 
SoSFNode translator
 
SoSFNode translatorRotInv
 
SoSFNode translatorSep
 
SoFieldSensorrotFieldSensor
 
SoFieldSensortranslFieldSensor
 
SoFieldSensorangleFieldSensor
 
SbPlaneProjectorplaneProj
 
- Protected Attributes inherited from SoDragger
SoSFNode motionMatrix
 
- Protected Attributes inherited from SoInteractionKit
SoSFNode geomSeparator
 
SoSFNode topSeparator
 
SoFieldSensorfieldSensor
 
SoSeparatoroldTopSep
 
- Protected Attributes inherited from SoBaseKit
SoSFNode callbackList
 
SoChildListchildren
 
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 SbUniqueId nextUniqueId = 1
 
static int nextActionMethodIndex = 0
 

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:

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

Node kit 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

◆ getTypeId()

SoType SoSpotLightDragger::getTypeId ( void  ) const
virtual

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

Usage example:

void foo(SoNode * node)
{
if (node->getTypeId() == SoFile::getClassTypeId()) {
SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type
}
}

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the predefined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

For more information on writing Coin extensions, see the class documentation of the top level superclasses for the various class groups.

Reimplemented from SoDragger.

◆ getFieldData()

const SoFieldData * SoSpotLightDragger::getFieldData ( void  ) const
protectedvirtual

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

Reimplemented from SoDragger.

◆ getNodekitCatalog()

const SoNodekitCatalog * SoSpotLightDragger::getNodekitCatalog ( void  ) const
virtual

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

Reimplemented from SoDragger.

◆ setUpConnections()

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

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.

◆ setDefaultOnNonWritingFields()

void SoSpotLightDragger::setDefaultOnNonWritingFields ( void  )
protectedvirtual

(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:

  1. field value is NULL and part is NULL by default

  2. it is a leaf SoGroup or SoSeparator node with no children

  3. it is a leaf listpart with no children and an SoGroup or SoSeparator container

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

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

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

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

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

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

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

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

◆ setBeamScaleFromAngle()

void SoSpotLightDragger::setBeamScaleFromAngle ( float  beamangle)
protected

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

Member Data Documentation

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

◆ translation

SoSFVec3f SoSpotLightDragger::translation

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

◆ angle

SoSFFloat SoSpotLightDragger::angle

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

Typically connected to a SoSpotLight::cutOffAngle field.

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

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

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


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