SoVRMLDragSensor(3)

📦 version 3.1.3, in fedora 43, fedora 44

🎀 SoVRMLDragSensor 🎀 — Library Functions Manual, section 3

okay so bestie, listen. this is SoVRMLDragSensor, and it lives in the Library Functions Manual. she's an abstract queen, she's a superclass, and honestly? she's the blueprint. let's get into it 💅

✨ NAME ✨

SoVRMLDragSensor — the class that is a superclass for VRML drag sensors. that's it. that's the whole name section. she's a parent, she's got kids, we'll meet them in a sec 🫶

🦋 SYNOPSIS 🦋

#include <Inventor/VRMLnodes/SoVRMLDragSensor.h>

Inherits SoVRMLSensor.

Inherited by SoVRMLCylinderSensor, SoVRMLPlaneSensor, and SoVRMLSphereSensor.

so yeah, the family tree is giving lineage 🌳✨

👑 Public Member Functions

her very own public methods, look at her go:

virtual SoType getTypeId (void) const
virtual void handleEvent (SoHandleEventAction *action)

💜 Public Member Functions inherited from SoNode

everything she got from SoNode, no cap:

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 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=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)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
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

the static girlypops she calls her own:

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

her own two fields, iconic honestly:

SoSFVec3f trackPoint_changed
SoSFBool autoOffset

💜 Public Attributes inherited from SoVRMLSensor

SoSFBool isActive
SoSFBool enabled

🧚 Protected Member Functions

protected = the inner circle, bestie 🔒✨

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

⭐ 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

the bonus lore, the extra crumbs she picked up along the way:

Public Types inherited from SoNode — the enum that ate:

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 }

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 = 1
static int nextActionMethodIndex = 0

💅 Detailed Description 💅

so, the tea: the SoVRMLDragSensor class is a superclass for VRML drag sensors. that's the assignment. that's her whole job.

she collects the two fields that are common for some of the sensor nodes, plus some common functions for those same nodes. she's the shared-mom-friend of the sensor world, holding everybody's stuff so nobody has to duplicate it. we love a communal resource 🫶

⚠️ now listen closely bestie, this part matters: since this is an abstract "helper" class, it does not represent an actual node from the VRML97 specification, so don't use it as such. like. do not. she's scaffolding, not the building. respect the boundary 🙈

and if you want the full deep dive? a detailed discussion of drag sensors is available 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. yep. she exists now. welcome to the world little one 🎀

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

Destructor. and now she's gone. virtual, so her children get to say their goodbyes properly. 😭✨

okay bestie that's the whole vibe so far — and there's still more coming, so don't go anywhere 💖

💖 MEMBER FUNCTION DOCUMENTATION 💖

okay bestie, this is the part where we meet the actual functions. grab a snack, there's a bunch of them, but they're all lowkey adorable once you get to know them. 🫶

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

so this one hands you back 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, that's how you peek at a generic pointer and go "oh wait, you're actually a SoFile, bestie". 💅

Usage example, look how cute this is:

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

now for the app programmers out there who wanna extend the library with brand-new nodes, engines, nodekits, draggers or whatever else — this method has to be overridden in all subclasses. no skipping, periodt. that's normally done as part of setting up the full type system for extension classes, and it's usually accomplished by using the pre-defined macros you can get 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. 🌈

want more tea on writing Coin extensions? go check 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]

gives you back 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 SoVRMLSensor.
  • Reimplemented in SoVRMLCylinderSensor, SoVRMLPlaneSensor, and SoVRMLSphereSensor.

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

the action method for SoHandleEventAction, bestie. it inspects the event data coming from action, and processes it if it's something this node should actually react to. 👑

heads up: nodes that influence relevant state variables for how event handling goes down also override this method. so if you're messing with that state, you know what to do.

  • Reimplemented from SoNode.

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

okay so this API member is considered internal to the library — it's not likely to be of any interest to the application programmer, so don't stress about it. 🙈

it gets called when the dragger is selected (picked) by the user. 👆

  • Implemented in SoVRMLCylinderSensor, SoVRMLPlaneSensor, and SoVRMLSphereSensor.

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

another one of those internal-to-the-library API members, not likely to be of interest to the application programmer. mind your business, it's fine. 💀

this one gets called when the user drags the mouse after picking the dragger. 🖱️

  • Implemented in SoVRMLCylinderSensor, SoVRMLPlaneSensor, and SoVRMLSphereSensor.

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

yep, internal to the library again, not likely to be of interest to the application programmer. the trio really said "we're mysterious". 🧚

it fires when the mouse button is released after picking and interacting with the dragger. ✋

  • Implemented in SoVRMLCylinderSensor, SoVRMLPlaneSensor, and SoVRMLSphereSensor.

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

returns the interaction starting point. short, sweet, iconic. ⭐

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

returns the matrix that transforms to the world coordinate system. 🌍

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

returns the matrix that transforms from the world coordinate system. yes it's the other direction, no they're not the same thing, don't @ me. 🌍

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

returns the current view volume. very "you are here, in 3D space" of it. 🔥

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

returns the current normalized pointer position. so you always know where the cursor's at. 👀

🎀 MEMBER DATA DOCUMENTATION 🎀

the fields, the icons, the main characters of this class:

  • SoSFVec3f SoVRMLDragSensor::trackPoint_changed — an event out that is generated when the trackpoint is changed. 💫
  • SoSFBool SoVRMLDragSensor::autoOffset — when TRUE, the offset field is updated when a dragging sequence is finished. default value is TRUE. ✨

👑 AUTHOR

generated automatically by Doxygen for Coin from the source code. so yeah, a robot wrote this, and honestly? it ate. 💅

that's the whole page bestie!! this was Coin Version 3.1.3, from the SoVRMLDragSensor(3) era, and you absolutely understood all of it. slay, go forth and drag your sensors. 🌸💖🦋

📦 where this page comes from