MSPluginSpecialFX< TYPE > Class Template Reference

#include <mxsPlugin.h>

Inheritance diagram for MSPluginSpecialFX< TYPE >:

Public Member Functions
void	DeleteThis ()
HWND	AddRollupPage (HINSTANCE hInst, const MCHAR *dlgTemplate, DLGPROC dlgProc, const MCHAR *title, LPARAM param=0, DWORD vflags=0, int category=ROLLUP_CAT_STANDARD) override
void	DeleteRollupPage (HWND hRollup) override
IRollupWindow *	GetRollupWindow () override
void	RollupMouseMessage (HWND hDlg, UINT message, WPARAM wParam, LPARAM lParam) override
ReferenceTarget *	get_delegate ()
void	GetClassName (MSTR &s, bool localized) const override
Class_ID	ClassID ()
void	FreeCaches ()
int	NumSubs ()
Animatable *	SubAnim (int i)
MSTR	SubAnimName (int i, bool localized=true) override
int	NumParamBlocks ()
IParamBlock2 *	GetParamBlock (int i)
IParamBlock2 *	GetParamBlockByID (BlockID id)
void *	GetInterface (ULONG id)
virtual BaseInterface *	GetInterface (Interface_ID id)
RefResult	NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate)
int	NumRefs ()
RefTargetHandle	GetReference (int i)
void	SetReference (int i, RefTargetHandle rtarg)
void	RefDeleted ()
void	RefAdded (RefMakerHandle rm)
IOResult	Save (ISave *iSave)
IOResult	Load (ILoad *iLoad)
MSTR	GetName (bool localized=true) const override
BOOL	Active (TimeValue t)
void	Update (TimeValue t, Interval &valid)
int	NumGizmos ()
INode *	GetGizmo (int i)
void	DeleteGizmo (int i)
void	AppendGizmo (INode *node)
BOOL	OKGizmo (INode *node)
void	EditGizmo (INode *node)
Public Member Functions inherited from MSPlugin
	MSPlugin ()
