MSTexmapXtnd Class Reference

#include <mxsPlugin.h>

Inheritance diagram for MSTexmapXtnd:

Public Member Functions
	MSTexmapXtnd (MSPluginClass *pc, BOOL loading)
	~MSTexmapXtnd ()
void	DeleteThis () override
	Deletes an instance of this class.
ReferenceTarget *	get_delegate () override
void	GetClassName (MSTR &s, bool localized) const override
	Retrieves the name of the plugin class.
Class_ID	ClassID () override
	Retrieves a constant that uniquely identifies the plugin class.
void	FreeCaches () override
int	NumSubs () override
Animatable *	SubAnim (int i) override
MSTR	SubAnimName (int i, bool localized=true) override
int	NumParamBlocks () override
IParamBlock2 *	GetParamBlock (int i) override
IParamBlock2 *	GetParamBlockByID (BlockID id) override
void *	GetInterface (ULONG id) override
int	NumRefs () override
	Returns the total number of references this ReferenceMaker can hold.
RefTargetHandle	GetReference (int i) override
	Returns the 'i-th' reference.
RefTargetHandle	Clone (RemapDir &remap) override
	This method is used by 3ds Max to clone an object.
RefResult	NotifyDependents (const Interval &changeInt, PartID partID, RefMessage message, SClass_ID sclass, BOOL propagate, RefTargetHandle hTarg, NotifyDependentsOption notifyDependentsOption) override
	Send a notification all classes that reference this class.
int	BuildMaps (TimeValue t, RenderMapsContext &rmc) override
ULONG	Requirements (int subMtlNum) override
ULONG	LocalRequirements (int subMtlNum) override
void	MappingsRequired (int subMtlNum, BitArray &mapreq, BitArray &bumpreq) override
void	LocalMappingsRequired (int subMtlNum, BitArray &mapreq, BitArray &bumpreq) override
BOOL	IsMultiMtl () override
void	Update (TimeValue t, Interval &valid) override
void	Reset () override
Interval	Validity (TimeValue t) override
ParamDlg *	CreateParamDlg (HWND hwMtlEdit, IMtlParams *imp) override
IOResult	Save (ISave *iSave) override
IOResult	Load (ILoad *iLoad) override
ULONG	GetGBufID ()
void	SetGBufID (ULONG id)
void	EnumAuxFiles (AssetEnumCallback &assetEnum, DWORD vflags) override
PStamp *	GetPStamp (int sz) override
PStamp *	CreatePStamp (int sz)
void	DiscardPStamp (int sz) override
int	NumSubTexmaps () override
Texmap *	GetSubTexmap (int i) override
void	SetSubTexmap (int i, Texmap *m) override
MSTR	GetSubTexmapSlotName (int i, bool localized=true) override
BOOL	SupportTexDisplay () override
DWORD_PTR	GetActiveTexHandle (TimeValue t, TexHandleMaker &thmaker) override
void	ActivateTexDisplay (BOOL onoff) override
BOOL	SupportsMultiMapsInViewport () override
void	SetupGfxMultiMaps (TimeValue t, Material *mtl, MtlMakerCallback &cb) override
ReferenceTarget *	GetRefTarget () override
AColor	EvalColor (ShadeContext &sc) override
float	EvalMono (ShadeContext &sc) override
Point3	EvalNormalPerturb (ShadeContext &sc) override
BOOL	HandleOwnViewPerturb () override
BITMAPINFO *	GetVPDisplayDIB (TimeValue t, TexHandleMaker &thmaker, Interval &valid, BOOL mono=FALSE, int forceW=0, int forceH=0) override
void	GetUVTransform (Matrix3 &uvtrans) override
int	GetTextureTiling () override
void	InitSlotType (int sType) override
int	GetUVWSource () override
int	GetMapChannel () override
UVGen *	GetTheUVGen () override
XYZGen *	GetTheXYZGen () override
void	SetOutputLevel (TimeValue t, float v) override
int	LoadMapFiles (TimeValue t) override
void	RenderBitmap (TimeValue t, Bitmap *bm, float scale3D=1.0f, BOOL filter=FALSE) override
bool	IsLocalOutputMeaningful (ShadeContext &sc) override
bool	IsOutputMeaningful (ShadeContext &sc) override
int	IsHighDynamicRange ()
void *	GetInterface (ULONG id) override
Public Member Functions inherited from MSPluginTexmap
	MSPluginTexmap ()
	MSPluginTexmap (MSPluginClass *pc, BOOL loading)
	~MSPluginTexmap ()
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 () override
void	DeleteThis () override
	Deletes an instance of this class.
void	GetClassName (MSTR &s, bool localized) const override
	Retrieves the name of the plugin class.
Class_ID	ClassID () override
	Retrieves a constant that uniquely identifies the plugin class.
void	FreeCaches () override
int	NumSubs () override
Animatable *	SubAnim (int i) override
MSTR	SubAnimName (int i, bool localized=true) override
int	NumParamBlocks () override
IParamBlock2 *	GetParamBlock (int i) override
IParamBlock2 *	GetParamBlockByID (BlockID id) override
void *	GetInterface (ULONG id) override
RefResult	NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate) override
	Receives and responds to messages.
int	NumRefs () override
	Returns the total number of references this ReferenceMaker can hold.
RefTargetHandle	GetReference (int i) override
	Returns the 'i-th' reference.
void	RefDeleted (RefMakerHandle rm) override
void	RefAdded (RefMakerHandle rm) override
	Called after a reference is made to a target.
void	RefAddedUndoRedo (RefMakerHandle rm) override
	Called after a reference is made to a target because of undo or redo.
void	RefDeletedUndoRedo (RefMakerHandle rm) override
	Called after a reference to this is deleted because of undo or redo.
RefTargetHandle	Clone (RemapDir &remap) override
	This method is used by 3ds Max to clone an object.
MSTR	GetFullName (bool localized=true) override
int	BuildMaps (TimeValue t, RenderMapsContext &rmc) override
ULONG	Requirements (int subMtlNum) override
ULONG	LocalRequirements (int subMtlNum) override
void	MappingsRequired (int subMtlNum, BitArray &mapreq, BitArray &bumpreq) override
void	LocalMappingsRequired (int subMtlNum, BitArray &mapreq, BitArray &bumpreq) override
BOOL	IsMultiMtl () override
int	NumSubTexmaps () override
Texmap *	GetSubTexmap (int i) override
void	SetSubTexmap (int i, Texmap *m) override
MSTR	GetSubTexmapSlotName (int i, bool localized=true) override
MSTR	GetSubTexmapTVName (int i, bool localized=true)
void	Update (TimeValue t, Interval &valid) override
void	Reset () override
Interval	Validity (TimeValue t) override
ParamDlg *	CreateParamDlg (HWND hwMtlEdit, IMtlParams *imp) override
IOResult	Save (ISave *iSave) override
IOResult	Load (ILoad *iLoad) override
ULONG	GetGBufID ()
void	SetGBufID (ULONG id)
void	EnumAuxFiles (AssetEnumCallback &assetEnum, DWORD vflags) override
PStamp *	GetPStamp (int sz) override
PStamp *	CreatePStamp (int sz)
void	DiscardPStamp (int sz) override
BOOL	SupportTexDisplay () override
DWORD_PTR	GetActiveTexHandle (TimeValue t, TexHandleMaker &thmaker) override
void	ActivateTexDisplay (BOOL onoff) override
BOOL	SupportsMultiMapsInViewport () override
void	SetupGfxMultiMaps (TimeValue t, Material *mtl, MtlMakerCallback &cb) override
ReferenceTarget *	GetRefTarget () override
AColor	EvalColor (ShadeContext &sc) override
float	EvalMono (ShadeContext &sc) override
Point3	EvalNormalPerturb (ShadeContext &sc) override
BOOL	HandleOwnViewPerturb () override
void	GetUVTransform (Matrix3 &uvtrans) override
int	GetTextureTiling () override
void	InitSlotType (int sType) override
int	GetUVWSource () override
int	GetMapChannel () override
UVGen *	GetTheUVGen () override
XYZGen *	GetTheXYZGen () override
void	SetOutputLevel (TimeValue t, float v) override
int	LoadMapFiles (TimeValue t) override
void	RenderBitmap (TimeValue t, Bitmap *bm, float scale3D=1.0f, BOOL filter=FALSE) override
bool	IsLocalOutputMeaningful (ShadeContext &sc) override
bool	IsOutputMeaningful (ShadeContext &sc) override
Public Member Functions inherited from MSPlugin
	MSPlugin ()
virtual	~MSPlugin ()
void	init (MSPluginClass *pClass)
ScripterExport void	gc_trace () override
ScripterExport void	collect () override
void	DeleteThis ()
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 vflags=0, int category=ROLLUP_CAT_STANDARD)=0
virtual void	DeleteRollupPage (HWND hRollup)=0
virtual IRollupWindow *	GetRollupWindow ()=0
virtual void	RollupMouseMessage (HWND hDlg, UINT message, WPARAM wParam, LPARAM lParam)=0
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)
ScripterExport void	RefDeleted (RefMakerHandle rm)
void	NotifyTarget (int msg, RefMakerHandle rm)
virtual ReferenceTarget *	get_delegate ()=0
IOResult	Save (ISave *isave) override
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=nullptr)
virtual ScripterExport Value *	apply_no_alloc_frame (Value **arglist, int count, CallContext *cc=nullptr)
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 Class_ID	get_max_class_id ()
virtual Value *	delete_vf (Value **arglist, int arg_count)
virtual 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 ScripterExport IOResult	Save (ISave *isave)
virtual void	drop_MAX_refs ()
virtual BaseInterface *	GetInterface (Interface_ID id)
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)
virtual void	collect ()=0
virtual ScripterExport void	gc_trace ()
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 Member Functions inherited from Texmap
CoreExport	Texmap ()
SClass_ID	SuperClassID ()
	Retrieves a constant representing the type of the plugin.
virtual void	GetClassName (MSTR &s, bool localized=true) const override
	Retrieves the name of the plugin class.
virtual CoreExport BITMAPINFO *	GetVPDisplayDIB (TimeValue t, TexHandleMaker &thmaker, Interval &valid, BOOL mono=FALSE, int forceW=0, int forceH=0)
CoreExport void	RecursInitSlotType (int sType)
CoreExport void	RefAdded (RefMakerHandle rm)
	Called after a reference is made to a target.
