.TH "SoVRMLCollision" 3 "Tue Jun 23 2026 23:48:38" "Version 4.0.10" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoVRMLCollision \- The \fBSoVRMLCollision\fP class is used for collision detection with the avatar\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <Inventor/VRMLnodes/SoVRMLCollision\&.h>\fP
.PP
Inherits \fBSoVRMLGroup\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const"
.br
.ti -1c
.RI "\fBSoVRMLCollision\fP (void)"
.br
.ti -1c
.RI "\fBSoVRMLCollision\fP (int numchildren)"
.br
.ti -1c
.RI "virtual void \fBGLRender\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBnotify\fP (\fBSoNotList\fP *list)"
.br
.in -1c

Public Member Functions inherited from \fBSoVRMLGroup\fP
.in +1c
.ti -1c
.RI "\fBSoVRMLGroup\fP (void)"
.br
.ti -1c
.RI "\fBSoVRMLGroup\fP (int numChildren)"
.br
.ti -1c
.RI "virtual void \fBdoAction\fP (\fBSoAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBcallback\fP (\fBSoCallbackAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBgetBoundingBox\fP (\fBSoGetBoundingBoxAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBgetMatrix\fP (\fBSoGetMatrixAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBrayPick\fP (\fBSoRayPickAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBsearch\fP (\fBSoSearchAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBwrite\fP (\fBSoWriteAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBgetPrimitiveCount\fP (\fBSoGetPrimitiveCountAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBaudioRender\fP (\fBSoAudioRenderAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBGLRenderBelowPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBGLRenderInPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBGLRenderOffPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.in -1c

Public Member Functions inherited from \fBSoVRMLParent\fP
.in +1c
.ti -1c
.RI "virtual SbBool \fBaffectsState\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBaddChild\fP (\fBSoNode\fP *child)"
.br
.ti -1c
.RI "virtual void \fBinsertChild\fP (\fBSoNode\fP *child, int idx)"
.br
.ti -1c
.RI "virtual \fBSoNode\fP * \fBgetChild\fP (int idx) const"
.br
.ti -1c
.RI "virtual int \fBfindChild\fP (const \fBSoNode\fP *child) const"
.br
.ti -1c
.RI "virtual int \fBgetNumChildren\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBremoveChild\fP (int idx)"
.br
.ti -1c
.RI "virtual void \fBremoveChild\fP (\fBSoNode\fP *child)"
.br
.ti -1c
.RI "virtual void \fBremoveAllChildren\fP (void)"
.br
.ti -1c
.RI "virtual void \fBreplaceChild\fP (int idx, \fBSoNode\fP *child)"
.br
.ti -1c
.RI "virtual void \fBreplaceChild\fP (\fBSoNode\fP *old, \fBSoNode\fP *child)"
.br
.ti -1c
.RI "virtual \fBSoChildList\fP * \fBgetChildren\fP (void) const"
.br
.in -1c

Public Member Functions inherited from \fBSoGroup\fP
.in +1c
.ti -1c
.RI "\fBSoGroup\fP (void)"
.br
.ti -1c
.RI "\fBSoGroup\fP (int nchildren)"
.br
.ti -1c
.RI "virtual void \fBhandleEvent\fP (\fBSoHandleEventAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBpick\fP (\fBSoPickAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBaddWriteReference\fP (\fBSoOutput\fP *out, SbBool isfromfield=FALSE)"
.br
.in -1c

Public Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "void \fBsetOverride\fP (const SbBool state)"
.br
.ti -1c
.RI "SbBool \fBisOverride\fP (void) const"
.br
.ti -1c
.RI "void \fBsetNodeType\fP (const \fBNodeType\fP type)"
.br
.ti -1c
.RI "\fBNodeType\fP \fBgetNodeType\fP (void) const"
.br
.ti -1c
.RI "virtual \fBSoNode\fP * \fBcopy\fP (SbBool copyconnections=FALSE) const"
.br
.ti -1c
.RI "virtual void \fBgrabEventsSetup\fP (void)"
.br
.ti -1c
.RI "virtual void \fBgrabEventsCleanup\fP (void)"
.br
.ti -1c
.RI "virtual void \fBstartNotify\fP (void)"
.br
.ti -1c
.RI "SbUniqueId \fBgetNodeId\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBwriteInstance\fP (\fBSoOutput\fP *out)"
.br
.ti -1c
.RI "virtual \fBSoNode\fP * \fBaddToCopyDict\fP (void) const"
.br
.ti -1c
.RI "virtual \fBSoFieldContainer\fP * \fBcopyThroughConnection\fP (void) const"
.br
.in -1c

