SoSpotLightDragger(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoSpotLightDragger 💖

okay bestie, welcome to the SoSpotLightDragger(3) page — that's the manual name right there, and this is a Library Functions Manual situation. Part 1 of 4, so buckle up, we're going on a journey 🦋

✨ NAME ✨

SoSpotLightDragger — the SoSpotLightDragger class provides interactive geometry for manipulating a spotlight. 💅

✨ SYNOPSIS ✨

#include <Inventor/draggers/SoSpotLightDragger.h>

Lowkey important: this thing inherits SoDragger. 👑

🌸 Public Member Functions 🌸

  • virtual SoType getTypeId (void) const
  • virtual const SoNodekitCatalog * getNodekitCatalog (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 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 SbMatrix & getMotionMatrix (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)
  • void setMotionMatrix (const SbMatrix &newmatrix)
  • void valueChanged (void)
  • const SbMatrix & getStartMotionMatrix (void)
  • virtual void saveStartParameters (void)
  • const SoPath * getPickPath (void) const
  • const SoEvent * getEvent (void) const
  • SoPath * createPathToThis (void)
  • const SoPath * getSurrogatePartPickedOwner (void) const
  • const SbName & getSurrogatePartPickedName (void) const
  • const SoPath * getSurrogatePartPickedPath (void) const
  • void setStartingPoint (const SoPickedPoint *newpoint)
  • void setStartingPoint (const SbVec3f &newpoint)
  • const SbViewVolume & getViewVolume (void)
  • void setViewVolume (const SbViewVolume &vol)
  • const SbViewportRegion & getViewportRegion (void)
  • void setViewportRegion (const SbViewportRegion &reg)
  • SoHandleEventAction * getHandleEventAction (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=1)
  • virtual SbBool setPartAsDefault (const SbName &partname, const SbName &nodename, SbBool onlyifdefault=1)
  • SbBool isPathSurrogateInMySubgraph (const SoPath *path, SoPath *&pathToOwner, SbName &surrogatename, SoPath *&surrogatepath, SbBool fillargs=1)
  • SbBool isPathSurrogateInMySubgraph (const SoPath *path)
  • virtual SbBool setPart (const SbName &partname, SoNode *from)

Public Member Functions inherited from SoBaseKit

  • SoBaseKit (void)
  • virtual SoNode * getPart (const SbName &partname, SbBool makeifneeded)
  • SbString getPartString (const SoBase *part)
  • virtual SoNodeKitPath * createPathToPart (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 SoChildList * getChildren (void) const
  • void printDiagram (void)
  • void printSubDiagram (const SbName &rootname, int level)
  • void printTable (void)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
  • 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 SoNode * copy (SbBool copyconnections=0) 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)
  • uint32_t getNodeId (void) const
  • virtual void writeInstance (SoOutput *out)
  • virtual SoFieldContainer * copyThroughConnection (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=0)
  • SbBool set (const char *const fielddata)
  • void get (SbString &fielddata)
  • virtual int getFields (SoFieldList &l) const
  • virtual int getAllFields (SoFieldList &l) const
  • virtual SoField * getField (const SbName &name) const
  • virtual SoField * getEventIn (const SbName &name) const
  • virtual SoField * getEventOut (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 *in)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • SbBool getIsBuiltIn (void) 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
  • 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 SoAuditorList & getAuditors (void) const
  • SbBool shouldWrite (void)
  • void assertAlive (void) const

🎀 Static Public Member Functions 🎀

  • static SoType getClassTypeId (void)
  • static const SoNodekitCatalog * getClassNodekitCatalog (void)
  • static void initClass (void)

Static Public Member Functions inherited from SoDragger

  • static SoType getClassTypeId (void)
  • static const SoNodekitCatalog * getClassNodekitCatalog (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 SoNodekitCatalog * getClassNodekitCatalog (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 SoNodekitCatalog * getClassNodekitCatalog (void)
  • static SbBool isSearchingChildren (void)
  • static void setSearchingChildren (const SbBool newval)
  • static SoNode * typeCheck (const SbName &partname, const SoType &parttype, SoNode *node)

Static Public Member Functions inherited from SoNode

  • static uint32_t getCompatibilityTypes (const SoType &nodetype)
  • static SoType getClassTypeId (void)
  • static SoNode * getByName (const SbName &name)
  • static int getByName (const SbName &name, SoNodeList &l)
  • static void initClass (void)
  • static void initClasses (void)
  • static uint32_t 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)

and that's the whole SYNOPSIS bestie — every single inherited signature, accounted for, no cap 💅 next part has the actual DESCRIPTION, so stay tuned ✨

💖 Static Public Member Functions inherited from SoFieldContainer 💖

okay bestie, so like, you also get these static public member functions from SoFieldContainer — they're literally inherited, no cap:

static void initClass (void)
static SoType getClassTypeId (void)
static void initCopyDict (void)
static void addCopy (const SoFieldContainer *orig, const
    SoFieldContainer *copy)
static SoFieldContainer * checkCopy (const SoFieldContainer *orig)
static SoFieldContainer * findCopy (const SoFieldContainer *orig, const
    SbBool copyconnections)
static void copyDone (void)

🦋 Static Public Member Functions inherited from SoBase 🦋

and these come from SoBase — the whole squad of static public member functions:

static void initClass (void)
static SoType getClassTypeId (void)
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 SoBase * getNamedBase (const SbName &name, SoType type)
static int getNamedBases (const SbName &name, SoBaseList &baselist,
    SoType type)
static SbBool read (SoInput *in, SoBase *&base, SoType expectedtype)
static void setInstancePrefix (const SbString &c)
static void setTraceRefs (SbBool trace)
static SbBool getTraceRefs (void)
static SbBool connectRoute (SoInput *in, const SbName &fromnodename,
    const SbName &fromfieldname, const SbName &tonodename, const SbName
    &tofieldname)
static SbBool readRoute (SoInput *in)

🌸 Public Attributes 🌸

these are the public attributes, and they're iconic:

  • 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 🎀

these are protected, so like, don't touch unless you know what you're doing, bestie:

virtual const SoFieldData * getFieldData (void) const
~SoSpotLightDragger ()
virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=0)
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 ()
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)
SoDragger * getActiveChildDragger (void) const
void updateDraggerCache (const SoPath *path)

🦋 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=1, SbBool onlyifdefault=1)
virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName
    &nodename, SbBool anypart=1, SbBool onlyifdefault=1)
SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool
    leafcheck=0, SbBool publiccheck=0)
void connectSeparatorFields (SoSeparator *dest, SbBool onOff)

🌸 Protected Member Functions inherited from SoBaseKit 🌸

virtual ~SoBaseKit ()
virtual SoNode * addToCopyDict (void) const
SoGroup * getContainerNode (const SbName &listname, SbBool
    makeifneeded=1)
virtual SoNode * getAnyPart (const SbName &partname, SbBool
    makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0)
virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname,
    SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0, const
    SoPath *pathtoextend=NULL)
virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool
    anypart=1)
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)
~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

💖 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
SoFieldSensor * rotFieldSensor
SoFieldSensor * translFieldSensor
SoFieldSensor * angleFieldSensor
SbPlaneProjector * planeProj

🦋 Protected Attributes inherited from SoDragger 🦋

SoSFNode motionMatrix

🌸 Protected Attributes inherited from SoInteractionKit 🌸

SoSFNode geomSeparator
SoSFNode topSeparator
SoFieldSensor * fieldSensor
SoSeparator * oldTopSep

💅 Protected Attributes inherited from SoBaseKit 💅

SoSFNode callbackList
SoChildList * children
SbBool connectionsSetUp

✨ Protected Attributes inherited from SoNode ✨

uint32_t 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
    }

✨ Protected Types inherited from SoBase ✨

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

