3ds Max C++ API Reference
IWorkBench Class Reference

The interface to the CS Workbench. More...

#include <AnimationWBImp.h>

+ Inheritance diagram for IWorkBench:

Public Types

enum  WorkBenchFunctions {
  toggleShowX = 0 , getShowX , toggleShowY , getShowY ,
  toggleShowZ , getShowZ , toggleLayerEdit , getLayerEdit ,
  toggleDrawDuringMove , getDrawDuringMove , toggleLimit180 , getLimit180 ,
  showQuatCurve , showPosCurve , showAngSpeedCurve , showAngAccelCurve ,
  showAngJerkCurve , showPosSpeedCurve , showPosAccelCurve , showPosJerkCurve ,
  posCurveToWorld , posCurveToBipRoot , posCurveToThisNode , open
}
 
- Public Types inherited from BaseInterface
enum  LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }
 

Public Member Functions

 DECLARE_DESCRIPTOR (IWorkBench)
 
virtual void Open ()
 Open the Workbench dialog. More...
 
virtual void ToggleShowX ()
 Toggle showing the bipeds fcurve x axis. More...
 
virtual BOOL GetShowX ()
 Retrieves display status of biped's fcurve X axis. More...
 
virtual void ToggleShowY ()
 Toggle showing the bipeds fcurve y axis. More...
 
virtual BOOL GetShowY ()
 Retrieves display status of biped's fcurve Y axis. More...
 
virtual void ToggleShowZ ()
 Toggle showing the bipeds fcurve z axis. More...
 
virtual BOOL GetShowZ ()
 Retrieves display status of biped's fcurve Z axis. More...
 
virtual void ToggleLayerEdit ()
 Toggle showing the layer edit tool. More...
 
virtual BOOL GetLayerEdit ()
 Get whether or not the z axis is shown. More...
 
virtual void ToggleDrawDuringMove ()
 Toggle interactive drawing of the biped fcurve. More...
 
virtual BOOL GetDrawDuringMove ()
 Get whether or not we interatively when moving the biped fcurve. More...
 
virtual void ToggleLimit180 ()
 Toggle limiting biped euler curves to -180/180. More...
 
virtual BOOL GetLimit180 ()
 Get whether or not euler curves are limited to -180/180. More...
 
virtual void ShowQuatCurve ()
 Show the biped quaternion curves. More...
 
virtual void ShowPosCurve ()
 Show the biped position curves. More...
 
virtual void ShowAngSpeedCurve ()
 Show the biped angular speed curves. More...
 
virtual void ShowAngAccelCurve ()
 Show the biped angular acceleration curves. More...
 
virtual void ShowAngJerkCurve ()
 Show the biped angular jerk curves. More...
 
virtual void ShowPosSpeedCurve ()
 Show the biped position speed curves. More...
 
virtual void ShowPosAccelCurve ()
 Show the biped position acceleration curves. More...
 
virtual void ShowPosJerkCurve ()
 Show the biped position jerk curves. More...
 
virtual void PosCurveToWorld ()
 Show the biped position curve relative to the world origin. More...
 
virtual void PosCurveToBipRoot ()
 Show the biped position curve relative to the biped's root node. More...
 
virtual void PosCurveToThisNode (INode *node)
 Show the biped position curve relative to the passed in node. More...
 
 VFN_0 (toggleShowX, ToggleShowX)
 
 FN_0 (getShowX, TYPE_BOOL, GetShowX)
 
 VFN_0 (toggleShowY, ToggleShowY)
 
 FN_0 (getShowY, TYPE_BOOL, GetShowY)
 
 VFN_0 (toggleShowZ, ToggleShowZ)
 
 FN_0 (getShowZ, TYPE_BOOL, GetShowZ)
 
 VFN_0 (toggleLayerEdit, ToggleLayerEdit)
 
 FN_0 (getLayerEdit, TYPE_BOOL, GetLayerEdit)
 
 VFN_0 (toggleDrawDuringMove, ToggleDrawDuringMove)
 
 FN_0 (getDrawDuringMove, TYPE_BOOL, GetDrawDuringMove)
 
 VFN_0 (toggleLimit180, ToggleLimit180)
 
 FN_0 (getLimit180, TYPE_BOOL, GetLimit180)
 
 VFN_0 (showQuatCurve, ShowQuatCurve)
 
 VFN_0 (showPosCurve, ShowPosCurve)
 
 VFN_0 (showAngSpeedCurve, ShowAngSpeedCurve)
 
 VFN_0 (showAngAccelCurve, ShowAngAccelCurve)
 
 VFN_0 (showAngJerkCurve, ShowAngJerkCurve)
 
 VFN_0 (showPosSpeedCurve, ShowPosSpeedCurve)
 
 VFN_0 (showPosAccelCurve, ShowPosAccelCurve)
 
 VFN_0 (showPosJerkCurve, ShowPosJerkCurve)
 
 VFN_0 (posCurveToWorld, PosCurveToWorld)
 
 VFN_0 (posCurveToBipRoot, PosCurveToBipRoot)
 
 VFN_1 (posCurveToThisNode, PosCurveToThisNode, TYPE_INODE)
 
 VFN_0 (open, Open)
 