Public Member Functions inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "void \fBsetToDefaults\fP (void)"
.br
.ti -1c
.RI "SbBool \fBhasDefaultValues\fP (void) const"
.br
.ti -1c
.RI "SbBool \fBfieldsAreEqual\fP (const \fBSoFieldContainer\fP *container) const"
.br
.ti -1c
.RI "void \fBcopyFieldValues\fP (const \fBSoFieldContainer\fP *container, SbBool copyconnections=FALSE)"
.br
.ti -1c
.RI "SbBool \fBset\fP (const char *const fielddata)"
.br
.ti -1c
.RI "void \fBget\fP (\fBSbString\fP &fielddata)"
.br
.ti -1c
.RI "virtual int \fBgetFields\fP (\fBSoFieldList\fP &l) const"
.br
.ti -1c
.RI "virtual int \fBgetAllFields\fP (\fBSoFieldList\fP &l) const"
.br
.ti -1c
.RI "virtual \fBSoField\fP * \fBgetField\fP (const \fBSbName\fP &name) const"
.br
.ti -1c
.RI "virtual \fBSoField\fP * \fBgetEventIn\fP (const \fBSbName\fP &name) const"
.br
.ti -1c
.RI "virtual \fBSoField\fP * \fBgetEventOut\fP (const \fBSbName\fP &name) const"
.br
.ti -1c
.RI "SbBool \fBgetFieldName\fP (const \fBSoField\fP *const field, \fBSbName\fP &name) const"
.br
.ti -1c
.RI "SbBool \fBenableNotify\fP (const SbBool flag)"
.br
.ti -1c
.RI "SbBool \fBisNotifyEnabled\fP (void) const"
.br
.ti -1c
.RI "SbBool \fBset\fP (const char *fielddata, \fBSoInput\fP *input)"
.br
.ti -1c
.RI "void \fBget\fP (\fBSbString\fP &fielddata, \fBSoOutput\fP *out)"
.br
.ti -1c
.RI "virtual SbBool \fBvalidateNewFieldValue\fP (\fBSoField\fP *field, void *newval)"
.br
.ti -1c
.RI "SbBool \fBgetIsBuiltIn\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBgetFieldsMemorySize\fP (size_t &managed, size_t &unmanaged) const"
.br
.ti -1c
.RI "void \fBsetUserData\fP (void *userdata) const"
.br
.ti -1c
.RI "void * \fBgetUserData\fP (void) const"
.br
.in -1c

