SoVRMLVisibilitySensor(3)

📦 version 2.5.0, in fedora 43, fedora 44

✨ SoVRMLVisibilitySensor ✨

okay bestie, welcome to the SoVRMLVisibilitySensor(3) page, aka the thing that spawns events based on whether stuff is visible or not. it's giving "am i being perceived right now" energy, and honestly? relatable 💅

🌸 NAME 🌸

SoVRMLVisibilitySensor — bestie, this class literally generates events based on visibility. that's the whole vibe. it watches. it reports. it slays. 👑

✨ SYNOPSIS ✨

first things first, you gotta pull in the header like so:

#include <Inventor/VRMLnodes/SoVRMLVisibilitySensor.h>

and guess what? it Inherits SoNode. so everything SoNode can do, it can do too. nepotism but make it C++ 🫶

💖 Public Member Functions 💖

the main character methods, periodt:

virtual SoType getTypeId (void) const — hands you the type id. you want the tea on what type this is? this is it.
SoVRMLVisibilitySensor (void) — the constructor, aka the birth of a legend. no args, just vibes.
virtual void GLRender (SoGLRenderAction *action) — does the GL render thing with that action. iconic behaviour.

🌈 Public Member Functions inherited from SoNode 🌈

all the stuff it got from its parent, no cap:

void setOverride (const SbBool state) — flips the override state on or off.
SbBool isOverride (void) const — are we overriding rn? returns the answer.
void setNodeType (const NodeType type) — sets the node type.
NodeType getNodeType (void) const — grabs the node type back.
virtual SoNode * copy (SbBool copyconnections=0) const — makes a copy. note the default copyconnections=0, bestie.
virtual SbBool affectsState (void) const — does it mess with state? asks the question.
virtual void doAction (SoAction *action) — performs the action.
virtual void GLRenderBelowPath (SoGLRenderAction *action) — GL render, below-path edition.
virtual void GLRenderInPath (SoGLRenderAction *action) — GL render, in-path edition.
virtual void GLRenderOffPath (SoGLRenderAction *action) — GL render, off-path edition.
virtual void callback (SoCallbackAction *action) — does the callback thing.
virtual void getBoundingBox (SoGetBoundingBoxAction *action) — grabs the bounding box.
virtual void getMatrix (SoGetMatrixAction *action) — grabs the matrix.
virtual void handleEvent (SoHandleEventAction *action) — handles the event, obviously.
virtual void pick (SoPickAction *action) — does picking.
virtual void rayPick (SoRayPickAction *action) — ray picking, fancy.
virtual void search (SoSearchAction *action) — searches.
virtual void write (SoWriteAction *action) — writes.
virtual void audioRender (SoAudioRenderAction *action) — renders audio.
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — counts primitives.
virtual void grabEventsSetup (void) — sets up event grabbing.
virtual void grabEventsCleanup (void) — cleans up event grabbing.
virtual void startNotify (void) — kicks off notification.
virtual void notify (SoNotList *l) — notifies with that list.
uint32_t getNodeId (void) const — returns the node id.
virtual SoChildList * getChildren (void) const — hands you the children list.
virtual void writeInstance (SoOutput *out) — writes the instance out.
virtual SoNode * addToCopyDict (void) const — adds itself to the copy dict.
virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections) — copies contents from that container.
virtual SoFieldContainer * copyThroughConnection (void) const — copy-through-connection, as one does.

🦋 Public Member Functions inherited from SoFieldContainer 🦋

the field-container side of the family tree:

void setToDefaults (void) — resets everything to defaults.
SbBool hasDefaultValues (void) const — checks if it's all defaults.
SbBool fieldsAreEqual (const SoFieldContainer *container) const — are the fields equal to that container's? returns yes or no.
void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0) — copies field values over. default copyconnections=0, don't forget.
SbBool set (const char *const fielddata) — sets from field data string.
void get (SbString &fielddata) — gets field data into that string.
virtual int getFields (SoFieldList &l) const — fills the list with fields, returns a count.
virtual int getAllFields (SoFieldList &l) const — same but ALL the fields.
virtual SoField * getField (const SbName &name) const — gets a field by name.
virtual SoField * getEventIn (const SbName &name) const — gets an event-in by name.
virtual SoField * getEventOut (const SbName &name) const — gets an event-out by name.
SbBool getFieldName (const SoField *const field, SbName &name) const — gets the name of a given field.
SbBool enableNotify (const SbBool flag) — turns notification on or off.
SbBool isNotifyEnabled (void) const — is notification enabled? asks.
SbBool set (const char *fielddata, SoInput *in) — sets with a SoInput.
void get (SbString &fielddata, SoOutput *out) — gets with a SoOutput.
virtual SbBool validateNewFieldValue (SoField *field, void *newval) — validates a new field value.
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0) — adds a write reference. default isfromfield=0.
SbBool getIsBuiltIn (void) const — is it built-in?
void setUserData (void *userdata) const — stashes some user data.
void * getUserData (void) const — grabs the user data back.

🎀 Public Member Functions inherited from SoBase 🎀

