SoPointLightDragger(3)

πŸ“¦ version 3.1.3, in fedora 43, fedora 44

πŸ’– SoPointLightDragger(3) πŸ’–

Library Functions Manual Β· SoPointLightDragger(3)

okay so bestie, meet SoPointLightDragger β€” the class that hands you interactive geometry for manipulating a point light source ✨ That's the whole vibe: a draggable little gizmo that lets you push your point light around the scene like it's the main character. Periodt. πŸ‘‘


πŸŽ€ SYNOPSIS πŸŽ€

#include <Inventor/draggers/SoPointLightDragger.h>

Inherits SoDragger β€” so yeah, everything the parent class can do, this baby can do too 🫢

🌸 Public Member Functions 🌸

  • virtual SoType getTypeId (void) const β€” the type id, standard issue ✨
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const β€” the nodekit catalog πŸŽ€
  • SoPointLightDragger (void) β€” the constructor, your entry point πŸ’…

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

ngl, this list is long, but it's all free with the parent class, so no cap β€” you get every single one of these:

  • 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

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

🧚 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

⭐ Static Public Member Functions ⭐

  • static SoType getClassTypeId (void) β€” class type id, go off ✨
  • static const SoNodekitCatalog * getClassNodekitCatalog (void) β€” the class-level nodekit catalog πŸŽ€
  • static void initClass (void) β€” set it all up πŸ’…

🌸 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 synopsis, bestie β€” more coming right up πŸ’–

Static Public Member Functions inherited from SoFieldContainer 🌈

bestie these are the ones you get for free from SoFieldContainer, no need to write them yourself:

  • static void initClass (void) β€” sets up the class, as one does.
  • static SoType getClassTypeId (void) β€” hands you the SoType for the class.
  • static void cleanupClass (void) β€” tidies everything back up.
  • static void initCopyDict (void) β€” preps the copy dictionary.
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) β€” registers an orig β†’ copy pair in that dict.
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) β€” peeks in the copy dict for orig.
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) β€” looks up the copy of orig, with copyconnections deciding the connections vibe.
  • static void copyDone (void) β€” wraps the whole copying situation up.

Static Public Member Functions inherited from SoBase πŸ’«

more inherited goodies, this time from SoBase:

  • static void initClass (void) β€” class setup.
  • static SoType getClassTypeId (void) β€” the SoType please.
  • static void addName (SoBase *const base, const char *const name) β€” gives base a name.
  • static void removeName (SoBase *const base, const char *const name) β€” takes that name away again.
  • static void incrementCurrentWriteCounter (void) β€” bumps the current write counter up.
  • static void decrementCurrentWriteCounter (void) β€” bumps it back down.
  • static SoBase * getNamedBase (const SbName &name, SoType type) β€” fetches the base with that name and type.
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) β€” grabs all the bases matching name and type into baselist.
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) β€” reads a base from input, expecting expectedtype.
  • static void setInstancePrefix (const SbString &c) β€” sets the instance prefix to c.
  • static void setTraceRefs (SbBool trace) β€” turns reference tracing on or off.
  • static SbBool getTraceRefs (void) β€” tells you if tracing is on.
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) β€” wires a route from the from-side to the to-side.
  • static SbBool readRoute (SoInput *input) β€” reads a route from input.

Public Attributes ✨

  • SoSFVec3f translation β€” the field holding the translation. that's the whole point of this dragger, honestly.

Public Attributes inherited from SoDragger πŸŽ€

  • SoSFBool isActive β€” is the dragger active or not.

Public Attributes inherited from SoInteractionKit πŸ¦‹

  • SoSFEnum renderCaching β€” render caching mode.
  • SoSFEnum boundingBoxCaching β€” bounding box caching mode.
  • SoSFEnum renderCulling β€” render culling mode.
  • SoSFEnum pickCulling β€” pick culling mode.

Protected Member Functions πŸ”’

  • virtual const SoFieldData * getFieldData (void) const β€” returns the field data.
  • virtual ~SoPointLightDragger (void) β€” the destructor (protected, so stay in your lane).
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE) β€” sets up the connections, onoff toggles them, doitalways defaults to FALSE.
  • virtual void setDefaultOnNonWritingFields (void) β€” sets defaults on the non-writing fields.

