3ds Max C++ API Reference
Loading...
Searching...
No Matches
IScriptCtrl Class Referenceabstract

#include <C:/adskgit/3dsmax/3dsmax/3dswin/src/maxsdk/include/maxscript/maxwrapper/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)
FPInterfaceDescGetDesc () override
virtual bool GetThrowOnError ()=0
virtual void SetThrowOnError (bool bOn)=0
virtual MSTR PrintDetails ()=0
virtual void Update ()=0
virtual BOOL SetExpression (const MSTR &expression)=0
virtual MSTR GetExpression ()=0
virtual MSTR GetDescription ()=0
virtual BOOL SetDescription (const MSTR &expression)=0
virtual BOOL AddConstant (const MSTR &name, FPValue &val)=0
virtual BOOL AddTarget (const MSTR &name, Value *target, int ticks, Value *owner=nullptr)=0
virtual BOOL AddObject (const MSTR &name, Value *obj)=0
virtual BOOL AddNode (const MSTR &name, INode *theNode)=0
virtual BOOL SetConstant (Value *which, FPValue &val)=0
virtual BOOL SetTarget (Value *which, Value *target, Value *owner=nullptr)=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 ValueGetTarget (Value *which, BOOL asObject=FALSE)=0
virtual ReferenceTargetGetObject (Value *which)=0
virtual INodeGetNode (Value *which)=0
virtual ValueGetVariable (Value *which, BOOL asObject=FALSE, TimeValue t=0)=0
virtual int NumVariables ()=0
virtual BOOL DeleteVariable (Value *which)=0
virtual BOOL VariableExists (const MSTR &name)=0
virtual BOOL RenameVariable (Value *which, const MSTR &name)=0
virtual TimeValue GetOffset (Value *which)=0
virtual BOOL SetOffset (Value *which, TimeValue tick)=0
virtual ValueGetVarValue (Value *which, TimeValue t)=0
virtual int GetVarType (Value *which)=0
virtual MSTR GetVarName (int index)=0
virtual int GetVarIndex (const 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 BaseInterfaceGetInterface (Interface_ID id)
virtual FPInterfaceDescGetDescByID (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 ActionTableGetActionTable ()
virtual void EnableActions (BOOL onOff)
Public Member Functions inherited from BaseInterface
virtual UtilExport ~BaseInterface ()
 Destructor.
virtual BaseInterfaceAcquireInterface ()
virtual void ReleaseInterface ()
virtual void DeleteInterface ()
virtual BaseInterfaceCloneInterface (void *remapDir=nullptr)
Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor.
template<class InterfaceType>
InterfaceType * GetTypedInterface ()

Additional Inherited Members

Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport voidoperator 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 voidoperator 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 voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects.
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary.
static UtilExport voidaligned_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.
Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc nullInterface
Protected Member Functions inherited from FPMixinInterface
 FPMixinInterface (const FPMixinInterface &rhs)
FPMixinInterfaceoperator= (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

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 
56 {
74 };
@ fnIdPrintDetails
Definition scriptcontroller.h:70
@ fnIdGetVarValue
Definition scriptcontroller.h:67
@ fnIdSetTarget
Definition scriptcontroller.h:60
@ fnIdRenameVariable
Definition scriptcontroller.h:72
@ fnIdGetConstant
Definition scriptcontroller.h:66
@ fnIdGetType
Definition scriptcontroller.h:68
@ fnIdUpdate
Definition scriptcontroller.h:65
@ enumValueType
Definition scriptcontroller.h:73
@ fnIdAddObject
Definition scriptcontroller.h:59
@ fnIdGetObject
Definition scriptcontroller.h:66
@ fnIdGetValue
Definition scriptcontroller.h:66
@ fnIdSetOffset
Definition scriptcontroller.h:64
@ fnIdSetNode
Definition scriptcontroller.h:60
@ fnIdGetThrowOnError
Definition scriptcontroller.h:71
@ fnIdGetDescription
Definition scriptcontroller.h:62
@ fnIdSetConstant
Definition scriptcontroller.h:60
@ fnIdGetExpression
Definition scriptcontroller.h:57
@ fnIdGetTarget
Definition scriptcontroller.h:66
@ fnIdGetName
Definition scriptcontroller.h:69
@ fnIdVariableExists
Definition scriptcontroller.h:63
@ fnIdSetObject
Definition scriptcontroller.h:60
@ fnIdGetIndex
Definition scriptcontroller.h:69
@ fnIdNumVars
Definition scriptcontroller.h:58
@ fnIdSetThrowOnError
Definition scriptcontroller.h:71
@ fnIdAddNode
Definition scriptcontroller.h:59
@ fnIdSetDescription
Definition scriptcontroller.h:62
@ fnIdGetOffset
Definition scriptcontroller.h:64
@ fnIdSetExpression
Definition scriptcontroller.h:57
@ fnIdGetNode
Definition scriptcontroller.h:66
@ fnIdAddConstant
Definition scriptcontroller.h:59
@ fnIdAddTarget
Definition scriptcontroller.h:59
@ fnIdDeleteVariable
Definition scriptcontroller.h:61

Member Function Documentation

◆ FN_1() [1/10]

◆ FN_0() [1/5]

◆ FN_0() [2/5]

◆ FN_1() [2/10]

◆ FN_0() [3/5]

◆ FN_2() [1/9]

◆ FN_4()

◆ FN_2() [2/9]

◆ FN_2() [3/9]

◆ FN_2() [4/9]

◆ FN_3()

◆ FN_2() [5/9]

◆ FN_2() [6/9]

◆ FN_1() [3/10]

◆ FN_2() [7/9]

◆ FN_1() [4/10]

◆ FN_1() [5/10]

◆ FN_2() [8/9]

◆ FNT_1() [1/2]

◆ FN_2() [9/9]

◆ FN_1() [6/10]

◆ FN_1() [7/10]

◆ FNT_2()

◆ FNT_1() [2/2]

◆ FN_1() [8/10]

◆ FN_1() [9/10]

◆ FN_1() [10/10]

◆ VFN_0()

VFN_0 ( fnIdUpdate ,
Update  )

◆ FN_0() [4/5]

◆ VFN_1()

◆ FN_0() [5/5]

◆ GetDesc()

FPInterfaceDesc * GetDesc ( )
overridevirtual
Remarks
Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

◆ GetThrowOnError()

virtual bool GetThrowOnError ( )
pure virtual

◆ SetThrowOnError()

virtual void SetThrowOnError ( bool bOn)
pure virtual

◆ PrintDetails()

virtual MSTR PrintDetails ( )
pure virtual

◆ Update()

virtual void Update ( )
pure virtual

◆ SetExpression()

virtual BOOL SetExpression ( const MSTR & expression)
pure virtual

◆ GetExpression()

virtual MSTR GetExpression ( )
pure virtual

◆ GetDescription()

virtual MSTR GetDescription ( )
pure virtual

◆ SetDescription()

virtual BOOL SetDescription ( const MSTR & expression)
pure virtual

◆ AddConstant()

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

◆ AddTarget()

virtual BOOL AddTarget ( const MSTR & name,
Value * target,
int ticks,
Value * owner = nullptr )
pure virtual

◆ AddObject()

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

◆ AddNode()

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

◆ SetConstant()

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

◆ SetTarget()

virtual BOOL SetTarget ( Value * which,
Value * target,
Value * owner = nullptr )
pure virtual

◆ SetObject()

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

◆ SetNode()

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

◆ GetConstant()

virtual FPValue GetConstant ( Value * which,
TimeValue t )
pure virtual

◆ GetTarget()

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

◆ GetObject()

virtual ReferenceTarget * GetObject ( Value * which)
pure virtual

◆ GetNode()

virtual INode * GetNode ( Value * which)
pure virtual

◆ GetVariable()

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

◆ NumVariables()

virtual int NumVariables ( )
pure virtual

◆ DeleteVariable()

virtual BOOL DeleteVariable ( Value * which)
pure virtual

◆ VariableExists()

virtual BOOL VariableExists ( const MSTR & name)
pure virtual

◆ RenameVariable()

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

◆ GetOffset()

virtual TimeValue GetOffset ( Value * which)
pure virtual

◆ SetOffset()

virtual BOOL SetOffset ( Value * which,
TimeValue tick )
pure virtual

◆ GetVarValue()

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

◆ GetVarType()

virtual int GetVarType ( Value * which)
pure virtual

◆ GetVarName()

virtual MSTR GetVarName ( int index)
pure virtual

◆ GetVarIndex()

virtual int GetVarIndex ( const MSTR & name)
pure virtual