#include <AnimationWBImp.h>

Class Description

Interface for perfoming workbench analysis functions.

This class peforms workbench functions related to analysis of biped fcurves. After analysis, a user may want to perform fixing

See also: IFixer. You get this interface by calling GetCOREInterface(ANALYZER_INTERFACE); IWorkbench

Inheritance diagram for IAnalyzer:

Public Types
enum	AnalyzeFunctions { doNoiseDetectorAnalysis = 0, doSpikeDetectorAnalysis, getResults, loadAnalysisFile, saveAnalysisFile, clearAnalysisResults, doKneeWobbleAnalysis, doKneeExtensionAnalysis }

Public Types inherited from BaseInterface
enum	LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }

Public Member Functions
	DECLARE_DESCRIPTOR (IAnalyzer)

virtual void	DoNoiseDetectorAnalysis (Tab< INode * > &nodesToAnalyze, Interval range, float deviation, BOOL angular, int noiseType, INode *pNode)
	Perform Noise Detection on the passed in biped nodes. More...

virtual void	DoSpikeDetectorAnalysis (Tab< INode * > &nodesToAnalyze, Interval range, float deviation)
	Perform Spike Detection on the passed in biped nodes. More...

virtual void	DoKneeWobbleAnalysis (Tab< INode * > &nodesToAnalyze, Interval range, float frameThreshold, float fluctuationThreshold)
	Perform Knee Wobble on the passed in biped nodes. More...

virtual void	DoKneeExtensionAnalysis (Tab< INode * > &nodesToAnalyze, Interval range, float kneeAngle)
	Perform Knee Extenstion detection on the passed in biped nodes. More...

virtual Tab< TimeValue >	GetResults (INode *node)
	Get The results of any analysis. More...

virtual void	LoadAnalysisFile (const MCHAR *filename)
	Load an analysis file. More...

virtual void	SaveAnalysisFile (Tab< INode * > &nodes, const MCHAR *filename)
	Save the analysis file. More...

virtual void	ClearAnalysisResults ()
	Clear all of the analysis results. Does so for every node. More...

	VFN_6 (doNoiseDetectorAnalysis, DoNoiseDetectorAnalysis, TYPE_INODE_TAB_BR, TYPE_INTERVAL, TYPE_FLOAT, TYPE_BOOL, TYPE_INT, TYPE_INODE)

	VFN_3 (doSpikeDetectorAnalysis, DoSpikeDetectorAnalysis, TYPE_INODE_TAB_BR, TYPE_INTERVAL, TYPE_FLOAT)

	FN_1 (getResults, TYPE_TIMEVALUE_TAB_BV, GetResults, TYPE_INODE)

	VFN_1 (loadAnalysisFile, LoadAnalysisFile, TYPE_FILENAME)

	VFN_2 (saveAnalysisFile, SaveAnalysisFile, TYPE_INODE_TAB_BR, TYPE_FILENAME)

	VFN_0 (clearAnalysisResults, ClearAnalysisResults)

	VFN_4 (doKneeWobbleAnalysis, DoKneeWobbleAnalysis, TYPE_INODE_TAB_BR, TYPE_INTERVAL, TYPE_FLOAT, TYPE_FLOAT)

	VFN_3 (doKneeExtensionAnalysis, DoKneeExtensionAnalysis, TYPE_INODE_TAB_BR, TYPE_INTERVAL, 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. 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)

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 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 BaseInterface *	AcquireInterface ()

virtual void	ReleaseInterface ()

virtual void	DeleteInterface ()

virtual BaseInterface *	CloneInterface (void *remapDir=NULL)

Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...

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. More...

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. More...

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. 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 void *	operator 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...

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)

Member Enumeration Documentation

enum AnalyzeFunctions

Enumerator
doNoiseDetectorAnalysis
doSpikeDetectorAnalysis
getResults
loadAnalysisFile
saveAnalysisFile
clearAnalysisResults
doKneeWobbleAnalysis
doKneeExtensionAnalysis

     {
         doNoiseDetectorAnalysis = 0,
         doSpikeDetectorAnalysis,
         getResults,
         loadAnalysisFile,
         saveAnalysisFile,
         clearAnalysisResults,
         doKneeWobbleAnalysis,
         doKneeExtensionAnalysis
     };

Member Function Documentation

DECLARE_DESCRIPTOR ( IAnalyzer )

virtual void DoNoiseDetectorAnalysis	(	Tab< INode * > &	nodesToAnalyze,
		Interval	range,
		float	deviation,
		BOOL	angular,
		int	noiseType,
		INode *	pNode
	)

virtual

