#include <scriptcontroller.h>

Inheritance diagram for IScriptCtrl:

Public Types
enum	{ fnIdSetExpression, fnIdGetExpression, fnIdNumVars, fnIdAddConstant, fnIdAddTarget, fnIdAddObject, fnIdAddNode, fnIdSetConstant, fnIdSetTarget, fnIdSetObject, fnIdSetNode, fnIdDeleteVariable, fnIdSetDescription, fnIdGetDescription, fnIdVariableExists, fnIdGetOffset, fnIdSetOffset, fnIdUpdate, fnIdGetConstant, fnIdGetTarget, fnIdGetObject, fnIdGetNode, fnIdGetValue, fnIdGetVarValue, fnIdGetType, fnIdGetName, fnIdGetIndex, fnIdPrintDetails, fnIdGetThrowOnError, fnIdSetThrowOnError, fnIdRenameVariable, enumValueType }

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

Public Member Functions
	FN_1 (fnIdSetExpression, TYPE_BOOL, SetExpression, TYPE_TSTR_BR)

	FN_0 (fnIdGetExpression, TYPE_TSTR_BV, GetExpression)

	FN_0 (fnIdGetDescription, TYPE_TSTR_BV, GetDescription)

	FN_1 (fnIdSetDescription, TYPE_BOOL, SetDescription, TYPE_TSTR_BR)

	FN_0 (fnIdNumVars, TYPE_INT, NumVariables)

	FN_2 (fnIdAddConstant, TYPE_BOOL, AddConstant, TYPE_TSTR_BR, TYPE_FPVALUE_BR)

	FN_4 (fnIdAddTarget, TYPE_BOOL, AddTarget, TYPE_TSTR_BR, TYPE_VALUE, TYPE_TIMEVALUE, TYPE_VALUE)

	FN_2 (fnIdAddObject, TYPE_BOOL, AddObject, TYPE_TSTR_BR, TYPE_VALUE)

	FN_2 (fnIdAddNode, TYPE_BOOL, AddNode, TYPE_TSTR_BR, TYPE_INODE)

	FN_2 (fnIdSetConstant, TYPE_BOOL, SetConstant, TYPE_VALUE, TYPE_FPVALUE_BR)

	FN_3 (fnIdSetTarget, TYPE_BOOL, SetTarget, TYPE_VALUE, TYPE_VALUE, TYPE_VALUE)

	FN_2 (fnIdSetObject, TYPE_BOOL, SetObject, TYPE_VALUE, TYPE_VALUE)

	FN_2 (fnIdSetNode, TYPE_BOOL, SetNode, TYPE_VALUE, TYPE_INODE)

	FN_1 (fnIdDeleteVariable, TYPE_BOOL, DeleteVariable, TYPE_VALUE)

	FN_2 (fnIdRenameVariable, TYPE_BOOL, RenameVariable, TYPE_VALUE, TYPE_TSTR_BR)

	FN_1 (fnIdVariableExists, TYPE_BOOL, VariableExists, TYPE_TSTR_BR)

	FN_1 (fnIdGetOffset, TYPE_TIMEVALUE, GetOffset, TYPE_VALUE)

	FN_2 (fnIdSetOffset, TYPE_BOOL, SetOffset, TYPE_VALUE, TYPE_TIMEVALUE)

	FNT_1 (fnIdGetConstant, TYPE_FPVALUE_BV, GetConstant, TYPE_VALUE)

	FN_2 (fnIdGetTarget, TYPE_VALUE, GetTarget, TYPE_VALUE, TYPE_BOOL)

	FN_1 (fnIdGetObject, TYPE_REFTARG, GetObject, TYPE_VALUE)

	FN_1 (fnIdGetNode, TYPE_INODE, GetNode, TYPE_VALUE)

	FNT_2 (fnIdGetValue, TYPE_VALUE, GetVariable, TYPE_VALUE, TYPE_BOOL)

	FNT_1 (fnIdGetVarValue, TYPE_VALUE, GetVarValue, TYPE_VALUE)

	FN_1 (fnIdGetType, TYPE_ENUM, GetVarType, TYPE_VALUE)

	FN_1 (fnIdGetName, TYPE_TSTR_BV, GetVarName, TYPE_INDEX)

	FN_1 (fnIdGetIndex, TYPE_INDEX, GetVarIndex, TYPE_TSTR_BR)

	VFN_0 (fnIdUpdate, Update)

	FN_0 (fnIdPrintDetails, TYPE_TSTR_BV, PrintDetails)

	VFN_1 (fnIdSetThrowOnError, SetThrowOnError, TYPE_bool)

	FN_0 (fnIdGetThrowOnError, TYPE_bool, GetThrowOnError)