CoreExport SvGraphNodeReference	SvTraverseAnimGraph (IGraphObjectManager *gom, Animatable *owner, int id, DWORD flags)
virtual int	IsHighDynamicRange () const
virtual int	MapSlotType (int i)
Public Member Functions inherited from MtlBase
CoreExport	MtlBase ()
CoreExport	~MtlBase ()
virtual CoreExport Class_ID	ClassID ()
	Retrieves a constant that uniquely identifies the plugin class.
int	GetMeditObjType ()
void	SetMeditObjType (int t)
int	GetMeditTiling ()
void	SetMeditTiling (int t)
CoreExport BOOL	AnyMulti ()
BOOL	TextureDisplayEnabled ()
CoreExport MtlBase &	operator= (const MtlBase &m)
CoreExport SvGraphNodeReference	SvTraverseAnimGraph (IGraphObjectManager *gom, Animatable *owner, int id, DWORD flags)
CoreExport bool	SvHandleDoubleClick (IGraphObjectManager *gom, IGraphNode *gNode)
CoreExport MSTR	SvGetName (IGraphObjectManager *gom, IGraphNode *gNode, bool isBeingEdited)
CoreExport bool	SvCanSetName (IGraphObjectManager *gom, IGraphNode *gNode)
CoreExport bool	SvSetName (IGraphObjectManager *gom, IGraphNode *gNode, const MSTR &name)
CoreExport COLORREF	SvHighlightColor (IGraphObjectManager *gom, IGraphNode *gNode)
CoreExport bool	SvIsSelected (IGraphObjectManager *gom, IGraphNode *gNode)
	Returns true if the object is selected in its schematic view.
CoreExport MultiSelectCallback *	SvGetMultiSelectCallback (IGraphObjectManager *gom, IGraphNode *gNode)
CoreExport bool	SvCanSelect (IGraphObjectManager *gom, IGraphNode *gNode)
CoreExport MtlBase *	GetActiveMB ()
	Get the active MtlBase.
CoreExport void	SetActiveMB (MtlBase *activeMB)
	Set the active MtlBase.
virtual CoreExport void *	GetInterface (ULONG id)
virtual BaseInterface *	GetInterface (Interface_ID id)
virtual ReferenceTarget *	GetRefTarget ()
virtual CoreExport int	SetProperty (ULONG id, void *data)
virtual CoreExport void *	GetProperty (ULONG id)
virtual CoreExport void	BaseClone (ReferenceTarget *from, ReferenceTarget *to, RemapDir &remap)
	This method copies base class data from an object to its clone.
virtual BOOL	GetTransparencyHint (TimeValue t, Interval &valid)
	Transparency hint indicates whether the material is potentially transparent for both rendering and viewport display, so that the renderers or viewport can decide whether to optimize it or not.
MSTR &	GetName ()
CoreExport void	SetName (MSTR s)
	__declspec (deprecated) virtual MSTR GetFullName() MAX_SEALED
CoreExport void	SetMtlFlag (int mask, BOOL val=TRUE)
CoreExport void	ClearMtlFlag (int mask)
CoreExport int	TestMtlFlag (int mask)
CoreExport void	DeactivateMapsInTree ()
void	Update (TimeValue t, Interval &&valid=FOREVER)
ULONG	GetGBufID ()
void	SetGBufID (ULONG id)
virtual CoreExport PStamp *	CreatePStamp (int sz, BOOL Render=FALSE)
CoreExport void	IncrActive ()
CoreExport void	DecrActive ()
int	Active ()
Public Member Functions inherited from ReferenceTarget
CoreExport void	GetClassName (MSTR &s, bool localized=true) const override
	Retrieves the name of the plugin class.
CoreExport SClass_ID	SuperClassID () override
	Retrieves a constant representing the type of the plugin.
BOOL	IsRefTarget () override
	Checks if this is a ReferenceTarget.
CoreExport RefResult	TestForLoop (const Interval &refInterval, RefMakerHandle hmaker)
	Tests for a cyclical reference.
CoreExport BOOL	HasDependents ()
	Checks if a ReferenceTarget has references.
CoreExport BOOL	HasRealDependents ()
	Checks if this has Real (Strong) Dependents.
void	BeginDependencyTest ()
	Starts Dependency Test.
BOOL	EndDependencyTest ()
	Ends Dependency Test.
	__declspec (deprecated) virtual void RefDeleted() final
virtual void	RefDeleted (ReferenceMaker *oldOwner)
	Called after a reference to this is deleted.
	__declspec (deprecated) virtual void RefDeletedUndoRedo() final
CoreExport RefResult	DeleteAllRefsToMe () override
	Deletes all references to this ReferenceTarget.
CoreExport RefResult	TransferReferences (RefTargetHandle oldTarget, BOOL delOld=FALSE)
	Transfers all the references from oldTarget to this.
CoreExport int	DoEnumDependents (DependentEnumProc *dep)
	Begins an enumeration that searches back in the dependency network.
CoreExport RefResult	NotifyDependents (const Interval &changeInt, PartID partID, RefMessage message, SClass_ID sclass=NOTIFY_ALL, BOOL propagate=TRUE, RefTargetHandle hTarg=nullptr, NotifyDependentsOption notifyDependentsOption=REFNOTIFY_ALLOW_OPTIMIZATIONS) override
	Notify all dependent RefMakers concerned with the message.
void	FlagDependents (TimeValue t, PartID which=PART_PUT_IN_FG)
	This sends the REFMSG_FLAGDEPENDENTS message up the pipeline.
virtual void	NotifyForeground (TimeValue t)
	This method is called to flag dependents into the FG.
virtual void	NotifyTarget (int message, ReferenceMaker *hMaker)
	Sends messages to ReferenceTargets.
CoreExport BaseInterface *	GetInterface (Interface_ID id) override
	Inherited from Animatable.
CoreExport	ReferenceTarget ()
	Constructor.
virtual CoreExport RefResult	AutoDelete ()
	Deletes the object when it has no more real dependents.
CoreExport RefResult	MaybeAutoDelete ()
	Deletes the object when it has no more real dependents.
Public Member Functions inherited from ReferenceMaker
void	GetClassName (MSTR &s, bool localized=true) const override
	Retrieves the name of the plugin class.
CoreExport SClass_ID	SuperClassID () override
	Retrieves a constant representing the type of the plugin.
CoreExport RefResult	ReplaceReference (int which, RefTargetHandle newtarg, BOOL delOld=TRUE)
	Used when cloning reference makers.
CoreExport RefResult	DeleteAllRefsFromMe ()
	Deletes all references from this ReferenceMaker.
CoreExport RefResult	DeleteAllRefs ()
	Deletes all references both to and from this item.
CoreExport RefResult	DeleteReference (int i)
	Deletes the specified reference.
virtual BOOL	CanTransferReference (int i)
	Tells whether this reference can be transfered.
CoreExport ReferenceSaveManager &	GetReferenceSaveManager ()
	Access the ReferenceSaveManager of this ReferenceMaker.
virtual CoreExport IOResult	Save (ISave *isave, ChannelMask)
	Access the ReferenceSaveManager of this ReferenceMaker.
virtual CoreExport IOResult	Load (ILoad *iload, ChannelMask)
	Access the ReferenceSaveManager of this ReferenceMaker.
virtual int	RemapRefOnLoad (int iref)
	Used to load old files with references.
virtual CoreExport void	RescaleWorldUnits (float f)
	Rescale size of all world units in reference hierarchy.
CoreExport void	EnumAuxFiles (AssetEnumCallback &assetEnum, DWORD flags) override
	Enumerate auxiliary files (e.g. bitmaps)
virtual CoreExport void	SaveEnum (SaveEnumProc &sep, BOOL isNodeCall=0)
	The default save enumeration.
virtual CoreExport bool	SpecifySaveReferences (ReferenceSaveManager &referenceSaveManager)
	Used to specify reference slot remapping during scene file save.
CoreExport int	DoEnumDependents (DependentEnumProc *dep)
	Begins an enumeration that searches back in the dependency network.
CoreExport bool	EnumRefHierarchy (RefEnumProc &proc, bool includeCustAttribs=true, bool includeIndirectRefs=true, bool includeNonPersistentRefs=true, bool preventDuplicatesViaFlag=true)
	This method provides a general purpose reference enumerator.
CoreExport int	FindRef (RefTargetHandle rtarg)
	Get the index of the ReferenceTarget.
BOOL	IsRefMaker () override
	Tells whether it is a ReferenceMaker.
virtual BOOL	IsRealDependency (ReferenceTarget *rtarg)
	Returns whether this is a "real" (strong) dependency or not.
virtual BOOL	ShouldPersistWeakRef (RefTargetHandle rtarg)
	Specifies whether a weak reference is to be persisted on a partial load or save.
CoreExport	ReferenceMaker ()
	Constructor.
CoreExport void	DeleteMe ()
	Deletes an instance of this class.
Public Member Functions inherited from Animatable
virtual void	FreeCaches ()
virtual int	NumChildren ()
virtual Animatable *	ChildAnim (int i)
virtual CoreExport MSTR	NodeName ()
virtual void	EditTrack ()
virtual CoreExport BOOL	SubAnimSetKeyBufferPresent (int subNum)
	returns true if the sub-anim has a "Set Key" buffer present
virtual BOOL	SetKeyBufferPresent ()
	returns true if there is a "Set Key" buffer present
virtual CoreExport void	SubAnimCommitSetKeyBuffer (TimeValue t, int subNum)
	Commit any "Set Key" buffers on the given sub-anim.
virtual void	CommitSetKeyBuffer (TimeValue t)
	Commit any "Set Key" buffers.
virtual CoreExport void	SubAnimRevertSetKeyBuffer (int subNum)
	Revert any "Set Key" buffers on the given sub-anim.
virtual void	RevertSetKeyBuffer ()
	Revert any "Set Key" buffers.
virtual LRESULT CALLBACK	TrackViewWinProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
	This function is obsolete.
virtual BOOL	IsRefMaker ()
	Tells whether it is a ReferenceMaker.
virtual bool	IsParamBlockDesc2Used (ParamBlockDesc2 *desc)
	Returns true if the passed description is being used.
virtual bool	GetMacroRecorderName (bool used_as_rhs_value, MSTR &objectSpecifiedName)
	This method is called to access the object specified name to use for the Maxscript macrorecorder.
CoreExport	Animatable ()
	Constructor.
MSTR	ClassName (bool localized=true) const
	Returns the name of the plugin class.
