SoVRMLProximitySensor(3)

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

✨ NAME ✨

Bestie, meet SoVRMLProximitySensor — yes, the SoVRMLProximitySensor(3) page you just opened, from the Coin crew. What does it even do? The SoVRMLProximitySensor class is used to generate events when the viewer enters or exits a region. That's it, that's the whole gig. 💖

🦋 SYNOPSIS 🦋

Pull it into your code like the icon you are:

#include <Inventor/VRMLnodes/SoVRMLProximitySensor.h>

And heads up: it Inherits SoNode. So everything SoNode can do, this baby can do too. 👑

Fair warning: the member list is long long. Not me scrolling for an hour. Grab a snack. 🍓

💅 Public Member Functions 💅

  • virtual SoType getTypeId (void) const
  • SoVRMLProximitySensor (void) — the constructor, hi bestie 👋
  • virtual SbBool affectsState (void) const
  • virtual void doAction (SoAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)

🌸 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 void GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void handleEvent (SoHandleEventAction *action)
  • virtual void pick (SoPickAction *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)
  • 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. Basically a vibe check on the class hierarchy 💅
  • 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. The classic "get everything ready" 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.
  • 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.
  • 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 🎀

These are the actual data slots, and ngl they're the main character energy of this whole node:

  • SoSFVec3f center
  • SoSFVec3f size
  • SoSFBool enabled
  • SoSFBool isActive
  • SoSFVec3f position_changed
  • SoSFRotation orientation_changed
  • SoSFTime enterTime
  • SoSFTime exitTime

🔥 Protected Member Functions 🔥

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoVRMLProximitySensor ()
  • virtual void notify (SoNotList *list)

🌸 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 💜

The big enum of node-type bitmask flags. Look at all these badges:

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 }

🌈 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
And that's part 1, bestie — the reference list keeps going, so don't you dare close the tab. 💅

✨ Detailed Description ✨

okay so the SoVRMLProximitySensor class is used to generate events when the viewer enters or exits a region. It's giving boundary-check energy. 💅

The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium:

ProximitySensor {
  exposedField SFVec3f    center      0 0 0    # (-,)
  exposedField SFVec3f    size        0 0 0    # [0,)
  exposedField SFBool     enabled     TRUE
  eventOut     SFBool     isActive
  eventOut     SFVec3f    position_changed
  eventOut     SFRotation orientation_changed
  eventOut     SFTime     enterTime
  eventOut     SFTime     exitTime
}

The ProximitySensor node generates events when the viewer enters, exits, and moves within a region in space (defined by a box). So it's like a little spy for your movements. 👀

A proximity sensor is enabled or disabled by sending it an enabled event with a value of TRUE or FALSE. A disabled sensor does not send events. Nope, not a single one. 🙅‍♀️

A ProximitySensor node generates isActive TRUE/FALSE events as the viewer enters and exits the rectangular box defined by its center and size fields. Browsers shall interpolate viewer positions and timestamp the isActive events with the exact time the viewer first intersected the proximity region. So precise, bestie. ⏱️

The center field defines the centre point of the proximity region in object space. The size field specifies a vector which defines the width (x), height (y), and depth (z) of the box bounding the region. The components of the size field shall be greater than or equal to zero. ProximitySensor nodes are affected by the hierarchical transformations of their parents. Family tree matters, bestie. 🌳

The enterTime event is generated whenever the isActive TRUE event is generated (user enters the box), and exitTime events are generated whenever an isActive FALSE event is generated (user exits the box). So it's like a little timestamp diary. 📅

The position_changed and orientation_changed eventOuts send events whenever the user is contained within the proximity region and the position and orientation of the viewer changes with respect to the ProximitySensor node's coordinate system including enter and exit times. So it's tracking every little move. 👀

The viewer movement may be a result of a variety of circumstances resulting from browser navigation, ProximitySensor node's coordinate system changes, or bound Viewpoint node's position or orientation changes. So many reasons to move, bestie. 💃

Each ProximitySensor node behaves independently of all other ProximitySensor nodes. Every enabled ProximitySensor node that is affected by the viewer's movement receives and sends events, possibly resulting in multiple ProximitySensor nodes receiving and sending events simultaneously. Unlike TouchSensor nodes, there is no notion of a ProximitySensor node lower in the scene graph "grabbing" events. No event stealing here. 🙅‍♀️

Instanced (DEF/USE) ProximitySensor nodes use the union of all the boxes to check for enter and exit. A multiply instanced ProximitySensor node will detect enter and exit for all instances of the box and send enter/exit events appropriately. However, the results are undefined if the any of the boxes of a multiply instanced ProximitySensor node overlap.

🚨 undefined behavior alert! So don't overlap, bestie. 🚫

A ProximitySensor node that surrounds the entire world has an enterTime equal to the time that the world was entered and can be used to start up animations or behaviours as soon as a world is loaded. Main character energy for your animations. 🌍✨

A ProximitySensor node with a box containing zero volume (i.e., any size field element of 0.0) cannot generate events. This is equivalent to setting the enabled field to FALSE. So zero volume = zero events. Math is math. 💀

