IFixer Class Reference

Interface for perfoming workbench fixer functions. More...

#include <AnimationWBImp.h>

Inheritance diagram for IFixer:

Public Types
enum	FilterFunctions {   doAngSmoothing = 0 , doAngBlurring , doAdvAngSmoothing , doPosSmoothing ,   doPosBlurring , doRemoveKeys , doKneeWobbleFix , doKneeExtensionFix }
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }

Public Member Functions
	DECLARE_DESCRIPTOR (IFixer)
virtual void	DoAngSmoothing (Tab< INode * > &nodes, int width, float damping)
	Perform Angular Smooth fixing on the passed in biped nodes.
virtual void	DoAngBlurring (Tab< INode * > &nodes, int width, float damping)
	Perform Angular Blur fixing on the passed in biped nodes.
virtual void	DoAdvAngSmoothing (Tab< INode * > &nodes, int width, float damping)
	Perform Advanced Angular Smooth fixing on the passed in biped nodes.
virtual void	DoPosSmoothing (Tab< INode * > &nodes, int width, float damping)
	Perform Position Smooth fixing on the passed in biped nodes.
virtual void	DoPosBlurring (Tab< INode * > &nodes, int width, float damping)
	Perform Position Blur fixing on the passed in biped nodes.
virtual void	DoRemoveKeys (Tab< INode * > &nodes, int intervalWidth, BOOL deleteKeys)
	Perform Remove Key fixing on the passed in biped nodes.
virtual void	DoKneeWobbleFix (Tab< INode * > &nodes, float frameThreshold, float fluctuationThreshold)
	Perform Knee Wobble Fix.
virtual void	DoKneeExtensionFix (Tab< INode * > &nodes, float kneeAngle)
	Perform Knee Extension Fix.
	VFN_3 (doAngSmoothing, DoAngSmoothing, TYPE_INODE_TAB_BR, TYPE_INT, TYPE_FLOAT)
	VFN_3 (doAngBlurring, DoAngBlurring, TYPE_INODE_TAB_BR, TYPE_INT, TYPE_FLOAT)
	VFN_3 (doAdvAngSmoothing, DoAdvAngSmoothing, TYPE_INODE_TAB_BR, TYPE_INT, TYPE_FLOAT)
	VFN_3 (doPosSmoothing, DoPosSmoothing, TYPE_INODE_TAB_BR, TYPE_INT, TYPE_FLOAT)
	VFN_3 (doPosBlurring, DoPosBlurring, TYPE_INODE_TAB_BR, TYPE_INT, TYPE_FLOAT)
	VFN_3 (doRemoveKeys, DoRemoveKeys, TYPE_INODE_TAB_BR, TYPE_INT, TYPE_BOOL)
	VFN_3 (doKneeWobbleFix, DoKneeWobbleFix, TYPE_INODE_TAB_BR, TYPE_FLOAT, TYPE_FLOAT)
	VFN_2 (doKneeExtensionFix, DoKneeExtensionFix, TYPE_INODE_TAB_BR, TYPE_FLOAT)
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 BaseInterface *	GetInterface (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.
CoreExport void	AppendProperty (int id,...)
	Add a new property to this interface descriptor.
CoreExport void	AppendEnum (int id,...)
	Add a new enum to this interface descriptor.
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)
FPInterfaceDesc *	GetDesc ()
Interface_ID	GetID ()
CoreExport FPFunctionDef *	GetFnDef (FunctionID fid)
ActionTable *	GetActionTable ()
CoreExport void	EnableActions (BOOL onOff)
virtual CoreExport HINSTANCE	HInstance ()
virtual CoreExport const MCHAR *	GetRsrcString (StringResID id)
Public Member Functions inherited from FPInterface
virtual BaseInterface *	GetInterface (Interface_ID id)
virtual FPInterfaceDesc *	GetDesc ()=0
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)
virtual ActionTable *	GetActionTable ()
virtual void	EnableActions (BOOL onOff)
Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor.
UtilExport BaseInterface *	GetInterface (Interface_ID id) override
virtual UtilExport Interface_ID	GetID ()
virtual LifetimeType	LifetimeControl ()
virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual BaseInterface *	AcquireInterface ()
virtual void	ReleaseInterface ()
virtual void	DeleteInterface ()
virtual BaseInterface *	CloneInterface (void *remapDir=nullptr)
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.
Public Attributes inherited from FPInterfaceDesc
Interface_ID	ID
MSTR	internal_name
StringResID	description
ClassDesc *	cd
USHORT	flags
Tab< FPFunctionDef * >	functions
Tab< FPPropDef * >	props
Tab< FPEnum * >	enumerations
MSPluginClass *	pc
Rollout *	rollout
ActionTable *	action_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

Interface for perfoming workbench fixer functions.

This class peforms workbench functions related to the fixing of fcurves.
Fixing is done after analysis is done and works by fixing the analysis detection locations.

See also

IAnalysis You get this interface by calling GetCOREInterface(FIXER_INTERFACE)

IWorkbench

Member Enumeration Documentation

FilterFunctions

enum FilterFunctions

