.TH "SoLightPath" 3 "Fri Sep 6 2024 15:32:06" "Version 4.0.3" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoLightPath \- The \fBSoLightPath\fP class is a light version of \fBSoPath\fP\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <Inventor/misc/SoLightPath\&.h>\fP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSoLightPath\fP (\fBSoNode\fP *node, const int approxlength)"
.br
.ti -1c
.RI "\fBSoLightPath\fP (const int approxlength)"
.br
.ti -1c
.RI "\fB~SoLightPath\fP ()"
.br
.ti -1c
.RI "void \fBsetHead\fP (\fBSoNode\fP *const node)"
.br
.ti -1c
.RI "void \fBappend\fP (const int childindex)"
.br
.ti -1c
.RI "void \fBpush\fP (const int childindex)"
.br
.ti -1c
.RI "void \fBpop\fP (void)"
.br
.ti -1c
.RI "void \fBsetTail\fP (const int childindex)"
.br
.ti -1c
.RI "\fBSoNode\fP * \fBgetTail\fP (void) const"
.br
.ti -1c
.RI "\fBSoNode\fP * \fBgetHead\fP (void) const"
.br
.ti -1c
.RI "\fBSoNode\fP * \fBgetNode\fP (const int index) const"
.br
.ti -1c
.RI "int \fBgetIndex\fP (const int index) const"
.br
.ti -1c
.RI "int \fBgetFullLength\fP () const"
.br
.ti -1c
.RI "void \fBtruncate\fP (const int startindex)"
.br
.ti -1c
.RI "void \fBmakeTempPath\fP (\fBSoTempPath\fP *path) const"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoLightPath\fP class is a light version of \fBSoPath\fP\&. 

\fBSoLightPath\fP can be used if you only need a temporary path, and don't want the overhead that comes with an \fBSoPath\fP (ref, unref, auditing etc)\&.

.PP
It is your responsibility to make sure the path is valid before using it\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoLightPath::SoLightPath (\fBSoNode\fP * headnodeptr, const int approxlength)"
A constructor\&. Supply the head node and the approximate length of the path\&. 
.SS "SoLightPath::SoLightPath (const int approxlength)"
A constructor\&. Supply the approximate length of the path\&. 
.SS "SoLightPath::~SoLightPath ()"
Destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "void SoLightPath::setHead (\fBSoNode\fP *const node)"
Sets head of path\&. Truncates path to length 1\&. 
.SS "void SoLightPath::append (const int childindex)"
Appends a \fIchildindex\fP to the path\&. 
.SS "void SoLightPath::push (const int childindex)"
Same as \fBappend()\fP\&. 
.SS "void SoLightPath::pop (void )"
Pops off the last child\&. 
.SS "void SoLightPath::setTail (const int childindex)"
Sets the tail of the path\&. 
.SS "\fBSoNode\fP * SoLightPath::getTail (void ) const"
Returns the tail node of the path\&. Uses \fBgetNode()\fP\&. 
.SS "\fBSoNode\fP * SoLightPath::getHead (void ) const"
Returns the head node\&. 
.SS "\fBSoNode\fP * SoLightPath::getNode (const int index) const"
Returns the index'th node in path\&. 
.SS "int SoLightPath::getIndex (const int index) const"
Returns the child index of the index'th node in the path\&. 
.SS "int SoLightPath::getFullLength () const"
Returns the length of the path\&. 
.SS "void SoLightPath::truncate (const int startindex)"
Truncates the path from \fIstartindex\fP\&. 
.SS "void SoLightPath::makeTempPath (\fBSoTempPath\fP * path) const"
Updates \fIpath\fP to be the same path as this path\&. 

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