.TH "SoFullPath" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoFullPath \- The \fBSoFullPath\fP class allows examination of hidden children in paths\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/SoFullPath\&.h>\fP
.PP
Inherits \fBSoPath\fP\&.
.PP
Inherited by \fBSoTempPath\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBvoid\fP \fBpop\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBSoNode\fP * \fBgetTail\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoNode\fP * \fBgetNodeFromTail\fP (\fBconst\fP int index) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetIndexFromTail\fP (\fBconst\fP int index) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetLength\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c

Public Member Functions inherited from \fBSoPath\fP
.in +1c
.ti -1c
.RI "\fBSoPath\fP (\fBconst\fP int \fBapproxlength\fP=4)"
.br
.ti -1c
.RI "\fBSoPath\fP (\fBSoNode\fP *\fBconst\fP head)"
.br
.ti -1c
.RI "\fBSoPath\fP (\fBconst\fP \fBSoPath\fP &rhs)"
.br
.ti -1c
.RI "\fBSoPath\fP & \fBoperator=\fP (\fBconst\fP \fBSoPath\fP &rhs)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP"
.br
.RI "Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for runtime type checking and 'downward' casting\&. "
.ti -1c
.RI "\fBvoid\fP \fBsetHead\fP (\fBSoNode\fP *\fBconst\fP head)"
.br
.ti -1c
.RI "\fBSoNode\fP * \fBgetHead\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBappend\fP (\fBconst\fP int \fBchildindex\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBappend\fP (\fBSoNode\fP *\fBconst\fP node)"
.br
.ti -1c
.RI "\fBvoid\fP \fBappend\fP (\fBconst\fP \fBSoPath\fP *\fBconst\fP \fBfrompath\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBpush\fP (\fBconst\fP int \fBchildindex\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBpop\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBSoNode\fP * \fBgetTail\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoNode\fP * \fBgetNode\fP (\fBconst\fP int index) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoNode\fP * \fBgetNodeFromTail\fP (\fBconst\fP int index) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetIndex\fP (\fBconst\fP int index) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetIndexFromTail\fP (\fBconst\fP int index) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetLength\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBtruncate\fP (\fBconst\fP int length)"
.br
.ti -1c
.RI "int \fBfindFork\fP (\fBconst\fP \fBSoPath\fP *\fBconst\fP path) \fBconst\fP"
.br
.ti -1c
.RI "int \fBfindNode\fP (\fBconst\fP \fBSoNode\fP *\fBconst\fP node) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBcontainsNode\fP (\fBconst\fP \fBSoNode\fP *\fBconst\fP node) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBcontainsPath\fP (\fBconst\fP \fBSoPath\fP *\fBconst\fP path) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoPath\fP * \fBcopy\fP (\fBconst\fP int \fBstartfromnodeindex\fP=0, int \fBnumnodes\fP=0) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBinsertIndex\fP (\fBSoNode\fP *\fBconst\fP parent, \fBconst\fP int \fBnewindex\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBremoveIndex\fP (\fBSoNode\fP *\fBconst\fP parent, \fBconst\fP int \fBoldindex\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBreplaceIndex\fP (\fBSoNode\fP *\fBconst\fP parent, \fBconst\fP int index, \fBSoNode\fP *\fBconst\fP \fBnewchild\fP)"
.br
.ti -1c
.RI "SbBool \fBisRelevantNotification\fP (\fBSoNotList\fP *\fBconst\fP \fBl\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBwrite\fP (\fBSoWriteAction\fP *action)"
.br
.in -1c

