SoSpotLightDragger(3)

📦 version 3.1.3, in fedora 43, fedora 44

okay bestie, sit down, hydrate, and lock in 💖 — what you're looking at is SoSpotLightDragger, straight out of the Library Functions Manual, section (3). Yes, that section. This is part 1 of 3, so don't you dare scroll away, there's more coming 🌸

🎀 NAME 🎀

SoSpotLightDragger — the class that gives you interactive geometry for manipulating a spotlight. Like, actual grabbable stuff you can drag around in the viewport to boss your spotlight into position. Main character energy, but for a light source 👑

🦋 SYNOPSIS 🦋

First things first, the summoning spell:

#include <Inventor/draggers/SoSpotLightDragger.h>

And the family tree, because this class is not self-made, she has ancestors:

Inherits SoDragger.

Everything below is the full roster — nothing skipped, nothing summarised, we're doing this properly 💅

✨ Public Member Functions ✨

The three that are hers, the ones this class actually owns:

virtual SoType getTypeId (void) const
virtual const SoNodekitCatalog * getNodekitCatalog (void) const
SoSpotLightDragger (void)

🫶 Public Member Functions inherited from SoDragger

Okay so this is the inheritance flex — everything here comes along for the ride when you're a dragger. Grab a snack, it's a long list but it's all important:

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 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)
virtual 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
note the getProjectorEpsilon / setProjectorEpsilon pair — yes, epsilon, iconic, we love a tolerance value 🫶

💖 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 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=FALSE)
SbBool forceChildDrivenWriteRefs (SoOutput *out)

the printDiagram / printTable trio lowkey being the cutest debugging tools in the whole kit, iykyk 🎀

⭐ 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=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)
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=FALSE)
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 *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
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
heads up bestie: ref / unref are the reference-counting girlies. Handle with care, don't be reckless, that's all I'm saying 🙈

✨ Static Public Member Functions ✨

These belong to the class itself, not to any one instance:

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 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 entire SYNOPSIS, every single signature, not one skipped 💅✨

okay that was the whole cast list — and bestie, we are not done. The actual descriptions, options and the rest of the lore are still coming, so stay tuned for part 2 🦋🍓

Static Public Member Functions inherited from SoFieldContainer

okay bestie these are all static, so you hit them up on the class itself, not on some instance, k? 💅

  • static void initClass (void) — sets up the class. The classic Coin ritual. ✨
  • static SoType getClassTypeId (void) — hands you back the type id for this class. 🎀
  • static void cleanupClass (void) — tidies the class back up when you're done. 🧹
  • static void initCopyDict (void) — kicks off the copy dictionary before a copy pass. 📖
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — registers one original→copy pair in that dictionary. 🔁
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — peeks inside the copy dictionary for orig. 👀
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — digs up the copy for orig, with a say in whether connections come along. 🔍
  • static void copyDone (void) — wraps the whole copy thing up. ✅

Static Public Member Functions inherited from SoBase

the SoBase fam, all static, all vibing on the class:

  • static void initClass (void) — class setup, again. it's a whole tradition. ✨
  • static SoType getClassTypeId (void) — the type id, again. 🎀
  • static void addName (SoBase *const base, const char *const name) — gives base a name so it can be looked up later. 🏷️
  • static void removeName (SoBase *const base, const char *const name) — takes that name back off. 🙈
  • static void incrementCurrentWriteCounter (void) — bumps the write counter up. 🔢
  • static void decrementCurrentWriteCounter (void) — bumps it back down. 🔢
  • static SoBase * getNamedBase (const SbName &name, SoType type) — fetches a base by name and type. 🔎
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — grabs all the matching bases into baselist. 🧺
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — reads a base off of input, expecting expectedtype. 📥
  • static void setInstancePrefix (const SbString &c) — sets the prefix used when naming instances. 🔤
  • static void setTraceRefs (SbBool trace) — flips reference tracing on or off. 🐛
  • static SbBool getTraceRefs (void) — tells you whether reference tracing is on. 🐛
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — wires a route from one node+field to another node+field. 🛤️
  • static SbBool readRoute (SoInput *input) — reads a route in from input. 📥

Public Attributes

