MSPlugin Class Reference
 
 
 
MSPlugin Class Reference

This reference page is linked to from the following overview topics: Plug-in Base Classes.


#include <mxsPlugin.h>

Inheritance diagram for MSPlugin:
Value Collectable MSCustAttrib MSPluginModifier MSPluginMtl MSPluginObject< TYPE > MSPluginObject< GenCamera > MSPluginObject< GenLight > MSPluginObject< GeomObject > MSPluginObject< HelperObject > MSPluginObject< ShapeObject > MSPluginSimpleManipulator MSPluginSimpleMod MSPluginSimpleObject MSPluginSpecialFX< TYPE > MSPluginSpecialFX< Atmospheric > MSPluginSpecialFX< Effect8 > MSPluginTexmap MSPluginTrackViewUtility

Public Member Functions

  MSPlugin ()
virtual  ~MSPlugin ()
void  init (MSPluginClass *pc)
ScripterExport void  gc_trace ()
ScripterExport void  collect ()
void  DeleteThis ()
ScripterExport void  RefDeleted ()
void  init_locals ()
void  call_handler (Value *handler, Value **arg_list, int count, TimeValue t, BOOL disable_on_error=FALSE)
Value _call_handler (Value *handler, Value **arg_list, int count, TimeValue t, BOOL disable_on_error=FALSE)
FPStatus  call_handler (const MCHAR *handler_name, FPParams *params, FPValue &result, TimeValue t, BOOL disable_on_error=FALSE)
FPStatus  call_handler (Value *handler, FPParams *params, FPValue &result, TimeValue t, BOOL disable_on_error=FALSE)
void  post_create (ReferenceTarget *me, BOOL loading)
void  call_all_set_handlers ()
void  disable ()
void  enable ()
BOOL  enabled ()
int  get_local_index (Value *prop)
Value get_local (int index)
void  set_local (int index, Value *val)
ScripterExport IParamBlock2 GetParamBlockByID (BlockID id)
virtual HWND  AddRollupPage (HINSTANCE hInst, const MCHAR *dlgTemplate, DLGPROC dlgProc, const MCHAR *title, LPARAM param=0, DWORD flags=0, int category=ROLLUP_CAT_STANDARD)=0
virtual HWND  AddRollupPage (HINSTANCE hInst, MCHAR *dlgTemplate, DLGPROC dlgProc, MCHAR *title, LPARAM param, DWORD flags, int category) sealed
virtual void  DeleteRollupPage (HWND hRollup)=0
virtual IRollupWindow GetRollupWindow ()=0
ScripterExport RefResult  NotifyRefChanged (Interval changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message)
ScripterExport RefTargetHandle  clone_from (MSPlugin *obj, ReferenceTarget *obj_as_ref, RemapDir &remap)
void  RefAdded (RefMakerHandle rm)
void  NotifyTarget (int msg, RefMakerHandle rm)
virtual ReferenceTarget get_delegate ()=0
IOResult  Save (ISave *isave)
IOResult  Load (ILoad *iload)
void  post_load (ILoad *iload, int which)
void  dump_local_vars_and_externals (int indentLevel)

Public Attributes

MSPluginClass *  pc
Value **  locals
short  flags
int  version
ReferenceTarget ref
Tab< IParamBlock2 * >  pblocks
ILoad iload

Constructor & Destructor Documentation

MSPlugin ( ) [inline]
{ flags = 0; }
virtual ~MSPlugin ( ) [virtual]

Member Function Documentation

void init ( MSPluginClass *  pc )
ScripterExport void gc_trace ( ) [virtual]
ScripterExport void collect ( ) [virtual]
void init_locals ( )
void call_handler ( Value handler,
Value **  arg_list,
int  count,
TimeValue  t,
BOOL  disable_on_error = FALSE 
)
Value* _call_handler ( Value handler,
Value **  arg_list,
int  count,
TimeValue  t,
BOOL  disable_on_error = FALSE 
)
FPStatus call_handler ( const MCHAR *  handler_name,
FPParams params,
FPValue result,
TimeValue  t,
BOOL  disable_on_error = FALSE 
)
FPStatus call_handler ( Value handler,
FPParams params,
FPValue result,
TimeValue  t,
BOOL  disable_on_error = FALSE 
)
void post_create ( ReferenceTarget me,
BOOL  loading 
)
void call_all_set_handlers ( )
void disable ( ) [inline]
void enable ( ) [inline]
BOOL enabled ( ) [inline]
int get_local_index ( Value prop )
Value* get_local ( int  index ) [inline]
{ return locals[index]; }
void set_local ( int  index,
Value val 
) [inline]
virtual HWND AddRollupPage ( HINSTANCE  hInst,
MCHAR *  dlgTemplate,
DLGPROC  dlgProc,
MCHAR *  title,
LPARAM  param,
DWORD  flags,
int  category 
) [inline, sealed, virtual]
Deprecated:
Deprecated method in terms of implementation as of 3ds Max 2013 - re-implement with const MCHAR* method signature
                                                                                                                                                          { 
                return AddRollupPage(hInst, const_cast<const MCHAR*>(dlgTemplate), dlgProc, const_cast<const MCHAR*>(title), param, flags, category); }
ScripterExport RefTargetHandle clone_from ( MSPlugin obj,
ReferenceTarget obj_as_ref,
RemapDir remap 
)
void post_load ( ILoad iload,
int  which 
)
void dump_local_vars_and_externals ( int  indentLevel )

Member Data Documentation

short flags