Public Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBvoid\fP \fBref\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBunref\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBunrefNoDelete\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "int32_t \fBgetRefCount\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBtouch\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "SbBool \fBisOfType\fP (\fBSoType\fP type) \fBconst\fP"
.br
.RI "Returns \fCTRUE\fP if the type of this object is either of the same type or inherited from \fItype\fP\&. "
.ti -1c
.RI "\fBvirtual\fP \fBSbName\fP \fBgetName\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBsetName\fP (\fBconst\fP \fBSbName\fP &\fBnewname\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBstartNotify\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBnotify\fP (\fBSoNotList\fP *\fBl\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBaddAuditor\fP (\fBvoid\fP *\fBconst\fP \fBauditor\fP, \fBconst\fP \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "\fBvoid\fP \fBremoveAuditor\fP (\fBvoid\fP *\fBconst\fP \fBauditor\fP, \fBconst\fP \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "\fBconst\fP \fBSoAuditorList\fP & \fBgetAuditors\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBaddWriteReference\fP (\fBSoOutput\fP *\fBout\fP, SbBool \fBisfromfield\fP=FALSE)"
.br
.ti -1c
.RI "SbBool \fBshouldWrite\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBassertAlive\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c
.SS "Additional Inherited Members"


Static Public Member Functions inherited from \fBSoPath\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.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 "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.RI "This static method returns the \fBSoType\fP object associated with objects of this class\&.   "
.ti -1c
.RI "\fBstatic\fP \fBSoPath\fP * \fBgetByName\fP (\fBconst\fP \fBSbName\fP name)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetByName\fP (\fBconst\fP \fBSbName\fP name, \fBSoPathList\fP &\fBl\fP)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.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 "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.RI "This static method returns the \fBSoType\fP object associated with objects of this class\&. "
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBaddName\fP (\fBSoBase\fP *\fBconst\fP base, \fBconst\fP char *\fBconst\fP name)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBremoveName\fP (\fBSoBase\fP *\fBconst\fP base, \fBconst\fP char *\fBconst\fP name)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBincrementCurrentWriteCounter\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBdecrementCurrentWriteCounter\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoBase\fP * \fBgetNamedBase\fP (\fBconst\fP \fBSbName\fP &name, \fBSoType\fP type)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetNamedBases\fP (\fBconst\fP \fBSbName\fP &name, \fBSoBaseList\fP &\fBbaselist\fP, \fBSoType\fP type)"
.br
.ti -1c
.RI "\fBstatic\fP SbBool \fBread\fP (\fBSoInput\fP *input, \fBSoBase\fP *&base, \fBSoType\fP \fBexpectedtype\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetInstancePrefix\fP (\fBconst\fP \fBSbString\fP &c)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetTraceRefs\fP (SbBool \fBtrace\fP)"
.br
.ti -1c
.RI "\fBstatic\fP SbBool \fBgetTraceRefs\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP SbBool \fBconnectRoute\fP (\fBSoInput\fP *input, \fBconst\fP \fBSbName\fP &\fBfromnodename\fP, \fBconst\fP \fBSbName\fP &\fBfromfieldname\fP, \fBconst\fP \fBSbName\fP &\fBtonodename\fP, \fBconst\fP \fBSbName\fP &\fBtofieldname\fP)"
.br
.ti -1c
.RI "\fBstatic\fP SbBool \fBreadRoute\fP (\fBSoInput\fP *input)"
.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 Member Functions inherited from \fBSoPath\fP
.in +1c
.ti -1c
.RI "\fBvirtual\fP \fB~SoPath\fP ()"
.br
.ti -1c
.RI "\fBvoid\fP \fBauditPath\fP (\fBconst\fP SbBool \fBflag\fP)"
.br
.in -1c

Protected Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBSoBase\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoBase\fP ()"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBdestroy\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "SbBool \fBhasMultipleWriteRefs\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBwriteHeader\fP (\fBSoOutput\fP *\fBout\fP, SbBool \fBisgroup\fP, SbBool \fBisengine\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBwriteFooter\fP (\fBSoOutput\fP *\fBout\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBconst\fP char * \fBgetFileFormatName\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoNotRec\fP \fBcreateNotRec\fP (\fBvoid\fP)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP uint32_t \fBgetCurrentWriteCounter\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBstaticDataLock\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBstaticDataUnlock\fP (\fBvoid\fP)"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoFullPath\fP class allows examination of hidden children in paths\&. 

\fBSoPath\fP allows only access from the head node to the first node with hidden children, but not any further\&.
.PP
Since the \fBSoFullPath\fP is derived from \fBSoPath\fP and contains no private data, you can cast \fBSoPath\fP instances to the \fBSoFullPath\fP type\&. This will allow you to examine hidden children\&.
.PP
(Actually, you are not supposed to allocate instances of this class at all\&. It is only available as an 'extended interface' into the superclass \fBSoPath\fP\&.) 
.SH "Member Function Documentation"
.PP 
.SS "\fBvoid\fP SoFullPath::pop (\fBvoid\fP)\fC [inline]\fP"
This method overrides \fBSoPath::pop()\fP to allow clients to get at all the nodes in the path\&. 
.SS "\fBSoNode\fP * SoFullPath::getTail (\fBvoid\fP) const"
This method overrides \fBSoPath::getTail()\fP to allow clients to get the tail node, counting internal path nodes\&. 
.SS "\fBSoNode\fP * SoFullPath::getNodeFromTail (\fBconst\fP int index) const"
This method overrides \fBSoPath::getNodeFromTail()\fP to allow clients to get the node positioned \fIindex\fP nodes from the tail, counting internal path nodes\&. 
.SS "int SoFullPath::getIndexFromTail (\fBconst\fP int index) const"
This method overrides \fBSoPath::getIndexFromTail()\fP to allow clients to get the child index number for nodes based on their position from the tail, counting hidden nodes\&. 
.SS "int SoFullPath::getLength (\fBvoid\fP) const"
This method returns the length of the path, counting hidden nodes also\&. 

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