Public Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "void \fBref\fP (void) const"
.br
.ti -1c
.RI "void \fBunref\fP (void) const"
.br
.ti -1c
.RI "void \fBunrefNoDelete\fP (void) const"
.br
.ti -1c
.RI "int32_t \fBgetRefCount\fP (void) const"
.br
.ti -1c
.RI "void \fBtouch\fP (void)"
.br
.ti -1c
.RI "SbBool \fBisOfType\fP (\fBSoType\fP type) const"
.br
.RI "Returns \fRTRUE\fP if the type of this object is either of the same type or inherited from \fItype\fP\&. "
.ti -1c
.RI "virtual \fBSbName\fP \fBgetName\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBsetName\fP (const \fBSbName\fP &newname)"
.br
.ti -1c
.RI "void \fBaddAuditor\fP (void *const auditor, const \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "void \fBremoveAuditor\fP (void *const auditor, const \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "const \fBSoAuditorList\fP & \fBgetAuditors\fP (void) const"
.br
.ti -1c
.RI "SbBool \fBshouldWrite\fP (void)"
.br
.ti -1c
.RI "void \fBassertAlive\fP (void) const"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoVRMLGroup\fP
.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.ti -1c
.RI "static void \fBsetNumRenderCaches\fP (int num)"
.br
.ti -1c
.RI "static int \fBgetNumRenderCaches\fP (void)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoVRMLParent\fP
.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.ti -1c
.RI "static void \fBupdateChildList\fP (const \fBSoNode\fP *const *nodes, const int numnodes, \fBSoChildList\fP &cl)"
.br
.ti -1c
.RI "static void \fBupdateChildList\fP (\fBSoNode\fP *nodewithsfnode, \fBSoChildList\fP &cl)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoGroup\fP
.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.    "
.in -1c

Static Public Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "static uint32_t \fBgetCompatibilityTypes\fP (const \fBSoType\fP &nodetype)"
.br
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static \fBSoNode\fP * \fBgetByName\fP (const \fBSbName\fP &name)"
.br
.ti -1c
.RI "static int \fBgetByName\fP (const \fBSbName\fP &name, \fBSoNodeList\fP &l)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.    "
.ti -1c
.RI "static void \fBinitClasses\fP (void)"
.br
.ti -1c
.RI "static SbUniqueId \fBgetNextNodeId\fP (void)"
.br
.ti -1c
.RI "static int \fBgetActionMethodIndex\fP (const \fBSoType\fP type)"
.br
.ti -1c
.RI "static void \fBgetBoundingBoxS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBGLRenderS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBcallbackS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBgetMatrixS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBhandleEventS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBpickS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBrayPickS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBsearchS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBwriteS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBaudioRenderS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "static void \fBgetPrimitiveCountS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.    "
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.RI "This static method returns the \fBSoType\fP object associated with objects of this class\&.    "
.ti -1c
.RI "static void \fBcleanupClass\fP (void)"
.br
.ti -1c
.RI "static void \fBinitCopyDict\fP (void)"
.br
.ti -1c
.RI "static void \fBaddCopy\fP (const \fBSoFieldContainer\fP *orig, const \fBSoFieldContainer\fP *copy)"
.br
.ti -1c
.RI "static \fBSoFieldContainer\fP * \fBcheckCopy\fP (const \fBSoFieldContainer\fP *orig)"
.br
.ti -1c
.RI "static \fBSoFieldContainer\fP * \fBfindCopy\fP (const \fBSoFieldContainer\fP *orig, const SbBool copyconnections)"
.br
.ti -1c
.RI "static void \fBcopyDone\fP (void)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. "
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.RI "This static method returns the \fBSoType\fP object associated with objects of this class\&. "
.ti -1c
.RI "static void \fBaddName\fP (\fBSoBase\fP *const base, const char *const name)"
.br
.ti -1c
.RI "static void \fBremoveName\fP (\fBSoBase\fP *const base, const char *const name)"
.br
.ti -1c
.RI "static void \fBincrementCurrentWriteCounter\fP (void)"
.br
.ti -1c
.RI "static void \fBdecrementCurrentWriteCounter\fP (void)"
.br
.ti -1c
.RI "static \fBSoBase\fP * \fBgetNamedBase\fP (const \fBSbName\fP &name, \fBSoType\fP type)"
.br
.ti -1c
.RI "static int \fBgetNamedBases\fP (const \fBSbName\fP &name, \fBSoBaseList\fP &baselist, \fBSoType\fP type)"
.br
.ti -1c
.RI "static SbBool \fBread\fP (\fBSoInput\fP *input, \fBSoBase\fP *&base, \fBSoType\fP expectedtype)"
.br
.ti -1c
.RI "static void \fBsetInstancePrefix\fP (const \fBSbString\fP &c)"
.br
.ti -1c
.RI "static void \fBsetTraceRefs\fP (SbBool trace)"
.br
.ti -1c
.RI "static SbBool \fBgetTraceRefs\fP (void)"
.br
.ti -1c
.RI "static SbBool \fBconnectRoute\fP (\fBSoInput\fP *input, const \fBSbName\fP &fromnodename, const \fBSbName\fP &fromfieldname, const \fBSbName\fP &tonodename, const \fBSbName\fP &tofieldname)"
.br
.ti -1c
.RI "static SbBool \fBreadRoute\fP (\fBSoInput\fP *input)"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "\fBSoSFBool\fP \fBcollide\fP"
.br
.ti -1c
.RI "\fBSoSFNode\fP \fBproxy\fP"
.br
.ti -1c
.RI "\fBSoSFTime\fP \fBcollideTime\fP"
.br
.in -1c

Public Attributes inherited from \fBSoVRMLGroup\fP
.in +1c
.ti -1c
.RI "\fBSoSFEnum\fP \fBrenderCaching\fP"
.br
.ti -1c
.RI "\fBSoSFEnum\fP \fBboundingBoxCaching\fP"
.br
.ti -1c
.RI "\fBSoSFEnum\fP \fBrenderCulling\fP"
.br
.ti -1c
.RI "\fBSoSFEnum\fP \fBpickCulling\fP"
.br
.ti -1c
.RI "\fBSoSFVec3f\fP \fBbboxCenter\fP"
.br
.ti -1c
.RI "\fBSoSFVec3f\fP \fBbboxSize\fP"
.br
.in -1c

Public Attributes inherited from \fBSoVRMLParent\fP
.in +1c
.ti -1c
.RI "\fBSoMFNode\fP \fBchildren\fP"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual const \fBSoFieldData\fP * \fBgetFieldData\fP (void) const"
.br
.ti -1c
.RI "virtual \fB~SoVRMLCollision\fP ()"
.br
.in -1c

Protected Member Functions inherited from \fBSoVRMLGroup\fP
.in +1c
.ti -1c
.RI "virtual \fB~SoVRMLGroup\fP ()"
.br
.ti -1c
.RI "virtual SbBool \fBcullTest\fP (\fBSoState\fP *state)"
.br
.in -1c

Protected Member Functions inherited from \fBSoVRMLParent\fP
.in +1c
.ti -1c
.RI "\fBSoVRMLParent\fP (void)"
.br
.ti -1c
.RI "\fBSoVRMLParent\fP (int approxchildren)"
.br
.ti -1c
.RI "virtual \fB~SoVRMLParent\fP ()"
.br
.ti -1c
.RI "virtual SbBool \fBreadInstance\fP (\fBSoInput\fP *in, unsigned short flags)"
.br
.ti -1c
.RI "virtual void \fBcopyContents\fP (const \fBSoFieldContainer\fP *from, SbBool copyConn)"
.br
.in -1c

Protected Member Functions inherited from \fBSoGroup\fP
.in +1c
.ti -1c
.RI "virtual \fB~SoGroup\fP ()"
.br
.ti -1c
.RI "virtual SbBool \fBreadChildren\fP (\fBSoInput\fP *in)"
.br
.ti -1c
.RI "virtual \fBSoNotRec\fP \fBcreateNotRec\fP (void)"
.br
.ti -1c
.RI "void \fBsetOperation\fP (const \fBSoNotRec::OperationType\fP opType=SoNotRec::UNSPECIFIED, const \fBSoNode\fP *cc=NULL, const \fBSoNode\fP *pc=NULL, const int ci=\-1)"
.br
.in -1c

Protected Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBSoNode\fP (void)"
.br
.ti -1c
.RI "virtual \fB~SoNode\fP ()"
.br
.in -1c

Protected Member Functions inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "\fBSoFieldContainer\fP (void)"
.br
.ti -1c
.RI "virtual \fB~SoFieldContainer\fP ()"
.br
.in -1c

Protected Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBSoBase\fP (void)"
.br
.ti -1c
.RI "virtual \fB~SoBase\fP ()"
.br
.ti -1c
.RI "virtual void \fBdestroy\fP (void)"
.br
.ti -1c
.RI "SbBool \fBhasMultipleWriteRefs\fP (void) const"
.br
.ti -1c
.RI "SbBool \fBwriteHeader\fP (\fBSoOutput\fP *out, SbBool isgroup, SbBool isengine) const"
.br
.ti -1c
.RI "void \fBwriteFooter\fP (\fBSoOutput\fP *out) const"
.br
.ti -1c
.RI "virtual const char * \fBgetFileFormatName\fP (void) const"
.br
.in -1c
.SS "Static Protected Member Functions"

.in +1c
.ti -1c
.RI "static const \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (void)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoVRMLGroup\fP
.in +1c
.ti -1c
.RI "static const \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (void)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoVRMLParent\fP
.in +1c
.ti -1c
.RI "static const \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (void)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoGroup\fP
.in +1c
.ti -1c
.RI "static const \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (void)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "static const \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (void)"
.br
.ti -1c
.RI "static void \fBsetNextActionMethodIndex\fP (int index)"
.br
.ti -1c
.RI "static int \fBgetNextActionMethodIndex\fP (void)"
.br
.ti -1c
.RI "static void \fBincNextActionMethodIndex\fP (void)"
.br
.ti -1c
.RI "static void \fBsetCompatibilityTypes\fP (const \fBSoType\fP &nodetype, const uint32_t bitmask)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "static uint32_t \fBgetCurrentWriteCounter\fP (void)"
.br
.ti -1c
.RI "static void \fBstaticDataLock\fP (void)"
.br
.ti -1c
.RI "static void \fBstaticDataUnlock\fP (void)"
.br
.in -1c
.SS "Additional Inherited Members"


Public Types inherited from \fBSoVRMLGroup\fP
.in +1c
.ti -1c
.RI "enum \fBCacheEnabled\fP { \fBOFF\fP, \fBON\fP, \fBAUTO\fP }"
.br
.in -1c

Public Types inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "enum \fBNodeType\fP { \fBINVENTOR\fP = 0x0000, \fBVRML1\fP = 0x0001, \fBVRML2\fP = 0x0002, \fBINVENTOR_1\fP = 0x0004, \fBINVENTOR_2_0\fP = 0x0008, \fBINVENTOR_2_1\fP = 0x0010, \fBINVENTOR_2_5\fP = 0x0020, \fBINVENTOR_2_6\fP = 0x0040, \fBCOIN_1_0\fP = 0x0080, \fBCOIN_2_0\fP = 0x0100, \fBEXTENSION\fP = 0x0200, \fBCOIN_2_2\fP = 0x0400, \fBCOIN_2_3\fP = 0x0800, \fBCOIN_2_4\fP = 0x1000, \fBINVENTOR_5_0\fP = 0x2000, \fBCOIN_2_5\fP = 0x4000, \fBCOIN_3_0\fP = 0x8000, \fBINVENTOR_6_0\fP = 0x10000, \fBCOIN_4_0\fP = 0x20000 }"
.br
.in -1c

Protected Types inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "enum \fBBaseFlags\fP { \fBIS_ENGINE\fP = 0x01, \fBIS_GROUP\fP = 0x02 }"
.br
.in -1c

Protected Attributes inherited from \fBSoVRMLParent\fP
.in +1c
.ti -1c
.RI "\fBSoMFNode\fP \fBaddChildren\fP"
.br
.ti -1c
.RI "\fBSoMFNode\fP \fBremoveChildren\fP"
.br
.in -1c

Protected Attributes inherited from \fBSoGroup\fP
.in +1c
.ti -1c
.RI "\fBSoChildList\fP * \fBchildren\fP"
.br
.in -1c

Protected Attributes inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "SbUniqueId \fBuniqueId\fP"
.br
.in -1c

Protected Attributes inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "SbBool \fBisBuiltIn\fP"
.br
.in -1c

Static Protected Attributes inherited from \fBSoVRMLGroup\fP
.in +1c
.ti -1c
.RI "static int \fBnumRenderCaches\fP = 2"
.br
.in -1c

Static Protected Attributes inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "static SbUniqueId \fBnextUniqueId\fP = 1"
.br
.ti -1c
.RI "static int \fBnextActionMethodIndex\fP = 0"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoVRMLCollision\fP class is used for collision detection with the avatar\&. 

\fBThe 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:\fP
.br

.br
 
.PP
.nf
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
}

