Public Types | Public Member Functions

IScriptCtrl Class Reference

Search for all occurrences

#include <scriptcontroller.h>

Inheritance diagram for IScriptCtrl:
Inheritance graph
[legend]

List of all members.

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

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

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 

Member Function Documentation

BEGIN_FUNCTION_MAP 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   
)
END_FUNCTION_MAP 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 IScriptCtrl IScriptCtrl IScriptCtrl IScriptCtrl IScriptCtrl IScriptCtrl IScriptCtrl IScriptCtrl IScriptCtrl
IScriptCtrl IScriptCtrl IScriptCtrl IScriptCtrl IScriptCtrl IScriptCtrl IScriptCtrl IScriptCtrl IScriptCtrl IScriptCtrl