SoPointLightDragger(3)

📦 version 2.5.0, in fedora 43, fedora 44

✨ NAME ✨

okay bestie, welcome to SoPointLightDragger(3) from the Library Functions Manual. this is part 1 of 3, and it's giving interactive geometry for manipulating a point light source. no cap.

SoPointLightDragger — The SoPointLightDragger class provides interactive geometry for manipulating a point light source. periodt. 💅

🦋 SYNOPSIS 🦋

#include <Inventor/draggers/SoPointLightDragger.h>

Inherits SoDragger.

👑 Public Member Functions 👑

these are the homegrown ones, bestie. only three, but they're iconic. 👑

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

💞 Public Member Functions inherited from SoDragger 💞

inherited but still ate. the whole dragger family tree is here. 🫶

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 🫶

and here's the SoInteractionKit lineup — yes, more inherited goodies. it's giving part-management energy. 💅

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 said "i'm the parent, you're welcome." these are its public member functions. 🌈

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 💜

SoNode is literally the blueprint, and these are its public member functions. main character energy. 👑

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 🎀

SoFieldContainer is giving field management energy. so many setters and getters, we love to see it. 🎀

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 💎

SoBase is the foundation, periodt. these are its public member functions. 💎

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 besties! these belong to the class itself, not an instance. iconic. ✨

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

🌸 Static Public Member Functions inherited from SoDragger 🌸

more static functions from SoDragger. it's giving "i contain multitudes". 🌸

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 ✨

SoInteractionKit static functions, coming right up. slay. ✨

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 💫

SoBaseKit static functions. type checking and searching? we love a utility moment. 💫

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 🌟

and finally, the SoNode static functions. this is the motherlode, bestie. 🌟

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)

✨ Static Public Member Functions inherited from SoFieldContainer ✨

bestie these are freebies, they come with the family 💅

  • static void initClass (void) — sets the class up, does the boring paperwork
  • static SoType getClassTypeId (void) — hands you the class type id
  • static void initCopyDict (void) — gets the copy dictionary ready
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — registers a copy in the dict
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — checks if a copy already exists
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — finds that copy, with a copyconnections toggle
  • static void copyDone (void) — copy time's over, wrap it up

✨ Static Public Member Functions inherited from SoBase ✨

the actual root of everything, no cap 🫶

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

  • SoSFVec3f translation — the whole point of this dragger, honestly. it's the field that holds the translation you're dragging around ✨

🌸 Public Attributes inherited from SoDragger 🌸

  • SoSFBool isActive — is the dragger currently doing its thing or nah

🌸 Public Attributes inherited from SoInteractionKit 🌸

  • SoSFEnum renderCaching
  • SoSFEnum boundingBoxCaching
  • SoSFEnum renderCulling
  • SoSFEnum pickCulling

💜 Protected Member Functions 💜

the secret menu, only the class and its kids get in 🙈

  • virtual const SoFieldData * getFieldData (void) const
  • ~SoPointLightDragger ()
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=0)
  • virtual void setDefaultOnNonWritingFields (void)

💜 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 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 material
  • SoSFNode translator
  • SoFieldSensor * fieldSensor

🎀 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 SoPointLightDragger class gives you interactive geometry for manipulating a point light source. literally that's the whole vibe 💡✨

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

🖼️ (the original page drops a picture right here — it's the dragger, default geometry, just chillin' inactive)

this dragger is well suited to use for setting up the fields of a SoPointLight node, because it gives the end-user geometry to translate a point in 3D space. periodt 🫶

the Coin library also ships a manipulator class, SoPointLightManip, which wraps everything this class does inside all the necessary mechanisms for connecting it to SoPointLight node instances in a scenegraph. so if you want the plug-and-play version, that's your girl 🎀

See also

  • SoPointLightManip

🧚 Constructor & Destructor Documentation 🧚

SoPointLightDragger::SoPointLightDragger (void )

Default constructor — it 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 SoPointLightDragger
-->"this"
      "callbackList"
      "topSeparator"
         "motionMatrix"
-->      "material"
-->      "translator"
         "geomSeparator"

(see SoBaseKit::printDiagram() for information about the output formatting, bestie)

Detailed information on catalog parts:

CLASS SoPointLightDragger
PVT   "this",  SoPointLightDragger  ---
      "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
PVT   "topSeparator",  SoSeparator  ---
PVT   "motionMatrix",  SoMatrixTransform  ---
      "material",  SoMaterial  ---
      "translator",  SoDragPointDragger  ---
PVT   "geomSeparator",  SoSeparator  ---

(see SoBaseKit::printTable() for information about the output formatting ✨)

