Public Types | Public Member Functions

IWorkBench Class Reference

Search for all occurrences

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

#include <AnimationWBImp.h>

Inheritance diagram for IWorkBench:
Inheritance graph
[legend]

List of all members.

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 Member Functions

  DECLARE_DESCRIPTOR (IWorkBench)
virtual void  Open ()
  Open the Workbench dialog.
virtual void  ToggleShowX ()
  Toggle showing the bipeds fcurve x axis.
virtual BOOL  GetShowX ()
  Retrieves display status of biped's fcurve X axis.
virtual void  ToggleShowY ()
  Toggle showing the bipeds fcurve y axis.
virtual BOOL  GetShowY ()
  Retrieves display status of biped's fcurve Y axis.
virtual void  ToggleShowZ ()
  Toggle showing the bipeds fcurve z axis.
virtual BOOL  GetShowZ ()
  Retrieves display status of biped's fcurve Z axis.
virtual void  ToggleLayerEdit ()
  Toggle showing the layer edit tool.
virtual BOOL  GetLayerEdit ()
  Get whether or not the z axis is shown.
virtual void  ToggleDrawDuringMove ()
  Toggle interactive drawing of the biped fcurve.
virtual BOOL  GetDrawDuringMove ()
  Get whether or not we interatively when moving the biped fcurve.
virtual void  ToggleLimit180 ()
  Toggle limiting biped euler curves to -180/180.
virtual BOOL  GetLimit180 ()
  Get whether or not euler curves are limited to -180/180.
virtual void  ShowQuatCurve ()
  Show the biped quaternion curves.
virtual void  ShowPosCurve ()
  Show the biped position curves.
virtual void  ShowAngSpeedCurve ()
  Show the biped angular speed curves.
virtual void  ShowAngAccelCurve ()
  Show the biped angular acceleration curves.
virtual void  ShowAngJerkCurve ()
  Show the biped angular jerk curves.
virtual void  ShowPosSpeedCurve ()
  Show the biped position speed curves.
virtual void  ShowPosAccelCurve ()
  Show the biped position acceleration curves.
virtual void  ShowPosJerkCurve ()
  Show the biped position jerk curves.
virtual void  PosCurveToWorld ()
  Show the biped position curve relative to the world origin.
virtual void  PosCurveToBipRoot ()
  Show the biped position curve relative to the biped's root node.
virtual void  PosCurveToThisNode (INode *node)
  Show the biped position curve relative to the passed in node.
BEGIN_FUNCTION_MAP  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)

Member Enumeration Documentation


Member Function Documentation

DECLARE_DESCRIPTOR ( IWorkBench  )
virtual void Open ( ) [virtual]

Open the Workbench dialog.

virtual void ToggleShowX ( ) [virtual]

Toggle showing the bipeds fcurve x axis.

virtual BOOL GetShowX ( ) [virtual]

Retrieves display status of biped's fcurve X axis.

Returns:
TRUE if X axis is displayed, otherwise FALSE
virtual void ToggleShowY ( ) [virtual]

Toggle showing the bipeds fcurve y axis.

virtual BOOL GetShowY ( ) [virtual]

Retrieves display status of biped's fcurve Y axis.

Returns:
TRUE if X axis is displayed, otherwise FALSE
virtual void ToggleShowZ ( ) [virtual]

Toggle showing the bipeds fcurve z axis.

virtual BOOL GetShowZ ( ) [virtual]

Retrieves display status of biped's fcurve Z axis.

Returns:
TRUE if Z axis is displayed, otherwise FALSE
virtual void ToggleLayerEdit ( ) [virtual]

Toggle showing the layer edit tool.

virtual BOOL GetLayerEdit ( ) [virtual]

Get whether or not the z axis is shown.

virtual void ToggleDrawDuringMove ( ) [virtual]

Toggle interactive drawing of the biped fcurve.

virtual BOOL GetDrawDuringMove ( ) [virtual]

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

virtual void ToggleLimit180 ( ) [virtual]

Toggle limiting biped euler curves to -180/180.

virtual BOOL GetLimit180 ( ) [virtual]

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

virtual void ShowQuatCurve ( ) [virtual]

Show the biped quaternion curves.

virtual void ShowPosCurve ( ) [virtual]

Show the biped position curves.

virtual void ShowAngSpeedCurve ( ) [virtual]

Show the biped angular speed curves.

virtual void ShowAngAccelCurve ( ) [virtual]

Show the biped angular acceleration curves.

virtual void ShowAngJerkCurve ( ) [virtual]

Show the biped angular jerk curves.

virtual void ShowPosSpeedCurve ( ) [virtual]

Show the biped position speed curves.

virtual void ShowPosAccelCurve ( ) [virtual]

Show the biped position acceleration curves.

virtual void ShowPosJerkCurve ( ) [virtual]

Show the biped position jerk curves.

virtual void PosCurveToWorld ( ) [virtual]

Show the biped position curve relative to the world origin.

virtual void PosCurveToBipRoot ( ) [virtual]

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

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

IWorkBench IWorkBench IWorkBench IWorkBench IWorkBench IWorkBench IWorkBench IWorkBench IWorkBench IWorkBench
IWorkBench IWorkBench IWorkBench IWorkBench IWorkBench IWorkBench IWorkBench IWorkBench IWorkBench IWorkBench