🎀 Static Protected Attributes inherited from SoNode 🎀

static uint32_t nextUniqueId = 0
static int nextActionMethodIndex = 0

✨ Detailed Description ✨

okay so the SoSpotLightDragger class? It's literally the interactive geometry for manipulating a spotlight, periodt. 💡

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

This dragger is well suited for setting up the fields of a SoSpotLight node, because it gives the end-user geometry 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 lightsource. No cap, it's giving full control. ✨

Note: there is one aspect of SoSpotLight nodes that can not be controlled with this dragger: the SoSpotLight::dropOffRate field. So don't @ me. 🙈

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 scenegraph. So you can just use that if you want the whole package. 💅

🌈 See also 🌈

  • SoSpotLightManip, SoSpotLight
  • SoDirectionalLightDragger, SoPointLightDragger

✨ Constructor & Destructor Documentation ✨

💖 SoSpotLightDragger::SoSpotLightDragger (void )

okay bestie, default constructor alert! This sets up the dragger nodekit catalog with the interaction and feedback geometry. It's giving “let's build the whole spotlight drag setup from scratch” energy.

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"

(If you wanna know how that output formatting works, see SoBaseKit::printDiagram().)

Detailed info 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  ---

(And for the table formatting tea, see SoBaseKit::printTable().)

References: SoDragger::addFinishCallback(), SoDragger::addMotionCallback(), SoDragger::addStartCallback(), SoDragger::addValueChangedCallback(), angle, angleFieldSensor, doneCB(), fieldSensorCB(), motionCB(), planeProj, SoInteractionKit::readDefaultParts(), rotation, rotFieldSensor, setBeamScaleFromAngle(), SoInteractionKit::setPartAsDefault(), SoInteractionKit::setSwitchValue(), setUpConnections(), SoDragger::SoDragger(), SoSpotLightDragger(), startCB(), translation, translFieldSensor, and valueChangedCB().

Referenced by: doneCB(), fieldSensorCB(), getFieldData(), motionCB(), SoSpotLightDragger(), startCB(), and valueChangedCB().

🫶 SoSpotLightDragger::~SoSpotLightDragger () [protected]

Protected destructor, bestie. No random deletion energy here.

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

References: angleFieldSensor, planeProj, rotFieldSensor, and translFieldSensor.

👑 Member Function Documentation 👑

SoType SoSpotLightDragger::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time 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
  }
  else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
    SoGroup * group = (SoGroup *)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 pre-defined 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 info on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Reimplemented from SoDragger.

const SoFieldData * SoSpotLightDragger::getFieldData (void ) const [protected], [virtual]

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

Reimplemented from SoDragger.

References: SoSpotLightDragger().

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

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

Reimplemented from SoDragger.

SbBool SoSpotLightDragger::setUpConnections (SbBool onoff, SbBool doitalways = 0) [protected], [virtual]

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.

References: angle, angleFieldSensor, SoBaseKit::connectionsSetUp, SoBaseKit::getAnyPart(), SoDragger::registerChildDragger(), rotation, rotFieldSensor, SoInteractionKit::setPartAsDefault(), SoBaseKit::setUpConnections(), SoDragger::SoDragger(), translation, translFieldSensor, and SoDragger::unregisterChildDragger().

Referenced by SoSpotLightDragger().

void SoSpotLightDragger::setDefaultOnNonWritingFields (void ) [protected], [virtual]