Perform Noise Detection on the passed in biped nodes.

Parameters

[in]	nodesToAnalyze	The nodes which to anlyze.
[in]	range	Interval over which to do the search.
[in]	deviation	Percentage from the curves standard deviation that will trigger a detection.
[in]	angular	Perform it on the angular or position changes.
[in]	noiseType	0 is speed, 1 is acceleration, 2 is jerk.
[in]	pNode	Only valid for calculating position noise detection, the angular param is false. This is the parent from which the positions will be calculated related to. If NULL, then it will use the world as the parent.

virtual void DoSpikeDetectorAnalysis	(	Tab< INode * > &	nodesToAnalyze,
		Interval	range,
		float	deviation
	)

virtual

Perform Spike Detection on the passed in biped nodes.

Parameters

[in]	nodesToAnalyze	- The nodes which to anlyze.
[in]	range	- Interval over which to do the search.
[in]	deviation	- Percentage from the curves standard deviation that will trigger a detection.

virtual void DoKneeWobbleAnalysis	(	Tab< INode * > &	nodesToAnalyze,
		Interval	range,
		float	frameThreshold,
		float	fluctuationThreshold
	)

virtual

Perform Knee Wobble on the passed in biped nodes.

Parameters

[in]	nodesToAnalyze	The nodes which to anlyze. Only works on biped knee nodes. Does nothing for non-biped non-knee nodes.
[in]	range	Interval over which to do the search.
[in]	frameThreshold	How much time, in terms of frames, that the calculation will use to check for the wobble.
[in]	fluctuationThreshold	How much deviation will that will trigger a detection. In degrees, from 0 to 360.

virtual void DoKneeExtensionAnalysis	(	Tab< INode * > &	nodesToAnalyze,
		Interval	range,
		float	kneeAngle
	)

virtual

Perform Knee Extenstion detection on the passed in biped nodes.

Parameters

[in]	nodesToAnalyze	The nodes which to anlyze. Only works on biped knee nodes.
[in]	range	Interval over which to do the search.
[in]	kneeAngle	How much knee bend beyond to look for. In degrees from 0 to 360.

virtual Tab<TimeValue > GetResults ( INode * node )

virtual

Get The results of any analysis.

Parameters

[in] node The nodes which to get the results for.

Returns: The times where the most recent analysis returned true.

virtual void LoadAnalysisFile ( const MCHAR * filename )

virtual

Load an analysis file.

Parameters

[in] filename The full path and name of the file. If file doesn't exist, the function does nothing.

virtual void SaveAnalysisFile	(	Tab< INode * > &	nodes,
		const MCHAR *	filename
	)

virtual

Save the analysis file.

Parameters

[in]	nodes	Save the current analysis on these nodes
[in]	filename	The full path and name of the file. Creates the file if it doesn't exists.

virtual void ClearAnalysisResults ( )

virtual

Clear all of the analysis results. Does so for every node.

VFN_6	(	doNoiseDetectorAnalysis	,
		DoNoiseDetectorAnalysis	,
		TYPE_INODE_TAB_BR	,
		TYPE_INTERVAL	,
		TYPE_FLOAT	,
		TYPE_BOOL	,
		TYPE_INT	,
		TYPE_INODE
	)

VFN_3	(	doSpikeDetectorAnalysis	,
		DoSpikeDetectorAnalysis	,
		TYPE_INODE_TAB_BR	,
		TYPE_INTERVAL	,
		TYPE_FLOAT
	)

FN_1	(	getResults	,
		TYPE_TIMEVALUE_TAB_BV	,
		GetResults	,
		TYPE_INODE
	)

VFN_1	(	loadAnalysisFile	,
		LoadAnalysisFile	,
		TYPE_FILENAME
	)

VFN_2	(	saveAnalysisFile	,
		SaveAnalysisFile	,
		TYPE_INODE_TAB_BR	,
		TYPE_FILENAME
	)

VFN_0	(	clearAnalysisResults	,
		ClearAnalysisResults
	)

VFN_4	(	doKneeWobbleAnalysis	,
		DoKneeWobbleAnalysis	,
		TYPE_INODE_TAB_BR	,
		TYPE_INTERVAL	,
		TYPE_FLOAT	,
		TYPE_FLOAT
	)

VFN_3	(	doKneeExtensionAnalysis	,
		DoKneeExtensionAnalysis	,
		TYPE_INODE_TAB_BR	,
		TYPE_INTERVAL	,
		TYPE_FLOAT
	)

IAnalyzer Class Reference

Class Description

Public Types

Public Member Functions

Additional Inherited Members

Member Enumeration Documentation

Member Function Documentation