3ds Max C++ API Reference
MAXScriptFunction Class Reference

#include <functions.h>

+ Inheritance diagram for MAXScriptFunction:

Public Member Functions

ScripterExport MAXScriptFunction (const MCHAR *name, int parm_count, int keyparm_count, Value **keyparms, int local_count, Value *body, HashTable *local_scope, MAXScript::ScriptSource scriptSource, short flags=0)
 
ScripterExport MAXScriptFunction (const MCHAR *name, int parm_count, int keyparm_count, Value **keyparms, int local_count, Value *body, HashTable *local_scope, Array *param_names, Value *owner, MAXScript::ScriptSource scriptSource, short flags=0)
 
 ~MAXScriptFunction ()
 
 classof_methods (MAXScriptFunction, Function)
 
BOOL _is_function ()
 
void collect ()
 
void gc_trace ()
 
void sprin1 (CharStream *s)
 
Valueapply (Value **arglist, int count, CallContext *cc=NULL)
 
Valueapply_no_alloc_frame (Value **arglist, int count, CallContext *cc=NULL)
 
value_cf get_c_callable_fn ()
 
Valueoperator() (Value **arg_list, int count)
 
void dump_local_vars_params_and_externals (Value **paramsFrame, Value **localsFrame, int indentLevel)
 
- Public Member Functions inherited from Function
 Function ()
 
ScripterExport Function (const MCHAR *name, const MCHAR *struct_name=NULL)
 
ScripterExport Function (const MCHAR *name, const MCHAR *struct_name, bool debuggerSafe)
 
ScripterExport ~Function ()
 
 classof_methods (Function, Value)
 
ScripterExport void export_to_scripter ()
 
- Public Member Functions inherited from Value
virtual ScripterExport BOOL is_kind_of (ValueMetaClass *c)
 
virtual ScripterExport ValueMetaClasslocal_base_class ()
 
virtual Valueeval ()
 
virtual Valueeval_no_wrapper ()
 
virtual Valuemap (node_map &m)
 
virtual Valuemap_path (PathName *path, node_map &m)
 
virtual Valuefind_first (BOOL(*test_fn)(INode *node, int level, const void *arg), const void *test_arg)
 
virtual Valueget_path (PathName *path)
 
virtual ScripterExport void sprint (CharStream *stream)
 
virtual void prin1 ()
 
virtual void print ()
 
virtual ScripterExport Class_ID get_max_class_id ()
 
virtual ScripterExport Valuedelete_vf (Value **arglist, int arg_count)
 
virtual ScripterExport ValueclearSelection_vf (Value **arglist, int arg_count)
 
virtual float to_float ()
 
virtual double to_double ()
 
virtual const MCHARto_string ()
 
virtual MSTR to_mstr ()
 
virtual MSTR to_filename ()
 
virtual int to_int ()
 
virtual INT64 to_int64 ()
 
virtual INT_PTR to_intptr ()
 
virtual BOOL to_bool ()
 
virtual BitArrayto_bitarray ()
 
virtual Point4 to_point4 ()
 
virtual Point3 to_point3 ()
 
virtual Point2 to_point2 ()
 
virtual AColor to_acolor ()
 
virtual COLORREF to_colorref ()
 
virtual INodeto_node ()
 
virtual Ray to_ray ()
 
virtual Interval to_interval ()
 
virtual Quat to_quat ()
 
virtual AngAxis to_angaxis ()
 
virtual Matrix3to_matrix3 ()
 
virtual Box3 to_box3 ()
 
virtual float * to_eulerangles ()
 
virtual Mtlto_mtl ()
 
virtual Texmapto_texmap ()
 
virtual MtlBaseto_mtlbase ()
 
virtual Modifierto_modifier ()
 
virtual TimeValue to_timevalue ()
 
virtual Controlto_controller ()
 
virtual Atmosphericto_atmospheric ()
 
virtual Effectto_effect ()
 
virtual IMultiPassCameraEffectto_mpassCamEffect ()
 
virtual ShadowTypeto_shadowtype ()
 
virtual FilterKernelto_filter ()
 
virtual INodeto_rootnode ()
 
virtual ITrackViewNodeto_trackviewnode ()
 
virtual NURBSIndependentPointto_nurbsindependentpoint ()
 
virtual NURBSPointto_nurbspoint ()
 
virtual NURBSObjectto_nurbsobject ()
 
virtual NURBSControlVertexto_nurbscontrolvertex ()
 
virtual NURBSCurveto_nurbscurve ()
 