Protected Member Functions inherited from SoDragger πŸ‘‘

  • SoDragger (void) β€” constructor.
  • virtual ~SoDragger (void) β€” destructor.
  • SbVec2f getNormalizedLocaterPosition (void) β€” normalized locater position.
  • SbVec2s getLocaterPosition (void) β€” locater position.
  • SbVec2s getStartLocaterPosition (void) const β€” the locater position it started at.
  • void setStartLocaterPosition (SbVec2s p) β€” sets the start locater position to p.
  • SbBool isAdequateConstraintMotion (void) β€” is the constraint motion adequate.
  • virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath) β€” should it grab, based on the surrogate?
  • void setCameraInfo (SoAction *action) β€” stashes the camera info from action.
  • virtual void handleEvent (SoHandleEventAction *ha) β€” handles the event.
  • void transferMotion (SoDragger *child) β€” passes motion along to child.
  • void setIgnoreInBbox (SbBool newval) β€” set the ignore-in-bbox flag to newval.
  • SbBool isIgnoreInBbox (void) β€” is it ignoring in bbox.
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) β€” fetches the bounding box.
  • void setActiveChildDragger (SoDragger *newchilddragger) β€” sets the active child dragger.
  • SoDragger * getActiveChildDragger (void) const β€” returns the active child dragger.
  • void updateDraggerCache (const SoPath *path) β€” updates the dragger cache.

Protected Member Functions inherited from SoInteractionKit πŸ’œ

  • virtual ~SoInteractionKit () β€” destructor.
  • virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections) β€” copies contents from fromFC, connections depending on copyConnections.
  • virtual SbBool setPart (const int partNum, SoNode *node) β€” sets part partNum to node.
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) β€” reads the instance from in with flags.
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) β€” sets a part as default by node.
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) β€” same but by nodename.
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) β€” sets a surrogate path.
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff) β€” connects the separator fields on dest.

Protected Member Functions inherited from SoBaseKit 🌸

  • virtual ~SoBaseKit () β€” destructor.
  • virtual SoNode * addToCopyDict (void) const β€” adds itself to the copy dict.
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE) β€” gets the container node for listname.
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) β€” gets any part by name.
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL) β€” builds a path to any part.
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE) β€” sets any part from a node.
  • void createNodekitPartsList (void) β€” creates the nodekit parts list.
  • void createFieldList (void) β€” creates 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) β€” reports a catalog error.
  • void countMyFields (SoOutput *out) β€” counts the fields.

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) β€” destroy it.
  • SbBool hasMultipleWriteRefs (void) const β€” does it have multiple write refs.
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const β€” writes the header.
  • void writeFooter (SoOutput *out) const β€” writes the footer.
  • virtual const char * getFileFormatName (void) const β€” returns the file format name.

Static Protected Member Functions 🧚

  • 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 fieldSensorCB (void *f, SoSensor *s) β€” the field sensor callback.
  • static void valueChangedCB (void *f, SoDragger *d) β€” fires when the value changes.

Static Protected Member Functions inherited from SoDragger πŸ’–

  • static const SoFieldData ** getFieldDataPtr (void) β€” field data pointer.
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) β€” class nodekit catalog pointer.
  • static void childTransferMotionAndValueChangedCB (void *, SoDragger *) β€” child motion-transfer + value-changed callback.
  • 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) β€” field data pointer.
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) β€” class nodekit catalog pointer.
  • static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize) β€” reads the default parts.
  • static void fieldSensorCB (void *, SoSensor *) β€” field sensor callback.

Static Protected Member Functions inherited from SoBaseKit 🌈

  • static const SoFieldData ** getFieldDataPtr (void) β€” field data pointer.
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) β€” class nodekit catalog pointer.

Static Protected Member Functions inherited from SoNode πŸ‘‘

  • static const SoFieldData ** getFieldDataPtr (void) β€” field data pointer.
  • static void setNextActionMethodIndex (int index) β€” sets the next action method index.
  • static int getNextActionMethodIndex (void) β€” gets 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 compatibility types.

Static Protected Member Functions inherited from SoBase πŸ’œ

  • static uint32_t getCurrentWriteCounter (void) β€” gets the current write counter.
  • static void staticDataLock (void) β€” locks the static data.
  • static void staticDataUnlock (void) β€” unlocks it again.

Protected Attributes πŸ”

  • SoSFNode material β€” the material node.
  • SoSFNode translator β€” the translator node.
  • SoFieldSensor * fieldSensor β€” the field sensor pointer.

Protected Attributes inherited from SoDragger ✨

  • SoSFNode motionMatrix β€” the motion matrix.

Protected Attributes inherited from SoInteractionKit πŸ¦‹

  • SoSFNode geomSeparator β€” the geom separator.
  • SoSFNode topSeparator β€” the top separator.
  • SoFieldSensor * fieldSensor β€” field sensor pointer.
  • SoSeparator * oldTopSep β€” the old top separator.

