MSSpecialFXXtnd< TYPE, MS_SUPER > Class Template Reference

#include <mxsPlugin.h>

Inheritance diagram for MSSpecialFXXtnd< TYPE, MS_SUPER >:

Public Member Functions
void	DeleteThis ()
ReferenceTarget *	get_delegate ()
void	GetClassName (MSTR &s, bool localized=true) 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)
int	NumRefs ()
RefTargetHandle	GetReference (int i)
void	SetReference (int i, RefTargetHandle rtarg)
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 Attributes
TYPE *	delegate

Member Function Documentation

DeleteThis()

void DeleteThis

(

)

get_delegate()

ReferenceTarget* get_delegate ( )

inline

{ return delegate; } 

GetClassName()

void GetClassName ( MSTR &  s, bool  localized = true  ) const

inlineoverride

{ UNUSED_PARAM(localized); s = MS_SUPER::pc->name->to_string(); }  // non-localized name

ClassID()

Class_ID ClassID ( )

inline

{ return MS_SUPER::pc->class_id; }

FreeCaches()

void FreeCaches ( )

inline

{ delegate->FreeCaches(); }         

NumSubs()

int NumSubs ( )

inline

{ return MS_SUPER::pblocks.Count() + 1; }  

SubAnim()

Animatable* SubAnim ( int  i )

inline

{ if (i == 0) { return delegate; } else return MS_SUPER::pblocks[i-1]; }

SubAnimName()

MSTR SubAnimName ( int  i, bool  localized = true  )

inlineoverride

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

NumParamBlocks()

int NumParamBlocks ( )

inline

{ return MS_SUPER::pblocks.Count(); }

GetParamBlock()

IParamBlock2* GetParamBlock ( int  i )

inline

{ return MS_SUPER::pblocks[i]; }

GetParamBlockByID()

IParamBlock2* GetParamBlockByID ( BlockID  id )

inline

{ return MSPlugin::GetParamBlockByID(id); }

GetInterface() [1/2]

void* GetInterface ( ULONG  id )

inline

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

GetInterface() [2/2]

virtual BaseInterface* GetInterface ( Interface_ID  id )

inlinevirtual

                                                        { 
        // 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 MSSpecialFXXtnd 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 MS_SUPER::GetInterface(id); 
    }

NumRefs()

int NumRefs

(

)

GetReference()

RefTargetHandle GetReference

(

int

i

)

SetReference()

void SetReference	(	int	i,
		RefTargetHandle	rtarg
	)

Active()

BOOL Active ( TimeValue  t )

inline

{ return delegate->Active(t); }

Update()

void Update	(	TimeValue	t,
		Interval &	valid
	)

NumGizmos()

int NumGizmos ( )

inline

{ return delegate->NumGizmos(); }

GetGizmo()

INode* GetGizmo ( int  i )

inline

{ return delegate->GetGizmo(i); }

DeleteGizmo()

void DeleteGizmo ( int  i )

inline

{ delegate->DeleteGizmo(i); }

AppendGizmo()

void AppendGizmo ( INode *  node )

inline

{ delegate->AppendGizmo(node); }

OKGizmo()

BOOL OKGizmo ( INode *  node )

inline

{ return delegate->OKGizmo(node); } 

EditGizmo()

void EditGizmo ( INode *  node )

inline

{ delegate->EditGizmo(node); } 

Member Data Documentation

delegate

TYPE* delegate