.fi
.PP

.PP
The Collision node is a grouping node that specifies the collision detection properties for its children (and their descendants), specifies surrogate objects that replace its children during collision detection, and sends events signalling that a collision has occurred between the avatar and the Collision node's geometry or surrogate\&. By default, all geometric nodes in the scene are collidable with the viewer except IndexedLineSet, PointSet, and Text\&. Browsers shall detect geometric collisions between the avatar (see \fBSoVRMLNavigationInfo\fP) and the scene's geometry and prevent the avatar from 'entering' the geometry\&. See 4\&.13\&.4, Collision detection and terrain following (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.13.4), for general information on collision detection\&.

.PP
If there are no Collision nodes specified in a VRML file, browsers shall detect collisions between the avatar and all objects during navigation\&.

.PP
Subclause 4\&.6\&.5, Grouping and children nodes (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.6.5), contains a description of the children, addChildren, and removeChildren fields and eventIns\&.

.PP
The Collision node's collide field enables and disables collision detection\&. If collide is set to FALSE, the children and all descendants of the Collision node shall not be checked for collision, even though they are drawn\&. This includes any descendent Collision nodes that have collide set to TRUE (i\&.e\&., setting collide to FALSE turns collision off for every node below it)\&.

.PP
Collision nodes with the collide field set to TRUE detect the nearest collision with their descendent geometry (or proxies)\&. When the nearest collision is detected, the collided Collision node sends the time of the collision through its collideTime eventOut\&. If a Collision node contains a child, descendant, or proxy (see below) that is a Collision node, and both Collision nodes detect that a collision has occurred, 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\&.