Enumerator
doAngSmoothing
doAngBlurring
doAdvAngSmoothing
doPosSmoothing
doPosBlurring
doRemoveKeys
doKneeWobbleFix
doKneeExtensionFix

    {
        doAngSmoothing = 0,
        doAngBlurring,
        doAdvAngSmoothing,
        doPosSmoothing,
        doPosBlurring,
        doRemoveKeys,
        doKneeWobbleFix,
        doKneeExtensionFix
    };

Member Function Documentation

DECLARE_DESCRIPTOR()

DECLARE_DESCRIPTOR

(

IFixer

)

DoAngSmoothing()

virtual void DoAngSmoothing ( Tab< INode * > &  nodes, int  width, float  damping  )

virtual

Perform Angular Smooth fixing on the passed in biped nodes.

Parameters

[in]	nodes	The nodes which to fix.
[in]	width	How many frames to do the fixing over.
[in]	damping	Damping value.

DoAngBlurring()

virtual void DoAngBlurring ( Tab< INode * > &  nodes, int  width, float  damping  )

virtual

Perform Angular Blur fixing on the passed in biped nodes.

Parameters

[in]	nodes	The nodes which to fix.
[in]	width	How many frames to do the fixing over.
[in]	damping	Damping value.

DoAdvAngSmoothing()

virtual void DoAdvAngSmoothing ( Tab< INode * > &  nodes, int  width, float  damping  )

virtual

Perform Advanced Angular Smooth fixing on the passed in biped nodes.

Parameters

[in]	nodes	- The nodes which to fix.
[in]	width	- How many frames to do the fixing over.
[in]	damping	- Damping value.

DoPosSmoothing()

virtual void DoPosSmoothing ( Tab< INode * > &  nodes, int  width, float  damping  )

virtual

Perform Position Smooth fixing on the passed in biped nodes.

Parameters

[in]	nodes	The nodes which to fix.
[in]	width	How many frames to do the fixing over.
[in]	damping	Damping value.

DoPosBlurring()

virtual void DoPosBlurring ( Tab< INode * > &  nodes, int  width, float  damping  )

virtual

Perform Position Blur fixing on the passed in biped nodes.

Parameters

[in]	nodes	The nodes which to fix.
[in]	width	How many frames to do the fixing over.
[in]	damping	Damping value.

DoRemoveKeys()

virtual void DoRemoveKeys ( Tab< INode * > &  nodes, int  intervalWidth, BOOL  deleteKeys  )

virtual

Perform Remove Key fixing on the passed in biped nodes.

Removes keys as the fix.

Parameters

[in]	nodes	The nodes which to fix.
[in]	intervalWidth	How many frames to do the fixing over.
[in]	deleteKeys	Whether or not to delete the keys or just move them as the fix.

DoKneeWobbleFix()

virtual void DoKneeWobbleFix ( Tab< INode * > &  nodes, float  frameThreshold, float  fluctuationThreshold  )

virtual

Perform Knee Wobble Fix.

Parameters

[in]	nodes	The nodes which to fix.
[in]	frameThreshold	How much time, in terms of frames, that the calculation will use to fix the wobble.
[in]	fluctuationThreshold	How much deviation will that will trigger a detection. In degrees, from 0 to 360.

DoKneeExtensionFix()

virtual void DoKneeExtensionFix ( Tab< INode * > &  nodes, float  kneeAngle  )

virtual

Perform Knee Extension Fix.

Parameters

[in]	nodes	The nodes which to fix.
[in]	kneeAngle	Knee Angle. In degrees, from 0 to 360.

VFN_3() [1/7]

VFN_3	(	doAngSmoothing	,
		DoAngSmoothing	,
		TYPE_INODE_TAB_BR	,
		TYPE_INT	,
		TYPE_FLOAT
	)

VFN_3() [2/7]

VFN_3	(	doAngBlurring	,
		DoAngBlurring	,
		TYPE_INODE_TAB_BR	,
		TYPE_INT	,
		TYPE_FLOAT
	)

VFN_3() [3/7]

VFN_3	(	doAdvAngSmoothing	,
		DoAdvAngSmoothing	,
		TYPE_INODE_TAB_BR	,
		TYPE_INT	,
		TYPE_FLOAT
	)

VFN_3() [4/7]

VFN_3	(	doPosSmoothing	,
		DoPosSmoothing	,
		TYPE_INODE_TAB_BR	,
		TYPE_INT	,
		TYPE_FLOAT
	)

VFN_3() [5/7]

VFN_3	(	doPosBlurring	,
		DoPosBlurring	,
		TYPE_INODE_TAB_BR	,
		TYPE_INT	,
		TYPE_FLOAT
	)

VFN_3() [6/7]

VFN_3	(	doRemoveKeys	,
		DoRemoveKeys	,
		TYPE_INODE_TAB_BR	,
		TYPE_INT	,
		TYPE_BOOL
	)

VFN_3() [7/7]

VFN_3	(	doKneeWobbleFix	,
		DoKneeWobbleFix	,
		TYPE_INODE_TAB_BR	,
		TYPE_FLOAT	,
		TYPE_FLOAT
	)

VFN_2()

VFN_2	(	doKneeExtensionFix	,
		DoKneeExtensionFix	,
		TYPE_INODE_TAB_BR	,
		TYPE_FLOAT
	)