References SoDragger::addValueChangedCallback(), fieldSensorCB(), SoInteractionKit::readDefaultParts(), SoInteractionKit::setPartAsDefault(), setUpConnections(), SoDragger::SoDragger(), SoPointLightDragger(), translation, and valueChangedCB().

Referenced by fieldSensorCB(), getFieldData(), SoPointLightDragger(), and valueChangedCB().

SoPointLightDragger::~SoPointLightDragger () — [protected]

Protected destructor, so don't come for it directly 🙈

💀 heads up: dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0. you don't delete them, they delete themselves when nobody's holding on anymore. iconic behaviour honestly.

✨ Member Function Documentation ✨

🌟 SoType SoPointLightDragger::getTypeId(void) const [virtual]

Okay bestie, this one gives you the type identification of any object derived from a class that inherits SoBase. It's what makes run-time type checking and "downward" casting possible — iykyk 💅

Usage example, straight up, no edits:

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

So here's the tea for anyone extending the library with brand new nodes, engines, nodekits, draggers or whatever else: you need to override this method in all your subclasses. It's typically part of setting up the full type system for your extension classes, and it's usually handled with the pre-defined macros — like the ones you get through 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. Slay.

Want the full lore on writing Coin extensions? Check the class documentation of the toplevel superclasses for the various class groups. 📚

Reimplemented from SoDragger.

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

Hands you a pointer to the class-wide field data storage object for this instance. And if there are literally no fields present? It returns NULL. That's it, that's the whole vibe.

Reimplemented from SoDragger.

References SoPointLightDragger().

🌟 const SoNodekitCatalog * SoPointLightDragger::getNodekitCatalog(void) const [virtual]

Returns the nodekit catalog that defines the layout of this class' kit. Iconic, honestly. 🎀

Reimplemented from SoDragger.

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

Sets up all the internal connections for instances of this class. Periodt.

Real talk: this method usually will not be of interest to the application programmer — unless you're out here wanting to extend the library with new custom nodekits or dragger classes. If that's you, go read the SoBaseKit class documentation. 🫶

Reimplemented from SoInteractionKit.

References SoBaseKit::connectionsSetUp, SoBaseKit::getAnyPart(), SoDragger::registerChildDragger(), SoInteractionKit::setPartAsDefault(), SoBaseKit::setUpConnections(), SoDragger::SoDragger(), translation, and SoDragger::unregisterChildDragger().

Referenced by SoPointLightDragger().

🌟 void SoPointLightDragger::setDefaultOnNonWritingFields(void) [protected], [virtual]

Heads up bestie: this method is unlikely to be of interest to the application programmer who doesn't want to extend the library with new custom nodekits or draggers. But if you are writing extensions, go check the info in the SoBaseKit class documentation. 💖

So this is a virtual method, and the code inside it should call SoField::setDefault() with argument TRUE on part fields that should not be written when you do 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. And from the subclass, do not forget to call "upwards" to your superclass' setDefaultOnNonWritingFields() method. No skipping steps, okay? 🙈

Reimplemented from SoDragger.

References SoDragger::setDefaultOnNonWritingFields().

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

This API member is considered internal to the library, since it is not likely to be of interest to the application programmer. Move along, nothing to see here (affectionately). 💀

References SoDragger::getMotionMatrix(), SoDragger::setMotionMatrix(), SoPointLightDragger(), and SoDragger::workFieldsIntoTransform().

Referenced by SoPointLightDragger().

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

Also internal to the library, also not likely to be of interest to the application programmer. Same energy, same disclaimer. 🌸

References SoFieldSensor::attach(), SoFieldSensor::detach(), SoDragger::getMotionMatrix(), SoDragger::SoDragger(), SoPointLightDragger(), and translation.

Referenced by SoPointLightDragger().

✨ Member Data Documentation ✨

🦋 SoSFVec3f SoPointLightDragger::translation

This field is continuously updated to contain the translation of the pointlight dragger. 💫 The application programmer will typically connect this to the SoPointLight::location field of a SoPointLight node — unless you're using the SoPointLightManip class, where this is taken care of automatically. Lucky you.

And it may also, of course, be connected to any other location / translation field controlling the position of scenegraph geometry. It does not have to be part of a SoPointLight node specifically. Flexible queen behavior. 👑

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

👑 Author

Generated automatically by Doxygen for Coin from the source code.

And that's a wrap, bestie!! 🎀✨ This whole thing came from Coin, Version 2.5.0, and this page is SoPointLightDragger(3) — go forth and drag those point lights with main character energy. 💖🦋🌸

📦 where this page comes from