Public Member Functions

IPatchSelectData Class Reference

Search for all occurrences

Detailed Description

See also:
Class IPatchSelect, Class Animatable, Class BitArray, Working with Patches, Class GenericNamedSelSetList.

Description:
This class is available in release 3.0 and later only.

When a developer gets the LocalModData from the ModContext of the Patch Select Modifier, they may cast it to this class and use these methods. They may be used to get/set the vertex/edge/patch sub-object 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_PATCHSELECTDATA.

For example:

IPatchSelectData *ips = (IPatchSelectData*)anim->GetInterface(I_PATCHSELECTDATA));

BitArray vs = ips->GetVertSel();

#include <istdplug.h>

Inheritance diagram for IPatchSelectData:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual BitArray  GetVecSel ()=0
virtual BitArray  GetVertSel ()=0
virtual BitArray  GetEdgeSel ()=0
virtual BitArray  GetPatchSel ()=0
virtual void  SetVecSel (BitArray &set, IPatchSelect *imod, TimeValue t)=0
virtual void  SetVertSel (BitArray &set, IPatchSelect *imod, TimeValue t)=0
virtual void  SetEdgeSel (BitArray &set, IPatchSelect *imod, TimeValue t)=0
virtual void  SetPatchSel (BitArray &set, IPatchSelect *imod, TimeValue t)=0
virtual GenericNamedSelSetList GetNamedVecSelList ()=0
virtual GenericNamedSelSetList GetNamedVertSelList ()=0
virtual GenericNamedSelSetList GetNamedEdgeSelList ()=0
virtual GenericNamedSelSetList GetNamedPatchSelList ()=0

Member Function Documentation

virtual BitArray GetVecSel ( ) [pure virtual]
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 PatchObject.

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

Implemented in PatchObject.

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

Implemented in PatchObject.

virtual void SetVecSel ( BitArray set,
IPatchSelect imod,
TimeValue  t 
) [pure virtual]
virtual void SetVertSel ( BitArray set,
IPatchSelect 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.

IPatchSelect *imod

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

TimeValue t

The current time at which the call is made.

Implemented in PatchObject.

virtual void SetEdgeSel ( BitArray set,
IPatchSelect imod,
TimeValue  t 
) [pure virtual]
Remarks:
Sets the edge selection of the modifier.
Parameters:
BitArray &set

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

IPatchSelect *imod

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

TimeValue t

The current time at which the call is made.

Implemented in PatchObject.

virtual void SetPatchSel ( BitArray set,
IPatchSelect imod,
TimeValue  t 
) [pure virtual]
Remarks:
Sets the patch selection of the modifier.
Parameters:
BitArray &set

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

IPatchSelect *imod

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

TimeValue t

The current time at which the call is made.

Implemented in PatchObject.

virtual GenericNamedSelSetList& GetNamedVecSelList ( ) [pure virtual]
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 PatchObject.

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

Implemented in PatchObject.

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

Implemented in PatchObject.


IPatchSelectData IPatchSelectData IPatchSelectData IPatchSelectData IPatchSelectData IPatchSelectData IPatchSelectData IPatchSelectData IPatchSelectData IPatchSelectData
IPatchSelectData IPatchSelectData IPatchSelectData IPatchSelectData IPatchSelectData IPatchSelectData IPatchSelectData IPatchSelectData IPatchSelectData IPatchSelectData