virtual NURBSCVCurveto_nurbscvcurve ()
 
virtual NURBSSurfaceto_nurbssurface ()
 
virtual NURBSTexturePointto_nurbstexturepoint ()
 
virtual NURBSSetto_nurbsset ()
 
virtual ReferenceTargetto_reftarg ()
 
virtual Meshto_mesh ()
 
virtual BezierShapeto_beziershape ()
 
virtual Thunkto_thunk ()
 
virtual void to_fpvalue (FPValue &v)
 
virtual Rendererto_renderer ()
 
virtual Box2to_box2 ()
 
virtual NURBSTextureSurfaceto_nurbstexturesurface ()
 
virtual NURBSDisplayto_nurbsdisplay ()
 
virtual TessApproxto_tessapprox ()
 
virtual Valuewiden_to (Value *arg, Value **arg_list)
 
virtual BOOL comparable (Value *arg)
 
virtual BOOL special_case_compare (Value *arg, bool &specialCaseCompareResult)
 
virtual ScripterExport Valuedeep_copy (HashTable *remapper)
 
virtual BOOL is_const ()
 
virtual ScripterExport Valueget_property (Value **arg_list, int count)
 
virtual ScripterExport Valueset_property (Value **arg_list, int count)
 
ScripterExport Value_get_property (Value *prop)
 
virtual ScripterExport Value_set_property (Value *prop, Value *val)
 
virtual Valueget_container_property (Value *prop, Value *cur_prop)
 
virtual Valueset_container_property (Value *prop, Value *val, Value *cur_prop)
 
virtual BOOL _is_collection ()
 
virtual BOOL _is_charstream ()
 
virtual BOOL _is_rolloutcontrol ()
 
virtual BOOL _is_rolloutthunk ()
 
virtual BOOL _is_selection ()
 
virtual BOOL _is_thunk ()
 
virtual BOOL _is_indirect_thunk ()
 
virtual SelectionIteratorselection_iterator ()
 
virtual ScripterExport IOResult Save (ISave *isave)
 
virtual void drop_MAX_refs ()
 
virtual BaseInterfaceGetInterface (Interface_ID id)
 
ScripterExport Valuemake_heap_permanent ()
 
ScripterExport Valuemake_heap_static ()
 
ScripterExport Valueget_heap_ptr ()
 
ScripterExport Valueget_stack_heap_ptr ()
 
ScripterExport Valuemigrate_to_heap ()
 
ScripterExport Valueget_live_ptr ()
 
virtual BOOL object_supports_case_sensitive_names ()
 
ScripterExport Value_get_property (Value *prop, Value *prop_name_as_parsed)
 
ScripterExport Value_set_property (Value *prop, Value *val, Value *prop_name_as_parsed)
 
virtual ScripterExport Valueget_case_sensitive_property (Value **arg_list, int count, const TCHAR *case_sensitive_name)
 
virtual ScripterExport Valueset_case_sensitive_property (Value **arg_list, int count, const TCHAR *case_sensitive_name)
 
ScripterExport Valueinvoke_getter_case_sensitive_property (Value *target, getter_vf getter, Value **arg_list, int count, const TCHAR *case_sensitive_name, const TCHAR *nested_prop_case_sensitive_name)
 
ScripterExport Valueinvoke_setter_case_sensitive_property (Value *target, setter_vf setter, Value **arg_list, int count, const TCHAR *case_sensitive_name, const TCHAR *nested_prop_case_sensitive_name)
 
- Public Member Functions inherited from Collectable
ScripterExport Collectable ()
 
virtual ScripterExport ~Collectable ()
 
ScripterExport voidoperator new (size_t sz, char flag)
 
ScripterExport voidoperator new (size_t sz)
 
ScripterExport void operator delete (void *val)
 
ScripterExport void operator delete (void *val, char flag)
 
ScripterExport bool derives_from_Animatable ()
 
virtual BOOL derives_from_MAXWrapper ()
 
ScripterExport void make_collectable ()
 
void make_permanent ()
 
void make_static ()
 
int is_marked ()
 
int is_not_marked ()
 
int is_garbage ()
 
int is_permanent ()
 
void mark_in_use ()
 
void unmark_in_use ()
 
int has_heap_copy ()
 
int is_in_heap ()
 
int is_on_stack ()
 

Public Attributes

short parameter_count
 
short local_count
 
short keyparm_count
 
short flags
 
Value ** keyparms
 
Valuebody
 