.PP
The bboxCenter and bboxSize fields specify a bounding box that encloses the Collision node's children\&. This is a hint that may be used for optimization purposes\&. 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, (-1, -1, -1), implies that the bounding box is not specified and if needed shall be calculated by the browser\&. More details on the bboxCenter and bboxSize fields can be found in 4\&.6\&.4, Bounding boxes\&. (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.6.4),

.PP
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/documents/specifications/14772/V2.0/part1/concepts.html#4.6.5), that is 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 the value of the collide field is TRUE and the proxy field is non-NULL, the proxy field defines the scene on which collision detection is performed\&. If the proxy value 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\&. In this manner, invisible collision objects may be supported\&.

.PP
The collideTime eventOut generates an event specifying the time when the avatar (see \fBSoVRMLNavigationInfo\fP) makes contact with the collidable children or proxy of the Collision node\&. An ideal implementation computes the exact time of collision\&. Implementations may approximate the ideal by sampling the positions of collidable objects and the user\&. The \fBSoVRMLNavigationInfo\fP node contains additional information for parameters that control the avatar size\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoVRMLCollision::SoVRMLCollision (void )"
Constructor\&. 
.SS "SoVRMLCollision::SoVRMLCollision (int numchildren)"
Constructor\&. \fInumchildren\fP is the expected number of children\&. 
.SS "SoVRMLCollision::~SoVRMLCollision ()\fR [protected]\fP, \fR [virtual]\fP"
Destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoVRMLCollision::getClassTypeId (void )\fR [static]\fP"
This static method returns the \fBSoType\fP object associated with objects of this class\&. 
.SS "\fBSoType\fP SoVRMLCollision::getTypeId (void ) const\fR [virtual]\fP"
Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for runtime type checking and "downward" casting\&. 
.PP
Reimplemented from \fBSoVRMLGroup\fP\&.
.SS "const \fBSoFieldData\fP ** SoVRMLCollision::getFieldDataPtr (void )\fR [static]\fP, \fR [protected]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br
 Returns the \fBSoFieldData\fP class which holds information about fields in this node\&. 
