IMeshSelect Class Reference
 
 
 
IMeshSelect Class Reference

#include <istdplug.h>

Inheritance diagram for IMeshSelect:
MaxHeapOperators

Class Description

See also:
Class Mesh, Class LocalModData, Class IMeshSelectData.

Description:
This class provides access to selection data for the Mesh Select Modifier, Editable Mesh and Edit Mesh modifier.

To get a pointer to this interface given a pointer to a modifier or editable mesh object, use the following macro (defined in AnimatableInterfaceIDs.h ). Using this macro, given any Animatable, it is easy to ask for the interface.

#define GetMeshSelectInterface(anim) ((IMeshSelect*)anim->GetInterface(I_MESHSELECT))

A plug-in developer may use this macro as follows:

IMeshSelect *ims = GetMeshSelectInterface(anim);

This return value will either be NULL or a pointer to a valid Mesh Select interface.

Public Member Functions

virtual DWORD  GetSelLevel ()=0
virtual void  SetSelLevel (DWORD level)=0
virtual void  LocalDataChanged ()=0
virtual BOOL  HasWeightedVertSel ()
virtual BOOL  CanAssignWeightedVertSel ()

Member Function Documentation

virtual DWORD GetSelLevel ( ) [pure virtual]
Remarks:
Returns the current level of selection for the modifier.
Returns:
One of the following values:

IMESHSEL_OBJECT: Object level.

IMESHSEL_VERTEX: Vertex level.

IMESHSEL_FACE: Face level.

IMESHSEL_EDGE: Edge level.
virtual void SetSelLevel ( DWORD  level ) [pure virtual]
Remarks:
Sets the selection level of the modifier.
Parameters:
DWORD level

One of the following values:

IMESHSEL_OBJECT: Object level.

IMESHSEL_VERTEX: Vertex level.

IMESHSEL_FACE: Face level.

IMESHSEL_EDGE: Edge level.
virtual void LocalDataChanged ( ) [pure virtual]
Remarks:
This method must be called when the LocalModData of the modifier is changed. Developers can use the methods of IMeshSelectData to get and set the actual selection for vertex, face and edge. When a developers does set any of these selection sets this method must be called when done.
virtual BOOL HasWeightedVertSel ( ) [inline, virtual]
Remarks:
Returns TRUE if this modifier or object has weighted vertex selection data (Soft Selection data), FALSE if not.
Default Implementation:
{ return FALSE; }
{ return FALSE; }
virtual BOOL CanAssignWeightedVertSel ( ) [inline, virtual]
Remarks:
Returns TRUE if this modifier or object can assign weighted vertex selection data; FALSE if it cannot.
Default Implementation:
{ return FALSE; }
{ return FALSE; }