SoVRMLDragSensor(3)

📦 version 2.5.0, in fedora 43, fedora 44

🎀 SoVRMLDragSensor — Library Functions Manual, section 3 🎀

okay bestie, sit down, hydrate, because we're doing a deep dive into SoVRMLDragSensor(3) and honestly? it's giving foundational. 💅

✨ NAME ✨

SoVRMLDragSensor — the superclass for VRML drag sensors. it's the momager of drag sensors, fr fr. 👑

🌸 SYNOPSIS 🌸

#include <Inheritor/VRMLnodes/SoVRMLDragSensor.h>

wait no, it's literally this, don't let me gaslight you:

#include <Inventor/VRMLnodes/SoVRMLDragSensor.h>

Inherits SoVRMLSensor.

Inherited by SoVRMLCylinderSensor, SoVRMLPlaneSensor, and SoVRMLSphereSensor. ✨ the whole girl group.

🫶 Public Member Functions

  • virtual SoType getTypeId (void) const — tells you the type id, queen.
  • virtual void handleEvent (SoHandleEventAction *action) — handles the event that comes in.

Public Member Functions inherited from SoNode

  • void setOverride (const SbBool state)
  • SbBool isOverride (void) const
  • void setNodeType (const NodeType type)
  • NodeType getNodeType (void) const
  • virtual SoNode * copy (SbBool copyconnections=0) const
  • virtual SbBool affectsState (void) const
  • virtual void doAction (SoAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void pick (SoPickAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual void write (SoWriteAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • virtual void notify (SoNotList *l)
  • uint32_t getNodeId (void) const
  • virtual SoChildList * getChildren (void) const
  • virtual void writeInstance (SoOutput *out)
  • virtual SoNode * addToCopyDict (void) const
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
  • virtual SoFieldContainer * copyThroughConnection (void) const

Public Member Functions inherited from SoFieldContainer

  • void setToDefaults (void)
  • SbBool hasDefaultValues (void) const
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0)
  • SbBool set (const char *const fielddata)
  • void get (SbString &fielddata)
  • virtual int getFields (SoFieldList &l) const
  • virtual int getAllFields (SoFieldList &l) const
  • virtual SoField * getField (const SbName &name) const
  • virtual SoField * getEventIn (const SbName &name) const
  • virtual SoField * getEventOut (const SbName &name) const
  • SbBool getFieldName (const SoField *const field, SbName &name) const
  • SbBool enableNotify (const SbBool flag)
  • SbBool isNotifyEnabled (void) const
  • SbBool set (const char *fielddata, SoInput *in)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
  • SbBool getIsBuiltIn (void) const
  • void setUserData (void *userdata) const
  • void * getUserData (void) const

Public Member Functions inherited from SoBase

  • void ref (void) const
  • void unref (void) const
  • void unrefNoDelete (void) const
  • int32_t getRefCount (void) const
  • void touch (void)
  • SbBool isOfType (SoType type) const
  • virtual SbName getName (void) const
  • virtual void setName (const SbName &newname)
  • void addAuditor (void *const auditor, const SoNotRec::Type type)
  • void removeAuditor (void *const auditor, const SoNotRec::Type type)
  • const SoAuditorList & getAuditors (void) const
  • SbBool shouldWrite (void)
  • void assertAlive (void) const

🦋 Static Public Member Functions

  • static SoType getClassTypeId (void)
  • static void initClass (void)

Static Public Member Functions inherited from SoVRMLSensor

  • static SoType getClassTypeId (void)
  • static void initClass (void)

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)

Static Public Member Functions inherited from SoFieldContainer

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

Static Public Member Functions inherited from SoBase

  • 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 trackPoint_changed
  • SoSFBool autoOffset

Public Attributes inherited from SoVRMLSensor

  • SoSFBool isActive
  • SoSFBool enabled

🌈 Protected Member Functions

  • virtual const SoFieldData * getFieldData (void) const
  • virtual SbBool dragStart (void)=0
  • virtual void drag (void)=0
  • virtual void dragFinish (void)=0
  • SoVRMLDragSensor (void)
  • virtual ~SoVRMLDragSensor ()
  • const SbVec3f & getLocalStartingPoint (void) const
  • const SbMatrix & getLocalToWorldMatrix (void) const
  • const SbMatrix & getWorldToLocalMatrix (void) const
  • const SbViewVolume & getViewVolume (void) const
  • const SbVec2f & getNormalizedLocaterPosition (void) const

Protected Member Functions inherited from SoNode

  • SoNode (void)
  • virtual ~SoNode ()
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)

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 Protected Member Functions inherited from SoVRMLSensor

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