- Public Member Functions inherited from FPInterfaceDesc
CoreExport FPInterfaceDesc ()
 
CoreExport FPInterfaceDesc (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, ULONG flag,...)
 
CoreExport ~FPInterfaceDesc ()
 
virtual void Init ()
 
LifetimeType LifetimeControl ()
 
virtual BaseInterfaceGetInterface (Interface_ID id)
 
CoreExport void LoadDescriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *pCD, ULONG flag,...)
 
CoreExport void AppendFunction (int id,...)
 Add a new function to this interface descriptor. More...
 
CoreExport void AppendProperty (int id,...)
 Add a new property to this interface descriptor. More...
 
CoreExport void AppendEnum (int id,...)
 Add a new enum to this interface descriptor. More...
 
CoreExport void SetClassDesc (ClassDesc *i_cd)
 
CoreExport va_list check_fn (va_list ap, int id)
 
CoreExport va_list scan_fn (va_list ap, int id, int index)
 
CoreExport va_list check_prop (va_list ap, int id)
 
CoreExport va_list scan_prop (va_list ap, int id, int index)
 
CoreExport va_list check_enum (va_list ap, EnumID id)
 
CoreExport va_list scan_enum (va_list ap, EnumID id, int index)
 
FPInterfaceDescGetDesc ()
 
Interface_ID GetID ()
 
CoreExport FPFunctionDefGetFnDef (FunctionID fid)
 
ActionTableGetActionTable ()
 
CoreExport void EnableActions (BOOL onOff)
 
virtual CoreExport HINSTANCE HInstance ()
 
virtual CoreExport const MCHARGetRsrcString (StringResID id)
 
- Public Member Functions inherited from FPInterface
virtual CoreExport FPStatus Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)
 
virtual FPStatus Invoke (FunctionID fid, FPParams *params)
 
virtual CoreExport FPStatus Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)
 
virtual FPStatus Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)
 
virtual CoreExport FunctionID FindFn (const MCHAR *name)
 
virtual CoreExport BOOL IsEnabled (FunctionID actionID)
 
virtual CoreExport BOOL IsChecked (FunctionID actionID)
 
