IPatchSelectData Class Reference

#include <istdplug.h>

Class Description

See also

Class IPatchSelect, Class Animatable, Class BitArray, Patches and Faces, Class GenericNamedSelSetList.

Description:

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();

Inheritance diagram for IPatchSelectData:

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

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Member Function Documentation

virtual BitArray GetVecSel ( )

pure virtual

Implemented in PatchObject.

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

Implemented in PatchObject.

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

Implemented in PatchObject.

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.