🧚 Additional Inherited Members

  • 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 }
  • Protected Attributes inherited from SoNode: uint32_t uniqueId
  • Protected Attributes inherited from SoFieldContainer: SbBool isBuiltIn
  • Static Protected Attributes inherited from SoNode: static uint32_t nextUniqueId = 0, static int nextActionMethodIndex = 0

💖 Detailed Description 💖

SoVRMLDragSensor is the superclass for VRML drag sensors. yes, we said it in NAME, we're saying it again, because it's that important. 💅

so the tea is: this class collects the two fields that are common for some of the sensor nodes, plus some common functions for those. and because this is an abstract "helper" class, it does not represent an actual node from the VRML97 spec — so bestie, do NOT use it as one. it's giving backstage crew, not main character. 🙈

for more info, there's a whole detailed discussion of drag sensors waiting for you in section 4.6.7.4 of the VRML97 specification:

http://www.web3d.org/x3d/specifications/vrml/ISO-
IEC-14772-VRML97/part1/concepts.html#4.6.7.4

🫶 Constructor & Destructor Documentation 🫶

SoVRMLDragSensor::SoVRMLDragSensor (void ) [protected]

Constructor. ✨

References autoOffset, SoVRMLDragSensor(), and trackPoint_changed.
Referenced by dragFinish(), getFieldData(), and SoVRMLDragSensor().

SoVRMLDragSensor::~SoVRMLDragSensor () [protected], [virtual]

Destructor. 💀 she's logging off, respectfully.

👑 Member Function Documentation 👑

okay bestie, this is the part where we meet the actual functions — the little workers that make this sensor do its thing. every single one is here, no cap 💅

💫 SoType SoVRMLDragSensor::getTypeId (void ) const [virtual]

this one hands you back the type identification of any object derived from a class that inherits SoBase. what's it for? run-time type checking and "downward" casting, bestie. iconic behavior ✨

usage example, and yes it's giving exactly this:

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 like, if you're an application programmer wanting to extend the library with new nodes, engines, nodekits, draggers or others — heads up: this method needs to be overridden in all subclasses. it's 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. fr fr, that's the move.

want more info on writing Coin extensions? see the class documentation of the toplevel superclasses for the various class groups 🫶

  • Reimplemented from SoVRMLSensor.
  • Reimplemented in SoVRMLCylinderSensor, SoVRMLPlaneSensor, and SoVRMLSphereSensor.

🌸 const SoFieldData * SoVRMLDragSensor::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. simple as 🎀

  • Reimplemented from SoVRMLSensor.
  • Reimplemented in SoVRMLCylinderSensor, SoVRMLPlaneSensor, and SoVRMLSphereSensor.
  • References SoVRMLDragSensor().

🔥 void SoVRMLDragSensor::handleEvent (SoHandleEventAction * action) [virtual]

this is the action method for SoHandleEventAction. what it does: inspects the event data from action, and processes it if it's something this node should react to. main character energy only for relevant events 💅

and psst — nodes influencing relevant state variables for how event handling is done also overrides this method. so it's a whole family thing.

  • Reimplemented from SoNode.
  • References SoPath::containsPath(), SoPath::copy(), drag(), dragFinish(), dragStart(), SoAction::getCurPath(), SoHandleEventAction::getEvent(), SoFullPath::getLength(), SoPickedPoint::getObjectToWorld(), SoPickedPoint::getPath(), SoHandleEventAction::getPickedPoint(), SoPickedPoint::getPoint(), SoAction::getState(), SoFullPath::getTail(), SoNode::handleEvent(), SbMatrix::inverse(), SbMatrix::multVecMatrix(), SoBase::ref(), SoNode::SoNode(), and SoBase::unref().

🦋 virtual SbBool SoVRMLDragSensor::dragStart (void ) [protected], [pure virtual]