FPInterfaceDesc *	GetDesc ()

virtual bool	GetThrowOnError ()=0

virtual void	SetThrowOnError (bool bOn)=0

virtual MSTR	PrintDetails ()=0

virtual void	Update ()=0

virtual BOOL	SetExpression (MSTR &expression)=0

virtual MSTR	GetExpression ()=0

virtual MSTR	GetDescription ()=0

virtual BOOL	SetDescription (MSTR &expression)=0

virtual BOOL	AddConstant (MSTR &name, FPValue &val)=0

virtual BOOL	AddTarget (MSTR &name, Value target, int ticks, Value owner=NULL)=0

virtual BOOL	AddObject (MSTR &name, Value *obj)=0

virtual BOOL	AddNode (MSTR &name, INode *theNode)=0

virtual BOOL	SetConstant (Value *which, FPValue &val)=0

virtual BOOL	SetTarget (Value which, Value target, Value *owner=NULL)=0

virtual BOOL	SetObject (Value which, Value obj)=0

virtual BOOL	SetNode (Value which, INode theNode)=0

virtual FPValue	GetConstant (Value *which, TimeValue t)=0

virtual Value *	GetTarget (Value *which, BOOL asObject=FALSE)=0

virtual ReferenceTarget *	GetObject (Value *which)=0

virtual INode *	GetNode (Value *which)=0

virtual Value *	GetVariable (Value *which, BOOL asObject=FALSE, TimeValue t=0)=0

virtual int	NumVariables ()=0

virtual BOOL	DeleteVariable (Value *which)=0

virtual BOOL	VariableExists (MSTR &name)=0

virtual BOOL	RenameVariable (Value *which, MSTR &name)=0

virtual TimeValue	GetOffset (Value *which)=0

virtual BOOL	SetOffset (Value *which, TimeValue tick)=0

virtual Value *	GetVarValue (Value *which, TimeValue t)=0

virtual int	GetVarType (Value *which)=0

virtual MSTR	GetVarName (int index)=0

virtual int	GetVarIndex (MSTR &name)=0

Public Member Functions inherited from FPMixinInterface
	FPMixinInterface ()

virtual LifetimeType	LifetimeControl ()

virtual CoreExport bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)

CoreExport	~FPMixinInterface ()

virtual BaseInterface *	GetInterface (Interface_ID id)

virtual FPInterfaceDesc *	GetDescByID (Interface_ID id)

virtual Interface_ID	GetID ()

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)

virtual ActionTable *	GetActionTable ()

virtual void	EnableActions (BOOL onOff)

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

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

Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface

Protected Member Functions inherited from FPMixinInterface
	FPMixinInterface (const FPMixinInterface &rhs)

FPMixinInterface &	operator= (const FPMixinInterface &rhs)

Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > *	interfaceNotifyCBs

Member Enumeration Documentation

anonymous enum

Enumerator
fnIdSetExpression
fnIdGetExpression
fnIdNumVars
fnIdAddConstant
fnIdAddTarget
fnIdAddObject
fnIdAddNode
fnIdSetConstant
fnIdSetTarget
fnIdSetObject
fnIdSetNode
fnIdDeleteVariable
fnIdSetDescription
fnIdGetDescription
fnIdVariableExists
fnIdGetOffset
fnIdSetOffset
fnIdUpdate
fnIdGetConstant
fnIdGetTarget
fnIdGetObject
fnIdGetNode
fnIdGetValue
fnIdGetVarValue
fnIdGetType
fnIdGetName
fnIdGetIndex
fnIdPrintDetails
fnIdGetThrowOnError
fnIdSetThrowOnError
fnIdRenameVariable
enumValueType

          {
         fnIdSetExpression, fnIdGetExpression,
         fnIdNumVars, 
         fnIdAddConstant, fnIdAddTarget, fnIdAddObject, fnIdAddNode,
         fnIdSetConstant, fnIdSetTarget, fnIdSetObject, fnIdSetNode,
         fnIdDeleteVariable,
         fnIdSetDescription, fnIdGetDescription,
         fnIdVariableExists,
         fnIdGetOffset, fnIdSetOffset,
         fnIdUpdate,
         fnIdGetConstant, fnIdGetTarget, fnIdGetObject, fnIdGetNode, fnIdGetValue, 
         fnIdGetVarValue,
         fnIdGetType,
         fnIdGetName, fnIdGetIndex,
         fnIdPrintDetails,
         fnIdGetThrowOnError, fnIdSetThrowOnError,
         fnIdRenameVariable,
         enumValueType,
     };

