Public Member Functions | Public Attributes

ShapeSSel Class Reference

Search for all occurrences

Detailed Description

See also:
Class BitArray, Class PolyShape.

Description:
This class stores and provides access to shape segment selection data. All methods of this class are implemented by the system.
Data Members:
int polys;

The number of splines in the shape.

BitArray *sel;

An array of BitArrays, one for each spline.

#include <shpsels.h>

Inheritance diagram for ShapeSSel:
Inheritance graph
[legend]

List of all members.

Public Member Functions

CoreExport  ShapeSSel ()
CoreExport  ShapeSSel (ShapeSSel &from)
CoreExport  ~ShapeSSel ()
CoreExport ShapeSSel operator= (ShapeSSel &from)
CoreExport BOOL  operator== (ShapeSSel &s)
CoreExport void  Insert (int where, int count=0)
CoreExport void  Delete (int where)
CoreExport void  SetSize (ShapeSSel &selset, BOOL save=FALSE)
CoreExport void  SetSize (BezierShape &shape, BOOL save=FALSE)
CoreExport void  SetSize (PolyShape &shape, BOOL save=FALSE)
CoreExport BitArray operator[] (int index)
CoreExport void  ClearAll ()
CoreExport void  SetAll ()
CoreExport void  Toggle ()
CoreExport void  Empty ()
CoreExport BOOL  IsCompatible (ShapeSSel &selset)
CoreExport BOOL  IsCompatible (BezierShape &shape)
CoreExport BOOL  IsCompatible (PolyShape &shape)
CoreExport IOResult  Save (ISave *isave)
CoreExport IOResult  Load (ILoad *iload)
CoreExport bool  Delete (const unsigned int *pIndices, unsigned int n)
  Delete multiple entries at once.

Public Attributes

int  polys
BitArray sel

Constructor & Destructor Documentation

CoreExport ShapeSSel ( )
Remarks:
Constructor. Initialize the class members.

Constructor. The number of splines is set to 0. The BitArray pointer is set to NULL.
CoreExport ShapeSSel ( ShapeSSel from )
CoreExport ~ShapeSSel ( )
Remarks:
Destructor. Any BitArrays are freed.

Member Function Documentation

CoreExport ShapeSSel& operator= ( ShapeSSel from )
Remarks:
Assignment operator.
CoreExport BOOL operator== ( ShapeSSel s )
CoreExport void Insert ( int  where,
int  count = 0 
)
Remarks:
Creates and inserts a new BitArray into sel.
Parameters:
int where

The index into sel indicating where to insert the new BitArray.

int count=0

The number of bits in the new BitArray.
CoreExport void Delete ( int  where )
Remarks:
Deletes the specified BitArray from the sel list.
Parameters:
int where

The index into sel indicating which BitArray to delete.
CoreExport void SetSize ( ShapeSSel selset,
BOOL  save = FALSE 
)
CoreExport void SetSize ( BezierShape shape,
BOOL  save = FALSE 
)
Remarks:
Sets the number of splines and allocates the corresponding number of BitArrays based on the shape passed. The size of each BitArray is set to the number of segments in each polyline.
Parameters:
BezierShape& shape

The shape whose splines determine the sizes set.

BOOL save=FALSE

TRUE to keep the previous BitArray contents. FALSE to discard it.
CoreExport void SetSize ( PolyShape shape,
BOOL  save = FALSE 
)
Remarks:
Sets the number of splines and allocates the corresponding number of BitArrays based on the shape passed. The size of each BitArray is set to the number of segments in each spline.
Parameters:
PolyShape& shape

The shape whose lines determine the sizes set.

BOOL save=FALSE

TRUE to keep the previous BitArray contents. FALSE to discard it.
CoreExport BitArray& operator[] ( int  index )
CoreExport void ClearAll ( )
Remarks:
Clears every bit for every poly.
CoreExport void SetAll ( )
CoreExport void Toggle ( )
CoreExport void Empty ( )
Remarks:
Sets the size of every poly BitArray to 0.
CoreExport BOOL IsCompatible ( ShapeSSel selset )
CoreExport BOOL IsCompatible ( BezierShape shape )
CoreExport BOOL IsCompatible ( PolyShape shape )
CoreExport IOResult Save ( ISave isave )
Remarks:
Saves the ShapeSSel to disk.
CoreExport IOResult Load ( ILoad iload )
Remarks:
Loads the ShapeSSel from disk.
Operators:
CoreExport bool Delete ( const unsigned int *  pIndices,
unsigned int  n 
)

Delete multiple entries at once.

Deleting multiple entries at once is faster than deleting one by one by calling Delete(), because the internal bookkeeping only needs to be done once.

Parameters:
[in] indices Point to an array of indices to delete. Indices should be unique, and sorted in ascending order.
[in] n Number of entries in the indices array.
Returns:
false if any of the vertex indices are invalid.
See also:
ShapeSSel::Delete

Member Data Documentation

int polys

ShapeSSel ShapeSSel ShapeSSel ShapeSSel ShapeSSel ShapeSSel ShapeSSel ShapeSSel ShapeSSel ShapeSSel
ShapeSSel ShapeSSel ShapeSSel ShapeSSel ShapeSSel ShapeSSel ShapeSSel ShapeSSel ShapeSSel ShapeSSel