Class IPatchOps
See Also: Class Animatable, Working with Patches.
class IPatchOps
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);
Methods:
public:
Prototype:
virtual void StartCommandMode(patchCommandMode mode)=0;
Remarks:
Begins the specified interactive command mode.
Parameters:
patchCommandMode mode
PcmAttach
PcmExtrude
PcmBevel
PcmCreate
PcmWeldTarget
PcmFlipNormal
PcmBind
Prototype:
virtual void ButtonOp(patchButtonOp opcode)=0;
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
Prototype:
virtual void GetUIParam(patchUIParam uiCode, int &ret);
Remarks:
This method is available in release 4.0 and later only.
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:
{ }
Prototype:
virtual void SetUIParam(patchUIParam uiCode, int val);
Remarks:
This method is available in release 4.0 and later only.
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:
{ }
Prototype:
virtual void GetUIParam(patchUIParam uiCode, float &ret);
Remarks:
This method is available in release 4.0 and later only.
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:
{ }
Prototype:
virtual void SetUIParam(patchUIParam uiCode, float val);
Remarks:
This method is available in release 4.0 and later only.
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:
{ }