Member Function Documentation

FN_1	(	fnIdSetExpression	,
		TYPE_BOOL	,
		SetExpression	,
		TYPE_TSTR_BR
	)

FN_0	(	fnIdGetExpression	,
		TYPE_TSTR_BV	,
		GetExpression
	)

FN_0	(	fnIdGetDescription	,
		TYPE_TSTR_BV	,
		GetDescription
	)

FN_1	(	fnIdSetDescription	,
		TYPE_BOOL	,
		SetDescription	,
		TYPE_TSTR_BR
	)

FN_0	(	fnIdNumVars	,
		TYPE_INT	,
		NumVariables
	)

FN_2	(	fnIdAddConstant	,
		TYPE_BOOL	,
		AddConstant	,
		TYPE_TSTR_BR	,
		TYPE_FPVALUE_BR
	)

FN_4	(	fnIdAddTarget	,
		TYPE_BOOL	,
		AddTarget	,
		TYPE_TSTR_BR	,
		TYPE_VALUE	,
		TYPE_TIMEVALUE	,
		TYPE_VALUE
	)

FN_2	(	fnIdAddObject	,
		TYPE_BOOL	,
		AddObject	,
		TYPE_TSTR_BR	,
		TYPE_VALUE
	)

FN_2	(	fnIdAddNode	,
		TYPE_BOOL	,
		AddNode	,
		TYPE_TSTR_BR	,
		TYPE_INODE
	)

FN_2	(	fnIdSetConstant	,
		TYPE_BOOL	,
		SetConstant	,
		TYPE_VALUE	,
		TYPE_FPVALUE_BR
	)

FN_3	(	fnIdSetTarget	,
		TYPE_BOOL	,
		SetTarget	,
		TYPE_VALUE	,
		TYPE_VALUE	,
		TYPE_VALUE
	)

FN_2	(	fnIdSetObject	,
		TYPE_BOOL	,
		SetObject	,
		TYPE_VALUE	,
		TYPE_VALUE
	)

FN_2	(	fnIdSetNode	,
		TYPE_BOOL	,
		SetNode	,
		TYPE_VALUE	,
		TYPE_INODE
	)

FN_1	(	fnIdDeleteVariable	,
		TYPE_BOOL	,
		DeleteVariable	,
		TYPE_VALUE
	)

FN_2	(	fnIdRenameVariable	,
		TYPE_BOOL	,
		RenameVariable	,
		TYPE_VALUE	,
		TYPE_TSTR_BR
	)

FN_1	(	fnIdVariableExists	,
		TYPE_BOOL	,
		VariableExists	,
		TYPE_TSTR_BR
	)

FN_1	(	fnIdGetOffset	,
		TYPE_TIMEVALUE	,
		GetOffset	,
		TYPE_VALUE
	)

FN_2	(	fnIdSetOffset	,
		TYPE_BOOL	,
		SetOffset	,
		TYPE_VALUE	,
		TYPE_TIMEVALUE
	)

FNT_1	(	fnIdGetConstant	,
		TYPE_FPVALUE_BV	,
		GetConstant	,
		TYPE_VALUE
	)

FN_2	(	fnIdGetTarget	,
		TYPE_VALUE	,
		GetTarget	,
		TYPE_VALUE	,
		TYPE_BOOL
	)

FN_1	(	fnIdGetObject	,
		TYPE_REFTARG	,
		GetObject	,
		TYPE_VALUE
	)

