SoVRMLCollision(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoVRMLCollision(3) 💖

okay so bestie, let's talk about SoVRMLCollision — it's literally the class that does collision detection with the avatar. no cap. 👑

🌸 NAME 🌸

The SoVRMLCollision class is used for collision detection with the avatar. periodt. 💅

✨ SYNOPSIS ✨

#include <Inventor/VRMLnodes/SoVRMLCollision.h>

Inherits SoVRMLGroup.

🫶 Public Member Functions

  • virtual SoType getTypeId (void) const
  • SoVRMLCollision (void)
  • SoVRMLCollision (int numchildren)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void notify (SoNotList *list)

💅 Public Member Functions inherited from SoVRMLGroup

  • SoVRMLGroup (void)
  • SoVRMLGroup (int numChildren)
  • virtual void doAction (SoAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual void write (SoWriteAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)
  • virtual void GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *action)

🦋 Public Member Functions inherited from SoVRMLParent

  • virtual SbBool affectsState (void) const
  • virtual void addChild (SoNode *child)
  • virtual void insertChild (SoNode *child, int idx)
  • virtual SoNode * getChild (int idx) const
  • virtual int findChild (const SoNode *child) const
  • virtual int getNumChildren (void) const
  • virtual void removeChild (int idx)
  • virtual void removeChild (SoNode *child)
  • virtual void removeAllChildren (void)
  • virtual void replaceChild (int idx, SoNode *child)
  • virtual void replaceChild (SoNode *old, SoNode *child)
  • virtual SoChildList * getChildren (void) const

🌈 Public Member Functions inherited from SoGroup

  • SoGroup (void)
  • SoGroup (int nchildren)
  • virtual void handleEvent (SoHandleEventAction *action)
  • virtual void pick (SoPickAction *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 grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • uint32_t getNodeId (void) const
  • virtual void writeInstance (SoOutput *out)
  • virtual SoNode * addToCopyDict (void) const
  • 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 SoVRMLGroup

  • static SoType getClassTypeId (void)
  • static void initClass (void)
  • static void setNumRenderCaches (int num)
  • static int getNumRenderCaches (void)

🎀 Static Public Member Functions inherited from SoVRMLParent

  • static SoType getClassTypeId (void)
  • static void initClass (void)
  • static void updateChildList (const SoNode *const *nodes, const int numnodes, SoChildList &cl)
  • static void updateChildList (SoNode *nodewithsfnode, SoChildList &cl)

🌸 Static Public Member Functions inherited from SoGroup

  • 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

  • SoSFBool collide
  • SoSFNode proxy
  • SoSFTime collideTime

🔥 Public Attributes inherited from SoVRMLGroup

  • SoSFEnum renderCaching
  • SoSFEnum boundingBoxCaching
  • SoSFEnum renderCulling
  • SoSFEnum pickCulling
  • SoSFVec3f bboxCenter
  • SoSFVec3f bboxSize

💧 Public Attributes inherited from SoVRMLParent

  • SoMFNode children

🛡️ Protected Member Functions

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoVRMLCollision ()

🌙 Protected Member Functions inherited from SoVRMLGroup

  • virtual ~SoVRMLGroup ()
  • virtual SbBool cullTest (SoState *state)

☁️ Protected Member Functions inherited from SoVRMLParent

  • SoVRMLParent (void)
  • SoVRMLParent (int approxchildren)
  • virtual ~SoVRMLParent ()
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyConn)

🪐 Protected Member Functions inherited from SoGroup

  • virtual ~SoGroup ()
  • virtual SbBool readChildren (SoInput *in)

🌱 Protected Member Functions inherited from SoNode

  • SoNode (void)
  • virtual ~SoNode ()

🫧 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 SoVRMLGroup

  • static const SoFieldData ** getFieldDataPtr (void)

🌺 Static Protected Member Functions inherited from SoVRMLParent

  • static const SoFieldData ** getFieldDataPtr (void)

🌼 Static Protected Member Functions inherited from SoGroup

  • 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 SoVRMLGroup

enum CacheEnabled { OFF, ON, AUTO }

💎 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 SoVRMLParent

  • SoMFNode addChildren
  • SoMFNode removeChildren

🍭 Protected Attributes inherited from SoGroup

  • SoChildList * children

and that's only part 1, bestie — part 2 is coming so don't go anywhere 💅✨

🛡️ Protected Attributes inherited from SoNode

  • uint32_t uniqueId

🛡️ Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

✨ Static Protected Attributes inherited from SoVRMLGroup

  • static int numRenderCaches = 2

✨ Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 0
  • static int nextActionMethodIndex = 0

✨ Detailed Description ✨

So like, the SoVRMLCollision class is literally used for collision detection with the avatar. 💅

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:

Collision {
  eventIn      MFNode   addChildren
  eventIn      MFNode   removeChildren
  exposedField MFNode   children        []
  exposedField SFBool   collide         TRUE
  field        SFVec3f  bboxCenter      0 0 0      # (-,)
  field        SFVec3f  bboxSize        -1 -1 -1   # (0,) or -1,-1,-1
  field        SFNode   proxy           NULL
  eventOut     SFTime   collideTime
}

Okay so the Collision node is a grouping node. It sets up collision detection properties for its children and their descendants, defines surrogate objects that swap in for its children during collision detection, and sends events saying “hey, a collision happened” between the avatar and the Collision node's geometry or surrogate. By default, every geometric node in the scene is collidable with the viewer — except IndexedLineSet, PointSet, and Text. Browsers shall detect geometric collisions between the avatar (peep SoVRMLNavigationInfo) and the scene's geometry, and prevent the avatar from 'entering' the geometry. For general collision detection tea, see 4.13.4, Collision detection and terrain following (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.13.4). 🫶

If there are no Collision nodes in a VRML file, browsers shall detect collisions between the avatar and all objects while navigating. No escape. 😭

Subclause 4.6.5, Grouping and children nodes (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.5), has the full description of the children, addChildren, and removeChildren fields and eventIns. Slay. 💅

The Collision node's collide field turns collision detection on and off. If collide is FALSE, the children and all descendants of the Collision node shall not be checked for collision, even though they're still drawn. That includes any descendent Collision nodes with collide set to TRUE — like, setting collide to FALSE turns collision off for every node below it. Periodt. 👑

Collision nodes with collide set to TRUE detect the nearest collision with their descendent geometry (or proxies). When that nearest collision is detected, the collided Collision node sends the collision time through its collideTime eventOut. If a Collision node contains a child, descendant, or proxy (see below) that is also a Collision node, and both Collision nodes detect a collision, both send a collideTime event at the same time. A collideTime event shall be generated if the avatar is colliding with collidable geometry when the Collision node is read from a VRML file or inserted into the transformation hierarchy. Iconic. ✨

The bboxCenter and bboxSize fields specify a bounding box that wraps the Collision node's children. This is a hint that may be used for optimization. The results are undefined if the specified bounding box is smaller than the actual bounding box of the children at any time. A default bboxSize value of (-1, -1, -1) implies the bounding box is not specified, and if needed it shall be calculated by the browser. More details on bboxCenter and bboxSize are in 4.6.4, Bounding boxes. (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.4),

The collision proxy, defined in the proxy field, is any legal children node as described in 4.6.5, Grouping and children nodes, (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.5). It's used as a substitute for the Collision node's children during collision detection. The proxy is used strictly for collision detection; it is not drawn. If collide is TRUE and proxy is non-NULL, the proxy field defines the scene on which collision detection is performed. If proxy is NULL, collision detection is performed against the children of the Collision node. If proxy is specified, any descendent children of the Collision node are ignored during collision detection. If children is empty, collide is TRUE, and proxy is specified, collision detection is performed against the proxy but nothing is displayed. That way, invisible collision objects can be supported. So sneaky. 🙈

The collideTime eventOut generates an event specifying the time when the avatar (peep SoVRMLNavigationInfo) makes contact with the collidable children or proxy of the Collision node. An ideal implementation computes the exact time of collision. Implementations may approximate that ideal by sampling the positions of collidable objects and the user. The SoVRMLNavigationInfo node has extra info for parameters that control the avatar size. 💖

🎀 Constructor & Destructor Documentation 🎀

🏗️ SoVRMLCollision::SoVRMLCollision (void )

Constructor energy. Referenced by getFieldData().

🏗️ SoVRMLCollision::SoVRMLCollision (int numchildren)

Constructor. numchildren is the expected number of children. Got it. 💅

🗑️ SoVRMLCollision::~SoVRMLCollision () [protected], [virtual]

Destructor. bye bestie 👋

✨ Member Function Documentation ✨

SoType SoVRMLCollision::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. iykyk. 💅

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 who wanna extend the library with new nodes, engines, nodekits, draggers or whatever: this method needs to be overridden in all subclasses. This is usually done as part of setting up the full type system for extension classes, which is typically done with the pre-defined macros in e.g. 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 info on writing Coin extensions, check the class documentation of the toplevel superclasses for the various class groups. 💅

Reimplemented from SoVRMLGroup.

const SoFieldData * SoVRMLCollision::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. Simple as. 🫶

Reimplemented from SoVRMLGroup.

References SoVRMLCollision().

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

Action method for the SoGLRenderAction. Main character moment. ✨

This gets called during rendering traversals. Nodes that influence the rendering state in any way, or that wanna throw geometry primitives at OpenGL, override this method.

Reimplemented from SoVRMLGroup.

References SoGLRenderAction::abortNow(), SoNode::affectsState(), SbPList::getArrayPtr(), SoVRMLParent::getChildren(), SoAction::getCurPathCode(), SbPList::getLength(), SoAction::getPathCode(), SoAction::getState(), SoNode::GLRender(), SoAction::hasTerminated(), SoState::pop(), SoAction::popCurPath(), SoAction::popPushCurPath(), SoState::push(), and SoAction::pushCurPath().

void SoVRMLCollision::notify (SoNotList * l) [virtual]

Notifies all auditors for this instance when changes are made. Tell the group chat. 📣

Reimplemented from SoVRMLGroup.

References SoVRMLGroup::notify().

💾 Member Data Documentation 💾

SoSFBool SoVRMLCollision::collide

Enable/disable collision. The switch. 🔛

SoSFNode SoVRMLCollision::proxy

Proxy node(s) used for collision testing. Stand-ins, bestie. 🦋

SoSFTime SoVRMLCollision::collideTime

An eventOut sent for each collision that occurs. Every single one. ⏰

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. Not me writing this by hand, obviously. 💅

Coin, Version 2.5.0, SoVRMLCollision(3) — that's the whole vibe. mwah 💋

📦 where this page comes from