MSObjectXtnd< TYPE, MS_SUPER > Class Template Reference

#include <mxsPlugin.h>

Inheritance diagram for MSObjectXtnd< TYPE, MS_SUPER >:

Public Member Functions
void	DeleteThis ()
	MSObjectXtnd ()
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)
const MCHAR *	GetObjectName (bool localized=true) const override
void	BeginEditParams (IObjParam *objParam, ULONG vflags, Animatable *pPrev)
void	EndEditParams (IObjParam *objParam, ULONG vflags, Animatable *pNext)
int	HitTest (TimeValue t, INode *inode, int type, int crossing, int vflags, IPoint2 *p, ViewExp *vpt)
int	Display (TimeValue t, INode *inode, ViewExp *vpt, int vflags)
virtual unsigned long	GetObjectDisplayRequirement () const
virtual bool	PrepareDisplay (const MaxSDK::Graphics::UpdateDisplayContext &prepareDisplayContext)
virtual bool	UpdatePerNodeItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer)
virtual bool	UpdatePerViewItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::UpdateViewContext &viewContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer)
const MaxSDK::Graphics::RenderItemHandleArray &	GetRenderItems () const
void	GetWorldBoundBox (TimeValue t, INode *inode, ViewExp *vpt, Box3 &box)
void	GetLocalBoundBox (TimeValue t, INode *inode, ViewExp *vpt, Box3 &box)
void	Snap (TimeValue t, INode *inode, SnapInfo *snap, IPoint2 *p, ViewExp *vpt)
CreateMouseCallBack *	GetCreateMouseCallBack ()
BOOL	HasUVW ()
void	SetGenUVW (BOOL sw)
void	SetExtendedDisplay (int vflags)
ObjectState	Eval (TimeValue time)
void	InitNodeName (MSTR &s)
Interval	ObjectValidity (TimeValue t)
int	CanConvertToType (Class_ID obtype)
Object *	ConvertToType (TimeValue t, Class_ID obtype)
void	GetCollapseTypes (Tab< Class_ID > &clist, Tab< MSTR * > &nlist)
void	GetDeformBBox (TimeValue t, Box3 &box, Matrix3 *tm, BOOL useSel)
int	IntersectRay (TimeValue t, Ray &r, float &at, Point3 &norm)

Public Attributes
TYPE *	delegate

Constructor & Destructor Documentation

MSObjectXtnd()

MSObjectXtnd ( )

inline

: MS_SUPER() {}

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)
        {
            return delegate->GetObjectName(localized);
        }
        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 MSObjectXtnd 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
	)

GetObjectName()

const MCHAR* GetObjectName ( bool  localized = true ) const

inlineoverride

{ return MS_SUPER::pc->name->to_string(); } // non-localized name

BeginEditParams()

void BeginEditParams	(	IObjParam *	objParam,
		ULONG	vflags,
		Animatable *	pPrev
	)

EndEditParams()

void EndEditParams	(	IObjParam *	objParam,
		ULONG	vflags,
		Animatable *	pNext
	)

HitTest()

int HitTest ( TimeValue  t, INode *  inode, int  type, int  crossing, int  vflags, IPoint2 *  p, ViewExp *  vpt  )

inline

                        { return delegate->HitTest(t, inode, type, crossing, vflags, p, vpt); }

Display()

int Display ( TimeValue  t, INode *  inode, ViewExp *  vpt, int  vflags  )

inline

                    { return delegate->Display(t, inode, vpt, vflags); }

GetObjectDisplayRequirement()

virtual unsigned long GetObjectDisplayRequirement ( ) const

virtual

PrepareDisplay()

virtual bool PrepareDisplay ( const MaxSDK::Graphics::UpdateDisplayContext &  prepareDisplayContext )

virtual

UpdatePerNodeItems()

virtual bool UpdatePerNodeItems ( const MaxSDK::Graphics::UpdateDisplayContext &  updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &  nodeContext, MaxSDK::Graphics::IRenderItemContainer &  targetRenderItemContainer  )

virtual

UpdatePerViewItems()

virtual bool UpdatePerViewItems ( const MaxSDK::Graphics::UpdateDisplayContext &  updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &  nodeContext, MaxSDK::Graphics::UpdateViewContext &  viewContext, MaxSDK::Graphics::IRenderItemContainer &  targetRenderItemContainer  )

virtual

GetRenderItems()

const MaxSDK::Graphics::RenderItemHandleArray& GetRenderItems ( ) const

inline

                    { return delegate->GetRenderItems(); }

GetWorldBoundBox()

void GetWorldBoundBox ( TimeValue  t, INode *  inode, ViewExp *  vpt, Box3 &  box  )

inline

{ delegate->GetWorldBoundBox(t, inode, vpt, box); }

GetLocalBoundBox()

void GetLocalBoundBox ( TimeValue  t, INode *  inode, ViewExp *  vpt, Box3 &  box  )

inline

{ delegate->GetLocalBoundBox(t, inode, vpt,  box ); }

Snap()

void Snap ( TimeValue  t, INode *  inode, SnapInfo *  snap, IPoint2 *  p, ViewExp *  vpt  )

inline

{ delegate->Snap(t, inode, snap, p, vpt); }

GetCreateMouseCallBack()

CreateMouseCallBack* GetCreateMouseCallBack

(

)

HasUVW()

BOOL HasUVW ( )

inline

{ return delegate->HasUVW(); }

SetGenUVW()

void SetGenUVW ( BOOL  sw )

inline

{ delegate->SetGenUVW(sw); }

SetExtendedDisplay()

void SetExtendedDisplay ( int  vflags )

inline

{ delegate->SetExtendedDisplay( vflags); }      // for setting mode-dependent display attributes

Eval()

ObjectState Eval

(

TimeValue

time

)

InitNodeName()

void InitNodeName ( MSTR &  s )

inline

{s = GetObjectName(true);} // non-localized name

ObjectValidity()

Interval ObjectValidity

(

TimeValue

t

)

CanConvertToType()

int CanConvertToType ( Class_ID  obtype )

inline

{ return delegate->CanConvertToType(obtype); }

ConvertToType()

Object* ConvertToType ( TimeValue  t, Class_ID  obtype  )

inline

                                                                {
                        // CAL-10/1/2002: Don't return the delegate, because it might be deleted.
                        //      Return a copy of the delegate instead. (422964)
                        Object* obj = delegate->ConvertToType(t, obtype);
                        if (obj == delegate) 
                        {
                            obj = delegate->MakeShallowCopy(OBJ_CHANNELS);
                            obj->LockChannels(OBJ_CHANNELS); //if we shallow copy these channels they need to be locked since they will get double deleted
                        }
                        return obj;
                    }

GetCollapseTypes()

void GetCollapseTypes ( Tab< Class_ID > &  clist, Tab< MSTR * > &  nlist  )

inline

{ delegate->GetCollapseTypes(clist, nlist); }

GetDeformBBox()

void GetDeformBBox ( TimeValue  t, Box3 &  box, Matrix3 *  tm, BOOL  useSel  )

inline

{ delegate->GetDeformBBox(t, box, tm, useSel); }

IntersectRay()

int IntersectRay ( TimeValue  t, Ray &  r, float &  at, Point3 &  norm  )

inline

{ return delegate->IntersectRay(t, r, at, norm); }

Member Data Documentation

delegate

TYPE* delegate