these are the public ones you can just reach out and touch (in a scene-graph sense 💖):

  • SoSFRotation rotation — the rotation. 🔄
  • SoSFVec3f translation — the translation. 📍
  • SoSFFloat angle — the angle. 📐

Public Attributes inherited from SoDragger

  • SoSFBool isActive — whether the dragger is currently active, i.e. being dragged. 🔥

Public Attributes inherited from SoInteractionKit

  • SoSFEnum renderCaching — the render caching setting. 🗄️
  • SoSFEnum boundingBoxCaching — the bounding box caching setting. 📦
  • SoSFEnum renderCulling — the render culling setting. ✂️
  • SoSFEnum pickCulling — the pick culling setting. 🎯

Protected Member Functions

the inner-circle stuff, for subclasses and the class's own guts 🫶

  • virtual const SoFieldData * getFieldData (void) const — returns the field data. 📋
  • virtual ~SoSpotLightDragger (void) — the destructor, and yes it's virtual. 💀
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE) — sets up (or tears down) the internal connections, with doitalways defaulting to FALSE. 🔌
  • virtual void setDefaultOnNonWritingFields (void) — handles which fields get defaulted when they're not being written out. 📝
  • void dragStart (void) — fires when a drag begins. 🏁
  • void drag (void) — fires while the drag is happening. 🏃‍♀️
  • void dragFinish (void) — fires when the drag wraps up. 🏁
  • void setBeamScaleFromAngle (float beamangle) — sets the beam scale based on beamangle. 🔆

Protected Member Functions inherited from SoDragger

  • SoDragger (void) — constructor. 🐣
  • virtual ~SoDragger (void) — destructor. 💀
  • SbVec2f getNormalizedLocaterPosition (void) — the locater position, normalized. 📐
  • SbVec2s getLocaterPosition (void) — the locater position. 📍
  • SbVec2s getStartLocaterPosition (void) const — where the locater was when this all started. 🚩
  • void setStartLocaterPosition (SbVec2s p) — sets that starting locater position to p. 🚩
  • SbBool isAdequateConstraintMotion (void) — checks whether the constraint motion is adequate. 🤔
  • virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath) — decides whether the grab should happen based on the surrogate path. 🫳
  • void setCameraInfo (SoAction *action) — pulls camera info out of action. 📷
  • virtual void handleEvent (SoHandleEventAction *ha) — handles the event action ha. 🎪
  • void transferMotion (SoDragger *child) — passes motion along to child. 🏓
  • void setIgnoreInBbox (SbBool newval) — sets whether this is ignored in bounding box calculations. 📦
  • SbBool isIgnoreInBbox (void) — asks whether it's ignored in bounding box calculations. 📦
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — computes the bounding box for action. 📦
  • void setActiveChildDragger (SoDragger *newchilddragger) — sets the active child dragger. 👶
  • SoDragger * getActiveChildDragger (void) const — returns the active child dragger. 👶
  • void updateDraggerCache (const SoPath *path) — refreshes the dragger cache for path. 🗄️

Protected Member Functions inherited from SoInteractionKit

  • virtual ~SoInteractionKit () — destructor. 💀
  • virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections) — copies contents over from fromFC, with a say on connections. 📄
  • virtual SbBool setPart (const int partNum, SoNode *node) — sets part number partNum to node. 🧩
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — reads an instance in from in with flags. 📥
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — sets any part named partname to node as the default, with anypart and onlyifdefault both defaulting to TRUE. 🧩
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — same deal, but by node name instead of a node pointer. 🧩
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — sets the surrogate path for name, with leafcheck and publiccheck both defaulting to FALSE. 🛤️
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff) — connects the separator fields on dest according to onOff. 🔌

