SoPointLightDragger(3)

πŸ“¦
version 4.0.10 Β· 4 versions
, in fedora 43, fedora 44

πŸ’– SoPointLightDragger πŸ’–

okay so bestie, this is the manual page for SoPointLightDragger, a Coin class. And it is LONG. like, so long it comes in three parts, and this is part 1, so we are doing the NAME and the whole entire SYNOPSIS before we even breathe. the other parts are coming, do not close the tab. πŸ’…βœ¨


πŸŽ€ NAME πŸŽ€

SoPointLightDragger β€” the class that gives you interactive geometry for manipulating a point light source. that's the whole job description. iconic. πŸ¦‹


🌸 SYNOPSIS 🌸

first things first, you gotta include the header or nothing works, periodt:

#include <Inventor/draggers/SoPointLightDragger.h>

and it Inherits SoDragger. so yeah, everything a dragger can do, this one can do too, it's giving nepo baby but in the best way. πŸ’–

✨ Public Member Functions ✨

these are the ones that live on SoPointLightDragger itself, the main character members:

  • virtual SoType getTypeId (void) const β€” the type-id getter, virtual, const, very "know thyself" energy πŸ”
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const β€” hands you the nodekit catalog, virtual and const, catalog girlie behavior πŸ—‚οΈ
  • SoPointLightDragger (void) β€” the constructor. no args, just vibes, ready to be built ✨

πŸ¦‹ Public Member Functions inherited from SoDragger πŸ¦‹

okay this list is a LOT but we're not skipping a single one, every one of these is in your toolkit the second you inherit from SoDragger:

  • virtual void callback (SoCallbackAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual void write (SoWriteAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
  • void setProjectorEpsilon (const float epsilon)
  • float getProjectorEpsilon (void) const
  • void addStartCallback (SoDraggerCB *func, void *data=NULL)
  • void removeStartCallback (SoDraggerCB *func, void *data=NULL)
  • void addMotionCallback (SoDraggerCB *func, void *data=NULL)
  • void removeMotionCallback (SoDraggerCB *func, void *data=NULL)
  • void addFinishCallback (SoDraggerCB *func, void *data=NULL)
  • void removeFinishCallback (SoDraggerCB *func, void *data=NULL)
  • void addValueChangedCallback (SoDraggerCB *func, void *data=NULL)
  • void removeValueChangedCallback (SoDraggerCB *func, void *data=NULL)
  • void setMinGesture (int pixels)
  • int getMinGesture (void) const
  • SbBool enableValueChangedCallbacks (SbBool newval)
  • const 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

slay, that was a workout. πŸ’ͺ✨

🌈 Public Member Functions inherited from SoInteractionKit 🌈

  • SoInteractionKit (void) β€” the constructor, doing constructor things πŸŽ€
  • 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) β€” constructor, hi hello πŸ‘‹
  • 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) β€” prints the diagram, cute of it πŸ–¨οΈ
  • void printSubDiagram (const SbName &rootname, int level)
  • void printTable (void) β€” prints the table 🧾
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
  • SbBool forceChildDrivenWriteRefs (SoOutput *out)

⭐ Public Member Functions inherited from SoNode ⭐

  • void setOverride (const SbBool state)
  • SbBool isOverride (void) const
  • void setNodeType (const NodeType type)
  • NodeType getNodeType (void) const
  • virtual 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)
  • SbUniqueId 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 β€” ref counts go up πŸ“ˆ
  • void unref (void) const β€” and down πŸ“‰
  • void unrefNoDelete (void) const
  • int32_t getRefCount (void) const β€” peep the refcount πŸ‘€
  • void touch (void)
  • SbBool isOfType (SoType type) const β€” Returns TRUE if the type of this object is either of the same type or inherited from type.
  • 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 πŸ’«

the ones you call on the class itself, no instance required, lowkey the most powerful move:

  • 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)
no, your eyes are not deceiving you, both initClass and initClasses are really there. yes it's a lot of init. we love init. πŸ’…

πŸŽ€ Static Public Member Functions inherited from SoInteractionKit πŸŽ€

  • static SoType getClassTypeId (void)
  • static const SoNodekitCatalog * getClassNodekitCatalog (void)
  • static void initClass (void) β€” Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static void setSwitchValue (SoNode *node, const int newVal)

🌷 Static Public Member Functions inherited from SoBaseKit 🌷

  • static SoType getClassTypeId (void)
  • static void initClass (void)
  • static const SoNodekitCatalog * getClassNodekitCatalog (void)
  • static SbBool isSearchingChildren (void)
  • static void setSearchingChildren (const SbBool newval)

okay so that's the whole NAME and the whole entire SYNOPSIS, all of it, every single signature accounted for, not one skipped, we ate that. πŸ“βœ¨

and bestie… we're not done. that was only part 1. the rest of the page is still coming, so don't you dare scroll away. πŸ’–