virtual void	BeginEditParams (IObjParam *ip, ULONG flags, Animatable *prev=NULL)
virtual void	EndEditParams (IObjParam *ip, ULONG flags, Animatable *next=NULL)
virtual CoreExport void	ReleaseInterface (ULONG id, void *i)
CoreExport void	AppendProperty (AnimProperty *prop)
	A function to directly add arbitrary properties to this object developers should ensure that the properties ID does not conflict with any Max-specific IDs.
CoreExport AnimProperty *	FindProperty (DWORD id)
	Find any property.
CoreExport void	AddAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid, DWORD len, void *data)
	Adds application/plugin specific (custom) data to an Animatable.
CoreExport AppDataChunk *	GetAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
	Retrieves the application/plugin specific (custom) data stored with an Animatable.
CoreExport BOOL	RemoveAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
	Deletes the application/plugin specific (custom) data stored with an Animatable.
CoreExport void	ClearAllAppData ()
	Deletes all application/plugin specific (custom) data stored with an Animatable.
	__declspec (deprecated) virtual MSTR SubAnimName(int i) MAX_SEALED
virtual BOOL	CanDeleteSubAnim (int i)
virtual void	DeleteSubAnim (int i)
virtual DWORD	GetSubAnimCurveColor (int subNum)
virtual int	SubNumToRefNum (int subNum)
virtual BOOL	CanCopyAnim ()
CoreExport int	HasSubElements (int type=0)
virtual int	GetSubFCurveExtents (int subNum, ParamDimensionBase *dim, float &min, float &max, DWORD flags)
	The values max and min should be initialized before calling this function.
virtual ParamDimension *	GetParamDimension (int i)
virtual BOOL	SelectSubAnim (int subNum)
virtual BOOL	BypassTreeView ()
virtual BOOL	BypassTrackBar ()
virtual BOOL	BypassPropertyLevel ()
virtual BOOL	InvisibleProperty ()
virtual int	NumKeys ()
virtual TimeValue	GetKeyTime (int index)
virtual int	GetKeyIndex (TimeValue t)
virtual BOOL	GetNextKeyTime (TimeValue t, DWORD flags, TimeValue &nt)
virtual void	CopyKeysFromTime (TimeValue src, TimeValue dst, DWORD flags)
virtual void	DeleteKeyAtTime (TimeValue t)
virtual BOOL	IsKeyAtTime (TimeValue t, DWORD flags)
virtual int	GetKeyTimes (Tab< TimeValue > &times, Interval range, DWORD flags)
virtual int	GetKeySelState (BitArray &sel, Interval range, DWORD flags)
CoreExport void	OpenTreeEntry (int type, DWORD tv)
CoreExport void	CloseTreeEntry (int type, DWORD tv)
CoreExport int	IsTreeEntryOpen (int type, DWORD tv)
CoreExport BOOL	GetSelInTrackView (DWORD tv)
CoreExport void	SetSelInTrackView (DWORD tv, BOOL sel)
CoreExport BOOL	InTrackViewSelSet (int which)
CoreExport void	SetTrackViewSelSet (int which, BOOL inOut)
virtual BOOL	AssignController (Animatable *control, int subAnim)
virtual BOOL	CanAssignController (int subAnim)
	Return true if we can reassign the subanim specified.
virtual BOOL	CanMakeUnique ()
CoreExport int	EnumAnimTree (AnimEnum *animEnum, Animatable *client, int subNum)
virtual int	RenderBegin (TimeValue t, ULONG flags=0)
virtual int	RenderEnd (TimeValue t)
virtual CoreExport Interval	GetTimeRange (DWORD flags)
virtual void	EditTimeRange (Interval range, DWORD flags)
virtual void	DeleteTime (Interval iv, DWORD flags)
virtual void	ReverseTime (Interval iv, DWORD flags)
virtual void	ScaleTime (Interval iv, float s)
virtual void	InsertTime (TimeValue ins, TimeValue amount)
virtual BOOL	SupportTimeOperations ()
virtual CoreExport void	MapKeys (TimeMap *map, DWORD flags)
virtual void	DeleteKeys (DWORD flags)
virtual void	DeleteKeyByIndex (int index)
virtual void	SelectKeys (TrackHitTab &sel, DWORD flags)
virtual void	SelectSubKeys (int subNum, TrackHitTab &sel, DWORD flags)
virtual void	SelectSubCurve (int subNum, BOOL sel)
virtual void	SelectKeyByIndex (int i, BOOL sel)
virtual BOOL	IsKeySelected (int i)
virtual void	FlagKey (TrackHitRecord hit)
virtual int	GetFlagKeyIndex ()
virtual int	NumSelKeys ()
virtual void	CloneSelectedKeys (BOOL offset=FALSE)
virtual void	AddNewKey (TimeValue t, DWORD flags)
virtual void	MoveKeys (ParamDimensionBase *dim, float delta, DWORD flags)
virtual void	ScaleKeyValues (ParamDimensionBase *dim, float origin, float scale, DWORD flags)
virtual void	SelectCurve (BOOL sel)
virtual BOOL	IsCurveSelected ()
	Returns TRUE if the function curve is selected; otherwise returns FALSE.
virtual BOOL	IsSubCurveSelected (int subNum)
	Returns the selected state of the sub-curve whose index is passed.