ngl 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. yup, that's the moment ✨

  • Implemented in SoVRMLCylinderSensor, SoVRMLPlaneSensor, and SoVRMLSphereSensor.
  • Referenced by handleEvent().

💖 virtual void SoVRMLDragSensor::drag (void ) [protected], [pure virtual]

same vibe, this API member is considered internal to the library — not likely to be of interest to the application programmer.

called when user drags the mouse after picking the dragger. 🖱️✨

  • Implemented in SoVRMLCylinderSensor, SoVRMLPlaneSensor, and SoVRMLSphereSensor.
  • Referenced by handleEvent().

🌈 virtual void SoVRMLDragSensor::dragFinish (void ) [protected], [pure virtual]

again bestie: this API member is considered internal to the library, not likely to be of interest to the application programmer.

called when mouse button is released after picking and interacting with the dragger. the grand finale of the drag 🎬

  • Implemented in SoVRMLCylinderSensor, SoVRMLPlaneSensor, and SoVRMLSphereSensor.
  • References getLocalStartingPoint(), getLocalToWorldMatrix(), getNormalizedLocaterPosition(), getViewVolume(), getWorldToLocalMatrix(), and SoVRMLDragSensor().
  • Referenced by handleEvent().

🧚 const SbVec3f & SoVRMLDragSensor::getLocalStartingPoint (void ) const [protected]

returns the interaction starting point. where it all began, lowkey 🥺

  • Referenced by SoVRMLCylinderSensor::drag(), SoVRMLPlaneSensor::drag(), dragFinish(), SoVRMLCylinderSensor::dragStart(), SoVRMLPlaneSensor::dragStart(), and SoVRMLSphereSensor::dragStart().

⭐ const SbMatrix & SoVRMLDragSensor::getLocalToWorldMatrix (void ) const [protected]

returns the matrix that transforms to the world coordinate system. glowy ✨

  • Referenced by SoVRMLCylinderSensor::drag(), SoVRMLPlaneSensor::drag(), SoVRMLSphereSensor::drag(), dragFinish(), and SoVRMLSphereSensor::dragStart().

💜 const SbMatrix & SoVRMLDragSensor::getWorldToLocalMatrix (void ) const [protected]

returns the matrix that transforms from the world coordinate system. the reverse trip, we love symmetry 💫

  • Referenced by SoVRMLSphereSensor::drag(), and dragFinish().

🍓 const SbViewVolume & SoVRMLDragSensor::getViewVolume (void ) const [protected]

returns the current view volume. literally just that 🎀

  • Referenced by SoVRMLCylinderSensor::drag(), SoVRMLPlaneSensor::drag(), SoVRMLSphereSensor::drag(), dragFinish(), and SoVRMLSphereSensor::dragStart().

🎀 const SbVec2f & SoVRMLDragSensor::getNormalizedLocaterPosition (void ) const [protected]

returns the current normalized pointer position. where's the cursor at? this function knows 🖱️👑

  • Referenced by SoVRMLCylinderSensor::drag(), SoVRMLPlaneSensor::drag(), SoVRMLSphereSensor::drag(), and dragFinish().

🌟 Member Data Documentation 🌟

the fields, the moment, the data 💅

💫 SoSFVec3f SoVRMLDragSensor::trackPoint_changed

an event out that is generated when the trackpoint is changed. it's giving notification ✨

  • Referenced by SoVRMLDragSensor().

🔥 SoSFBool SoVRMLDragSensor::autoOffset

when TRUE, the offset field is updated when a dragging sequence is finished. default value is TRUE. iconic default behavior, we love to see it 👑

  • Referenced by SoVRMLCylinderSensor::dragFinish(), SoVRMLPlaneSensor::dragFinish(), SoVRMLSphereSensor::dragFinish(), and SoVRMLDragSensor().

🦋 Author 🦋

generated automatically by Doxygen for Coin from the source code. so like, not a human author, a robot one. still ate tho 🤖💖

and that's the whole page bestie!! this was SoVRMLDragSensor(3) from Coin, Version 2.5.0 🌸 thanks for reading all the way through, you're literally the best 🫶✨ periodt.

📦 where this page comes from