IPatchOps Class Reference

#include <istdplug.h>

Class Description

See also

Class Animatable, Patches and Faces.

Description:

This class provides an interface to the command modes and button press operations of the Editable Patch object. To obtain a pointer to this class use the method Animatable::GetInterface() passing I_PATCHOPS.

For example:

IPatchOps ipo = (IPatchOps)anim->GetInterface(I_PATCHOPS));

ipo->StartCommandMode(PcmAttach);

Inheritance diagram for IPatchOps:

Public Member Functions
virtual void	StartCommandMode (patchCommandMode mode)=0
virtual void	ButtonOp (patchButtonOp opcode)=0
virtual void	GetUIParam (patchUIParam uiCode, int &ret)
virtual void	SetUIParam (patchUIParam uiCode, int val)
virtual void	GetUIParam (patchUIParam uiCode, float &ret)
virtual void	SetUIParam (patchUIParam uiCode, float val)

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...

Member Function Documentation

virtual void StartCommandMode ( patchCommandMode  mode )

pure virtual

Remarks

Begins the specified interactive command mode.

Parameters:

patchCommandMode mode

PcmAttach

PcmExtrude

PcmBevel

PcmCreate

PcmWeldTarget

PcmFlipNormal

PcmBind

Implemented in PatchObject.

virtual void ButtonOp ( patchButtonOp  opcode )

pure virtual

Remarks

Performs the same operation as a button press inside the Editable Patch UI.

Parameters:

patchButtonOp opcode

The button operation to execute. One of the following values:

PopBind

PopUnbind

PopHide

PopUnhideAll

PopWeld

PopDelete

PopSubdivide

PopAddTri

PopAddQuad

PopDetach

Implemented in PatchObject.

virtual void GetUIParam ( patchUIParam  uiCode, int &  ret  )

inlinevirtual

Remarks

This method allows you to get the edit patch parameters from the command panel. Currently not in use.

Parameters:

patchUIParam uiCode

This enum is currently empty.

int &ret

The returned value.

Default Implementation:

{ }

Reimplemented in PatchObject.

{ }

virtual void SetUIParam ( patchUIParam  uiCode, int  val  )

inlinevirtual

Remarks

This method allows you to set the edit patch parameters from the command panel. Currently not in use.

Parameters:

patchUIParam uiCode

This enum is currently empty.

int val

The value to set.

Default Implementation:

{ }

Reimplemented in PatchObject.

{ }

virtual void GetUIParam ( patchUIParam  uiCode, float &  ret  )

inlinevirtual

Remarks

This method allows you to get the edit patch parameters from the command panel. Currently not in use.

Parameters:

patchUIParam uiCode

This enum is currently empty.

float &ret

The returned value.

Default Implementation:

{ }

Reimplemented in PatchObject.

{ }

virtual void SetUIParam ( patchUIParam  uiCode, float  val  )

inlinevirtual

Remarks

This method allows you to set the edit patch parameters from the command panel. Currently not in use.

Parameters:

patchUIParam uiCode

This enum is currently empty.

float val

The value to set.

Default Implementation:

{ }

Reimplemented in PatchObject.

{ }