SoVRMLProximitySensor(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoVRMLProximitySensor — the manual page, but make it cute 💖

okay bestie, welcome to SoVRMLProximitySensor(3) from the Library Functions Manual ✨. Buckle up, this one's a whole vibe.

🌸 NAME 🌸

SoVRMLProximitySensor — it's the class that's literally built to generate events when the viewer walks into or dips out of a region. Like a little doorbell for 3D space. Ding dong, bestie arrived 🛎️

✨ SYNOPSIS ✨

First things first, you gotta include it:

#include <Inventor/VRMLnodes/SoVRMLProximitySensor.h>

And guess what — it inherits SoNode. Family tree matters, iykyk 👑

🫶 Public Member Functions 🫶

virtual SoType getTypeId (void) const
SoVRMLProximitySensor (void)
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=0) 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)
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 `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 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)
~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 `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

okay pookie that's the whole SYNOPSIS portion wrapped up with a little bow 🎀 — part 2 is coming next, don't go anywhere 💅✨

✨ Detailed Description ✨

Okay bestie, so the SoVRMLProximitySensor class? It's literally here to generate events when the viewer enters or exits a region. No cap.

The tea is that this detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It's copyright The Web3D Consortium, and 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
}

So the ProximitySensor node generates events when the viewer enters, exits, and moves within a region in space (defined by a box).

You enable or disable a proximity sensor by sending it an enabled event with a value of TRUE or FALSE. A disabled sensor? It does not send events. Periodt.

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. Fr fr.

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. And yes, ProximitySensor nodes are affected by the hierarchical transformations of their parents. 💅

The <orange>enterTime</orange> event is generated whenever the isActive TRUE event is generated (user enters the box), and <orange>exitTime</orange> events are generated whenever an isActive FALSE event is generated (user exits the box).

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.

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.

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.

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. So don't do that, bestie. 🚫

A ProximitySensor node that surrounds the entire world has an <orange>enterTime</orange> 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. Iconic.

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.

A ProximitySensor read from a VRML file shall generate isActive TRUE, position_changed, orientation_changed and <orange>enterTime</orange> events if the sensor is enabled and the viewer is inside the proximity region.

A ProximitySensor inserted into the transformation hierarchy shall generate isActive TRUE, position_changed, orientation_changed and <orange>enterTime</orange> events if the sensor is enabled and the viewer is inside the proximity region.

A ProximitySensor removed from the transformation hierarchy shall generate isActive FALSE, position_changed, orientation_changed and <orange>exitTime</orange> events if the sensor is enabled and the viewer is inside the proximity region.

🛠️ Constructor & Destructor Documentation 🛠️

`SoVRMLProximitySensor::SoVRMLProximitySensor (void )`

Constructor. It's the glow-up moment. ✨

References center, enabled, <orange>enterTime</orange>, <orange>exitTime</orange>, isActive, orientation_changed, position_changed, size, and SoVRMLProximitySensor().

Referenced by getFieldData(), and SoVRMLProximitySensor().

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

Destructor. She's done. 💅

📚 Member Function Documentation 📚

`SoType SoVRMLProximitySensor::getTypeId (void ) const` [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting.

Usage example:

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

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. 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.

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

Implements SoBase.

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

References SoVRMLProximitySensor().

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

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

This function performs the typical operation of a node for any action.

Reimplemented from SoNode.

References center, enabled, <orange>enterTime</orange>, <orange>exitTime</orange>, SbViewVolume::getProjectionPoint(), SoAction::getState(), SbBox3f::intersect(), SbMatrix::inverse(), SbRotation::inverse(), isActive, SbMatrix::multVecMatrix(), orientation_changed, position_changed, and size.

Referenced by GLRender().

`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 who wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoNode.

References doAction().

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

`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 overrides this method.

Reimplemented from SoNode.

`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 calculates their bounding box also overrides this method to change the relevant state variables.

Reimplemented from SoNode.

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

Notifies all auditors for this instance when changes are made.

Reimplemented from SoNode.

References SoNode::notify().