.TH "SoPathList" 3 "Tue Jun 23 2026 23:48:38" "Version 4.0.10" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoPathList \- The \fBSoPathList\fP class is a container for pointers to \fBSoPath\fP objects\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <Inventor/lists/SoPathList\&.h>\fP
.PP
Inherits \fBSoBaseList\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSoPathList\fP (void)"
.br
.ti -1c
.RI "\fBSoPathList\fP (const int size)"
.br
.ti -1c
.RI "\fBSoPathList\fP (const \fBSoPathList\fP &pl)"
.br
.ti -1c
.RI "\fB~SoPathList\fP ()"
.br
.ti -1c
.RI "void \fBappend\fP (\fBSoPath\fP *const path)"
.br
.ti -1c
.RI "\fBSoPath\fP * \fBoperator[]\fP (const int i) const"
.br
.ti -1c
.RI "\fBSoPathList\fP & \fBoperator=\fP (const \fBSoPathList\fP &pl)"
.br
.ti -1c
.RI "int \fBfindPath\fP (const \fBSoPath\fP &path) const"
.br
.ti -1c
.RI "void \fBsort\fP (void)"
.br
.ti -1c
.RI "void \fBuniquify\fP (void)"
.br
.in -1c

Public Member Functions inherited from \fBSoBaseList\fP
.in +1c
.ti -1c
.RI "\fBSoBaseList\fP (void)"
.br
.ti -1c
.RI "\fBSoBaseList\fP (const int size)"
.br
.ti -1c
.RI "\fBSoBaseList\fP (const \fBSoBaseList\fP &l)"
.br
.ti -1c
.RI "\fB~SoBaseList\fP ()"
.br
.ti -1c
.RI "void \fBappend\fP (\fBSoBase\fP *ptr)"
.br
.ti -1c
.RI "void \fBinsert\fP (\fBSoBase\fP *ptr, const int addbefore)"
.br
.ti -1c
.RI "void \fBremove\fP (const int index)"
.br
.ti -1c
.RI "void \fBremoveItem\fP (\fBSoBase\fP *item)"
.br
.ti -1c
.RI "void \fBtruncate\fP (const int length)"
.br
.ti -1c
.RI "void \fBcopy\fP (const \fBSoBaseList\fP &l)"
.br
.ti -1c
.RI "\fBSoBaseList\fP & \fBoperator=\fP (const \fBSoBaseList\fP &l)"
.br
.ti -1c
.RI "\fBSoBase\fP * \fBoperator[]\fP (const int i) const"
.br
.ti -1c
.RI "void \fBset\fP (const int i, \fBSoBase\fP *const ptr)"
.br
.ti -1c
.RI "void \fBaddReferences\fP (const SbBool flag)"
.br
.ti -1c
.RI "SbBool \fBisReferencing\fP (void) const"
.br
.in -1c

Public Member Functions inherited from \fBSbPList\fP
.in +1c
.ti -1c
.RI "\fBSbPList\fP (const int sizehint=DEFAULTSIZE)"
.br
.ti -1c
.RI "\fBSbPList\fP (const \fBSbPList\fP &l)"
.br
.ti -1c
.RI "\fB~SbPList\fP ()"
.br
.ti -1c
.RI "void \fBcopy\fP (const \fBSbPList\fP &l)"
.br
.ti -1c
.RI "\fBSbPList\fP & \fBoperator=\fP (const \fBSbPList\fP &l)"
.br
.ti -1c
.RI "void \fBfit\fP (void)"
.br
.ti -1c
.RI "void \fBappend\fP (void *item)"
.br
.ti -1c
.RI "int \fBfind\fP (const void *item) const"
.br
.ti -1c
.RI "void \fBinsert\fP (void *item, const int insertbefore)"
.br
.ti -1c
.RI "void \fBremoveItem\fP (void *item)"
.br
.ti -1c
.RI "void \fBremove\fP (const int index)"
.br
.ti -1c
.RI "void \fBremoveFast\fP (const int index)"
.br
.ti -1c
.RI "int \fBgetLength\fP (void) const"
.br
.ti -1c
.RI "void \fBtruncate\fP (const int length, const int \fBfit\fP=0)"
.br
.ti -1c
.RI "void ** \fBgetArrayPtr\fP (const int start=0) const"
.br
.ti -1c
.RI "void *& \fBoperator[]\fP (const int index) const"
.br
.ti -1c
.RI "int \fBoperator==\fP (const \fBSbPList\fP &l) const"
.br
.ti -1c
.RI "int \fBoperator!=\fP (const \fBSbPList\fP &l) const"
.br
.ti -1c
.RI "void * \fBget\fP (const int index) const"
.br
.ti -1c
.RI "void \fBset\fP (const int index, void *item)"
.br
.in -1c
.SS "Additional Inherited Members"


Protected Member Functions inherited from \fBSbPList\fP
.in +1c
.ti -1c
.RI "void \fBexpand\fP (const int size)"
.br
.ti -1c
.RI "int \fBgetArraySize\fP (void) const"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoPathList\fP class is a container for pointers to \fBSoPath\fP objects\&. 

As this class inherits \fBSoBaseList\fP, referencing and dereferencing will default be done on the objects at \fBappend()\fP, \fBremove()\fP, \fBinsert()\fP etc\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoPathList::SoPathList (void )"
Default constructor\&. 
.SS "SoPathList::SoPathList (const int size)"
Constructor with a hint about the number of elements the list will hold\&.

.PP
\fBSee also\fP
.RS 4
\fBSoBaseList::SoBaseList(const int)\fP 
.RE
.PP

.SS "SoPathList::SoPathList (const \fBSoPathList\fP & pl)"
Copy constructor\&.

.PP
Does a shallow copy of the \fBSoPath\fP pointer values, but updates reference count\&.

.PP
\fBSee also\fP
.RS 4
\fBSoBaseList::SoBaseList(const SoBaseList &)\fP 
.RE
.PP

.SS "SoPathList::~SoPathList ()"
Destructor\&.

.PP
\fBSee also\fP
.RS 4
\fBSoBaseList::~SoBaseList()\fP 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "void SoPathList::append (\fBSoPath\fP *const path)"
Append \fIptr\fP to the list\&.

.PP
\fBSee also\fP
.RS 4
\fBSoBaseList::append()\fP 
.RE
.PP

.SS "\fBSoPath\fP * SoPathList::operator[] (const int i) const"
Return node pointer at index \fIi\fP\&.

.PP
\fBSee also\fP
.RS 4
\fBSoBaseList::operator[]()\fP 
.RE
.PP

.SS "\fBSoPathList\fP & SoPathList::operator= (const \fBSoPathList\fP & pl)"
Shallow copy of contents of list \fIpl\fP to this list\&.

.PP
\fBSee also\fP
.RS 4
\fBSoBaseList::operator=()\fP 
.RE
.PP

.SS "int SoPathList::findPath (const \fBSoPath\fP & path) const"
Find and return index of first item equal to \fIpath\fP\&. 
.SS "void SoPathList::sort (void )"
Sort paths in list according to how early they are run into when traversing the scene graph\&. 
.SS "void SoPathList::uniquify (void )"
Removes identical paths and paths that go through the tail of another path\&.

.PP
Note that this method assumes the list to be in a sorted order\&.

.PP
\fBSee also\fP
.RS 4
\fBsort()\fP 
.RE
.PP


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