the O.G. base class behaviour:

void ref (void) const — bumps the ref count.
void unref (void) const — drops the ref count.
void unrefNoDelete (void) const — unrefs without deleting.
int32_t getRefCount (void) const — tells you the ref count.
void touch (void) — touches it, triggering notifies.
SbBool isOfType (SoType type) const — is it of that type?
virtual SbName getName (void) const — gets the name.
virtual void setName (const SbName &newname) — sets a new name.
void addAuditor (void *const auditor, const SoNotRec::Type type) — adds an auditor.
void removeAuditor (void *const auditor, const SoNotRec::Type type) — removes an auditor.
const SoAuditorList & getAuditors (void) const — hands you the auditor list.
SbBool shouldWrite (void) — should it write? returns the verdict.
void assertAlive (void) const — asserts it's alive, dramatic but necessary.

⭐ Static Public Member Functions ⭐

the ones you call without an instance, periodt:

static SoType getClassTypeId (void) — class type id, static style.
static void initClass (void) — initialises the class.

💜 Static Public Member Functions inherited from SoNode 💜

static uint32_t getCompatibilityTypes (const SoType &nodetype) — gets compatibility types for that node type.
static SoType getClassTypeId (void) — the class type id.
static SoNode * getByName (const SbName &name) — finds a node by name.
static int getByName (const SbName &name, SoNodeList &l) — finds nodes by name, fills the list, returns a count.
static void initClass (void) — init the class.
static void initClasses (void) — init ALL the classes.
static uint32_t getNextNodeId (void) — gets the next node id.
static int getActionMethodIndex (const SoType type) — gets the action method index for that type.
static void getBoundingBoxS (SoAction *action, SoNode *node) — the static bounding-box helper.
static void GLRenderS (SoAction *action, SoNode *node) — static GL render helper.
static void callbackS (SoAction *action, SoNode *node) — static callback helper.
static void getMatrixS (SoAction *action, SoNode *node) — static get-matrix helper.
static void handleEventS (SoAction *action, SoNode *node) — static handle-event helper.
static void pickS (SoAction *action, SoNode *node) — static pick helper.
static void rayPickS (SoAction *action, SoNode *node) — static ray-pick helper.
static void searchS (SoAction *action, SoNode *node) — static search helper.
static void writeS (SoAction *action, SoNode *node) — static write helper.
static void audioRenderS (SoAction *action, SoNode *node) — static audio-render helper.
static void getPrimitiveCountS (SoAction *action, SoNode *node) — static primitive-count helper.

🌸 Static Public Member Functions inherited from SoFieldContainer 🌸

static void initClass (void) — init the class.
static SoType getClassTypeId (void) — the class type id.
static void initCopyDict (void) — sets up the copy dictionary.
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — adds a copy to the dict.
static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — checks for a copy.
static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — finds a copy, respecting the copyconnections flag.
static void copyDone (void) — wraps up the copying.

🌈 Static Public Member Functions inherited from SoBase 🌈

static void initClass (void) — init the class.
static SoType getClassTypeId (void) — the class type id.
static void addName (SoBase *const base, const char *const name) — registers a name.
static void removeName (SoBase *const base, const char *const name) — un-registers a name.
static void incrementCurrentWriteCounter (void) — bumps the current write counter.
static void decrementCurrentWriteCounter (void) — drops the current write counter.
static SoBase * getNamedBase (const SbName &name, SoType type) — gets a named base of that type.
static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — gets named bases into the list, returns a count.
static SbBool read (SoInput *in, SoBase *&base, SoType expectedtype) — reads a base.
static void setInstancePrefix (const SbString &c) — sets the instance prefix.
static void setTraceRefs (SbBool trace) — toggles ref tracing.
static SbBool getTraceRefs (void) — is ref tracing on?
static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — connects a route between nodes and fields.
static SbBool readRoute (SoInput *in) — reads a route.

🔥 Public Attributes 🔥

the public fields, the ones out in the open, loud and proud:

SoSFVec3f center — the center, as a SoSFVec3f.
SoSFVec3f size — the size, as a SoSFVec3f.
SoSFBool enabled — the enabled flag, as a SoSFBool.

🧚 Protected Member Functions 🧚

protected, so it's giving "you can peek if you're in the family":

virtual const SoFieldData * getFieldData (void) const — gets the field data pointer.
virtual ~SoVRMLVisibilitySensor () — the destructor. say bye bestie 💀

💅 Protected Member Functions inherited from SoNode 💅

SoNode (void) — the SoNode constructor.
virtual ~SoNode () — the SoNode destructor.
virtual SbBool readInstance (SoInput *in, unsigned short flags) — reads an instance with those flags.

🍓 Protected Member Functions inherited from SoFieldContainer 🍓

SoFieldContainer (void) — the constructor.
~SoFieldContainer () — the destructor.

🫶 Protected Member Functions inherited from SoBase 🫶

SoBase (void) — the constructor.
virtual ~SoBase () — the destructor.
virtual void destroy (void) — destroys it.
SbBool hasMultipleWriteRefs (void) const — has multiple write refs?
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes a header with those flags.
void writeFooter (SoOutput *out) const — writes the footer.
virtual const char * getFileFormatName (void) const — gets the file format name.