🌈 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) β€” bestie this one sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. it's the little housekeeping era ✨
  • static void initClasses (void)
  • static SbUniqueId getNextNodeId (void)
  • static int getActionMethodIndex (const SoType type)
  • static void getBoundingBoxS (SoAction *action, SoNode *node)
  • static void GLRenderS (SoAction *action, SoNode *node)
  • static void callbackS (SoAction *action, SoNode *node)
  • static void getMatrixS (SoAction *action, SoNode *node)
  • static void handleEventS (SoAction *action, SoNode *node)
  • static void pickS (SoAction *action, SoNode *node)
  • static void rayPickS (SoAction *action, SoNode *node)
  • static void searchS (SoAction *action, SoNode *node)
  • static void writeS (SoAction *action, SoNode *node)
  • static void audioRenderS (SoAction *action, SoNode *node)
  • static void getPrimitiveCountS (SoAction *action, SoNode *node)

πŸ’œ Static Public Member Functions inherited from SoFieldContainer πŸ’œ

  • static void initClass (void) β€” again with the setup: it sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. same ritual, different class 🫢
  • static SoType getClassTypeId (void) β€” this static method returns the SoType object associated with objects of this class. it's giving "who am I" but in type-system language πŸ’…
  • static void cleanupClass (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 πŸ¦‹

  • static void initClass (void) β€” yeah yeah, you know the drill: sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system ✨
  • static SoType getClassTypeId (void) β€” this static method returns the SoType object associated with objects of this class. iconic behaviour honestly πŸ‘‘
  • 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 *input, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *input)

πŸŽ€ Public Attributes πŸŽ€

  • SoSFVec3f translation

Public Attributes inherited from SoDragger

  • SoSFBool isActive

Public Attributes inherited from SoInteractionKit

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

πŸ’… Protected Member Functions πŸ’…

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

Protected Member Functions inherited from SoDragger

  • SoDragger (void)
  • virtual ~SoDragger (void)
  • SbVec2f getNormalizedLocaterPosition (void)
  • SbVec2s getLocaterPosition (void)
  • SbVec2s getStartLocaterPosition (void) const
  • void setStartLocaterPosition (SbVec2s p)
  • SbBool isAdequateConstraintMotion (void)
  • virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath)
  • void setCameraInfo (SoAction *action)
  • virtual void handleEvent (SoHandleEventAction *ha)
  • void transferMotion (SoDragger *child)
  • void setIgnoreInBbox (SbBool newval)
  • SbBool isIgnoreInBbox (void)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • void setActiveChildDragger (SoDragger *newchilddragger)
  • SoDragger * getActiveChildDragger (void) const
  • void updateDraggerCache (const SoPath *path)
  • virtual const SoPickedPoint * getPickedPointForStart (SoHandleEventAction *action)

Protected Member Functions inherited from SoInteractionKit

  • virtual ~SoInteractionKit ()
  • virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections)
  • virtual SbBool setPart (const int partNum, SoNode *node)
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE)
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE)
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE)
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff)

Protected Member Functions inherited from SoBaseKit

  • virtual ~SoBaseKit ()
  • virtual SoNode * addToCopyDict (void) const
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE)
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE)
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL)
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE)
  • void createNodekitPartsList (void)
  • void createFieldList (void)
  • virtual void createDefaultParts (void)
  • const SoNodekitParts * getNodekitPartsList (void) const
  • const SbList< SoSFNode * > & getCatalogInstances (void) const
  • void catalogError (void)
  • void countMyFields (SoOutput *out)

Protected Member Functions inherited from SoNode

  • SoNode (void)
  • virtual ~SoNode ()

Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void)
  • virtual ~SoFieldContainer ()

Protected Member Functions inherited from SoBase

  • SoBase (void)
  • virtual ~SoBase ()
  • virtual void destroy (void)
  • SbBool hasMultipleWriteRefs (void) const
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
  • void writeFooter (SoOutput *out) const
  • virtual const char * getFileFormatName (void) const
  • virtual SoNotRec createNotRec (void)

🌸 Static Protected Member Functions 🌸

  • static const SoFieldData ** getFieldDataPtr (void)
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
  • static void 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

  • SbUniqueId uniqueId

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

⭐ Additional Inherited Members ⭐

Public Types inherited from SoDragger

  • enum ProjectorFrontSetting { FRONT, BACK, USE_PICK }

Public Types inherited from SoInteractionKit

  • enum CacheEnabled { OFF, ON, AUTO }

Public Types inherited from SoNode

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

Protected Types inherited from SoBase

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

Static Protected Attributes inherited from SoNode

  • static SbUniqueId nextUniqueId = 1
  • static int nextActionMethodIndex = 0

πŸ”₯ Detailed Description πŸ”₯

The SoPointLightDragger class provides interactive geometry for manipulating a point light source. yes bestie, you literally grab it and move it around πŸ’–

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

(there's a picture here of the dragger just vibing, default geometry, not active β€” you'd know it if you saw it) πŸ¦‹

This dragger is well suited to use for setting up the fields of a SoPointLight node, as it provides geometry for the end-user to translate a point in 3D space. it's giving "here's a handle, go wild" ✨