Protected Attributes inherited from SoBaseKit 🌸

  • SoSFNode callbackList β€” the callback list.
  • SoChildList * children β€” the children.
  • SbBool connectionsSetUp β€” are the connections set up.

Protected Attributes inherited from SoNode ⭐

  • uint32_t uniqueId β€” the unique id.

Protected Attributes inherited from SoFieldContainer 🫢

  • SbBool isBuiltIn β€” is it built in.

Additional Inherited Members πŸ’…

Public Types inherited from SoDragger

  • enum ProjectorFrontSetting { FRONT, BACK, USE_PICK }

Public Types inherited from SoInteractionKit

  • enum CacheEnabled { OFF, ON, AUTO }

Public Types inherited from SoNode

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

Protected Types inherited from SoBase

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

Static Protected Attributes inherited from SoNode

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

Detailed Description πŸ“–

The SoPointLightDragger class provides interactive geometry for manipulating a point light source. literally its whole personality.

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

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 "drag the light around and watch the world relight itself."

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 scenegraph. so if you want the whole connected-to-a-node thing done for you, that's the one, bestie.

See also 🌟

  • SoPointLightManip

Constructor & Destructor Documentation πŸ› οΈ

SoPointLightDragger::SoPointLightDragger (void )

Default constructor, sets up the dragger nodekit catalog with the interaction and feedback geometry.

Node kit structure (new entries versus parent class marked with arrow prefix):

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

(See SoBaseKit::printDiagram() for information about the output formatting.)

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

SoPointLightDragger::~SoPointLightDragger (void ) [protected], [virtual]

Protected destructor. πŸ™ˆ

(Dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0.) so like, don't go delete-ing it yourself, the refcounting has it handled.

πŸ’– Member Function Documentation πŸ’–

okay bestie, this is the part where we meet the actual methods, the little guys doing the work behind the scenes. strap in, there's a lot of them and they're all iconic in their own way ✨


getTypeId πŸ¦‹

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

Returns the type identification of an object derived from a class inheriting SoBase. Basically it's the name tag moment β€” this is what gets used for run-time type checking and "downward" casting, iykyk πŸ‘‘

Usage example, and yes you're getting it verbatim because it's literally the whole point:

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

So for application programmers who wanna extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. fr fr, no skipping it. 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. macros doing the heavy lifting so you don't have to πŸ’…

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

Reimplemented from SoDragger.

getFieldData πŸŽ€

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. that's it, that's the whole vibe 🌸

Reimplemented from SoDragger.

getNodekitCatalog ⭐

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

Returns the nodekit catalog which defines the layout of this class' kit. it's giving interior design blueprint but for nodekits 🫢

Reimplemented from SoDragger.

setUpConnections πŸ”₯

SbBool SoPointLightDragger::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.)

so like... if you're just vibing and using the library, this is not your moment. if you're out here building custom nodekits or draggers, go read SoBaseKit bestie πŸ“š

Reimplemented from SoInteractionKit.

setDefaultOnNonWritingFields πŸ’€

void SoPointLightDragger::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. And from the subclass, do remember to call "upwards" to your superclass' setDefaultOnNonWritingFields() method. don't leave your parent class hanging, that's so rude πŸ™ˆ

Reimplemented from SoDragger.

fieldSensorCB 🧚

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. so like, nothing to see here, keep scrolling bestie πŸ’…


valueChangedCB 🌈

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

Same energy, same warning: this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. πŸ™ˆ


πŸ“ Member Data Documentation πŸ“


translation πŸ‘‘

SoSFVec3f SoPointLightDragger::translation

This field is continuously updated to contain the translation of the pointlight dragger. like it's literally always tracking where the dragger is at, main character energy fr.

The application programmer will typically connect this to the SoPointLight::location field of a SoPointLight node β€” (unless using the SoPointLightManip class, where this is taken care of automatically). so if you're on SoPointLightManip, you can just sit back and let it handle itself, slay ✨

It may also of course be connected to any other location / translation field controlling the position of scenegraph geometry, it does not have to part of a SoPointLight node specifically. freedom, options, versatility β€” we love to see it 🌸


🌟 Author 🌟

Generated automatically by Doxygen for Coin from the source code.


and that's a wrap on SoPointLightDragger(3) bestie!! πŸŽ€πŸ¦‹πŸ’– this page came to you from Coin, Version 3.1.3, dated as ever β€” go forth and drag those point lights around, you absolute legend πŸ‘‘πŸ’…βœ¨

πŸ“¦ where this page comes from