HashTablelocal_scope
 
value_cf c_callable_fn
 
ArrayparamNames
 
Valueowner
 
const MAXScript::ScriptSource scriptSource
 
- Public Attributes inherited from Function
const MCHARname
 
const MCHARstruct_name
 
- Public Attributes inherited from Value
ValueMetaClasstag
 
- Public Attributes inherited from Collectable
Collectablenext
 
Collectableprev
 
byte flags
 
byte flags2
 
short flags3
 

Protected Member Functions

Valuewrap_arg (Value *arg)
 

Additional Inherited Members

- Static Public Member Functions inherited from Collectable
static ScripterExport void for_all_values (void(*map_fn)(Value *val), ValueMapper *mapper=NULL, ValueMetaClass *c=NULL)
 
static void mark ()
 
static void sweep ()
 
static void setup (size_t)
 
static ScripterExport void gc ()
 
static void coalesce_free_list ()
 
static void close_down ()
 
static void drop_maxwrapper_refs ()
 
static ScripterExport void push_alloc_stack_frame ()
 
static ScripterExport void pop_alloc_stack_frame ()
 
static ScripterExport ULONGLONG get_num_values_created ()
 
static ScripterExport bool validate_value_linkages ()
 
- Static Public Attributes inherited from Collectable
static CRITICAL_SECTION heap_update
 
static Collectablecollectable_list
 
static Collectablepermanent_list
 
static free_memfree_list [GC_NUM_SUBLISTS]
 
static size_t heap_allocated
 
static size_t heap_size
 
static ScripterExport collectable_state state
 
static ScripterExport bool fullCollectNextHoldFlush
 
static bool gc_light
 
static bool in_gc
 
static HANDLE hGCCompletedEvent
 
- Static Protected Attributes inherited from Value
static ScripterExport Valuekeyarg_marker_value
 

Constructor & Destructor Documentation

◆ MAXScriptFunction() [1/2]

ScripterExport MAXScriptFunction ( const MCHAR name,
int  parm_count,
int  keyparm_count,
Value **  keyparms,
int  local_count,
Value body,
HashTable local_scope,
MAXScript::ScriptSource  scriptSource,
short  flags = 0 
)

◆ MAXScriptFunction() [2/2]

ScripterExport MAXScriptFunction ( const MCHAR name,
int  parm_count,
int  keyparm_count,
Value **  keyparms,
int  local_count,
Value body,
HashTable local_scope,
Array param_names,
Value owner,
MAXScript::ScriptSource  scriptSource,
short  flags = 0 
)

◆ ~MAXScriptFunction()

Member Function Documentation

◆ classof_methods()

classof_methods ( MAXScriptFunction  ,
Function   
)

◆ _is_function()

BOOL _is_function ( )
inlinevirtual

Reimplemented from Function.

207 { DbgAssert(!is_sourcepositionwrapper(this)); return TRUE; }
#define DbgAssert(expr)
Definition: assert1.h:82
#define is_sourcepositionwrapper(v)
Definition: value.h:591

◆ collect()

void collect ( )
virtual

Implements Collectable.

◆ gc_trace()

void gc_trace ( )
virtual

Reimplemented from Collectable.

◆ sprin1()

void sprin1 ( CharStream s)
virtual

Reimplemented from Function.

◆ apply()

Value* apply ( Value **  arglist,
int  count,
CallContext cc = NULL 
)
virtual

Reimplemented from Value.

◆ apply_no_alloc_frame()

Value* apply_no_alloc_frame ( Value **  arglist,
int  count,
CallContext cc = NULL 
)
virtual

Reimplemented from Value.

◆ get_c_callable_fn()

value_cf get_c_callable_fn ( )

◆ operator()()

Value* operator() ( Value **  arg_list,
int  count 
)

◆ dump_local_vars_params_and_externals()

void dump_local_vars_params_and_externals ( Value **  paramsFrame,
Value **  localsFrame,
int  indentLevel 
)

◆ wrap_arg()

Value* wrap_arg ( Value arg)
protected

Member Data Documentation

◆ parameter_count

short parameter_count

◆ local_count

short local_count

◆ keyparm_count

short keyparm_count

◆ flags

short flags

◆ keyparms

Value** keyparms

◆ body

Value* body

◆ local_scope

HashTable* local_scope

◆ c_callable_fn

value_cf c_callable_fn

◆ paramNames

Array* paramNames

◆ owner

Value* owner

◆ scriptSource

const MAXScript::ScriptSource scriptSource