virtual	~MSPlugin ()
void	init (MSPluginClass *pClass)
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)
ScripterExport RefResult	NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate)
ScripterExport RefTargetHandle	clone_from (MSPlugin *obj, ReferenceTarget *obj_as_ref, RemapDir &remap)
void	RefAdded (RefMakerHandle rm)
void	NotifyTarget (int msg, RefMakerHandle rm)
IOResult	Load (ILoad *iLoad)
void	post_load (ILoad *iLoad, int which)
void	dump_local_vars_and_externals (int indentLevel)
Public Member Functions inherited from Value
virtual ScripterExport BOOL	is_kind_of (ValueMetaClass *c)
virtual ScripterExport ValueMetaClass *	local_base_class ()
virtual Value *	eval ()
virtual Value *	eval_no_wrapper ()
virtual ScripterExport Value *	apply (Value **arglist, int count, CallContext *cc=NULL)
virtual ScripterExport Value *	apply_no_alloc_frame (Value **arglist, int count, CallContext *cc=NULL)
virtual void	export_to_scripter ()
virtual Value *	map (node_map &m)
virtual Value *	map_path (PathName *path, node_map &m)
virtual Value *	find_first (BOOL(*test_fn)(INode *node, int level, const void *arg), const void *test_arg)
virtual Value *	get_path (PathName *path)
virtual ScripterExport void	sprin1 (CharStream *stream)
virtual ScripterExport void	sprint (CharStream *stream)
virtual void	prin1 ()
virtual void	print ()
virtual ScripterExport Class_ID	get_max_class_id ()
virtual ScripterExport Value *	delete_vf (Value **arglist, int arg_count)
virtual ScripterExport Value *	clearSelection_vf (Value **arglist, int arg_count)
virtual float	to_float ()
virtual double	to_double ()
virtual const MCHAR *	to_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 BitArray &	to_bitarray ()
virtual Point4	to_point4 ()
virtual Point3	to_point3 ()
virtual Point2	to_point2 ()
virtual AColor	to_acolor ()
virtual COLORREF	to_colorref ()
virtual INode *	to_node ()
virtual Ray	to_ray ()
virtual Interval	to_interval ()
virtual Quat	to_quat ()
virtual AngAxis	to_angaxis ()
virtual Matrix3 &	to_matrix3 ()
virtual Box3	to_box3 ()
virtual float *	to_eulerangles ()
virtual Mtl *	to_mtl ()
virtual Texmap *	to_texmap ()
virtual MtlBase *	to_mtlbase ()
virtual Modifier *	to_modifier ()
virtual TimeValue	to_timevalue ()
virtual Control *	to_controller ()
virtual Atmospheric *	to_atmospheric ()
virtual Effect *	to_effect ()
virtual IMultiPassCameraEffect *	to_mpassCamEffect ()
virtual ShadowType *	to_shadowtype ()
virtual FilterKernel *	to_filter ()
virtual INode *	to_rootnode ()
virtual ITrackViewNode *	to_trackviewnode ()
virtual NURBSIndependentPoint *	to_nurbsindependentpoint ()
virtual NURBSPoint *	to_nurbspoint ()
virtual NURBSObject *	to_nurbsobject ()
virtual NURBSControlVertex *	to_nurbscontrolvertex ()
virtual NURBSCurve *	to_nurbscurve ()
virtual NURBSCVCurve *	to_nurbscvcurve ()
virtual NURBSSurface *	to_nurbssurface ()
virtual NURBSTexturePoint *	to_nurbstexturepoint ()
virtual NURBSSet *	to_nurbsset ()
virtual ReferenceTarget *	to_reftarg ()
virtual Mesh *	to_mesh ()
virtual BezierShape *	to_beziershape ()
virtual Thunk *	to_thunk ()
virtual void	to_fpvalue (FPValue &v)
virtual Renderer *	to_renderer ()
virtual Box2 &	to_box2 ()
virtual NURBSTextureSurface *	to_nurbstexturesurface ()
virtual NURBSDisplay *	to_nurbsdisplay ()
virtual TessApprox *	to_tessapprox ()
virtual Value *	widen_to (Value *arg, Value **arg_list)
virtual BOOL	comparable (Value *arg)
virtual BOOL	special_case_compare (Value *arg, bool &specialCaseCompareResult)
virtual ScripterExport Value *	deep_copy (HashTable *remapper)
virtual BOOL	is_const ()
virtual ScripterExport Value *	get_property (Value **arg_list, int count)
virtual ScripterExport Value *	set_property (Value **arg_list, int count)
ScripterExport Value *	_get_property (Value *prop)
virtual ScripterExport Value *	_set_property (Value *prop, Value *val)
virtual Value *	get_container_property (Value *prop, Value *cur_prop)
virtual Value *	set_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_function ()
virtual BOOL	_is_selection ()
virtual BOOL	_is_thunk ()
virtual BOOL	_is_indirect_thunk ()
virtual SelectionIterator *	selection_iterator ()
virtual void	drop_MAX_refs ()
ScripterExport Value *	make_heap_permanent ()
ScripterExport Value *	make_heap_static ()
ScripterExport Value *	get_heap_ptr ()
ScripterExport Value *	get_stack_heap_ptr ()
ScripterExport Value *	migrate_to_heap ()
ScripterExport Value *	get_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 Value *	get_case_sensitive_property (Value **arg_list, int count, const TCHAR *case_sensitive_name)
virtual ScripterExport Value *	set_case_sensitive_property (Value **arg_list, int count, const TCHAR *case_sensitive_name)
ScripterExport Value *	invoke_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 Value *	invoke_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 void *	operator new (size_t sz, char flag)
ScripterExport void *	operator 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
IRendParams *	ip
Public Attributes inherited from MSPlugin
MSPluginClass *	pc
Value **	locals
short	flags
int	version
ReferenceTarget *	ref
Tab< IParamBlock2 * >	pblocks
ILoad *	iload
Public Attributes inherited from Value
ValueMetaClass *	tag
Public Attributes inherited from Collectable
Collectable *	next
Collectable *	prev
byte	flags
byte	flags2
short	flags3

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 Collectable *	collectable_list
static Collectable *	permanent_list
static free_mem *	free_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 Value *	keyarg_marker_value

Member Function Documentation

DeleteThis()

void DeleteThis

(

)

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

AddRollupPage()

HWND AddRollupPage ( HINSTANCE  hInst, const MCHAR *  dlgTemplate, DLGPROC  dlgProc, const MCHAR *  title, LPARAM  param = 0, DWORD  vflags = 0, int  category = ROLLUP_CAT_STANDARD  )

overridevirtual

Implements MSPlugin.

DeleteRollupPage()

void DeleteRollupPage ( HWND  hRollup )

overridevirtual

Implements MSPlugin.

GetRollupWindow()

IRollupWindow* GetRollupWindow ( )

overridevirtual

Implements MSPlugin.

RollupMouseMessage()

void RollupMouseMessage ( HWND  hDlg, UINT  message, WPARAM  wParam, LPARAM  lParam  )

overridevirtual

Implements MSPlugin.

get_delegate()

ReferenceTarget* get_delegate ( )

inlinevirtual

Implements MSPlugin.

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

{ return NULL; }  // no delegate

GetClassName()

void GetClassName ( MSTR &  s, bool  localized  ) const

