Detailed Description
- See also:
- Class Animatable, Working with
Patches.
- Description:
- This class is available in release 3.0 and later only.
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);
#include <istdplug.h>
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) |
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 | ||
| ) | [inline, virtual] |
- 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 | ||
| ) | [inline, virtual] |
- 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 | ||
| ) | [inline, virtual] |
- 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 | ||
| ) | [inline, virtual] |
- 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.
{ }