⭐ Static Protected Member Functions ⭐

static const SoFieldData ** getFieldDataPtr (void) — gets the field data pointer-pointer. yes, double pointer, we love a lil indirection 💫

🌈 Static Protected Member Functions inherited from SoNode 🌈

static const SoFieldData ** getFieldDataPtr (void) — the field data pointer-pointer again.
static void setNextActionMethodIndex (int index) — sets the next action method index.
static int getNextActionMethodIndex (void) — gets the next action method index.
static void incNextActionMethodIndex (void) — increments the next action method index.
static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets compatibility types for a node type with a bitmask.

💜 Static Protected Member Functions inherited from SoBase 💜

static uint32_t getCurrentWriteCounter (void) — gets the current write counter.
static void staticDataLock (void) — locks the static data.
static void staticDataUnlock (void) — unlocks the static data.

🎀 Protected Attributes 🎀

SoSFTime enterTime — the enter time, as a SoSFTime.
SoSFTime exitTime — the exit time, as a SoSFTime.
SoSFBool isActive — the is-active flag, as a SoSFBool.

💖 Protected Attributes inherited from SoNode 💖

uint32_t uniqueId — the unique id, natch.

🦋 Protected Attributes inherited from SoFieldContainer 🦋

SbBool isBuiltIn — whether it's built-in.

🌟 Additional Inherited Members 🌟

✨ Public Types inherited from SoNode ✨

the NodeType enum, all 16 flavours, no cap:

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 🌈

the BaseFlags enum:

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

⭐ Static Protected Attributes inherited from SoNode ⭐

static uint32_t nextUniqueId = 0 — the next unique id, starting at 0.
static int nextActionMethodIndex = 0 — the next action method index, starting at 0.

bestie we are SO not done, there's more coming in part 2 💖 don't close the tab, the rest of the lore drops next 🫶✨

✨ Detailed Description ✨

okay so SoVRMLVisibilitySensor is literally the visibility vibe-checker of Coin. It generates events based on visibility. 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:

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

The VisibilitySensor node detects visibility changes of a rectangular box as the user navigates the world. VisibilitySensor is typically used to detect when the user can see a specific object or region in the scene in order to activate or deactivate some behaviour or animation. The purpose is often to attract the attention of the user or to improve performance.

The enabled field enables and disables the VisibilitySensor node. If enabled is set to FALSE, the VisibilitySensor node does not send events. If enabled is TRUE, the VisibilitySensor node detects changes to the visibility status of the box specified and sends events through the isActive eventOut. A TRUE event is output to isActive when any portion of the box impacts the rendered view. A FALSE event is sent when the box has no effect on the view. Browsers shall guarantee that, if isActive is FALSE, the box has absolutely no effect on the rendered view. Browsers may err liberally when isActive is TRUE. For example, the box may affect the rendering.

The exposed fields center and size specify the object space location of the box centre and the extents of the box (i.e., width, height, and depth). The VisibilitySensor node's box is affected by hierarchical transformations of its parents. The components of the size field shall be greater than or equal to zero.

The enterTime event is generated whenever the isActive TRUE event is generated, and exitTime events are generated whenever isActive FALSE events are generated. A VisibilitySensor read from a VRML file shall generate isActive TRUE and enterTime events if the sensor is enabled and the visibility box is visible. A VisibilitySensor inserted into the transformation hierarchy shall generate isActive TRUE and enterTime events if the sensor is enabled and the visibility box is visible. A VisibilitySensor removed from the transformation hierarchy shall generate isActive FALSE and exitTime events if the sensor is enabled and the visibility box is visible.

Each VisibilitySensor node behaves independently of all other VisibilitySensor nodes. Every enabled VisibilitySensor node that is affected by the user's movement receives and sends events, possibly resulting in multiple VisibilitySensor nodes receiving and sending events simultaneously. Unlike TouchSensor nodes, there is no notion of a VisibilitySensor node lower in the scene graph "grabbing" events. Multiply instanced VisibilitySensor nodes (i.e., DEF/USE) use the union of all the boxes defined by their instances. An instanced VisibilitySensor node shall detect visibility changes for all instances of the box and send events appropriately.

💅 Constructor & Destructor Documentation 💅

`SoVRMLVisibilitySensor::SoVRMLVisibilitySensor (void )`

Constructor.

References center, enabled, enterTime, exitTime, isActive, size, and SoVRMLVisibilitySensor().

Referenced by getFieldData(), and SoVRMLVisibilitySensor().

`SoVRMLVisibilitySensor::~SoVRMLVisibilitySensor ()` — [protected], [virtual]

Destructor.

🦋 Member Function Documentation 🦋

`SoType SoVRMLVisibilitySensor::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 * SoVRMLVisibilitySensor::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 SoVRMLVisibilitySensor().

`void SoVRMLVisibilitySensor::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 center, enterTime, exitTime, SoAction::getState(), isActive, and size.