(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 info 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 scenegraph 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's 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.

References: angle, and SoDragger::setDefaultOnNonWritingFields().

void SoSpotLightDragger::startCB (void * f, SoDragger * d) [static], [protected]

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

References: dragStart(), SoDragger::SoDragger(), and SoSpotLightDragger().

Referenced by SoSpotLightDragger().

void SoSpotLightDragger::motionCB (void * f, SoDragger * d) [static], [protected]

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

References: drag(), SoDragger::SoDragger(), and SoSpotLightDragger().

Referenced by SoSpotLightDragger().

void SoSpotLightDragger::doneCB (void * f, SoDragger * d) [static], [protected]

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

References: dragFinish(), SoDragger::SoDragger(), and SoSpotLightDragger().

Referenced by SoSpotLightDragger().

void SoSpotLightDragger::fieldSensorCB (void * d, SoSensor * s) [static], [protected]

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

References: angle, angleFieldSensor, SoDragger::getMotionMatrix(), SoScale::scaleFactor, SoDragger::setMotionMatrix(), SoSpotLightDragger(), SoDragger::valueChanged(), and SoDragger::workFieldsIntoTransform().

Referenced by SoSpotLightDragger().

void SoSpotLightDragger::valueChangedCB (void * f, SoDragger * d) [static], [protected]

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

References: SoFieldSensor::attach(), SoFieldSensor::detach(), SoDragger::getMotionMatrix(), SbMatrix::getTransform(), SbRotation::inverse(), SoRotation::rotation, rotation, rotFieldSensor, SoDragger::SoDragger(), SoSpotLightDragger(), translation, and translFieldSensor.

Referenced by SoSpotLightDragger().

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.

References: SoDragger::getActiveChildDragger(), SoDragger::getLocalStartingPoint(), SbVec3f::getValue(), planeProj, and SoInteractionKit::setSwitchValue().

Referenced by startCB().

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.

References: SbVec3f::dot(), SoDragger::getActiveChildDragger(), SoDragger::getLocalToWorldMatrix(), SoDragger::getNormalizedLocaterPosition(), SbVec3f::getValue(), SoDragger::getViewVolume(), SbVec3f::length(), planeProj, and setBeamScaleFromAngle().

Referenced by motionCB().

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.

References: SoDragger::getActiveChildDragger(), and SoInteractionKit::setSwitchValue().

Referenced by doneCB().

void SoSpotLightDragger::setBeamScaleFromAngle (float beamangle) [protected]

Scales the geometry representing the “lampshade” around the lightsource to represent the given beamangle.

References: angle, and SoScale::scaleFactor.

Referenced by drag(), and SoSpotLightDragger().

💖 Member Data Documentation 💖

okay bestie, here come the data members — the little fields that keep this dragger's whole vibe in sync. no skips, no summaries, we're listing every single one. 💅

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 you're using the SoSpotLightManip class, where this is taken care of automatically, no cap. 🦋

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

Referenced by setUpConnections(), SoSpotLightDragger(), and valueChangedCB().

SoSFVec3f SoSpotLightDragger::translation

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

Referenced by setUpConnections(), SoSpotLightDragger(), and valueChangedCB().

SoSFFloat SoSpotLightDragger::angle

The cut-off angle for the "lampshade" around the lightsource. ✨

Typically connected to a SoSpotLight::cutOffAngle field.

Referenced by fieldSensorCB(), SoSpotLightManip::fieldSensorCB(), setBeamScaleFromAngle(), setDefaultOnNonWritingFields(), setUpConnections(), and SoSpotLightDragger().

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

Referenced by setUpConnections(), SoSpotLightDragger(), valueChangedCB(), and ~SoSpotLightDragger().

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

Referenced by setUpConnections(), SoSpotLightDragger(), valueChangedCB(), and ~SoSpotLightDragger().

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

Referenced by fieldSensorCB(), setUpConnections(), SoSpotLightDragger(), and ~SoSpotLightDragger().

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

Referenced by drag(), dragStart(), SoSpotLightDragger(), and ~SoSpotLightDragger().

✨ Author ✨

Generated automatically by Doxygen for Coin from the source code. so like, no human author here, just the machine doing its thing. 💅

okay bestie, that's the whole page! 💖 Source: Coin, Version 2.5.0. Page: SoSpotLightDragger(3). Date? The footer didn't hand me one, so we're just gonna say it's giving Coin 2.5.0 energy, and that's enough. periodt. 🫶

📦 where this page comes from