inlineoverride

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

{ s = (localized) ? pc->ClassName() : pc->NonLocalizedClassName(); }

ClassID()

Class_ID ClassID ( )

inline

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

{ return pc->class_id; }

FreeCaches()

void FreeCaches ( )

inline

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

{ }         

NumSubs()

int NumSubs ( )

inline

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

{ return pblocks.Count(); }  

SubAnim()

Animatable* SubAnim ( int  i )

inline

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

{ return pblocks[i]; }

SubAnimName()

MSTR SubAnimName ( int  i, bool  localized = true  )

inlineoverride

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

    {
        if (pblocks[i]->GetDesc()->local_name != 0)
        {
            return localized ? pblocks[i]->GetLocalName() : pblocks[i]->GetDesc()->int_name.data();
        }
        else
        {
            return _T("");
        }
    }

NumParamBlocks()

int NumParamBlocks ( )

inline

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

{ return pblocks.Count(); }

GetParamBlock()

IParamBlock2* GetParamBlock ( int  i )

inline

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

{ return pblocks[i]; }

GetParamBlockByID()

IParamBlock2* GetParamBlockByID ( BlockID  id )

inline

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

{ return MSPlugin::GetParamBlockByID(id); }

GetInterface() [1/2]

void* GetInterface ( ULONG  id )

inline

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

{ if (id == I_MAXSCRIPTPLUGIN) return (MSPlugin*)this; else return TYPE::GetInterface(id); }

GetInterface() [2/2]

virtual BaseInterface* GetInterface ( Interface_ID  id )

inlinevirtual

Reimplemented from Value.

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

                                                       { 
        // GetInterface(Interface_ID) was added after the MAX 4
        // SDK shipped. This did not break the SDK because
        // it only calls the base class implementation. If you add
        // any other code here, plugins compiled with the MAX 4 SDK
        // that derive from MSPluginSpecialFX and call Base class
        // implementations of GetInterface(Interface_ID), will not call
        // that code in this routine. This means that the interface
        // you are adding will not be exposed for these objects,
        // and could have unexpected results.
        return TYPE::GetInterface(id); 
    }

NotifyRefChanged()

RefResult NotifyRefChanged ( const Interval &  changeInt, RefTargetHandle  hTarget, PartID &  partID, RefMessage  message, BOOL  propagate  )

inline

                    { 
                        return ((MSPlugin*)this)->NotifyRefChanged(changeInt, hTarget, partID, message, propagate); 
                    }

NumRefs()

int NumRefs

(

)

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

GetReference()

RefTargetHandle GetReference

(

int

i

)

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

SetReference()

void SetReference	(	int	i,
		RefTargetHandle	rtarg
	)

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

RefDeleted()

void RefDeleted ( )

inline

{ MSPlugin::RefDeleted(); }

RefAdded()

void RefAdded ( RefMakerHandle  rm )

inline

{ MSPlugin::RefAdded( rm); }

Save()

IOResult Save ( ISave *  iSave )

inlinevirtual

Reimplemented from MSPlugin.

{ MSPlugin::Save(iSave); return SpecialFX::Save(iSave); }

Load()

IOResult Load ( ILoad *  iLoad )

inline

{ MSPlugin::Load(iLoad); return SpecialFX::Load(iLoad); }

GetName()

MSTR GetName ( bool  localized = true ) const

inlineoverride

{ return localized ? pc->class_name->to_string() : pc->nonLocalized_class_name->to_string(); }

Active()

BOOL Active ( TimeValue  t )

inline

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

{ return SpecialFX::Active(t); }

Update()

void Update ( TimeValue  t, Interval &  valid  )

inline

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

{ SpecialFX::Update(t, valid); }

NumGizmos()

int NumGizmos ( )

inline

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

{ return SpecialFX::NumGizmos(); }

GetGizmo()

INode* GetGizmo ( int  i )

inline

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

{ return SpecialFX::GetGizmo(i); }

DeleteGizmo()

void DeleteGizmo ( int  i )

inline

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

{ SpecialFX::DeleteGizmo(i); }

AppendGizmo()

void AppendGizmo ( INode *  node )

inline

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

{ SpecialFX::AppendGizmo(node); }

OKGizmo()

BOOL OKGizmo ( INode *  node )

inline

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

{ return SpecialFX::OKGizmo(node); } 

EditGizmo()

void EditGizmo ( INode *  node )

inline

Reimplemented in MSSpecialFXXtnd< Effect, MSPluginEffect >, and MSSpecialFXXtnd< Atmospheric, MSPluginAtmos >.

{ SpecialFX::EditGizmo(node); } 

Member Data Documentation

ip

IRendParams* ip