Protected Member Functions inherited from SoBaseKit

  • virtual ~SoBaseKit () — destructor. 💀
  • virtual SoNode * addToCopyDict (void) const — adds this into the copy dictionary. 📖
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE) — grabs the container node for listname, making it if needed (TRUE by default). 📦
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — gets any part by name, with leafcheck and publiccheck defaulting to FALSE. 🧩
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL) — builds a path to any part, optionally extending pathtoextend, which defaults to NULL. 🛤️
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE) — sets any part named partname from from. 🧩
  • void createNodekitPartsList (void) — builds the nodekit parts list. 📋
  • void createFieldList (void) — builds the field list. 📋
  • virtual void createDefaultParts (void) — creates the default parts. 🐣
  • const SoNodekitParts * getNodekitPartsList (void) const — returns the nodekit parts list. 📋
  • const SbList< SoSFNode * > & getCatalogInstances (void) const — returns the catalog instances. 🗂️
  • void catalogError (void) — handles a catalog error. 🚨
  • void countMyFields (SoOutput *out) — counts this node's fields into out. 🔢

Protected Member Functions inherited from SoNode

  • SoNode (void) — constructor. 🐣
  • virtual ~SoNode () — destructor. 💀

Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void) — constructor. 🐣
  • virtual ~SoFieldContainer () — destructor. 💀

Protected Member Functions inherited from SoBase

  • SoBase (void) — constructor. 🐣
  • virtual ~SoBase () — destructor. 💀
  • virtual void destroy (void) — destroys this. 💥
  • SbBool hasMultipleWriteRefs (void) const — checks for multiple write references. 🤔
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes the header out, told whether it's a group and whether it's an engine. 📝
  • void writeFooter (SoOutput *out) const — writes the footer out. 📝
  • virtual const char * getFileFormatName (void) const — returns the file format name. 🏷️

Static Protected Member Functions

  • static const SoFieldData ** getFieldDataPtr (void) — returns a pointer to the field data pointer. 📋
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — returns a pointer to the class nodekit catalog pointer. 🗂️
  • static void startCB (void *f, SoDragger *d) — the start callback. 🏁
  • static void motionCB (void *f, SoDragger *d) — the motion callback. 🏃‍♀️
  • static void doneCB (void *f, SoDragger *d) — the done callback. ✅
  • static void fieldSensorCB (void *f, SoSensor *s) — the field sensor callback. 📡
  • static void valueChangedCB (void *f, SoDragger *d) — the value-changed callback. 🔔

Static Protected Member Functions inherited from SoDragger

  • static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer. 📋
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — pointer to the class nodekit catalog pointer. 🗂️
  • static void childTransferMotionAndValueChangedCB (void *, SoDragger *) — child callback for transferred motion and value changes. 🏓
  • static void childValueChangedCB (void *, SoDragger *) — child value-changed callback. 🔔
  • static void childStartCB (void *, SoDragger *) — child start callback. 🏁
  • static void childMotionCB (void *, SoDragger *) — child motion callback. 🏃‍♀️
  • static void childFinishCB (void *, SoDragger *) — child finish callback. 🏁
  • static void childOtherEventCB (void *, SoDragger *) — child other-event callback. 🎪

Static Protected Member Functions inherited from SoInteractionKit

  • static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer. 📋
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — pointer to the class nodekit catalog pointer. 🗂️
  • static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize) — reads the default parts from fileName out of defaultBuffer of size defBufSize. 📥
  • static void fieldSensorCB (void *, SoSensor *) — field sensor callback. 📡

Static Protected Member Functions inherited from SoBaseKit

  • static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer. 📋
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — pointer to the class nodekit catalog pointer. 🗂️

Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer. 📋
  • static void setNextActionMethodIndex (int index) — sets the next action method index to index. 🔢
  • static int getNextActionMethodIndex (void) — returns the next action method index. 🔢
  • static void incNextActionMethodIndex (void) — increments the next action method index. 🔢
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets the compatibility types for nodetype using bitmask. 🧬

Static Protected Member Functions inherited from SoBase

  • static uint32_t getCurrentWriteCounter (void) — returns the current write counter. 🔢
  • static void staticDataLock (void) — locks the static data. 🔒
  • static void staticDataUnlock (void) — unlocks the static data. 🔓