FN_1	(	fnIdGetNode	,
		TYPE_INODE	,
		GetNode	,
		TYPE_VALUE
	)

FNT_2	(	fnIdGetValue	,
		TYPE_VALUE	,
		GetVariable	,
		TYPE_VALUE	,
		TYPE_BOOL
	)

FNT_1	(	fnIdGetVarValue	,
		TYPE_VALUE	,
		GetVarValue	,
		TYPE_VALUE
	)

FN_1	(	fnIdGetType	,
		TYPE_ENUM	,
		GetVarType	,
		TYPE_VALUE
	)

FN_1	(	fnIdGetName	,
		TYPE_TSTR_BV	,
		GetVarName	,
		TYPE_INDEX
	)

FN_1	(	fnIdGetIndex	,
		TYPE_INDEX	,
		GetVarIndex	,
		TYPE_TSTR_BR
	)

VFN_0	(	fnIdUpdate	,
		Update
	)

FN_0	(	fnIdPrintDetails	,
		TYPE_TSTR_BV	,
		PrintDetails
	)

VFN_1	(	fnIdSetThrowOnError	,
		SetThrowOnError	,
		TYPE_bool
	)

FN_0	(	fnIdGetThrowOnError	,
		TYPE_bool	,
		GetThrowOnError
	)

FPInterfaceDesc* GetDesc ( )

virtual

Remarks: Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

virtual bool GetThrowOnError ( )

pure virtual

virtual void SetThrowOnError ( bool bOn )

pure virtual

virtual MSTR PrintDetails ( )

pure virtual

virtual void Update ( )

pure virtual

virtual BOOL SetExpression ( MSTR & expression )

pure virtual

virtual MSTR GetExpression ( )

pure virtual

virtual MSTR GetDescription ( )

pure virtual

virtual BOOL SetDescription ( MSTR & expression )

pure virtual

virtual BOOL AddConstant	(	MSTR &	name,
		FPValue &	val
	)

pure virtual

virtual BOOL AddTarget	(	MSTR &	name,
		Value *	target,
		int	ticks,
		Value *	owner = `NULL`
	)

pure virtual

virtual BOOL AddObject	(	MSTR &	name,
		Value *	obj
	)

pure virtual

virtual BOOL AddNode	(	MSTR &	name,
		INode *	theNode
	)

pure virtual

virtual BOOL SetConstant	(	Value *	which,
		FPValue &	val
	)

pure virtual

virtual BOOL SetTarget	(	Value *	which,
		Value *	target,
		Value *	owner = `NULL`
	)

pure virtual

virtual BOOL SetObject	(	Value *	which,
		Value *	obj
	)

pure virtual

virtual BOOL SetNode	(	Value *	which,
		INode *	theNode
	)

pure virtual

virtual FPValue GetConstant	(	Value *	which,
		TimeValue	t
	)

pure virtual

virtual Value* GetTarget	(	Value *	which,
		BOOL	asObject = `FALSE`
	)

pure virtual

virtual ReferenceTarget* GetObject ( Value * which )

pure virtual

virtual INode* GetNode ( Value * which )

pure virtual

virtual Value* GetVariable	(	Value *	which,
		BOOL	asObject = `FALSE`,
		TimeValue	t = `0`
	)

pure virtual

virtual int NumVariables ( )

pure virtual

virtual BOOL DeleteVariable ( Value * which )

pure virtual

virtual BOOL VariableExists ( MSTR & name )

pure virtual

virtual BOOL RenameVariable	(	Value *	which,
		MSTR &	name
	)

pure virtual

virtual TimeValue GetOffset ( Value * which )

pure virtual

virtual BOOL SetOffset	(	Value *	which,
		TimeValue	tick
	)

pure virtual

virtual Value* GetVarValue	(	Value *	which,
		TimeValue	t
	)

pure virtual

virtual int GetVarType ( Value * which )

pure virtual

virtual MSTR GetVarName ( int index )

pure virtual

virtual int GetVarIndex ( MSTR & name )

pure virtual

IScriptCtrl Class Reference

Public Types

Public Member Functions

Additional Inherited Members

Member Enumeration Documentation

Member Function Documentation