virtual int	GetSelKeyCoords (TimeValue &t, float &val, DWORD flags)
virtual void	SetSelKeyCoords (TimeValue t, float val, DWORD flags)
virtual int	SetSelKeyCoordsExpr (ParamDimension *dim, const MCHAR *timeExpr, const MCHAR *valExpr, DWORD flags)
virtual void	AdjustTangents (TrackHitRecord hit, ParamDimensionBase *dim, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, int dx, int dy, DWORD flags)
virtual void	AdjustTangents (TrackHitRecord hit, ParamDimensionBase *dim, float angle, float length, DWORD flags)
virtual CoreExport BOOL	IsAnimated ()
virtual BOOL	CanCopyTrack (Interval iv, DWORD flags)
virtual BOOL	CanPasteTrack (TrackClipObject *cobj, Interval iv, DWORD flags)
virtual TrackClipObject *	CopyTrack (Interval iv, DWORD flags)
virtual void	PasteTrack (TrackClipObject *cobj, Interval iv, DWORD flags)
virtual BOOL	CanCopySubTrack (int subNum, Interval iv, DWORD flags)
virtual BOOL	CanPasteSubTrack (int subNum, TrackClipObject *cobj, Interval iv, DWORD flags)
virtual TrackClipObject *	CopySubTrack (int subNum, Interval iv, DWORD flags)
virtual void	PasteSubTrack (int subNum, TrackClipObject *cobj, Interval iv, DWORD flags)
virtual int	GetTrackVSpace (int lineHeight)
virtual int	HitTestTrack (TrackHitTab &hits, Rect &rcHit, Rect &rcTrack, float zoom, int scroll, DWORD flags)
virtual int	PaintTrack (ParamDimensionBase *dim, HDC hdc, Rect &rcTrack, Rect &rcPaint, float zoom, int scroll, DWORD flags)
virtual int	PaintSubTrack (int subNum, ParamDimensionBase *dim, HDC hdc, Rect &rcTrack, Rect &rcPaint, float zoom, int scroll, DWORD flags)
virtual int	PaintFCurves (ParamDimensionBase *dim, HDC hdc, Rect &rcGraph, Rect &rcPaint, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
virtual int	HitTestFCurves (ParamDimensionBase *dim, TrackHitTab &hits, Rect &rcHit, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
virtual int	PaintSubFCurves (int subNum, ParamDimensionBase *dim, HDC hdc, Rect &rcGraph, Rect &rcPaint, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
virtual int	HitTestSubFCurves (int subNum, ParamDimensionBase *dim, TrackHitTab &hits, Rect &rcHit, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
virtual void	EditTrackParams (TimeValue t, ParamDimensionBase *dim, const MCHAR *pname, HWND hParent, IObjParam *ip, DWORD flags)
virtual int	TrackParamsType ()
virtual int	GetFCurveExtents (ParamDimensionBase *dim, float &min, float &max, DWORD flags)
	This method is called to calculate the largest and smallest values of the anim.
CoreExport void	AddNoteTrack (NoteTrack *note)
CoreExport void	DeleteNoteTrack (NoteTrack *note, BOOL delNote=TRUE)
CoreExport BOOL	HasNoteTracks ()
CoreExport int	NumNoteTracks ()
CoreExport NoteTrack *	GetNoteTrack (int i)
virtual void	FreeAllBitmaps ()
virtual void	GetSystemNodes (INodeTab &nodes, SysNodeContext Context)
virtual BOOL	IsSubClassOf (Class_ID classID)
	returns true if the animatable has sub-classed off the given class
virtual CoreExport void	MouseCycleCompleted (TimeValue t)
virtual CoreExport void	MouseCycleStarted (TimeValue t)
CoreExport bool	SvSaveData (ISave *isave, USHORT id)
CoreExport bool	SvLoadData (ILoad *iLoad)
CoreExport DWORD	SvGetRefIndex ()
CoreExport void	SvSetRefIndex (DWORD i)
CoreExport bool	SvDeleteRefIndex ()
CoreExport SvGraphNodeReference	SvStdTraverseAnimGraph (IGraphObjectManager *gom, Animatable *owner, int id, DWORD flags)
virtual CoreExport bool	SvCanInitiateLink (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvCanConcludeLink (IGraphObjectManager *gom, IGraphNode *gNode, IGraphNode *gNodeChild)
virtual CoreExport bool	SvCanRemoveThis (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvRemoveThis (IGraphObjectManager *gom, IGraphNode *gNode)
	Called when the user deletes this object in the schematic view...
virtual CoreExport bool	SvIsHighlighted (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport COLORREF	SvGetSwatchColor (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvIsInactive (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvLinkChild (IGraphObjectManager *gom, IGraphNode *gNodeThis, IGraphNode *gNodeChild)
virtual CoreExport bool	SvEditProperties (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport MSTR	SvGetTip (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport MSTR	SvGetRefTip (IGraphObjectManager *gom, IGraphNode *gNode, IGraphNode *gNodeMaker)
virtual CoreExport bool	SvCanDetach (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvDetach (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport MSTR	SvGetRelTip (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Returns a string to be displayed in the tip window in the schematic view for a relationship from "gNodeMaker" to "gNodeTarget"...
virtual CoreExport bool	SvCanDetachRel (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Returns true if this object can respond to the SvDetachRel(...) method...
virtual CoreExport bool	SvDetachRel (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Detach this relationship.
virtual CoreExport bool	SvHandleRelDoubleClick (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Called when this relationship is double-clicked in the schematic view...
CoreExport ICustAttribContainer *	GetCustAttribContainer ()
	This method returns a pointer to the custom attributes container interface class.
CoreExport void	AllocCustAttribContainer ()
	This method allocates space for a custom attributes container.
CoreExport void	DeleteCustAttribContainer ()
	This method deletes space used by a custom attributes container.
void	SetAFlag (DWORD mask)
void	ClearAFlag (DWORD mask)
	Clears one or more bits in the Animatable flags.
bool	TestAFlag (DWORD mask) const
	Tests one or more bits in the Animatable flags.
void	SetAFlagEx (DWORD mask)
	Sets one or more bits in the Animatable extended flags.
void	ClearAFlagEx (DWORD mask)
	Clears one or more bits in the Animatable extended flags.
bool	TestAFlagEx (DWORD mask) const
	Tests one or more bits in the Animatable extended flags.
CoreExport bool	TestFlagBit (int index)
	Tests the specified flag bit.
CoreExport void	SetFlagBit (int index, bool newValue=true)
	Sets the specified flag bit.
CoreExport void	ClearFlagBit (int index)
	Clears the specified flag bit.
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()
Public Member Functions inherited from ISubMap
virtual	~ISubMap ()
virtual int	NumSubTexmaps ()
virtual Texmap *	GetSubTexmap (int i)
virtual int	MapSlotType (int i)=0
virtual void	SetSubTexmap (int i, Texmap *m)
virtual int	SubTexmapOn (int i)
	__declspec (deprecated) virtual MSTR GetSubTexmapSlotName(int i) MAX_SEALED
virtual CoreExport MSTR	GetSubTexmapSlotName (int i, bool localized)
CoreExport MSTR	GetSubTexmapTVName (int i, bool localized=true)
virtual BOOL	SetDlgThing (ParamDlg *dlg)
CoreExport void	CopySubTexmap (HWND hwnd, int ifrom, int ito)
virtual ReferenceTarget *	GetRefTarget ()=0

Public Attributes
Texmap *	delegate
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
Public Attributes inherited from Texmap
int	cacheID
Public Attributes inherited from MtlBase
Quat	meditRotate
ULONG	gbufID

Protected Member Functions
void	SetReference (int i, RefTargetHandle rtarg) override
	Stores a ReferenceTarget as its 'i-th' reference`.
void	SetReference (int i, RefTargetHandle rtarg) override
	Stores a ReferenceTarget as its 'i-th' reference`.
Protected Member Functions inherited from ReferenceTarget
CoreExport int	DoEnumDependentsImpl (DependentEnumProc *dep) override
	Method to perform an enumeration on a ReferenceTarget.
virtual CoreExport	~ReferenceTarget ()=0
	Destructor.
Protected Member Functions inherited from ReferenceMaker
virtual CoreExport	~ReferenceMaker ()=0
	Destructor.
void	BlockEval ()
	Validates a given reference link between this reference maker and its reference target.
void	UnblockEval ()
	Validates a given reference link between this reference maker and its reference target.
int	Evaluating ()
	Validates a given reference link between this reference maker and its reference target.
CoreExport RefResult	StdNotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID partID, RefMessage message, BOOL propagate, NotifyDependentsOption notifyDependentsOption)
	Validates a given reference link between this reference maker and its reference target.
Protected Member Functions inherited from Animatable
virtual CoreExport	~Animatable ()=0
	Destructor.
Protected Member Functions inherited from Noncopyable
	Noncopyable ()
	~Noncopyable ()

Additional Inherited Members
Static Public Member Functions inherited from MSPluginTexmap
static RefTargetHandle	create (MSPluginClass *pc, BOOL loading)
Static Public Member Functions inherited from Collectable
static ScripterExport void	for_all_values (void(*map_fn)(Value *val), ValueMapper *mapper=nullptr, ValueMetaClass *c=nullptr)
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 Member Functions inherited from Animatable
static CoreExport BOOL	IsDeleted (Animatable *anim)
	Debug method to determine whether an object has been deleted.
static CoreExport AnimHandle	GetHandleByAnim (Animatable *anim)
	Get the unique handle for an Animatable object.
static CoreExport Animatable *	GetAnimByHandle (AnimHandle handle)
	Get an Animatable object from its unique handle.
static CoreExport AnimHandle	GetNextHandle ()
	Get the unique handle for the next Animatable object to be created.
static CoreExport void	EnumerateAllAnimatables (EnumAnimList &enumProcObject)
	Enumerator to enumerate across all animatables.
static CoreExport bool	RegisterAppDataLoadCallback (const Class_ID &cid, SClass_ID sid, APPDATALOADPROC proc)
	Registers a callback proc that is called when an AppDataChunk is read from a scene file.
static CoreExport bool	UnRegisterAppDataLoadCallback (const Class_ID &cid, SClass_ID sid, APPDATALOADPROC proc)
	Unregisters a callback proc that is called when an AppDataChunk is read from a scene file.
static CoreExport bool	RegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
	Registers a callback proc that is called when an AppDataChunk is read from a scene file.
static CoreExport bool	UnRegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
	Unregisters a callback proc that is called when an AppDataChunk is read from a scene file.
static CoreExport void	ClearAFlagInAllAnimatables (DWORD mask)
	Clears one or more bits in the Animatable flags in all Animatables.
static CoreExport void	ClearAFlagExInAllAnimatables (DWORD mask)
	Clears one or more bits in the Animatable extended flags in all Animatables.
static CoreExport int	RequestFlagBit ()
	Requests an unique flag bit index.
static CoreExport void	ReleaseFlagBit (int index)
	Releases the flag bit index.
static CoreExport void	ClearFlagBitInAllAnimatables (int index)
	Clears the specified flag bit in all Animatables.
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.
Static Public Attributes inherited from MSPluginTexmap
static MSAutoMParamDlg *	mainMDlg
static IMtlParams *	ip
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 Public Attributes inherited from Animatable
static const AnimHandle	kInvalidAnimHandle = 0
Protected Attributes inherited from Animatable
DWORD	aflag
AnimPropertyList	aprops
Static Protected Attributes inherited from Value
static ScripterExport Value *	keyarg_marker_value

Constructor & Destructor Documentation

MSTexmapXtnd()

MSTexmapXtnd	(	MSPluginClass *	pc,
		BOOL	loading
	)

~MSTexmapXtnd()

~MSTexmapXtnd ( )

inline

{ DeleteAllRefsFromMe(); }

Member Function Documentation

DeleteThis()

void DeleteThis ( )

overridevirtual

Deletes an instance of this class.

3ds Max calls this method when it needs to delete a plugin object (an instance of a class derived from Animatable). Similarly, plugins that need to delete instances of an Animatable or a class directly derived from it via an Animatable pointer, should call this method instead of calling directly operator delete. Following these rules will ensure that the same memory manager is used to allocate and deallocate the object. The default implementation of this method deletes the object. Plugin instances that never need to be deleted from the heap can overwrite this method to do nothing.

Note

See the method ClassDesc::Create() for details on how Max allocates plugin objects.

See ReferenceMaker::DeleteMe() and ReferenceTarget::MaybeAutoDelete() for information on how plugin instances are deleted by the system.

Remarks

See Memory Management.

See also

Required DLL Functions, Class ClassDesc.

Reimplemented from MSPluginTexmap.

get_delegate()

ReferenceTarget * get_delegate ( )

inlineoverridevirtual

Reimplemented from MSPluginTexmap.

{ return delegate; } 

GetClassName()

void GetClassName ( MSTR &  s, bool  localized  ) const

inlineoverridevirtual

Retrieves the name of the plugin class.

This name is used in 3ds Max's UI and in MAXScript. For Material plug-ins this method is used to put up the material "type" name in the Material Editor.

Parameters

s	Reference to a string filled in with the name of the plugin class.
localized	If true, then the class name returned should be localized in the language 3ds Max is currently using. Otherwise it should be the class name in English. If a plugin does not provide localized string resources, it can disregard this parameter and always return the class name in English.

Reimplemented from MSPluginTexmap.

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

ClassID()

Class_ID ClassID ( )

inlineoverridevirtual

Retrieves a constant that uniquely identifies the plugin class.

This method must return the unique ID for the plugin class. If two ClassIDs conflict, the system will only load the first conflicting one it finds. A program (gencid.exe) is provided to generate unique class id values.

Returns

A class id that uniquely identifies a plugin class

See also

Class ClassID, class ID definitions in plugapi.h.

Reimplemented from MSPluginTexmap.

{ return pc->class_id; }

FreeCaches()

void FreeCaches ( )

inlineoverridevirtual

Remarks

This is called to delete any item that can be rebuilt. For example, the procedural sphere object has a mesh that it caches. It could call Mesh::FreeAll() on the mesh from this method. This will free the vertex/face/uv arrays. If the sphere is ever evaluated again it can just rebuild the mesh. If an object (like a sphere) has modifiers applied to it, and those modifiers are not animated, then the result of the pipeline is cached in the node. So there is no reason for the sphere to also have a cache of its representation. Therefore when this method is called, the sphere can free the data of the mesh.

Default Implementation:

{}

Reimplemented from MSPluginTexmap.

{ delegate->FreeCaches(); }     

NumSubs()

int NumSubs ( )

overridevirtual

Remarks

The system uses a virtual array mechanism to access the sub-anims of a plug-in. This method returns the total number of sub-anims maintained by the plug-in. If a plug-in is using a parameter block to manage its parameters it should just return 1 for all the parameters directed by the parameter block.

Returns

The number of sub-anims used by the plug-in.

Default Implementation:

{ return 0; }

Reimplemented from MSPluginTexmap.

SubAnim()

Animatable * SubAnim ( int  i )

overridevirtual

Remarks

This method returns a pointer to the 'i-th' sub-anim. If a plug-in is using a parameter block to manage all its parameters it should just return a pointer to the parameter block itself from this method. This method may return NULL so developers need to check the return value before calling other sub anim methods (such as SubAnimName()).

Parameters

i	This is the index of the sub-anim to return.

Default Implementation:

{ return NULL };

Reimplemented from MSPluginTexmap.

SubAnimName()

MSTR SubAnimName ( int  i, bool  localized = true  )

overridevirtual

Remarks

This method returns the name of the 'i-th' sub-anim to appear in track view. The system has no idea what name to assign to the sub-anim (it only knows it by the virtual array index), so this method is called to retrieve the name to display. Developer need to make sure the 'i-th' SubAnim() is non-NULL or this method will fail.

Parameters

i	The index of the parameter name to return
localized	If true, then the sub-anim name returned should be localized in the language 3ds Max is currently using. Otherwise it should be the sub-anim name in English. If a plugin does not provide localized string resources, it can disregard this parameter and always return the sub-anim name in English.

Returns

The name of the 'i-th' parameter.

Reimplemented from MSPluginTexmap.

NumParamBlocks()

int NumParamBlocks ( )

inlineoverridevirtual

Remarks

This method is available in release 3.0 and later only.

This method returns the number of ParamBlock2s in this instance.

Default Implementation:

{ return 0; }

Reimplemented from MSPluginTexmap.

{ return pblocks.Count(); }

GetParamBlock()

IParamBlock2 * GetParamBlock ( int  i )

inlineoverridevirtual

Remarks

This method return 'i-th' ParamBlock2 in this instance (or NULL if not available).

Parameters

i	The zero based index of the ParamBlock2 to return.

Default Implementation:

{ return NULL; }

Reimplemented from MSPluginTexmap.

{ return pblocks[i]; }

GetParamBlockByID()

IParamBlock2 * GetParamBlockByID ( BlockID  id )

inlineoverridevirtual

Remarks

This method returns a pointer to the ParamBlock2 as specified by the ID passed (or NULL if not available).

Parameters

id	The BlockID of the ParamBlock2 instance.

Default Implementation:

{ return NULL; }

Reimplemented from MSPluginTexmap.

{ return MSPlugin::GetParamBlockByID(id); }

GetInterface() [1/2]

void * GetInterface ( ULONG  id )

inlineoverridevirtual

Remarks

This method provides a mechanism for extending the class in the future. In 3ds Max 4.0 there are new interfaces that are accessed by passing an id to this method and it will respond by returning the corresponding interface pointer.

This method has been used however for a different purpose. It currently is used to determine if an object is of a particular class. With controllers for example, there is one base class Control, however there are many super classes (CTRL_FLOAT_CLASS_ID, CTRL_SCALE_CLASS_ID, etc.). If you wanted to find out if a given Animatable was a controller you would need to compare its SuperClassID to all the known types and only if it wasn't one of the known types could you be sure it wasn't a controller. Having to do this is inconvenient for a developer.

Instead the Control class implements this method. It looks at the id, and if it matches a predefined constant I_CONTROL, it returns its this pointer. In this way, given any Animatable, it is easy to find out if it is a controller by simply asking for the control interface. There is a macro that does this:

#define GetControlInterface(anim)
((Control*)anim-\>GetInterface(I_CONTROL))

A plug-in developer may use this macro as follows:

Control *c = GetControlInterface(anim);

This will either be NULL or a pointer to a valid controller.

Note: Plug-in defined interfaces should be greater than the following value:

#define I_USERINTERFACE 0x0000ffff

If a plug-in implements this method for its own purposes, it would, in general, switch on the id and if it is not aware of the id it would call this method on the base class. Otherwise it could respond to the id as it needed. See the sample code below for the how the Control class implements this method.

Parameters

id	The id of the interface.

Default Implementation:

{ return NULL; }

Sample Code:

The following is the Control class implementation of this method. It looks at the id passed, and if it matches I_CONTROL it returns its this pointer. Otherwise it calls the base class method.

void* Control::GetInterface(ULONG id)
{
    if (id==I_CONTROL) {
        return this;
    }
    else {
        return Animatable::GetInterface(id);
    }
}

Reimplemented from MSPluginTexmap.

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

NumRefs()

int NumRefs ( )

overridevirtual

Returns the total number of references this ReferenceMaker can hold.

The plugin implements this method to indicate the total number of of references it can make. This includes all references whether they are NULL (inactive) or non-NULL (active) at the time when this method is called. A plugin can hold a variable number of references, thus the return value of this method is not to be cached and reused by client code.

Returns

The total number of references this plugin can hold. The default implementation is return 0.

Reimplemented from MSPluginTexmap.

GetReference()

RefTargetHandle GetReference ( int  i )

overridevirtual

Returns the 'i-th' reference.

The plugin implements this method to return its 'i-th' reference. The plug-in simply keeps track of its references using an integer index for each one. This method is normally called by the system.

Parameters

i	- The index of the reference to retrieve. Valid values are from 0 to NumRefs()-1.

Returns

The reference handle of the 'i-th' reference. Note that different calls to this method with the same 'i' value can result in different reference handles being retrieved, as the plugin changes the scene objects it references as its 'i-th' reference.

Reimplemented from MSPluginTexmap.

SetReference()

void SetReference ( int  i, RefTargetHandle  rtarg  )

overrideprotectedvirtual

Stores a ReferenceTarget as its 'i-th' reference`.

The plugin implements this method to store the reference handle passed to it as its 'i-th' reference. In its implementation of this method, the plugin should simply assign the reference handle passed in as a parameter to the member variable that holds the 'i-th' reference. Other reference handling methods such as ReferenceMaker::DeleteReference(), or ReferenceMaker::ReplaceReference() should not be called from within this method. The plugin itself or other plugins should not call this method directly. The system will call this method when a new reference is created or an existing one is replaced by calling ReferenceMaker::ReplaceReference().

Parameters

i	- The index of the reference to store. Valid values are from 0 to NumRefs()-1.
rtarg	- The reference handle to store.

Reimplemented from MSPluginTexmap.

Clone()

RefTargetHandle Clone ( RemapDir &  remap )

overridevirtual

This method is used by 3ds Max to clone an object.

See also

CloneRefHierarchy(), class RemapDir This method is called by 3ds Max to have the plugin clone itself. The plug-in's implementation of this method should copy both the data structure and all the data residing in the data structure of this reference target. The plugin should clone all its references as well. Also, the plug-in's implementation of this method must call BaseClone(). In order for classes derived from this class to clone cleanly, the Clone method should just create the new instance, and then call an implementation of BaseClone that clones the references and copies any other necessary data. For example:

class MyDerivedPlugin
    : public MyBasePlugin
{
    const int MY_REFERENCE = 1;
 
    ReferenceTarget* Clone(RemapDir& remap)
    {
        ReferenceTarget* result = new MyDerivedPlugin();
        BaseClone(this, result, remap);
        return result;
    }
 
    void BaseClone(ReferenceTarget* from, ReferenceTarget* to, RemapDir& remap)
    {
        if (!to || !from || from == to)
            return;    
        MyBasePlugin::BaseClone(from, to, remap);
        to->ReplaceReference(MY_REFERENCE, remap->CloneRef(from->GetReference(MY_REFERENCE)));
    }
};

This method should not be directly called by plug-ins. Instead, either RemapDir::CloneRef() or CloneRefHierachy() should be used to perform cloning. These methods ensure that the mapping from the original object to the clone is added to the RemapDir used for cloning, which may be used during backpatch operations

Note

See the remarks in method BaseClone() below.

Parameters

remap

- A RemapDir instance used for remapping references during a Clone.

Returns

A pointer to the cloned item.

Reimplemented from MSPluginTexmap.

NotifyDependents()

RefResult NotifyDependents ( const Interval &  changeInt, PartID  partID, RefMessage  message, SClass_ID  sclass, BOOL  propagate, RefTargetHandle  hTarg, NotifyDependentsOption  notifyDependentsOption  )

overridevirtual

Send a notification all classes that reference this class.

Since a ReferenceMaker cannot have dependents, ReferenceMaker::NotifyDependents() is implemented to simply return REF_SUCCEED.

See also

ReferenceTarget::NotifyDependents for a detailed description of this method.

Reimplemented from ReferenceMaker.

BuildMaps()

int BuildMaps ( TimeValue  t, RenderMapsContext &  rmc  )

inlineoverridevirtual

Remarks

This method is called for a plug-in to do any work it needs to do prior to rendering. For example this is used by the 3ds Max Mirror and Auto Reflect materials to render their bitmaps.

Parameters

t	The current time.
rmc	Provides information about the view being rendered and can provide access to the global rendering environment information via RenderGlobalContext *gc = rmc.GetGlobalContext(). See Class RenderMapsContext and Class RenderGlobalContext.

Returns

Nonzero on success; zero on failure. In the case of failure the renderer is halted (rendering is cancelled).

Reimplemented from MSPluginTexmap.

{ return delegate->BuildMaps(t, rmc); }

Requirements()

ULONG Requirements ( int  subMtlNum )

inlineoverridevirtual

Remarks

This method returns the cumulative requirements of the material and its sub-materials and maps. The default implementation just ORs together the local requirements of the material with the requirements of all its children. Most materials will only need to implement LocalRequirements().

Parameters

subMtlNum

Specifies the number of the sub-material whose requirements should be returned. -1 may be used to return a value generated by looping over all the sub-materials and ORing together the requirements.

Returns

See Material Requirements Flags.

Default Implementation:

The default implementation automatically traverses the sub-material/map tree. On any MtlBase that returns TRUE for IsMultiMtl() it will only recursively call the sub material (or map) for the subMtlNum called. The exception to this is when subMtlNum<0: in this case all sub-mtls and submaps are enumerated. Therefore the LocalRequirements() method below only needs to consider the material or map itself, not the sub-mtls and sub-maps.

Reimplemented from MSPluginTexmap.

{ return delegate->Requirements(subMtlNum); }

LocalRequirements()

ULONG LocalRequirements ( int  subMtlNum )

inlineoverridevirtual

Remarks

Specifies various requirements for this material. The value returned from this method should not include requirements of its sub-materials and sub-maps.

Parameters

subMtlNum

Specifies the number of the sub-material whose requirements should be returned.

Returns

See Material Requirements Flags.

Default Implementation:

{ return 0; }

Reimplemented from MSPluginTexmap.

{ return delegate->LocalRequirements(subMtlNum); }

MappingsRequired()

void MappingsRequired ( int  subMtlNum, BitArray &  mapreq, BitArray &  bumpreq  )

inlineoverridevirtual

Remarks

This method gives the UVW channel requirements of the material and its tree. The default implementation just OR's together the local mapping requirements of the material with the requirements of all its children. For most materials, all they need to implement is the LocalMappingsRequired() method.

Parameters

subMtlNum	Specifies the number of the sub-material whose mapping information is retrieved.
mapreq	This array of bits is initialized to an empty set with MAX_MESHMAPS elements. Each bit corresponds to a mapping channel. Set a bit to one to indicate the material requires the corresponding UVW channel.
bumpreq	This array of bits is initialized to an empty set with MAX_MESHMAPS elements. Each bit corresponds to a mapping channel. Set a bit to one to indicate the material requires the corresponding bump mapping channel.

Reimplemented from MSPluginTexmap.

{ delegate->MappingsRequired(subMtlNum, mapreq, bumpreq); } 

LocalMappingsRequired()

void LocalMappingsRequired ( int  subMtlNum, BitArray &  mapreq, BitArray &  bumpreq  )

inlineoverridevirtual

Remarks

This method specifies UVW channel requirements for the material: This method should not include UVW channel requirements of any sub-materials and sub-maps.

Parameters

subMtlNum	Specifies the number of the sub-material whose mapping information is retrieved.
mapreq	This array of bits is initialized to an empty set with MAX_MESHMAPS elements. Each bit corresponds to a mapping channel. Set a bit to one to indicate the material requires the corresponding UVW channel.
bumpreq	This array of bits is initialized to an empty set with MAX_MESHMAPS elements. Each bit corresponds to a mapping channel. Set a bit to one to indicate the material requires the corresponding bump mapping channel.

Default Implementation:

{}

Sample Code:

All 2D textures that use UVGen or otherwise select mapping channels need to implement this method Here's an example:

void LocalMappingsRequired(int subMtlNum, BitArray & mapreq, BitArray &bumpreq)
{
    uvGen->MappingsRequired(subMtlNum,mapreq,bumpreq);
}

All 3D textures that use the XYZGen to put up a coordinates rollup must implement this method. Here's an example:

void LocalMappingsRequired(int subMtlNum, BitArray & mapreq,BitArray &bumpreq)
{
    xyzGen->MappingsRequired(subMtlNum,mapreq,bumpreq);
}

Reimplemented from MSPluginTexmap.

{ delegate->LocalMappingsRequired(subMtlNum, mapreq, bumpreq); }

IsMultiMtl()

BOOL IsMultiMtl ( )

inlineoverridevirtual

Remarks

This method returns TRUE for materials or textures that select sub-materials based on submaterial number (for example a mesh faceMtlIndex).

The only materials for which this method should return TRUE are those that choose to use one of their sub-maps or sub-mtls based on the submaterial number. For the majority of materials and maps, they should return FALSE, and in that case all of the submaterials and maps are enumerated by MtlBase::Requirements().

Default Implementation:

{ return FALSE; }

Reimplemented from MSPluginTexmap.

{ return delegate->IsMultiMtl(); }

Update()

void Update ( TimeValue  t, Interval &  valid  )

overridevirtual

Remarks

A material has a Shade() method, and a texture map has a EvalColor() method. These are called by the renderer for every pixel. This method is called before rendering begins to allow the plug-in to evaluate anything prior to the render so it can store this information. In this way this information does not need to be calculated over and over for every pixel when Shade() or EvalColor() is called. This allows texture and material evaluation to be more efficient. It is generally called once at the start of each frame, or during interactive playback when the time changes. It is not guaranteed to get called on every frame, because if you returned a validity interval that covers several frames, your parent material won't bother to call you if the current frame is still in that interval.

Parameters

t	The current time.
valid	The validity interval to update to reflect the validity interval of the material or texture at the time passed.

Reimplemented from MSPluginTexmap.

Reset()

void Reset ( )

inlineoverridevirtual

Remarks

This method is called to reset the material or texmap back to its default values. This should be done by calling the Reset method of the material or texture map plugin's class descriptor (ClassDesc2::Reset). In addition, the plugin can execute any other initialization code it has. Example from maxsdk\samples\materials\dblsided.cpp

void DoubleSided::Reset() {
    dblsidedCD.Reset(this, TRUE); // Resets all pb2's
    Init();
} 

Note

When migrating plugins from ClassDesc to ClassDesc2 and IParamBlock2, do not forget to update this method to call the class descriptor's Reset method. If the plugin's Reset tries to replace parameter block objects based on IParamBlock2 that use the P_AUTO_UI flag, the UI code will continue to hold a pointer to the replaced parameter block, and this will lead to problems.

Reimplemented from MSPluginTexmap.

{ delegate->Reset(); pc->cd2->Reset(this, TRUE); }

Validity()

Interval Validity ( TimeValue  t )

overridevirtual

Remarks

This method is called to determine the validity interval of the material or texture.

Parameters

t	Specifies the time about which to compute the validity interval.

Returns

The validity interval of the item at the specified time.

Reimplemented from MSPluginTexmap.

CreateParamDlg()

ParamDlg * CreateParamDlg ( HWND  hwMtlEdit, IMtlParams *  imp  )

overridevirtual

Remarks

This method gets called when the material or texture is to be displayed in the material editor parameters area. The plug-in should allocate a new instance of a class derived from ParamDlg to manage the user interface.

Note: The following is a discussion of this CreateParamDlg() method, and the SetDlgThing() method, and the way they relate to the ParamMap2 system. A good example for this discussion is a texture map which typically has several rollouts, say its texmap parameters, a UVW coordinates rollout, and an Output rollout.

The normal way for a texmap to implement these other (common) rollouts is for the it to create a UVGen instance and a TextureOutput instance as 'sub-objects' in the map and then ask them to put up their rollouts when it is asked to do so by the Materials Editor (in CreateParamDlg()). The Materials Editor requires a ParamDlg pointer back from the CreateParamDlg() on which it calls methods to control the UI, such as time change updates or loading up a new texmap of the same class into the UI when the user switches them, so that the whole UI doesn't need to be rebuilt.

Prior to the ParamMap2 system, a texmap would implement its own ParamDlg subclass and would keep track of the UVGen and TextureOutput ParamDialogs and pass on any time change or SetThing() calls to them. ParamMap2 introduced its own ParamDlg subclass (Class IAutoMParamDlg) that you can ask it to build for you and have manage all interaction with the Materials Editor automatically. As before, this still needs to know about the other (sub-object) ParamDlgs, and so it has the ability to keep a list of 'secondary' ParamDlgs to which it passes on the SetTime()s and SetThing()s.

When the Materials Editor asks the texmap to CreateParamDlg(), the texmap asks its ClassDesc2 to build one of these (ClassDesc2::CreateParamDlgs()). If the texmap itself has multiple ParamBlock2s, CreateParamDlgs() builds one ParamDlg per pblock/rollout, makes the first of them a 'driver' and adds the rest as secondary ParamDlgs. The texmap then asks the UVGen and TextureOutput objects to CreateParamDlg() for their rollouts and adds them to the driver IAutoMParamDlg also.

Now consider the need for the SetDlgThing() method below. It is related to the SetThing() method that the Materials Editor calls on the 'driver' ParamDlg to switch into the UI a texmap of the same class as that currently in the UI. Normally, the driver IAutoParamDlg would propagate the SetThing() to its registered secondary ParamDlgs. In the case of multiple paramblock2s in the texmap, this would be correct, since the 'thing' in this case is the incoming texmap. But this doesn't work for the secondary UVGen and TextureOutput ParamDlgs; their 'things' are the UVGen and TextureOutput subobjects of the incoming map. So, IAutoParamDlg first calls SetDlgThing() on the incoming texmap so that it gets a chance to call the correct SetThing()s on the sub-object ParamDlgs with the appropriate incoming sub-objects. A clear example of this is in Gradient::SetDlgThing() in /MAXSDK/SAMPLES/MATERIALS/GRADIENT.CPP. It is called once for each secondary ParamDlg. For those ParamDlgs that have special SetThing() requirements, it does the appropriate sub-object SetThing() and returns TRUE. If it does no special handling for a particular ParamDlg, it returns FALSE, signalling to the IAutoMParamDlg that it should do the standard SetThing() propagation for that dialog.

The Render Effects dialog has a similar arrangement to the Materials Editor for controlling Effect UI and so there is an IAutoEParamDlg that works exactly the same way as the IAuotMParamDlg.

Parameters

hwMtlEdit	The window handle of the materials editor.
imp	The interface pointer for calling methods in 3ds Max.

Returns

A pointer to the created instance of a class derived from ParamDlg.

Reimplemented from MSPluginTexmap.

Save()

IOResult Save ( ISave *  iSave )

inlineoverridevirtual

Reimplemented from MSPluginTexmap.

{ return MSPluginTexmap::Save(iSave); }

Load()

IOResult Load ( ILoad *  iload )

inlineoverridevirtual

Remarks

Implemented by the System.

This method is called to load the material or texture from disk. The common MtlBase data must be loaded as well. See the code below.

Parameters

iload

An interface pointer for calling methods to load data. See Class ILoad, I/O Results.

Sample Code:

IOResult Gradient::Load(ILoad *iload)
{
    IOResult res;
    int id;
    while (IO_OK==(res=iload->OpenChunk())) {
        switch(id = iload->CurChunkID()) {
            case MTL_HDR_CHUNK:
                res = MtlBase::Load(iload);
                break;
            case MAPOFF_CHUNK+0:
            case MAPOFF_CHUNK+1:
            case MAPOFF_CHUNK+2:
                mapOn[id-MAPOFF_CHUNK] = 0;
                break;
        }
        iload->CloseChunk();
        if (res!=IO_OK)
            return res;
    }
    iload->RegisterPostLoadCallback(new ParamBlockPLCB(versions,NUM_OLDVERSIONS,&curVersion,this,1));
    return IO_OK;
}

Reimplemented from MSPluginTexmap.

{ return MSPluginTexmap::Load(iLoad); }

GetGBufID()

ULONG GetGBufID ( )

inline

{ return delegate->GetGBufID(); }

SetGBufID()

void SetGBufID ( ULONG  id )

inline

{ delegate->SetGBufID(id); }

EnumAuxFiles()

void EnumAuxFiles ( AssetEnumCallback &  nameEnum, DWORD  flags  )

inlineoverridevirtual

Remarks

This is an implementation of the Animatable method. This default implementation simply recurses, skipping inactive subTexmaps if appropriate.

Reimplemented from MSPluginTexmap.

    {
        if ((vflags&FILE_ENUM_CHECK_AWORK1)&&TestAFlag(A_WORK1)) return; // LAM - 4/21/03
        ReferenceTarget::EnumAuxFiles(assetEnum, vflags);
    }

GetPStamp()

PStamp * GetPStamp ( int  sz )

inlineoverridevirtual

Remarks

Implemented by the System.

Returns a pointer to the postage stamp image for the file.

Parameters

sz	One of the following values: PS_SMALL for small (32x32) images. PS_LARGE for large (88x88) images. PS_TINY for tiny (24x24) images.

Reimplemented from MSPluginTexmap.

{ return delegate->GetPStamp(sz); }

CreatePStamp()

PStamp * CreatePStamp ( int  sz )

inline

{ return delegate->CreatePStamp(sz); }          

DiscardPStamp()

void DiscardPStamp ( int  sz )

inlineoverridevirtual

Remarks

Implemented by the System.

Discards the postage stamp image.

Parameters

sz	One of the following values: PS_SMALL for small (32x32) images. PS_LARGE for large (88x88) images. PS_TINY for tiny (24x24) images.

Reimplemented from MSPluginTexmap.

{ delegate->DiscardPStamp(sz); }            

NumSubTexmaps()

int NumSubTexmaps ( )

overridevirtual

Remarks

Returns the number of sub-textures managed by this material or texture.

Default Implementation:

{ return 0; }

Reimplemented from MSPluginTexmap.

GetSubTexmap()

Texmap * GetSubTexmap ( int  i )

overridevirtual

Remarks

Returns a pointer to the 'i-th' sub-texmap managed by the material or texture.

Note: For the 3ds Max Standard material, the sub-texmap indexes used with this method are listed in Texture Map Indices.

Parameters:

int i

Specifies the texmap to return.

Default Implementation:

{ return NULL; }

Reimplemented from MSPluginTexmap.

SetSubTexmap()

void SetSubTexmap ( int  i, Texmap *  m  )

overridevirtual

Remarks

Stores the 'i-th' sub-texmap managed by the material or texture.

Note: For the 3ds Max Standard material, the sub-texmap indexes used with this method are listed in Texture Map Indices.

Parameters:

int i

The index of the storage for the texmap.

Texmap *m

The texmap to store.

Default Implementation:

{}

Reimplemented from MSPluginTexmap.

GetSubTexmapSlotName()

MSTR GetSubTexmapSlotName ( int  i, bool  localized = true  )

overridevirtual

Remarks

This method returns the slot name of the 'i-th' sub-texmap. This name appears in the materials editor dialog. For instance, if you are in a material and then you go down into a map, this is the name that appears just below the 'Get Material' icon. For example, in the Standard material when you choose one of the maps, the map name appears to let you know which slot you are working on. For the Standard material, this may be "Ambient", "Diffuse", "Specular", etc.

Parameters:

int i

Specifies the slot whose name is returned. bool localized

If true, then the slot name returned should be localized in the language 3ds Max is currently using. Otherwise it should be the slot name in English. If a plugin does not provide localized string resources, it can disregard this parameter and always return the slot name in English.

Default Implementation:

The default implementation returns an empty ("") string.

Reimplemented from MSPluginTexmap.

SupportTexDisplay()

BOOL SupportTexDisplay ( )

inlineoverridevirtual

Remarks

Returns TRUE if this texture supports being used in the interactive renderer; otherwise FALSE. If the texture does return TRUE it is expected to implement the methods ActivateTexDisplay() and GetActiveTexHandle().

Default Implementation:

{ return FALSE; }

Reimplemented from MSPluginTexmap.

{ return delegate->SupportTexDisplay(); }

GetActiveTexHandle()

DWORD_PTR GetActiveTexHandle ( TimeValue  t, TexHandleMaker &  thmaker  )

inlineoverridevirtual

Remarks

This method is called to retrieve a texture handle to this texture map.

Parameters

t	The time to return the texture handle.
thmaker	This class provides methods for creating a texture handle from a 3ds Max bitmap and a Windows DIB. It also has a method to retrieve the required size of the texture map. See Class TexHandleMaker.

Returns

The texture handle.

Default Implementation:

{return 0;}

Reimplemented from MSPluginTexmap.

{ return delegate->GetActiveTexHandle(t, thmaker); }

ActivateTexDisplay()

void ActivateTexDisplay ( BOOL  onoff )

inlineoverridevirtual

Remarks

This method is called when the usage of the texture the interactive renderer changes. This method must only be implemented if SupportTexDisplay() returns TRUE. This method does not cause the texture map to be drawn in the viewport but should be called with TRUE as the argument before this can occur. For viewport drawing of textures refer to Interface::ActivateTexture() and Interface::DeActivateTexture() instead.

Parameters

onoff

TRUE if the texture is being used; FALSE if it is no longer being used.

Default Implementation:

{}

Reimplemented from MSPluginTexmap.

{ delegate->ActivateTexDisplay(onoff); }

SupportsMultiMapsInViewport()

BOOL SupportsMultiMapsInViewport ( )

inlineoverridevirtual

Remarks

Returns TRUE if this material supports the display of multi-maps in the viewports (interactive renderer); FALSE if it doesn't.

Default Implementation:

{ return FALSE; }

Reimplemented from MSPluginTexmap.

{ return delegate->SupportsMultiMapsInViewport(); }

SetupGfxMultiMaps()

void SetupGfxMultiMaps ( TimeValue  t, Material *  mtl, MtlMakerCallback &  cb  )

inlineoverridevirtual

Remarks

This method is called to initialize the interactive renderer Material passed with the properties of this MtlBase.

If a MtlBase (material or texmap) wants to display multiple textures in the viewports, it implements

SupportsMultiMapsInViewport() to return TRUE, and implements SetupGfxMultiMaps to store the necessary information in the Material passed in, including the TextureInfo's for each texture.

The MtlMakerCallback passed in to SetupGfxMultiMaps provides functions to help in setting up the "Material" data structure. The function NumberTexturesSupported() lets you know the capabilities of the current hardware, so you can adapt accordingly. The function GetGfxTexInfoFromTexmap fills in the fields of a TextureInfo except the texHandle and texture ops.

The implementation of SetupGfxMultiMaps must create the "texHandle" for each of the textures described in its TextureInfo array. It typically does this by calling the submap's GetVPDisplayDIB() method, and then creates the texHandle by calling the callBack function MakeHandle(bmi). To avoid doing this calculation when not necessary it is best to save the texHandles along with their validity intervals. Then when SetupGfxMultiMaps is called, if valid texHandles are already in hand they can just be used without recomputing.

Parameters

t	The time at which to evaluate the material.
mtl	Points to the interactive renderer material to update.
cb	This callback object is provided as a helper to fill in the Material properties above. See Class MtlMakerCallback.

Default Implementation:

{}

Reimplemented from MSPluginTexmap.

{ delegate->SetupGfxMultiMaps(t, mtl, cb); }

GetRefTarget()

ReferenceTarget * GetRefTarget ( )

inlineoverridevirtual

Remarks

Implemented by the System.

The implementation of this method is provided by MtlBase. It returns its this pointer.

Reimplemented from MSPluginTexmap.

{ return delegate->GetRefTarget(); }

EvalColor()

AColor EvalColor ( ShadeContext &  sc )

inlineoverridevirtual

Remarks

This method is called to evaluate the color of the texture map for the context. This is for channels that have a color such as diffuse, specular, ambient, etc. This method is called for every pixel of the texture.

Parameters:

ShadeContext& sc

Describes the properties of the pixel to evaluate.

Returns

An AColor object which stores the r, g, b, a values. Note: The alpha is pre multiplied, and the alpha value goes into AColor::a.

Reimplemented from MSPluginTexmap.

{ return delegate->EvalColor(sc); }

EvalMono()

float EvalMono ( ShadeContext &  sc )

inlineoverridevirtual

Remarks

Evaluate the map for a "mono" channel. Mono channels are those that don't have a color, but rather a single value. This is for things like shininess, transparency, etc. This just permits a bit of optimization.

Parameters:

ShadeContext& sc

Describes the properties of the pixel to evaluate.

Returns

A floating point value for the mono channel.

Default Implementation:

{return Intens(EvalColor(sc));}

Reimplemented from MSPluginTexmap.

{ return delegate->EvalMono(sc); }

EvalNormalPerturb()

Point3 EvalNormalPerturb ( ShadeContext &  sc )

inlineoverridevirtual

Remarks

This method is used for bump mapping to retrieve a perturbation to apply to a normal.

Parameters:

ShadeContext& sc

Describes the properties of the pixel to evaluate.

Returns

A deflection vector for perturbing the normal.

Reimplemented from MSPluginTexmap.

{ return delegate->EvalNormalPerturb(sc); }

HandleOwnViewPerturb()

BOOL HandleOwnViewPerturb ( )

inlineoverridevirtual

Remarks

This query is made of maps plugged into the Reflection or Refraction slots: Normally the view vector is replaced with a reflected or refracted one before calling the map: if the plugged in map doesn't need this, it should return TRUE.

Default Implementation:

{ return FALSE; }

Reimplemented from MSPluginTexmap.

{ return delegate->HandleOwnViewPerturb(); }

GetVPDisplayDIB()

BITMAPINFO * GetVPDisplayDIB ( TimeValue  t, TexHandleMaker &  thmaker, Interval &  valid, BOOL  mono = FALSE, int  forceW = 0, int  forceH = 0  )

inlineoverridevirtual

Remarks

This gets the viewport display bitmap in DIB format, useful when combining several maps for hardware-supported multiple texture display. If mono is TRUE, the map should do a mono evaluation and place the result in RGB. forceW and forceH, if non-zero, override dimensions specified by thmaker.

Parameters:

TimeValue t

The time to get the bitmap at.

TexHandleMaker& thmaker

This class provides methods for creating a texture handle from a 3ds Max bitmap and a Windows DIB. It also has a method to retrieve the required size of the texture map. See Class TexHandleMaker.

Interval &valid

The validity interval of the returned bitmap.

BOOL mono

Indicates whether a map should do mono evaluation.

int forceW

Overrides the bitmap width usually supplied by thmaker.

int forceH

Overrides the bitmap height usually supplied by thmaker.

Reimplemented from Texmap.

                    { return delegate->GetVPDisplayDIB(t, thmaker, valid, mono, forceW, forceH);  }

GetUVTransform()

void GetUVTransform ( Matrix3 &  uvtrans )

inlineoverridevirtual

Remarks

This method is called to retrieve the UV transformation matrix for use in the viewports. If a developer is using an instance of UVGen, a method of that class may be called to retrieve the value:

(i.e. { uvGen->GetUVTransform(uvtrans); } ).

Parameters:

Matrix3 &uvtrans

The transformation matrix is returned here.

Default Implementation:

{}

Reimplemented from MSPluginTexmap.

{delegate->GetUVTransform(uvtrans); }

GetTextureTiling()

int GetTextureTiling ( )

inlineoverridevirtual

Remarks

This method is called to get the tiling state of the texture for use in the viewports. This is described by a set of symmetry flags that may be ORed together. If you are using an instance of UVGen to handle the UV user interface you may simply call a method of UVGen to handle this.

For example: { return uvGen->GetTextureTiling(); }

Returns

See Texture Symmetry Flags.

Default Implementation:

{ return U_WRAP|V_WRAP; }

Reimplemented from MSPluginTexmap.

{ return delegate->GetTextureTiling(); }

InitSlotType()

void InitSlotType ( int  sType )

inlineoverridevirtual

Remarks

This method is called to initialize the slot type. This sets the proper button in the coordinate user interface rollup page. If you are using an instance of UVGen to handle the UV user interface you may simply call a method of UVGen to handle this. For example: { if (uvGen) uvGen->InitSlotType(sType); }

Parameters:

int sType

See Map Slot Types.

Default Implementation:

{}

Reimplemented from MSPluginTexmap.

{ delegate->InitSlotType(sType); }             

GetUVWSource()

int GetUVWSource ( )

inlineoverridevirtual

Remarks

Returns a value indicating where to get the texture vertices for the Texmap.

Returns

One of the following values:

UVWSRC_EXPLICIT

Use explicit mesh texture vertices from one of the mapping channels (see GetMapChannel() below to determine which one). This uses the UVW coordinates assigned to the object, either through the Generate Mapping Coordinates option in the object's creation parameters, or through mapping modifiers, such as UVW Map.

UVWSRC_EXPLICIT2

Use explicit mesh texture vertices from the Vertex Color Channel.

UVWSRC_OBJXYZ

Generate planar UVW mapping coordinates from the object local XYZ on-the-fly. This corresponds to the "Planar from Object XYZ" option.

UVWSRC_WORLDXYZ

This value is available in release 3.0 and later only.

Generate planar UVW mapping coordinates from the world XYZ on-the-fly. This corresponds to the "Planar From World XYZ" option. Note: this value used for the UVW is the world XYZ, taken directly, with out normalization to the objects bounding box. This differs from "Planar from Object XYZ", where the values are normalized to the object's bounding box.

Default Implementation:

{ return UVWSRC_EXPLICIT; }

Reimplemented from MSPluginTexmap.

{ return delegate->GetUVWSource(); }

GetMapChannel()

int GetMapChannel ( )

inlineoverridevirtual

Remarks

Returns the map channel being used by the texmap if GetUVWSource() returns UVWSRC_EXPLICIT. The return value should be at least 1. A value of 0 is not acceptable.

Default Implementation:

{ return 1; }

Reimplemented from MSPluginTexmap.

{ return delegate->GetMapChannel (); }  // only relevant if above returns UVWSRC_EXPLICIT

GetTheUVGen()

UVGen * GetTheUVGen ( )

inlineoverridevirtual

Remarks

Texture maps that use a UVGen should implement this method to return a pointer to it.

Default Implementation:

{ return NULL; }

Reimplemented from MSPluginTexmap.

{ return delegate->GetTheUVGen(); }  // maps with a UVGen should implement this

GetTheXYZGen()

XYZGen * GetTheXYZGen ( )

inlineoverridevirtual

Remarks

Texture maps that use a XYZGen should implement this method to return a pointer to it.

Default Implementation:

{ return NULL; }

Reimplemented from MSPluginTexmap.

{ return delegate->GetTheXYZGen(); } // maps with a XYZGen should implement this

SetOutputLevel()

void SetOutputLevel ( TimeValue  t, float  v  )

inlineoverridevirtual

Remarks

Sets the output level at the specified time. It is used to set the output level of the embedded Texout object, principally by importing plug-ins. It is implemented in all Texmaps.

Parameters:

TimeValue t

The time to set the output level.

float v

The value to set.

Default Implementation:

{}

Reimplemented from MSPluginTexmap.

{ delegate->SetOutputLevel(t, v); }

LoadMapFiles()

int LoadMapFiles ( TimeValue  t )

inlineoverridevirtual

Remarks

This method is called prior to rendering to allow the plug-in to load any bitmap files it requires.

Note that LoadMapFiles() is called to load map files only, not to list the missing files. The missing files are listed using the EnumAuxFiles() method, which allows enumerating them without loading them.

Also Note: There is currently not an UnloadMapFiles() method. There are a couple of ways to do this however. One is to call Interface::FreeAllBitmaps(). That method traverses the scene reference hierarchy and calls Animatable::FreeAllBitmaps() on each item. Another approach is to evaluate the Material / TextureMap hierarchy on each material. Then call Animatable::FreeAllBitmaps() yourself in the MtlEnum::proc() shown below.

class MtlEnum   
{
    virtual void proc(MtlBase *m) = 0;
};
 
void EnumMtlTree(MtlBase *mb, MtlEnum &tenum)
{
    tenum.proc(mb);
    for (int i=0; i<mb->NumSubTexmaps(); i++) {
        Texmap *st = mb->GetSubTexmap(i);
        if (st)
            EnumMtlTree(st,tenum);
    }
    if (IsMtl(mb)) {
        Mtl *m = (Mtl *)mb;
        for (i=0; i<m->NumSubMtls(); i++) {
            Mtl *sm = m->GetSubMtl(i);
            if (sm)
                EnumMtlTree(sm,tenum);
        }
    }
}

Now just define a subclass of MtlEnum that does what you want, and call EnumMtlTree. In this particular case it is more efficient than enumerating the entire reference hierarchy. If you do want to enumerate the entire reference hierarchy, here's how:

class RefEnumProc
{
    virtual void proc(ReferenceMaker *rm)=0;
};
 
void EnumRefs(ReferenceMaker *rm, RefEnumProc &proc)
{
    proc.proc(rm);
    int numRefs = rm->NumRefs();
    for (int i=0; i < numRefs; i++) {
        ReferenceMaker *srm = rm->GetReference(i);
        if (srm) EnumRefs(srm,proc);
    }
}

Just define a subclass of RefEnumProc that does what you want, and call EnumRefs on the part of the reference hierarchy you want to enumerate. For example:

class MyEnum: public RefEnumProc
{
    void proc(ReferenceMaker *rm) {
        // do something ...
    }
}
 
void afunction(Mtl* m)
{
    MyEnum enumer;
    EnumRefs(m,&enumer);
}

Parameters:

TimeValue t

The time the maps are being loaded.

Returns

Always return nonzero from this method.

Default Implementation:

{ return 1; }

Reimplemented from MSPluginTexmap.

{ return delegate->LoadMapFiles(t); } 

RenderBitmap()

void RenderBitmap ( TimeValue  t, Bitmap *  bm, float  scale3D = 1.0f, BOOL  filter = FALSE  )

inlineoverridevirtual

Remarks

This method is used to render a 2D bitmap version of this texmap.

Parameters:

TimeValue t

The time at which to render the texmap to the bitmap.

Bitmap *bm

A pointer to a bitmap to render to. This bitmap must be created at the resolution you wish to render to.

float scale3D=1.0f

This is a scale factor applied to 3D Texmaps. This is the scale of the surface in 3d space that is mapped to UV. This controls how much of the texture appears in the bitmap representation.

BOOL filter = FALSE

If TRUE the bitmap is filtered. It is quite a bit slower to rescale bitmaps with filtering on.

Default Implementation:

The default implementation calls Interface::RenderTexmap().

Reimplemented from MSPluginTexmap.

{ delegate->RenderBitmap(t, bm, scale3D, filter); }

IsLocalOutputMeaningful()

bool IsLocalOutputMeaningful ( ShadeContext &  sc )

inlineoverridevirtual

Remarks

Returns TRUE if the output of this texmap is meaningful for the given context; it should not take into account subtexmaps. This method is called by IsOutputMeaningful().

Parameters:

ShadeContext& sc

This describes the context of the question.

Default Implementation:

{ return false; }

Reimplemented from MSPluginTexmap.

{ return delegate->IsLocalOutputMeaningful( sc ); }

IsOutputMeaningful()

bool IsOutputMeaningful ( ShadeContext &  sc )

inlineoverridevirtual

Remarks

Implemented by the system.

Returns true only if all submaps and itself have a meaningful output.

Returns false if at least one sub-texmap or itself does not have a meaningful output

The output of a texmap is meaningful in a given ShadeContext if it is the same as when the scene is rendered. If the map cannot determine whether the output value is the same as when rendered, it should not be meaningful. This method can be called before EvalColor() or EvalMono() on a texmap in order to decide whether to call these methods at all or if their return values should be used in further calculations.

Parameters:

ShadeContext& sc

This describes the context of the question.

Reimplemented from MSPluginTexmap.

{ return delegate->IsOutputMeaningful( sc ); }

IsHighDynamicRange()

int IsHighDynamicRange ( )

inline

{ return delegate->IsHighDynamicRange( ); }

GetInterface() [2/2]

void * GetInterface ( ULONG  id )

inlineoverridevirtual

Remarks

This method provides a mechanism for extending the class in the future. In 3ds Max 4.0 there are new interfaces that are accessed by passing an id to this method and it will respond by returning the corresponding interface pointer.

This method has been used however for a different purpose. It currently is used to determine if an object is of a particular class. With controllers for example, there is one base class Control, however there are many super classes (CTRL_FLOAT_CLASS_ID, CTRL_SCALE_CLASS_ID, etc.). If you wanted to find out if a given Animatable was a controller you would need to compare its SuperClassID to all the known types and only if it wasn't one of the known types could you be sure it wasn't a controller. Having to do this is inconvenient for a developer.

Instead the Control class implements this method. It looks at the id, and if it matches a predefined constant I_CONTROL, it returns its this pointer. In this way, given any Animatable, it is easy to find out if it is a controller by simply asking for the control interface. There is a macro that does this:

#define GetControlInterface(anim)
((Control*)anim-\>GetInterface(I_CONTROL))

A plug-in developer may use this macro as follows:

Control *c = GetControlInterface(anim);

This will either be NULL or a pointer to a valid controller.

Note: Plug-in defined interfaces should be greater than the following value:

#define I_USERINTERFACE 0x0000ffff

If a plug-in implements this method for its own purposes, it would, in general, switch on the id and if it is not aware of the id it would call this method on the base class. Otherwise it could respond to the id as it needed. See the sample code below for the how the Control class implements this method.

Parameters

id	The id of the interface.

Default Implementation:

{ return NULL; }

Sample Code:

The following is the Control class implementation of this method. It looks at the id passed, and if it matches I_CONTROL it returns its this pointer. Otherwise it calls the base class method.

void* Control::GetInterface(ULONG id)
{
    if (id==I_CONTROL) {
        return this;
    }
    else {
        return Animatable::GetInterface(id);
    }
}

Reimplemented from MSPluginTexmap.

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

Member Data Documentation

delegate

Texmap* delegate