SoVRMLSensor(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

💖 SoVRMLSensor(3) — abstract sensor superclass energy 💖

okay bestie, this is the manual page for SoVRMLSensor, and no cap, it's a whole mood. it's an abstract superclass for VRML sensors. that's it. that's the tea. 🫶

🌸 NAME 🌸

SoVRMLSensor — the class that is an abstract superclass for VRML sensors. it's giving "parent class", it's giving "i don't do anything myself, my kids handle it". iconic behavior fr. ✨

🎀 SYNOPSIS 🎀

#include <Inventor/VRMLnodes/SoVRMLSensor.h>

Inherits SoNode. so it's a node, obviously, we love a node. 💅

Inherited by SoVRMLDragSensor. the children are out here doing the actual work, periodt.

🦋 Public Member Functions

  • virtual SoType getTypeId (void) const

✨ 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 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 handleEvent (SoHandleEventAction *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)
  • SbUniqueId 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 — returns TRUE if the type of this object is either of the same type or inherited from type. so it's the "are we fam?" check, iykyk. 🫶
  • 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 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. it's the "get ready bestie, we're going live" moment. 💅
  • 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) — 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.
  • 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. yes, again. it's a whole tradition at this point. 🎀
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class.
  • 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

  • SoSFBool isActive
  • SoSFBool enabled

look at them. two little fields. the whole personality of a sensor honestly. 👑

🦋 Protected Member Functions

  • virtual const SoFieldData * getFieldData (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
  • virtual SoNotRec createNotRec (void)

🔥 Static Protected Member Functions

  • 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,
    COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000, COIN_4_0 = 0x20000 }

that's a lot of hex, bestie. a whole buffet of version flags. 🍓

🧚 Protected Types inherited from SoBase

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

🌸 Protected Attributes inherited from SoNode

  • SbUniqueId uniqueId

🌸 Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

🌟 Static Protected Attributes inherited from SoNode

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

💅 Detailed Description 💅

the SoVRMLSensor class is an abstract superclass for VRML sensors. that's the whole description, no notes, no lore, just vibes and inheritance. it's giving "i contain multitudes but i will not elaborate". 😭

👑 Member Function Documentation 👑

SoType SoVRMLSensor::getClassTypeId (void ) [static]

this static method returns the SoType object associated with objects of this class. it's the "who dis" of the type system, fr fr. ✨

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

returns the type identification of an object derived from a class inheriting SoBase. this is used for runtime type checking and "downward" casting. so basically it's the class saying "yes bestie, i'm this one" at runtime. 🔥

Implements SoBase.

Reimplemented in SoVRMLCylinderSensor, SoVRMLDragSensor, SoVRMLPlaneSensor, and SoVRMLSphereSensor. the whole squad is out here reimplementing, we love to see it. 💖

const SoFieldData ** SoVRMLSensor::getFieldDataPtr (void ) [static], [protected]

this API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

returns the SoFieldData class which holds information about fields in this node. lowkey an inside-the-library thing, you probably won't be calling this at brunch. 🙈

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

returns a pointer to the class-wide field data storage object for this instance. if no fields are present, returns NULL. yes, NULL, the classic. 💀

Reimplemented from SoFieldContainer.

Reimplemented in SoVRMLCylinderSensor, SoVRMLDragSensor, SoVRMLPlaneSensor, and SoVRMLSphereSensor.

void SoVRMLSensor::initClass (void ) [static]

(no description given in the original, bestie — it just vibes there with its name and signature. iconic honestly.) 🎀

🌈 Author 🌈

generated automatically by Doxygen for Coin from the source code. so technically the author is a robot and honestly? it ate. 🤖💅

and that's the whole page, bestie!! this was Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00, and the page title was SoVRMLSensor(3). go forth and be abstract, queen. 💖✨👑

📦 where this page comes from