A ProximitySensor read from a VRML file shall generate isActive TRUE, position_changed, orientation_changed and enterTime events if the sensor is enabled and the viewer is inside the proximity region. So if you're inside and it's on, it's sending. 📤

A ProximitySensor inserted into the transformation hierarchy shall generate isActive TRUE, position_changed, orientation_changed and enterTime events if the sensor is enabled and the viewer is inside the proximity region. Same energy. 📥

A ProximitySensor removed from the transformation hierarchy shall generate isActive FALSE, position_changed, orientation_changed and exitTime events if the sensor is enabled and the viewer is inside the proximity region. So it says bye with events. 👋

🛠️ Constructor & Destructor Documentation 🛠️

SoVRMLProximitySensor::SoVRMLProximitySensor (void )

Constructor. Yep, it constructs. Iconic. ✨

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

Destructor. It's protected and virtual, so handle with care. 💅

🧠 Member Function Documentation 🧠

SoType SoVRMLProximitySensor::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class. So type-identification realness. 🔍

SoType SoVRMLProximitySensor::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. Implements SoBase. Downward casting? We love a dramatic reveal. 🎭

const SoFieldData ** SoVRMLProximitySensor::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. So lowkey internal, bestie. 🤫

const SoFieldData * SoVRMLProximitySensor::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. Reimplemented from SoFieldContainer. So if there's no fields, it's NULL. Periodt. 🚫

void SoVRMLProximitySensor::initClass (void ) [static]

No description given in the original manpage, bestie. It's just a static method doing its thing. 🛠️

SbBool SoVRMLProximitySensor::affectsState (void ) const [virtual]

Returns TRUE if the node could have any effect on the state during traversal. If it returns FALSE, no data in the traversal state will change from the pre-traversal state to the post-traversal state. The SoSeparator node will for instance return FALSE, as it pushes and pops the state before and after traversal of its children. All SoShape nodes will also return FALSE, as just pushing out geometry data to the rendering engine won't affect the actual rendering state. The default method returns TRUE, on a "better safe than sorry" philosophy. Reimplemented from SoNode. So it's giving cautious energy. 🛡️

void SoVRMLProximitySensor::doAction (SoAction * action) [virtual]

This function performs the typical operation of a node for any action. Reimplemented from SoNode. So it does the action thing. 🎬

void SoVRMLProximitySensor::GLRender (SoGLRenderAction * action) [virtual]

Action method for the SoGLRenderAction. This is called during rendering traversals. Nodes influencing the rendering state in any way or want to throw geometry primitives at OpenGL override this method. Reimplemented from SoNode. Throwing geometry at OpenGL? Slay. 🎨

void SoVRMLProximitySensor::callback (SoCallbackAction * action) [virtual]

Action method for SoCallbackAction. Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph. Reimplemented from SoNode. So callback realness. 📞

void SoVRMLProximitySensor::rayPick (SoRayPickAction * action) [virtual]

Action method for SoRayPickAction. Checks the ray specification of the action and tests for intersection with the data of the node. Nodes influencing relevant state variables for how picking is done also override this method. Reimplemented from SoNode. Ray picking? It's giving laser focus. 🔦

void SoVRMLProximitySensor::getBoundingBox (SoGetBoundingBoxAction * action) [virtual]

Action method for the SoGetBoundingBoxAction. Calculates bounding box and center coordinates for node and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node. Nodes influencing how geometry nodes calculate their bounding box also override this method to change the relevant state variables. Reimplemented from SoNode. Bounding box? More like boundaries, bestie. 📦

void SoVRMLProximitySensor::notify (SoNotList * l) [protected], [virtual]

Notifies all auditors for this instance when changes are made. Reimplemented from SoNode. So it tells everyone when things change. Gossip girl energy. 📢

📦 Member Data Documentation 📦

SoSFVec3f SoVRMLProximitySensor::center

The center of the region. Default value is (0,0,0). So centered, bestie. 🎯

SoSFVec3f SoVRMLProximitySensor::size

The region size. Default value is (0, 0, 0). So no size by default. Interesting. 📏

SoSFBool SoVRMLProximitySensor::enabled

Enable/disable sensor. Default value is TRUE. So it's on by default. Slay. ✅

SoSFBool SoVRMLProximitySensor::isActive

An eventOut that is sent every time the sensor changes state. So state changes = events. 🔄

SoSFVec3f SoVRMLProximitySensor::position_changed

An eventOut that is sent when the viewer is inside the region and the viewer position or orientation is changed. So position updates. 📍

SoSFRotation SoVRMLProximitySensor::orientation_changed

An eventOut that is sent when the viewer is inside the region and the viewer position or orientation is changed. So orientation updates too. 🔄

SoSFTime SoVRMLProximitySensor::enterTime

An eventOut that is sent when the viewer enters the region. So entry timestamp. ⏰

SoSFTime SoVRMLProximitySensor::exitTime

An eventOut that is sent when the viewer exits the region. So exit timestamp. ⏰

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. So it's a bot, but make it fashion. 🤖✨

peace out, besties 💖 this page was generated by Doxygen for Coin from the source code, version 4.0.10, dated Thu Jun 25 2026 00:00:00. SoVRMLProximitySensor(3) forever ✨

📦 where this page comes from