SoPickedPointList(3)

NAME
SoPickedPointList - The SoPickedPointList class is a container for pointers to SoPickedPoint objects.

SYNOPSIS

#include <Inventor/lists/SoPickedPointList.h>

Inherits SbPList.

  Public Member Functions
SoPickedPointList (void)
SoPickedPointList (const int sizehint)
SoPickedPointList (const SoPickedPointList &l)
void append (SoPickedPoint *pp)
void insert (SoPickedPoint *pp, const int insertbefore)
SoPickedPoint * operator[] (const int idx) const
void truncate (const int start, const int fit=0)
void set (const int idx, SoPickedPoint *pp)

  Additional Inherited Members

Detailed Description

The SoPickedPointList class is a container for pointers to SoPickedPoint 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.

See also
    SbPList

Constructor & Destructor Documentation

  SoPickedPointList::SoPickedPointList (void) [inline]
Default constructor.

  SoPickedPointList::SoPickedPointList (const int sizehint) [inline]
This constructor initializes the internal allocated size for the list to sizehint. Note that the list will still initially contain zero items.

See also
    SbPList::SbPList(const int sizehint)

  SoPickedPointList::SoPickedPointList (const SoPickedPointList & l)
Copy constructor. Will copy picked points, not just pointers.

See also
    SbList::SbList(const SbList<Type> & l)

Member Function Documentation

  void SoPickedPointList::append (SoPickedPoint * pp) [inline]
Append item to the end of the list.

Automatically allocates more items internally if needed.

Overloaded from parent to accept an SoPickedPoint pointer argument.

See also
    SbPList::append()

  void SoPickedPointList::insert (SoPickedPoint * pp, const int insertbefore) [inline]
Insert item at index insertbefore.

insertbefore should not be larger than the current number of items in the list.

Overloaded from parent to accept an SoPickedPoint pointer argument.

See also
    SbPList::insert()

  SoPickedPoint * SoPickedPointList::operator[] (const int idx) const [inline]
Returns element at index.

Will automatically expand the size of the internal array if index is outside the current bounds of the list. The values of any additional pointers are then set to NULL.

Overloaded from parent to return an SoPickedPoint pointer.

See also
    SbPList::operator[]()

  void SoPickedPointList::truncate (const int start, const int fit = 0)
Shorten the list to contain length elements, removing items from index length and onwards.

If fit 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.

Overloaded from parent to delete truncated items.

See also
    SbPList::truncate()

  void SoPickedPointList::set (const int idx, SoPickedPoint * pp)
Index operator to set element at index. Does not expand array bounds if index is outside the list.

Overloaded from parent to destruct the replaced item.

See also
    SbPList::set()

Author

Generated automatically by Doxygen for Coin from the source code.