virtual CoreExport BOOL IsVisible (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsEnabled (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsChecked (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsVisible (FunctionID actionID)
 
- Public Member Functions inherited from BaseInterface
virtual UtilExport ~BaseInterface ()
 Destructor. More...
 
virtual bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual BaseInterfaceAcquireInterface ()
 
virtual void ReleaseInterface ()
 
virtual void DeleteInterface ()
 
virtual BaseInterfaceCloneInterface (void *remapDir=nullptr)
 
- Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor. More...
 
template<class InterfaceType >
InterfaceType * GetTypedInterface ()
 

Additional Inherited Members

- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary. More...
 
static UtilExport voidaligned_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...
 
- Public Attributes inherited from FPInterfaceDesc
Interface_ID ID
 
MSTR internal_name
 
StringResID description
 
ClassDesccd
 
USHORT flags
 
Tab< FPFunctionDef * > functions
 
Tab< FPPropDef * > props
 
Tab< FPEnum * > enumerations
 
MSPluginClasspc
 
Rolloutrollout
 
ActionTableaction_table
 
- Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc nullInterface
 
- Protected Member Functions inherited from FPInterfaceDesc
CoreExport void load_descriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, USHORT flag, va_list ap)
 
- Protected Member Functions inherited from FPInterface
virtual FPStatus _dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)
 

Detailed Description

The interface to the CS Workbench.

This class contains all of the functionality found in the UI of the workbench. Note that these functions also affect the drawing and viewing of CS curves in the normal trackview. Thus you can extend the normal curve editor, via quad menus, etc.. to basically work like the workbench. You get this interface by calling GetCOREInterface(WORKBENCH_INTERFACE)

See also
IWorkbench2
IAnylyzer
IFixer
IFilter

Member Enumeration Documentation

◆ WorkBenchFunctions

Enumerator
toggleShowX 
getShowX 
toggleShowY 
getShowY 
toggleShowZ 
getShowZ 
toggleLayerEdit 
getLayerEdit 
toggleDrawDuringMove 
getDrawDuringMove 
toggleLimit180 
getLimit180 
showQuatCurve 
showPosCurve 
showAngSpeedCurve 
showAngAccelCurve 
showAngJerkCurve 
showPosSpeedCurve 
showPosAccelCurve 
showPosJerkCurve 
posCurveToWorld 
posCurveToBipRoot 
posCurveToThisNode 
open 
119  {
126  };
@ getShowX
Definition: AnimationWBImp.h:120
@ getLimit180
Definition: AnimationWBImp.h:122
@ toggleShowY
Definition: AnimationWBImp.h:120
@ toggleLimit180
Definition: AnimationWBImp.h:122
@ posCurveToWorld
Definition: AnimationWBImp.h:124
@ showPosCurve
Definition: AnimationWBImp.h:123
@ open
Definition: AnimationWBImp.h:125
@ toggleDrawDuringMove
Definition: AnimationWBImp.h:121
@ getDrawDuringMove
Definition: AnimationWBImp.h:121
@ showQuatCurve
Definition: AnimationWBImp.h:123
@ showPosSpeedCurve
Definition: AnimationWBImp.h:124
@ showAngJerkCurve
Definition: AnimationWBImp.h:123
@ showPosJerkCurve
Definition: AnimationWBImp.h:124
@ posCurveToBipRoot
Definition: AnimationWBImp.h:124
@ getShowZ
Definition: AnimationWBImp.h:120
@ toggleShowX
Definition: AnimationWBImp.h:120
@ toggleShowZ
Definition: AnimationWBImp.h:120
@ toggleLayerEdit
Definition: AnimationWBImp.h:121
@ showPosAccelCurve
Definition: AnimationWBImp.h:124
@ getShowY
Definition: AnimationWBImp.h:120
@ posCurveToThisNode
Definition: AnimationWBImp.h:125
@ showAngAccelCurve
Definition: AnimationWBImp.h:123
@ showAngSpeedCurve
Definition: AnimationWBImp.h:123
@ getLayerEdit
Definition: AnimationWBImp.h:121

Member Function Documentation

◆ DECLARE_DESCRIPTOR()

DECLARE_DESCRIPTOR ( IWorkBench  )

◆ Open()

virtual void Open ( )
virtual

Open the Workbench dialog.

◆ ToggleShowX()

virtual void ToggleShowX ( )
virtual

Toggle showing the bipeds fcurve x axis.

◆ GetShowX()

virtual BOOL GetShowX ( )
virtual

Retrieves display status of biped's fcurve X axis.

Returns
TRUE if X axis is displayed, otherwise FALSE

◆ ToggleShowY()

virtual void ToggleShowY ( )
virtual

Toggle showing the bipeds fcurve y axis.

◆ GetShowY()

virtual BOOL GetShowY ( )
virtual

Retrieves display status of biped's fcurve Y axis.

Returns
TRUE if X axis is displayed, otherwise FALSE

◆ ToggleShowZ()

virtual void ToggleShowZ ( )
virtual

Toggle showing the bipeds fcurve z axis.

◆ GetShowZ()

virtual BOOL GetShowZ ( )
virtual

Retrieves display status of biped's fcurve Z axis.

Returns
TRUE if Z axis is displayed, otherwise FALSE

◆ ToggleLayerEdit()

virtual void ToggleLayerEdit ( )
virtual

Toggle showing the layer edit tool.

◆ GetLayerEdit()

virtual BOOL GetLayerEdit ( )
virtual

Get whether or not the z axis is shown.

◆ ToggleDrawDuringMove()

virtual void ToggleDrawDuringMove ( )
virtual

Toggle interactive drawing of the biped fcurve.

◆ GetDrawDuringMove()

virtual BOOL GetDrawDuringMove ( )
virtual

Get whether or not we interatively when moving the biped fcurve.

◆ ToggleLimit180()

virtual void ToggleLimit180 ( )
virtual

Toggle limiting biped euler curves to -180/180.

◆ GetLimit180()

virtual BOOL GetLimit180 ( )
virtual

Get whether or not euler curves are limited to -180/180.

◆ ShowQuatCurve()

virtual void ShowQuatCurve ( )
virtual

Show the biped quaternion curves.

◆ ShowPosCurve()

virtual void ShowPosCurve ( )
virtual

Show the biped position curves.

◆ ShowAngSpeedCurve()

virtual void ShowAngSpeedCurve ( )
virtual

Show the biped angular speed curves.

◆ ShowAngAccelCurve()

virtual void ShowAngAccelCurve ( )
virtual

Show the biped angular acceleration curves.

◆ ShowAngJerkCurve()

virtual void ShowAngJerkCurve ( )
virtual

Show the biped angular jerk curves.

◆ ShowPosSpeedCurve()

virtual void ShowPosSpeedCurve ( )
virtual

Show the biped position speed curves.

◆ ShowPosAccelCurve()

virtual void ShowPosAccelCurve ( )
virtual

Show the biped position acceleration curves.

◆ ShowPosJerkCurve()

virtual void ShowPosJerkCurve ( )
virtual

Show the biped position jerk curves.

◆ PosCurveToWorld()

virtual void PosCurveToWorld ( )
virtual

Show the biped position curve relative to the world origin.

◆ PosCurveToBipRoot()

virtual void PosCurveToBipRoot ( )
virtual

Show the biped position curve relative to the biped's root node.

◆ PosCurveToThisNode()

virtual void PosCurveToThisNode ( INode node)
virtual

Show the biped position curve relative to the passed in node.

Parameters
[in]node- The node the curve is relative to.

◆ VFN_0() [1/17]

VFN_0 ( toggleShowX  ,
ToggleShowX   
)

◆ FN_0() [1/6]

FN_0 ( getShowX  ,
TYPE_BOOL  ,
GetShowX   
)

◆ VFN_0() [2/17]

VFN_0 ( toggleShowY  ,
ToggleShowY   
)

◆ FN_0() [2/6]

FN_0 ( getShowY  ,
TYPE_BOOL  ,
GetShowY   
)

◆ VFN_0() [3/17]

VFN_0 ( toggleShowZ  ,
ToggleShowZ   
)

◆ FN_0() [3/6]

FN_0 ( getShowZ  ,
TYPE_BOOL  ,
GetShowZ   
)

◆ VFN_0() [4/17]

VFN_0 ( toggleLayerEdit  ,
ToggleLayerEdit   
)

◆ FN_0() [4/6]

FN_0 ( getLayerEdit  ,
TYPE_BOOL  ,
GetLayerEdit   
)

◆ VFN_0() [5/17]

◆ FN_0() [5/6]

◆ VFN_0() [6/17]

VFN_0 ( toggleLimit180  ,
ToggleLimit180   
)

◆ FN_0() [6/6]

FN_0 ( getLimit180  ,
TYPE_BOOL  ,
GetLimit180   
)

◆ VFN_0() [7/17]

VFN_0 ( showQuatCurve  ,
ShowQuatCurve   
)

◆ VFN_0() [8/17]

VFN_0 ( showPosCurve  ,
ShowPosCurve   
)

◆ VFN_0() [9/17]

◆ VFN_0() [10/17]

◆ VFN_0() [11/17]

VFN_0 ( showAngJerkCurve  ,
ShowAngJerkCurve   
)

◆ VFN_0() [12/17]

◆ VFN_0() [13/17]

◆ VFN_0() [14/17]

VFN_0 ( showPosJerkCurve  ,
ShowPosJerkCurve   
)

◆ VFN_0() [15/17]

VFN_0 ( posCurveToWorld  ,
PosCurveToWorld   
)

◆ VFN_0() [16/17]

◆ VFN_1()

◆ VFN_0() [17/17]

VFN_0 ( open  ,
Open   
)