.TH "SoPickedPointList" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoPickedPointList \- The \fBSoPickedPointList\fP class is a container for pointers to \fBSoPickedPoint\fP objects\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBSbPList\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBSoPickedPointList\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBSoPickedPointList\fP (\fBconst\fP int \fBsizehint\fP)" .br .ti -1c .RI "\fBSoPickedPointList\fP (\fBconst\fP \fBSoPickedPointList\fP &\fBl\fP)" .br .ti -1c .RI "\fBvoid\fP \fBappend\fP (\fBSoPickedPoint\fP *\fBpp\fP)" .br .ti -1c .RI "\fBvoid\fP \fBinsert\fP (\fBSoPickedPoint\fP *\fBpp\fP, \fBconst\fP int \fBinsertbefore\fP)" .br .ti -1c .RI "\fBSoPickedPoint\fP * \fBoperator[]\fP (\fBconst\fP int idx) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBtruncate\fP (\fBconst\fP int start, \fBconst\fP int \fBfit\fP=0)" .br .ti -1c .RI "\fBvoid\fP \fBset\fP (\fBconst\fP int idx, \fBSoPickedPoint\fP *\fBpp\fP)" .br .in -1c Public Member Functions inherited from \fBSbPList\fP .in +1c .ti -1c .RI "\fBSbPList\fP (\fBconst\fP int \fBsizehint\fP=DEFAULTSIZE)" .br .ti -1c .RI "\fBSbPList\fP (\fBconst\fP \fBSbPList\fP &\fBl\fP)" .br .ti -1c .RI "\fB~SbPList\fP ()" .br .ti -1c .RI "\fBvoid\fP \fBcopy\fP (\fBconst\fP \fBSbPList\fP &\fBl\fP)" .br .ti -1c .RI "\fBSbPList\fP & \fBoperator=\fP (\fBconst\fP \fBSbPList\fP &\fBl\fP)" .br .ti -1c .RI "\fBvoid\fP \fBfit\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvoid\fP \fBappend\fP (\fBvoid\fP *\fBitem\fP)" .br .ti -1c .RI "int \fBfind\fP (\fBconst\fP \fBvoid\fP *\fBitem\fP) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBinsert\fP (\fBvoid\fP *\fBitem\fP, \fBconst\fP int \fBinsertbefore\fP)" .br .ti -1c .RI "\fBvoid\fP \fBremoveItem\fP (\fBvoid\fP *\fBitem\fP)" .br .ti -1c .RI "\fBvoid\fP \fBremove\fP (\fBconst\fP int index)" .br .ti -1c .RI "\fBvoid\fP \fBremoveFast\fP (\fBconst\fP int index)" .br .ti -1c .RI "int \fBgetLength\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBtruncate\fP (\fBconst\fP int length, \fBconst\fP int \fBfit\fP=0)" .br .ti -1c .RI "\fBvoid\fP ** \fBgetArrayPtr\fP (\fBconst\fP int start=0) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP *& \fBoperator[]\fP (\fBconst\fP int index) \fBconst\fP" .br .ti -1c .RI "int \fBoperator==\fP (\fBconst\fP \fBSbPList\fP &\fBl\fP) \fBconst\fP" .br .ti -1c .RI "int \fBoperator!=\fP (\fBconst\fP \fBSbPList\fP &\fBl\fP) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP * \fBget\fP (\fBconst\fP int index) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBset\fP (\fBconst\fP int index, \fBvoid\fP *\fBitem\fP)" .br .in -1c .SS "Additional Inherited Members" Protected Member Functions inherited from \fBSbPList\fP .in +1c .ti -1c .RI "\fBvoid\fP \fBexpand\fP (\fBconst\fP int size)" .br .ti -1c .RI "int \fBgetArraySize\fP (\fBvoid\fP) \fBconst\fP" .br .in -1c .SH "Detailed Description" .PP The \fBSoPickedPointList\fP class is a container for pointers to \fBSoPickedPoint\fP objects\&. This list class will delete the picked points when destructed/truncated, or when a picked point in the list is replaced by another picked point\&. The caller is responsible for allocating the picked points passed to the list, but should not deallocate them since this will be handled by the list\&. .PP \fBSee also\fP .RS 4 \fBSbPList\fP .RE .PP .SH "Constructor & Destructor Documentation" .PP .SS "SoPickedPointList::SoPickedPointList (\fBvoid\fP)\fC [inline]\fP" Default constructor\&. .SS "SoPickedPointList::SoPickedPointList (\fBconst\fP int sizehint)\fC [inline]\fP" This constructor initializes the internal allocated size for the list to \fIsizehint\fP\&. Note that the list will still initially contain zero items\&. .PP \fBSee also\fP .RS 4 \fBSbPList::SbPList(const int sizehint)\fP .RE .PP .SS "SoPickedPointList::SoPickedPointList (\fBconst\fP \fBSoPickedPointList\fP & l)" Copy constructor\&. Will copy picked points, not just pointers\&. .PP \fBSee also\fP .RS 4 \fBSbList::SbList(const SbList & l)\fP .RE .PP .SH "Member Function Documentation" .PP .SS "\fBvoid\fP SoPickedPointList::append (\fBSoPickedPoint\fP * pp)\fC [inline]\fP" Append \fIitem\fP to the end of the list\&. .PP Automatically allocates more items internally if needed\&. .PP Overloaded from parent to accept an \fBSoPickedPoint\fP pointer argument\&. .PP \fBSee also\fP .RS 4 \fBSbPList::append()\fP .RE .PP .SS "\fBvoid\fP SoPickedPointList::insert (\fBSoPickedPoint\fP * pp, \fBconst\fP int insertbefore)\fC [inline]\fP" Insert \fIitem\fP at index \fIinsertbefore\fP\&. .PP \fIinsertbefore\fP should not be larger than the current number of items in the list\&. .PP Overloaded from parent to accept an \fBSoPickedPoint\fP pointer argument\&. .PP \fBSee also\fP .RS 4 \fBSbPList::insert()\fP .RE .PP .SS "\fBSoPickedPoint\fP * SoPickedPointList::operator[] (\fBconst\fP int idx) const\fC [inline]\fP" Returns element at \fIindex\fP\&. .PP Will automatically expand the size of the internal array if \fIindex\fP is outside the current bounds of the list\&. The values of any additional pointers are then set to \fCNULL\fP\&. .PP Overloaded from parent to return an \fBSoPickedPoint\fP pointer\&. .PP \fBSee also\fP .RS 4 \fBSbPList::operator[]()\fP .RE .PP .SS "\fBvoid\fP SoPickedPointList::truncate (\fBconst\fP int start, \fBconst\fP int fit = \fC0\fP)" Shorten the list to contain \fIlength\fP elements, removing items from \fIindex\fP \fIlength\fP and onwards\&. .PP If \fIfit\fP is non-zero, will also shrink the internal size of the allocated array\&. Note that this is much less efficient than not re-fitting the array size\&. .PP Overloaded from parent to delete truncated items\&. .PP \fBSee also\fP .RS 4 \fBSbPList::truncate()\fP .RE .PP .SS "\fBvoid\fP SoPickedPointList::set (\fBconst\fP int idx, \fBSoPickedPoint\fP * pp)" Index operator to set element at \fIindex\fP\&. Does \fInot\fP expand array bounds if \fIindex\fP is outside the list\&. .PP Overloaded from parent to destruct the replaced item\&. .PP \fBSee also\fP .RS 4 \fBSbPList::set()\fP .RE .PP .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.