ISplineSelectData Class Reference
 
 
 
ISplineSelectData Class Reference

#include <istdplug.h>

Inheritance diagram for ISplineSelectData:
MaxHeapOperators SplineShape

Class Description

See also:
Class ISplineSelect, Class Animatable, Class BitArray, Working with Shapes and Splines, Class GenericNamedSelSetList.

Description:
When a developer gets the LocalModData from the ModContext of the Spline Select Modifier, they may cast it to this class and use these methods. They may be used to get/set the vertex/segment/spline selection state of the modifier as well as the named selection sets.

To obtain a pointer to this class use the method Animatable::GetInterface() passing I_SPLINESELECTDATA.

For example:

ISplineSelectData *iss = (ISplineSelectData*)anim->GetInterface(I_SPLINESELECTDATA));

BitArray vs = iss->GetVertSel();

Public Member Functions

virtual BitArray  GetVertSel ()=0
virtual BitArray  GetSegmentSel ()=0
virtual BitArray  GetSplineSel ()=0
virtual void  SetVertSel (BitArray &set, ISplineSelect *imod, TimeValue t)=0
virtual void  SetSegmentSel (BitArray &set, ISplineSelect *imod, TimeValue t)=0
virtual void  SetSplineSel (BitArray &set, ISplineSelect *imod, TimeValue t)=0
virtual GenericNamedSelSetList GetNamedVertSelList ()=0
virtual GenericNamedSelSetList GetNamedSegmentSelList ()=0
virtual GenericNamedSelSetList GetNamedSplineSelList ()=0

Member Function Documentation

virtual BitArray GetVertSel ( ) [pure virtual]
Remarks:
Returns a BitArray that reflects the current vertex selection. There is one bit for each vertex. Bits that are 1 indicate the vertex is selected.

Implemented in SplineShape.

virtual BitArray GetSegmentSel ( ) [pure virtual]
Remarks:
Returns a BitArray that reflects the current segment selection. There is one bit for each segment. Bits that are 1 indicate the segment is selected.

Implemented in SplineShape.

virtual BitArray GetSplineSel ( ) [pure virtual]
Remarks:
Returns a BitArray that reflects the current spline selection. There is one bit for each spline. Bits that are 1 indicate the spline is selected.

Implemented in SplineShape.

virtual void SetVertSel ( BitArray set,
ISplineSelect imod,
TimeValue  t 
) [pure virtual]
Remarks:
Sets the vertex selection of the modifier.
Parameters:
BitArray &set

There is one bit for each vertex. Bits that are 1 indicate the vertex should be selected.

ISplineSelect *imod

Points to the ISplineSelect instance (generally this is a modifier).

TimeValue t

The current time at which the call is made.

Implemented in SplineShape.

virtual void SetSegmentSel ( BitArray set,
ISplineSelect imod,
TimeValue  t 
) [pure virtual]
Remarks:
Sets the segment selection of the modifier.
Parameters:
BitArray &set

There is one bit for each vertex. Bits that are 1 indicate the segment should be selected.

ISplineSelect *imod

Points to the ISplineSelect instance (generally this is a modifier).

TimeValue t

The current time at which the call is made.

Implemented in SplineShape.

virtual void SetSplineSel ( BitArray set,
ISplineSelect imod,
TimeValue  t 
) [pure virtual]
Remarks:
Sets the spline selection of the modifier.
Parameters:
BitArray &set

There is one bit for each spline. Bits that are 1 indicate the spline should be selected.

ISplineSelect *imod

Points to the ISplineSelect instance (generally this is a modifier).

TimeValue t

The current time at which the call is made.

Implemented in SplineShape.

virtual GenericNamedSelSetList& GetNamedVertSelList ( ) [pure virtual]
Remarks:
Returns a reference to a class used for manipulating the lists of vertex level named selection sets associated with this modifier.

Implemented in SplineShape.

virtual GenericNamedSelSetList& GetNamedSegmentSelList ( ) [pure virtual]
Remarks:
Returns a reference to a class used for manipulating the lists of segment level named selection sets associated with this modifier.

Implemented in SplineShape.

virtual GenericNamedSelSetList& GetNamedSplineSelList ( ) [pure virtual]
Remarks:
Returns a reference to a class used for manipulating the lists of spline level named selection sets associated with this modifier.

Implemented in SplineShape.