Protected Attributes

  • SoSFNode beam — the beam. 💡
  • SoSFNode beamActive — the active beam. 💡
  • SoSFNode beamPlacement — the beam placement. 📍
  • SoSFNode beamScale — the beam scale. 📏
  • SoSFNode beamSep — the beam separator. 🧩
  • SoSFNode beamSwitch — the beam switch. 🎚️
  • SoSFNode material — the material. 🎨
  • SoSFNode rotator — the rotator. 🔄
  • SoSFNode translator — the translator. ↔️
  • SoSFNode translatorRotInv — the inverted-rotation translator. 🔄
  • SoSFNode translatorSep — the translator separator. 🧩
  • SoFieldSensor * rotFieldSensor — field sensor for rotation. 📡
  • SoFieldSensor * translFieldSensor — field sensor for translation. 📡
  • SoFieldSensor * angleFieldSensor — field sensor for the angle. 📡
  • SbPlaneProjector * planeProj — the plane projector. 📐

Protected Attributes inherited from SoDragger

  • SoSFNode motionMatrix — the motion matrix. 🔢

Protected Attributes inherited from SoInteractionKit

  • SoSFNode geomSeparator — the geometry separator. 🧩
  • SoSFNode topSeparator — the top separator. 🧩
  • SoFieldSensor * fieldSensor — the field sensor. 📡
  • SoSeparator * oldTopSep — the old top separator. 🧩

Protected Attributes inherited from SoBaseKit

  • SoSFNode callbackList — the callback list. 📋
  • SoChildList * children — the children. 👶
  • SbBool connectionsSetUp — whether connections have been set up. 🔌

Protected Attributes inherited from SoNode

  • uint32_t uniqueId — this node's unique id. 🆔

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn — whether this is built in. 🏛️

Additional Inherited Members

Public Types inherited from SoDragger

  • enum ProjectorFrontSetting { FRONT, BACK, USE_PICK } — where the projector is set to front, back, or decided by the pick. 🎯

Public Types inherited from SoInteractionKit

  • enum CacheEnabled { OFF, ON, AUTO } — caching off, on, or 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 } — the whole menu of node types, each with its own little hex value. 🧬

Protected Types inherited from SoBase

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } — the base flags. 🚩

Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 1 — the next unique id, starting at 1. 🆔
  • static int nextActionMethodIndex = 0 — the next action method index, starting at 0. 🔢

💖 Detailed Description 💖

okay so the whole point of SoSpotLightDragger is that it gives you interactive geometry for manipulating a spotlight. ✨

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

🎀 [picture it, bestie — default geometry, all chill and inactive] 🎀

This dragger is lowkey the perfect match for setting up the fields of an SoSpotLight node — it hands the end-user geometry to interact with, so they can:

  • mess with a directional vector for the spotlight 🧭
  • set up its position 📍
  • control the cut-off angle for the "lampshade" around the lightsource 💡
⚠️ But heads up, bestie: there's one aspect of SoSpotLight nodes that this dragger cannot control — the SoSpotLight::dropOffRate field. Not happening. Not today. 🙈

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

🌸 See also 🌸

  • SoSpotLightManip, SoSpotLight
  • SoDirectionalLightDragger, SoPointLightDragger

🛠️ Constructor & Destructor Documentation 🛠️

SoSpotLightDragger::SoSpotLightDragger (void ) ✨

Default constructor, bestie — it sets up the dragger nodekit catalog with the interaction and feedback geometry. Iconic.

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"

For the tea on output formatting, see SoBaseKit::printDiagram(). 🫖

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

For the tea on output formatting, see SoBaseKit::printTable(). 🫖

SoSpotLightDragger::~SoSpotLightDragger (void ) [protected], [virtual] 🛡️

Protected destructor. Protected, bestie — handle with care.

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

🔧 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. iykyk, it's the whole RTTI vibe.

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

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 = FALSE) [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.

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

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.

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.

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.

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.

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.

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.

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.

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.

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

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

💾 Member Data Documentation 💾

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 scenegraph geometry, it does not have to part of a SoSpotLight node specifically.

SoSFVec3f SoSpotLightDragger::translation 📍

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

SoSFFloat SoSpotLightDragger::angle 🔦

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

Typically connected to a SoSpotLight::cutOffAngle field.

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.

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.

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.

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.

✍️ Author ✍️

Generated automatically by Doxygen for Coin from the source code. 💅

💖 That's the whole page, bestie. This one came from Coin, Version 3.1.3, and it's SoSpotLightDragger(3). Stay slaying with those draggers. 💅✨

📦 where this page comes from