.TH "SoVRMLAnchor" 3 "Fri Sep 6 2024 15:32:06" "Version 4.0.3" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoVRMLAnchor \- The \fBSoVRMLAnchor\fP class is used for linking to other URL resources\&.  

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

.in +1c
.ti -1c
.RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const"
.br
.ti -1c
.RI "\fBSoVRMLAnchor\fP (void)"
.br
.ti -1c
.RI "virtual void \fBhandleEvent\fP (\fBSoHandleEventAction\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
.ti -1c
.RI "virtual void \fBdoAction\fP (\fBSoAction\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
.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 \fBGLRender\fP (\fBSoGLRenderAction\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 \fBpick\fP (\fBSoPickAction\fP *action)"
.br
.ti -1c
.RI "virtual void \fBaudioRender\fP (\fBSoAudioRenderAction\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 \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
.ti -1c
.RI "virtual void \fBrayPick\fP (\fBSoRayPickAction\fP *action)"
.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
.ti -1c
.RI "static void \fBsetFetchURLCallBack\fP (SoVRMLAnchorCB *, void *closure)"
.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 "\fBSoMFString\fP \fBurl\fP"
.br
.ti -1c
.RI "\fBSoSFString\fP \fBdescription\fP"
.br
.ti -1c
.RI "\fBSoMFString\fP \fBparameter\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

Public Attributes inherited from \fBSoBase\fP
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual const \fBSoFieldData\fP * \fBgetFieldData\fP (void) const"
.br
.ti -1c
.RI "virtual \fB~SoVRMLAnchor\fP ()"
.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 void \fBnotify\fP (\fBSoNotList\fP *list)"
.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 \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 \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 \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 \fBSoVRMLAnchor\fP class is used for linking to other URL resources\&. 

\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
Anchor {
  eventIn      MFNode   addChildren
  eventIn      MFNode   removeChildren
  exposedField MFNode   children        []
  exposedField SFString description     ''
  exposedField MFString parameter       []
  exposedField MFString url             []
  field        SFVec3f  bboxCenter      0 0 0     # (-inf, inf)
  field        SFVec3f  bboxSize        -1 -1 -1  # (0, inf) or -1,-1,-1
}
.fi
.PP

.PP
The Anchor grouping node retrieves the content of a URL when the user activates (e\&.g\&., clicks) some geometry contained within the Anchor node's children\&. If the URL points to a valid VRML file, that world replaces the world of which the Anchor node is a part (except when the parameter field, described below, alters this behaviour)\&. If non-VRML data is retrieved, the browser shall determine how to handle that data; typically, it will be passed to an appropriate non-VRML browser\&. Exactly how a user activates geometry contained by the Anchor node depends on the pointing device and is determined by the VRML browser\&. Typically, clicking with the pointing device will result in the new scene replacing the current scene\&. An Anchor node with an empty url does nothing when its children are chosen\&. A description of how multiple Anchors and pointing-device sensors are resolved on activation is contained in 4\&.6\&.7, Sensor nodes (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.6.7)\&.

.PP
More details on the children, addChildren, and removeChildren fields and eventIns can be found in 4\&.6\&.5, Grouping and children nodes (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.6.5)\&.

.PP
The description field in the Anchor node specifies a textual description of the Anchor node\&. This may be used by browser-specific user interfaces that wish to present users with more detailed information about the Anchor\&. The parameter exposed field may be used to supply any additional information to be interpreted by the browser\&. Each string shall consist of 'keyword=value' pairs\&. For example, some browsers allow the specification of a 'target' for a link to display a link in another part of an HTML document\&. The parameter field is then:

.PP
.PP
.nf
Anchor {
  parameter [ 'target=name_of_frame' ]
  \&.\&.\&.
}
.fi
.PP

.PP
An Anchor node may be used to bind the initial Viewpoint node in a world by specifying a URL ending with '#ViewpointName' where 'ViewpointName' is the name of a viewpoint defined in the VRML file\&. For example:

.PP
.PP
.nf
Anchor {
  url 'http://www\&.school\&.edu/vrml/someScene\&.wrl#OverView'
  children  Shape { geometry Box {} }
}
.fi
.PP

.PP
specifies an anchor that loads the VRML file 'someScene\&.wrl' and binds the initial user view to the Viewpoint node named 'OverView' when the Anchor node's geometry (Box) is activated\&. If the named Viewpoint node is not found in the VRML file, the VRML file is loaded using the default Viewpoint node binding stack rules (see VRMLViewpoint)\&. If the url field is specified in the form '#ViewpointName' (i\&.e\&. no file name), the Viewpoint node with the given name ('ViewpointName') in the Anchor's runtime name scope(s) shall be bound (set_bind TRUE)\&. The results are undefined if there are multiple Viewpoints with the same name in the Anchor's runtime name scope(s)\&. The results are undefined if the Anchor node is not part of any runtime name scope or is part of more than one runtime name scope\&. See 4\&.4\&.6, Runtime name scope, for a description of runtime name scopes\&. See VRMLViewpoint, for the Viewpoint transition rules that specify how browsers shall interpret the transition from the old Viewpoint node to the new one\&. For example:

.PP
.PP
.nf
Anchor {
  url '#Doorway'
  children Shape {
    geometry Sphere {}
  }
}
.fi
.PP

.PP
binds the viewer to the viewpoint defined by the 'Doorway' viewpoint in the current world when the sphere is activated\&. In this case, if the Viewpoint is not found, no action occurs on activation\&. More details on the url field are contained in 4\&.5, VRML and the World Wide Web (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.5)\&. The bboxCenter and bboxSize fields specify a bounding box that encloses the Anchor'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\&. The 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)\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoVRMLAnchor::SoVRMLAnchor (void )"
Default constructor\&. 
.SS "SoVRMLAnchor::~SoVRMLAnchor ()\fR [protected]\fP, \fR [virtual]\fP"
Destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoVRMLAnchor::getClassTypeId (void )\fR [static]\fP"
This static method returns the \fBSoType\fP object associated with objects of this class\&. 
.br
 
.SS "\fBSoType\fP SoVRMLAnchor::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\&. 
.br
 
.PP
Reimplemented from \fBSoVRMLParent\fP\&.
.SS "const \fBSoFieldData\fP ** SoVRMLAnchor::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\&. 
.br
 
.SS "const \fBSoFieldData\fP * SoVRMLAnchor::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 \fBSoVRMLParent\fP\&.
.SS "void SoVRMLAnchor::initClass (void )\fR [static]\fP"

.SS "void SoVRMLAnchor::setFetchURLCallBack (SoVRMLAnchorCB * f, void * closure)\fR [static]\fP"
Sets the callback that will be called when the node is selected\&. 
.SS "void SoVRMLAnchor::handleEvent (\fBSoHandleEventAction\fP * action)\fR [virtual]\fP"
Action method for \fBSoHandleEventAction\fP\&.

.PP
Inspects the event data from \fIaction\fP, and processes it if it is something which this node should react to\&.

.PP
Nodes influencing relevant state variables for how event handling is done also override this method\&. 
.PP
Reimplemented from \fBSoGroup\fP\&.
.SH "Member Data Documentation"
.PP 
.SS "\fBSoMFString\fP SoVRMLAnchor::url"
The URL string\&. 
.SS "\fBSoSFString\fP SoVRMLAnchor::description"
The textual description of the URL\&. 
.SS "\fBSoMFString\fP SoVRMLAnchor::parameter"
May be used to supply additional information to the browser\&.

.PP
Each string should be pairs of \fIkeyword\fP = \fIvalue\fP\&. 
.SS "\fBSoSFVec3f\fP SoVRMLAnchor::bboxCenter"
Children bounding box hint center\&. Default value is (0, 0, 0)\&. 
.SS "\fBSoSFVec3f\fP SoVRMLAnchor::bboxSize"
Children bounding box size hint\&. Default value is (-1, -1, -1)\&. 

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