The Coin library also includes a manipulator class, SoPointLightManip, which wraps the functionality provided by this class inside the necessary mechanisms for connecting it to SoPointLight node instances in a scene graph. so like... this dragger is the raw vibe, and the manip is the same vibe but pre-wired into your scene graph, no cap πŸ‘‘


🫢 See also 🫢

  • SoPointLightManip

✨ Constructor & Destructor Documentation ✨

πŸŽ€ SoPointLightDragger::SoPointLightDragger (void )

okay so this is the default constructor, and what it does is set up the dragger nodekit catalog with the interaction geometry and the feedback geometry. both. it's giving overachiever πŸ’…

here's the nodekit structure, and bestie pay attention bc the new entries versus the parent class are marked with an arrow prefix -->:

CLASS SoPointLightDragger
-->"this"
      "callbackList"
      "topSeparator"
         "motionMatrix"
-->      "material"
-->      "translator"
         "geomSeparator"

(if you wanna know more about how that output formatting works, go peek at SoBaseKit::printDiagram() β€” it's all in there 🫢)

and now the detailed info on the catalog parts, no skimping:

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

(and for how that output formatting works, see SoBaseKit::printTable() ✨)


πŸ¦‹ SoPointLightDragger::~SoPointLightDragger (void ) [protected], [virtual]

protected destructor, bestie. it's the quiet exit.

and here's the lore: dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0. so like, you don't have to do anything, the vibes handle it themselves 😌


πŸ’– Member Function Documentation πŸ’–

🌸 SoType SoPointLightDragger::getClassTypeId (void ) [static]

this static method returns the SoType object associated with objects of this class. very demure, very static.

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

returns the type identification of an object derived from a class inheriting SoBase. this is what's used for runtime type checking and for "downward" casting.

Reimplemented from SoDragger.

πŸ’… const SoFieldData ** SoPointLightDragger::getFieldDataPtr (void ) [static], [protected]

ngl this API member is considered internal to the library, because it's not likely to be of interest to the application programmer. iykyk.

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

πŸŽ€ const SoFieldData * SoPointLightDragger::getFieldData (void ) const [protected], [virtual]

returns a pointer to the class-wide field data storage object for this instance. and if there are no fields present? it returns NULL. no fields, no problem.

Reimplemented from SoDragger.

⭐ const SoNodekitCatalog * SoPointLightDragger::getClassNodekitCatalog (void ) [static]

returns the nodekit catalog which defines the layout of this class' kit. it's literally the blueprint 🫢

πŸ¦‹ const SoNodekitCatalog * SoPointLightDragger::getNodekitCatalog (void ) const [virtual]

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

Reimplemented from SoDragger.

✨ const SoNodekitCatalog ** SoPointLightDragger::getClassNodekitCatalogPtr (void ) [static], [protected]

returns the pointer to the pointer of the nodekit catalog for this class. yes bestie, a pointer to a pointer. double the pointer, double the power πŸ’€

πŸ”₯ void SoPointLightDragger::initClass (void ) [static]

initializes the type system for this dragger class.

application programmers should usually not have to invoke this method β€” go read the documentation of SoInteraction::init() instead, it's the main character here πŸ‘‘

πŸ’œ SbBool SoPointLightDragger::setUpConnections (SbBool onoff, SbBool doitalways = FALSE) [protected], [virtual]

sets up all internal connections for instances of this class.

(okay so this method will usually not be of interest to the application programmer β€” unless you're out here extending the library with new custom nodekits or dragger classes. if that's you, iconic, go see the SoBaseKit class documentation.)

Reimplemented from SoInteractionKit.

πŸ“ void SoPointLightDragger::setDefaultOnNonWritingFields (void ) [protected], [virtual]

heads up bestie: 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, go read 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 scene graph export operations.

this is typically done when:

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

subclasses should usually override this to do additional settings for new member fields. and from the subclass, do remember to call "upwards" to your superclass' setDefaultOnNonWritingFields() method β€” don't leave your parent hanging fr fr.

Reimplemented from SoDragger.

🧚 void SoPointLightDragger::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 SoPointLightDragger::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. (yes, same energy as the one above. they're a matching set πŸŽ€)


πŸ‘‘ Member Data Documentation πŸ‘‘

πŸ’« SoSFVec3f SoPointLightDragger::translation

this field is continuously updated to contain the translation of the point light 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. slay, no manual labor required πŸ’…

and it may also of course be connected to any other location / translation field controlling the position of scene graph geometry. it does not have to be part of a SoPointLight node specifically. versatile queen ✨


🌈 Author 🌈

generated automatically by Doxygen for Coin from the source code. the robots did this one, we just gave it the glow-up 🫢


and that's a wrap on the whole page, bestie!! πŸ’– this was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and you just read SoPointLightDragger(3) β€” go forth and drag those point lights, you absolute icon πŸ‘‘βœ¨

πŸ“¦ where this page comes from