.SS "const \fBSoFieldData\fP * SoVRMLCollision::getFieldData (void ) const\fR [protected]\fP, \fR [virtual]\fP"
Returns a pointer to the class-wide field data storage object for this instance\&. If no fields are present, returns \fRNULL\fP\&. 
.PP
Reimplemented from \fBSoVRMLGroup\fP\&.
.SS "void SoVRMLCollision::initClass (void )\fR [static]\fP"

.SS "void SoVRMLCollision::GLRender (\fBSoGLRenderAction\fP * action)\fR [virtual]\fP"
Action method for the \fBSoGLRenderAction\fP\&.

.PP
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\&. 
.PP
Reimplemented from \fBSoVRMLGroup\fP\&.
.SS "void SoVRMLCollision::notify (\fBSoNotList\fP * l)\fR [virtual]\fP"
Notifies all auditors for this instance when changes are made\&. 
.PP
Reimplemented from \fBSoVRMLGroup\fP\&.
.SH "Member Data Documentation"
.PP 
.SS "\fBSoSFBool\fP SoVRMLCollision::collide"
Enable/disable collision\&. 
.SS "\fBSoSFNode\fP SoVRMLCollision::proxy"
Proxy node(s) used for collision testing\&. 
.SS "\fBSoSFTime\fP SoVRMLCollision::collideTime"
An eventOut sent for each collision that occurs\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.