MSSimpleModXtnd Class Reference

#include <mxsPlugin.h>

Inheritance diagram for MSSimpleModXtnd:

Public Member Functions
	MSSimpleModXtnd (MSPluginClass *pc, BOOL loading)
	~MSSimpleModXtnd ()
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.
SClass_ID	SuperClassID () override
	Retrieves a constant representing the type of the plugin.
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
	An object or modifier should implement this method if it wishes to make its parameter block available for other plug-ins to access it.
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.
const MCHAR *	GetObjectName (bool localized=true) const override
void	BeginEditParams (IObjParam *objParam, ULONG vflags, Animatable *pPrev) override
void	EndEditParams (IObjParam *objParam, ULONG vflags, Animatable *pNext) override
int	HitTest (TimeValue t, INode *inode, int type, int crossing, int vflags, IPoint2 *p, ViewExp *vpt, ModContext *mc) override
	This method is used in modifier gizmo hit testing.
int	Display (TimeValue t, INode *inode, ViewExp *vpt, int vflags, ModContext *mc) override
	When this method is called the plug-in should respond by performing a quick render of the modifier gizmo in viewport using the current TM.
void	GetWorldBoundBox (TimeValue t, INode *inode, ViewExp *vpt, Box3 &box, ModContext *mc) override
	This method computes the world space bounding box of the modifier gizmo (or any object that when in sub-object mode has a gizmo).
void	GetLocalBoundBox (TimeValue t, INode *inode, ViewExp *vpt, Box3 &box) override
	This is the object space bounding box, the box in the object's local coordinates.
void	Snap (TimeValue t, INode *inode, SnapInfo *snap, IPoint2 *p, ViewExp *vpt) override
	Checks the point passed for a snap and updates the SnapInfo structure.
CreateMouseCallBack *	GetCreateMouseCallBack () override
	This method allows the system to retrieve a callback object used in creating an object in the 3D viewports.
BOOL	HasUVW () override
	Call this method to find out if the object has UVW coordinates.
void	SetGenUVW (BOOL sw) override
	This method is called to change the state of its Generate UVW boolean.
void	GetSubObjectCenters (SubObjAxisCallback *cb, TimeValue t, INode *node, ModContext *mc) override
	When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis.
void	GetSubObjectTMs (SubObjAxisCallback *cb, TimeValue t, INode *node, ModContext *mc) override
	When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis.
BOOL	ChangeTopology () override
	This method asks the question of an object or modifier "Do you change topology"? An object or modifier returns TRUE if it is capable of changing topology when its parameters are being edited; otherwise FALSE.
ChannelMask	ChannelsUsed () override
	These are channels that the modifier needs in order to perform its modification.
ChannelMask	ChannelsChanged () override
	These are the channels that the modifier actually modifies.
void	NotifyInputChanged (const Interval &changeInt, PartID partID, RefMessage message, ModContext *mc) override
	This method is called when an item in the modifier stack before this modifier sends a REFMSG_CHANGE message via NotifyDependents().
void	ModifyObject (TimeValue t, ModContext &mc, ObjectState *os, INode *node) override
	This is the method that actually modifies the input object.
BOOL	DependOnTopology (ModContext &mc) override
	Modifiers that place a dependency on topology should return TRUE for this method.
Class_ID	InputType () override
	This is the type of object that the modifier knows how to modify.
IOResult	SaveLocalData (ISave *iSave, LocalModData *ld) override
	When a 3ds Max file is being saved, this method is called so that the modifier can save the localData structure that is hung off each ModContext.
IOResult	LoadLocalData (ILoad *iLoad, LocalModData **pld) override
	When a 3ds Max file is being loaded, this method is called so that the modifier can load the LocalModData structure that is hung off each ModContext.
Deformer &	GetDeformer (TimeValue t, ModContext &mc, Matrix3 &mat, Matrix3 &invmat) override
void	InvalidateUI () override
Interval	GetValidity (TimeValue t) override
BOOL	GetModLimits (TimeValue t, float &zmin, float &zmax, int &axis) override
void *	GetInterface (ULONG id) override
Public Member Functions inherited from MSPluginSimpleMod
	MSPluginSimpleMod ()
	MSPluginSimpleMod (MSPluginClass *pc, BOOL loading)
	~MSPluginSimpleMod ()
void	DeleteThis () override
	Deletes an instance of this class.
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	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.
SClass_ID	SuperClassID () override
	Retrieves a constant representing the type of the plugin.
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
	An object or modifier should implement this method if it wishes to make its parameter block available for other plug-ins to access it.
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.
IOResult	Save (ISave *iSave) override
IOResult	Load (ILoad *iLoad) override
	Called for loading data.
void	NotifyTarget (int msg, RefMakerHandle rm) override
const MCHAR *	GetObjectName (bool localized=true) const override
void	BeginEditParams (IObjParam *objParam, ULONG vflags, Animatable *pPrev) override
void	EndEditParams (IObjParam *objParam, ULONG vflags, Animatable *pNext) override
Deformer &	GetDeformer (TimeValue t, ModContext &mc, Matrix3 &mat, Matrix3 &invmat) override
void	InvalidateUI () override
Interval	GetValidity (TimeValue t) override
BOOL	GetModLimits (TimeValue t, float &zmin, float &zmax, int &axis) 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 SimpleModBase
CoreExport	SimpleModBase ()
ChannelMask	ChannelsUsed () override
	These are channels that the modifier needs in order to perform its modification.
ChannelMask	ChannelsChanged () override
	These are the channels that the modifier actually modifies.
CoreExport void	ModifyObject (TimeValue t, ModContext &mc, ObjectState *os, INode *node) override
	This is the method that actually modifies the input object.
Class_ID	InputType () override
	This is the type of object that the modifier knows how to modify.
CoreExport Interval	LocalValidity (TimeValue t) override
	This method returns the validity interval of a modifier.
CoreExport Matrix3	CompMatrix (TimeValue t, ModContext &mc, Matrix3 &ntm, Interval &valid, BOOL needOffset)
CoreExport void	CompOffset (TimeValue t, Matrix3 &offset, Matrix3 &invoffset)
CoreExport int	HitTest (TimeValue t, INode *inode, int type, int crossing, int flags, IPoint2 *p, ViewExp *vpt, ModContext *mc) override
	This method is used in modifier gizmo hit testing.
CoreExport int	Display (TimeValue t, INode *inode, ViewExp *vpt, int flagst, ModContext *mc) override
	When this method is called the plug-in should respond by performing a quick render of the modifier gizmo in viewport using the current TM.
CoreExport void	GetWorldBoundBox (TimeValue t, INode *inode, ViewExp *vpt, Box3 &box, ModContext *mc) override
	This method computes the world space bounding box of the modifier gizmo (or any object that when in sub-object mode has a gizmo).
CoreExport void	GetSubObjectCenters (SubObjAxisCallback *cb, TimeValue t, INode *node, ModContext *mc) override
	When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis.
CoreExport void	GetSubObjectTMs (SubObjAxisCallback *cb, TimeValue t, INode *node, ModContext *mc) override
	When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis.
BOOL	ChangeTopology () override
	This method asks the question of an object or modifier "Do you change topology"? An object or modifier returns TRUE if it is capable of changing topology when its parameters are being edited; otherwise FALSE.
CoreExport void	Move (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Point3 &val, BOOL localOrigin=FALSE) override
	When this method is called the plug-in should respond by moving its selected sub-object components.
CoreExport void	Rotate (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Quat &val, BOOL localOrigin=FALSE) override
	When this method is called the plug-in should respond by rotating its selected sub-object components.
CoreExport void	Scale (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Point3 &val, BOOL localOrigin=FALSE) override
	When this method is called the plug-in should respond by scaling its selected sub-object components.
int	NumRefs () override
	Returns the total number of references this ReferenceMaker can hold.
CoreExport RefTargetHandle	GetReference (int i) override
	Returns the 'i-th' reference.
int	NumSubs () override
CoreExport Animatable *	SubAnim (int i) override
CoreExport MSTR	SubAnimName (int i, bool localized=true) override
CoreExport int	SubNumToRefNum (int subNum) override
CoreExport BOOL	AssignController (Animatable *control, int subAnim) override
CoreExport RefResult	NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate) override
	Receives and responds to messages.
CreateMouseCallBack *	GetCreateMouseCallBack () override
	This method allows the system to retrieve a callback object used in creating an object in the 3D viewports.
CoreExport void	ActivateSubobjSel (int level, XFormModes &modes) override
	When the user changes the selection of the sub-object drop down, this method is called to notify the plug-in.
CoreExport void	SimpleModBaseClone (SimpleModBase *smodSource, RemapDir &remap)
	When clients are cloning themselves, they should call this method on the clone to copy SimpleModBase's data.
CoreExport void	BeginEditParams (IObjParam *objParam, ULONG flags, Animatable *prev) override
	Clients of SimpleModBase probably want to override these.
CoreExport void	EndEditParams (IObjParam *objParam, ULONG flags, Animatable *next) override
virtual Deformer &	GetDeformer (TimeValue t, ModContext &mc, Matrix3 &mat, Matrix3 &invmat)=0
virtual void	InvalidateUI ()
virtual Interval	GetValidity (TimeValue t)
virtual BOOL	GetModLimits (TimeValue t, float &zmin, float &zmax, int &axis)
CoreExport int	NumSubObjTypes () override
	Objects and modifiers that support subobjects have to overwrite this method - as well as GetSubObjType() - and return a class derived from ISubObjType in GetSubObjType().
CoreExport ISubObjType *	GetSubObjType (int i) override
	Returns a pointer to the sub-object type for the sub-object whose index is passed.
Public Member Functions inherited from Modifier
CoreExport	Modifier ()
CoreExport	~Modifier ()
	__declspec (deprecated) virtual MSTR GetName() MAX_SEALED
SClass_ID	SuperClassID () override
	Retrieves a constant representing the type of the plugin.
virtual void	ForceNotify (Interval &i) override
	Notifies dependents of a change.
CoreExport SvGraphNodeReference	SvTraverseAnimGraph (IGraphObjectManager *gom, Animatable *owner, int id, DWORD flags) override
CoreExport MSTR	SvGetName (IGraphObjectManager *gom, IGraphNode *gNode, bool isBeingEdited) override
CoreExport bool	SvCanSetName (IGraphObjectManager *gom, IGraphNode *gNode) override
CoreExport bool	SvSetName (IGraphObjectManager *gom, IGraphNode *gNode, const MSTR &name) override
CoreExport bool	SvHandleDoubleClick (IGraphObjectManager *gom, IGraphNode *gNode) override
CoreExport COLORREF	SvHighlightColor (IGraphObjectManager *gom, IGraphNode *gNode) override
CoreExport bool	SvIsSelected (IGraphObjectManager *gom, IGraphNode *gNode) override
	Returns true if the object is selected in its schematic view.
CoreExport MultiSelectCallback *	SvGetMultiSelectCallback (IGraphObjectManager *gom, IGraphNode *gNode) override
CoreExport bool	SvCanSelect (IGraphObjectManager *gom, IGraphNode *gNode) override
CoreExport bool	SvCanInitiateLink (IGraphObjectManager *gom, IGraphNode *gNode) override
CoreExport bool	SvCanConcludeLink (IGraphObjectManager *gom, IGraphNode *gNode, IGraphNode *gNodeChild) override
CoreExport bool	SvLinkChild (IGraphObjectManager *gom, IGraphNode *gNodeThis, IGraphNode *gNodeChild) override
CoreExport bool	SvCanRemoveThis (IGraphObjectManager *gom, IGraphNode *gNode) override
CoreExport bool	SvRemoveThis (IGraphObjectManager *gom, IGraphNode *gNode) override
	Called when the user deletes this object in the schematic view...
virtual CoreExport MSTR	GetName (bool localized) const
	Implemented by the System.
virtual CoreExport void	SetName (MSTR n)
	Implemented by the System.
virtual void	DisableModApps ()
	This method is used internally.
virtual void	EnableModApps ()
	This method is used internally.
virtual CoreExport void	DisableMod ()
	Implemented by the System.
virtual CoreExport void	EnableMod ()
	Implemented by the System.
virtual int	IsEnabled ()
	Implemented by the System.
virtual CoreExport void	DisableModInViews ()
	Implemented by the System.
virtual CoreExport void	EnableModInViews ()
	Implemented by the System.
virtual int	IsEnabledInViews ()
	Implemented by the System.
virtual CoreExport void	DisableModInRender ()
	Implemented by the System.
virtual CoreExport void	EnableModInRender ()
	Implemented by the System.
virtual int	IsEnabledInRender ()
	Implemented by the System.
virtual bool	ChangesSelType ()
	If a modifier want to make it possible to switch dynamically between changing the selection type that flows up the stack, or leaving it like it is, it can overwrite this.
virtual CoreExport ChannelMask	TotalChannelsUsed ()
	Returns the same value as ChannelsUsed() above except GFX_DATA_CHANNEL will be ORed in if the TOPO_CHANNEL or the TEXMAP_CHANNEL are being used.
virtual CoreExport ChannelMask	TotalChannelsChanged ()
	Returns the same value as ChannelsChanged() above except GFX_DATA_CHANNEL will be ORed in if the TOPO_CHANNEL, the TEXMAP_CHANNEL , or the VERTCOLOR_CHANNEL are being changed.
virtual bool	AnyObjectFilter (Object *object) const
	When InputType() returns anyObjectClassID, this method is used to determine whether the modifier can be applied to a specific object.
CoreExport IOResult	Save (ISave *isave) override
	Implemented by the System.
CoreExport IOResult	Load (ILoad *iload) override
	Implemented by the System.
virtual bool	ShouldCollapseOnSave ()
	In cases where a modifier does not exist in the specified save version returned by GetSavingVersion(), or where a modifier employs new functionality which cannot be retained in the specified save version, it may return true to indicate that the owning object should be saved in a state with its modifier stack collapsed at least up to this modifier.
virtual CoreExport void	EnumModContexts (ModContextEnumProc *proc)
	Implemented by the System.
virtual CoreExport void	GetIDerivedObject (ModContext *mc, IDerivedObject *&derObj, int &modIndex)
	This method will retrieve the IDerivedObject and index of this modifier for a given modifier context.
virtual CoreExport void	CopyAdditionalChannels (Object *fromObj, Object *toObj)
	In case the modifier changes the object type (basically the os->obj pointer in ModifyObject) and changes the ExtensionChannel, it has to overwrite this method and copy only the channels that it doesn't modify/added already to the new object.
CoreExport INode *	GetNodeFromModData (LocalModData *data, int &index)
	This function allows modifiers to find the nodes they are modifying.
CoreExport INode *	GetNodeFromModContext (ModContext *mc, int &index)
	This function allows modifiers to find the nodes they are modifying.
Public Member Functions inherited from BaseObject
virtual CoreExport unsigned long	GetObjectDisplayRequirement () const
virtual CoreExport bool	PrepareDisplay (const MaxSDK::Graphics::UpdateDisplayContext &prepareDisplayContext)
virtual CoreExport bool	UpdatePerNodeItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer)
virtual CoreExport bool	UpdatePerViewItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::UpdateViewContext &viewContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer)
virtual CoreExport const MaxSDK::Graphics::RenderItemHandleArray &	GetRenderItems () const
virtual CoreExport void *	GetInterface (ULONG id) override
virtual CoreExport BaseInterface *	GetInterface (Interface_ID id) override
CoreExport	BaseObject ()
virtual CoreExport	~BaseObject ()
virtual BOOL	HasViewDependentBoundingBox ()
	This method return true if GetWorldBoundBox returns different boxes for different viewports.
virtual int	HitTest (TimeValue t, INode *inode, int type, int crossing, int flags, IPoint2 *p, ViewExp *vpt)
	This method is called to determine if the specified screen point intersects the item.
virtual void	SetExtendedDisplay (int flags)
	This method is used for storing mode-dependent display attributes.
virtual int	Display (TimeValue t, INode *inode, ViewExp *vpt, int flags)
	This is called by the system to have the item display itself (perform a quick render in viewport, using the current TM).
virtual void	GetWorldBoundBox (TimeValue t, INode *inode, ViewExp *vp, Box3 &box)
	This method returns the world space bounding box for Objects (see below for the Sub-object gizmo or Modifiers gizmo version).
	__declspec (deprecated) virtual const MCHAR *GetObjectName() MAX_SEALED
virtual CoreExport BOOL	OKToChangeTopology (MSTR &modName)
	Implemented by the System.
virtual IParamArray *	GetParamBlock ()
	An object or modifier should implement this method if it wishes to make its parameter block available for other plug-ins to access it.
virtual int	GetParamBlockIndex (int id)
	If a plug-in makes its parameter block available (using GetParamBlock()) then it will need to provide #defines for indices into the parameter block.
virtual void	TransformStart (TimeValue t)
	This method is called before the first Move(), Rotate() or Scale() call and before a hold is in effect.
virtual void	TransformHoldingStart (TimeValue t)
	This method is called before the first Move(), Rotate() or Scale() call and after a hold is in effect.
virtual void	TransformHoldingFinish (TimeValue t)
	This method is called after the user has completed the Move(), Rotate() or Scale() operation and before the undo object has been accepted.
virtual void	TransformFinish (TimeValue t)
	This method is called after the user has completed the Move(), Rotate() or Scale() operation and the undo object has been accepted.
virtual void	TransformCancel (TimeValue t)
	This method is called when the transform operation is canceled by a right-click and the undo has been canceled.
virtual void	CloneSelSubComponents (TimeValue t)
	This method is called to make a copy of the selected sub-object components of the item.
virtual void	AcceptCloneSelSubComponents (TimeValue t)
	This method is called when the user mouses up after shift-cloning a sub-object selection.
virtual void	SelectSubComponent (HitRecord *hitRec, BOOL selected, BOOL all, BOOL invert=FALSE)
	This method is called to change the selection state of the component identified by hitRec.
virtual void	ClearSelection (int selLevel)
	This method is called to clear the selection for the given sub-object level.
virtual void	SelectAll (int selLevel)
	This method is called to select every element of the given sub-object level.
virtual void	InvertSelection (int selLevel)
	This method is called to invert the specified sub-object level.
virtual int	SubObjectIndex (HitRecord *hitRec)
	Returns the index of the sub-object element identified by the HitRecord hitRec.
virtual BOOL	SupportsNamedSubSels ()
	An object that supports sub-object selection can choose to support named sub object selection sets.
virtual void	ActivateSubSelSet (MSTR &setName)
	When the user chooses a name from the drop down list this method is called.
virtual void	NewSetFromCurSel (MSTR &setName)
	If the user types a new name into the named selection set drop down then this method is called.
virtual void	RemoveSubSelSet (MSTR &setName)
	If the user selects a set from the drop down and then chooses Remove Named Selections from the Edit menu this method is called.
virtual void	SetupNamedSelDropDown ()
	To support the Edit Named Selections dialog, plug-ins must implement this method.
virtual int	NumNamedSelSets ()
	To support the Edit Named Selections dialog, plug-ins must implement this method.
virtual MSTR	GetNamedSelSetName (int i)
	To support the Edit Named Selections dialog, plug-ins must implement this method.
virtual void	SetNamedSelSetName (int i, MSTR &newName)
	To support the Edit Named Selections dialog, plug-ins must implement this method.
virtual void	NewSetByOperator (MSTR &newName, Tab< int > &sets, int op)
	To support the Edit Named Selections dialog, plug-ins must implement this method.
virtual void	NotifyPreCollapse (INode *node, IDerivedObject *derObj, int index)
	This method is called before a modifier or object is collapsed.
virtual void	NotifyPostCollapse (INode *node, Object *obj, IDerivedObject *derObj, int index)
	This method is called after a modifier or object is collapsed.
virtual CoreExport int	GetSubObjectLevel ()
	This method returns an integer which indicates the current sub-object level of the modifier or base object.
virtual BOOL	HasUVW (int mapChannel)
	Call this method to find out if the object is has UVW coordinates for the specified mapping channel.
virtual void	SetGenUVW (int mapChannel, BOOL sw)
	This method is called to change the state of its Generate UVW boolean for the specified mapping channel.
virtual void	ShowEndResultChanged (BOOL showEndResult)
	This method notifies the BaseObject that the end result display has been switched (the "Show End Result" button has been toggled).
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.
virtual CoreExport void	BaseClone (ReferenceTarget *from, ReferenceTarget *to, RemapDir &remap)
	This method copies base class data from an object to its clone.
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 CoreExport void	ReleaseInterface (ULONG id, void *i)
virtual CoreExport int	SetProperty (ULONG id, void *data)
virtual CoreExport void *	GetProperty (ULONG id)
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 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	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	SvIsHighlighted (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport COLORREF	SvGetSwatchColor (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvIsInactive (IGraphObjectManager *gom, IGraphNode *gNode)
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 Attributes
SimpleMod *	delegate
Public Attributes inherited from MSPluginSimpleMod
IObjParam *	ip
Point3Value *	vec
Point3Value *	extent
Point3Value *	min
Point3Value *	max
Point3Value *	center
BOOL	busy
TimeValue	last_time
Point3	last_in
Point3	last_out
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 SimpleModBase
Control *	tmControl
Control *	posControl

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 SimpleModBase
virtual CoreExport	~SimpleModBase ()
	Destructor. This is a base class that is not meant to be instantiated directly.
virtual CoreExport 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 MSPluginSimpleMod
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 Modifier
static CoreExport bool	GetInputType (ClassDesc *cd, Class_ID &inputType)
	To determine the input type of a modifier, an instance of the modifier needs to be created.
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 MSPluginSimpleMod
static CRITICAL_SECTION	def_sync
static BOOL	setup_sync
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 SimpleModBase
static CoreExport IObjParam *	ip
static MoveModBoxCMode *	moveMode
static RotateModBoxCMode *	rotMode
static UScaleModBoxCMode *	uscaleMode
static NUScaleModBoxCMode *	nuscaleMode
static SquashModBoxCMode *	squashMode
static SimpleModBase *	editMod
Static Public Attributes inherited from Animatable
static const AnimHandle	kInvalidAnimHandle = 0
Protected Attributes inherited from BaseObject
MaxSDK::Graphics::RenderItemHandleArray	mRenderItemHandles
Protected Attributes inherited from Animatable
DWORD	aflag
AnimPropertyList	aprops
Static Protected Attributes inherited from Value
static ScripterExport Value *	keyarg_marker_value

Constructor & Destructor Documentation

MSSimpleModXtnd()

MSSimpleModXtnd	(	MSPluginClass *	pc,
		BOOL	loading
	)

~MSSimpleModXtnd()

~MSSimpleModXtnd ( )

inline

{ DeleteAllRefsFromMe(); }

Member Function Documentation

DeleteThis()

void DeleteThis ( )

inlineoverridevirtual

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 MSPluginSimpleMod.

{  MSPlugin::DeleteThis(); }

get_delegate()

ReferenceTarget * get_delegate ( )

inlineoverridevirtual

Reimplemented from MSPluginSimpleMod.

{ 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 MSPluginSimpleMod.

{ 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 MSPluginSimpleMod.

{ return pc->class_id; }

SuperClassID()

SClass_ID SuperClassID ( )

inlineoverridevirtual

Retrieves a constant representing the type of the plugin.

Returns

A super class id that uniquely identifies the type (category) of the plugin. Note that several plugin classes can be of the same type, thus return the same super class id. Plugins are uniquely identified by their class ids.

See also

SClass_ID

Reimplemented from MSPluginSimpleMod.

{ return pc->sclass_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 MSPluginSimpleMod.

{ delegate->FreeCaches(); }         

NumSubs()

int NumSubs ( )

inlineoverridevirtual

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 MSPluginSimpleMod.

{ return pblocks.Count() + 1; }  

SubAnim()

Animatable * SubAnim ( int  i )

inlineoverridevirtual

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 MSPluginSimpleMod.

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

SubAnimName()

MSTR SubAnimName ( int  i, bool  localized = true  )

inlineoverridevirtual

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 MSPluginSimpleMod.

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

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 MSPluginSimpleMod.

{ return pblocks.Count(); }

GetParamBlock()

IParamBlock2 * GetParamBlock ( int  i )

inlineoverridevirtual

An object or modifier should implement this method if it wishes to make its parameter block available for other plug-ins to access it.

The system itself doesn't actually call this method. This method is optional.

Returns

A pointer to the item's parameter block. See Class IParamArray.

Reimplemented from MSPluginSimpleMod.

{ 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 MSPluginSimpleMod.

{ 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 MSPluginSimpleMod.

{ if (id == I_MAXSCRIPTPLUGIN) return (MSPlugin*)this; return MSPluginSimpleMod::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 MSPluginSimpleMod.

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 MSPluginSimpleMod.

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 MSPluginSimpleMod.

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 MSPluginSimpleMod.

GetObjectName()

const MCHAR * GetObjectName ( bool  localized = true ) const

inlineoverridevirtual

Returns

the name that will appear in the modifier stack.

Parameters

localized

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

Reimplemented from MSPluginSimpleMod.

{ return pc->class_name->to_string(); } // localized name

BeginEditParams()

void BeginEditParams ( IObjParam *  ip, ULONG  flags, Animatable *  prev  )

overridevirtual

Remarks

This method is called by the system when the user may edit the item's (object, modifier, controller, etc.) parameters.

Parameters

ip	Interface pointer. The developer can use it to call methods such as AddRollupPage(). Note that this pointer is only valid between BeginEditParams() and EndEditParams(). It should not be used outside this interval.
flags	Describe which branch of the command panel or dialog the item is being edited in. The following are possible values: BEGIN_EDIT_CREATE Indicates an item is being edited in the create branch. BEGIN_EDIT_MOTION Indicates a controller is being edited in the motion branch. BEGIN_EDIT_HIERARCHY Indicates a controller is being edited in the Pivot subtask of the hierarchy branch. BEGIN_EDIT_IK Indicates a controller is being edited in the IK subtask of the hierarchy branch. BEGIN_EDIT_LINKINFO Indicates a controller is being edited in the Link Info subtask of the hierarchy branch.
prev	Pointer to an Animatable object. This parameter may be used in the motion and hierarchy branches of the command panel. This pointer allows a plug-in to look at the ClassID of the previous item that was being edited, and if it is the same as this item, to not replace the entire UI in the command panel, but simply update the values displayed in the UI fields. This prevents the UI from 'flickering' when the current item begins its edit. For example, if you are in the motion branch and are looking at an item's PRS controller values, and then select another item that is displayed with a PRS controller, the UI will not change - only the values displayed in the fields will change. If however you selected a target camera that has a lookat controller (not a PRS controller) the UI will change because a different set of parameters need to be displayed. Note that for items that are edited in the modifier branch this field can be ignored.

Reimplemented from MSPluginSimpleMod.

EndEditParams()

void EndEditParams ( IObjParam *  ip, ULONG  flags, Animatable *  next  )

overridevirtual

Remarks

This method is called when the user is finished editing an objects parameters. The system passes a flag into the EndEditParams() method to indicate if the rollup page should be removed. If this flag is TRUE, the plug-in must un-register the rollup page, and delete it from the panel.

Parameters

ip	An interface pointer. The developer may use the interface pointer to call methods such as DeleteRollupPage().
flags	The following flag may be set: END_EDIT_REMOVEUI If TRUE, the item's user interface should be removed.
next	Animatable pointer. Can be used in the motion and hierarchy branches of the command panel. It allows a plug-in to look at the ClassID of the next item that was being edited, and if it is the same as this item, to not replace the entire UI in the command panel. Note that for items that are edited in the modifier branch this field can be ignored.

Reimplemented from MSPluginSimpleMod.

HitTest()

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

inlineoverridevirtual

This method is used in modifier gizmo hit testing.

It is called to determine if the specified screen point intersects the gizmo. The method returns nonzero if the item was hit; otherwise 0.

Parameters

t	The time to perform the hit test.
inode	A pointer to the node to test.
type	The type of hit testing to perform. See Scene and Node Hit Test Types. for details.
crossing	The state of the crossing setting. If TRUE crossing selection is on.
flags	The hit test flags. See Scene and Node Hit Testing Flags for details.
p	The screen point to test.
vpt	An interface pointer that may be used to call methods associated with the viewports.
mc	A pointer to the modifiers ModContext.

Returns

Nonzero if the item was hit; otherwise 0.

Reimplemented from BaseObject.

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

Display()

int Display ( TimeValue  t, INode *  inode, ViewExp *  vpt, int  flags, ModContext *  mc  )

inlineoverridevirtual

When this method is called the plug-in should respond by performing a quick render of the modifier gizmo in viewport using the current TM.

Note for Modifiers: For this method to be called properly, one must send two reference messages using NotifyDependents. In BeginEditParams send: NotifyDependents(Interval(t,t), PART_ALL, REFMSG_MOD_DISPLAY_ON);

In EndEditParams send: NotifyDependents(Interval(t,t), PART_ALL, REFMSG_MOD_DISPLAY_OFF);

Parameters

t	The time to display the item.
inode	The node to render.
vpt	An interface pointer that may be used to call methods associated with the viewports.
flags	See Display Flags.
mc	A pointer to the modifiers ModContext.

Returns

Default return value is -1, means this object doesn't have display function. 0 means it didn't draw anything in current frame. Otherwise return positive values..

Reimplemented from BaseObject.

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

GetWorldBoundBox()

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

inlineoverridevirtual

This method computes the world space bounding box of the modifier gizmo (or any object that when in sub-object mode has a gizmo).

Parameters

t	The time to compute the bounding box.
inode	The node to calculate the bounding box for.
vpt	An interface pointer that may be used to call methods associated with the viewports.
box	The returned bounding box.
mc	A pointer to the modifiers ModContext.

Reimplemented from BaseObject.

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

GetLocalBoundBox()

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

inlineoverridevirtual

This is the object space bounding box, the box in the object's local coordinates.

The system expects that requesting the object space bounding box will be fast.

Parameters

t	The time to retrieve the bounding box.
inode	The node to calculate the bounding box for.
vp	An interface pointer that may be used to call methods associated with the viewports.
box	Contains the returned bounding box.

Reimplemented from BaseObject.

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

Snap()

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

inlineoverridevirtual

Checks the point passed for a snap and updates the SnapInfo structure.

Note

Developers wanting to find snap points on an Editable Mesh object should see the method XmeshSnap::Snap() in /MAXSDK/SAMPLES/SNAPS/XMESH/XMESH.CPP.

Parameters

t	The time to check.
inode	The node to check.
snap	The snap info structure to update.
p	The screen point to check.
vpt	An interface pointer that may be used to call methods associated with the viewports.

Reimplemented from BaseObject.

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

GetCreateMouseCallBack()

CreateMouseCallBack * GetCreateMouseCallBack ( )

inlineoverridevirtual

This method allows the system to retrieve a callback object used in creating an object in the 3D viewports.

This method returns a pointer to an instance of a class derived from CreateMouseCallBack. This class has a method proc() which is where the programmer defines the user/mouse interaction during the object creation phase.

Returns

A pointer to an instance of a class derived from CreateMouseCallBack.

Implements BaseObject.

{ return delegate->GetCreateMouseCallBack(); } 

HasUVW()

BOOL HasUVW ( )

inlineoverridevirtual

Call this method to find out if the object has UVW coordinates.

This method returns TRUE if the object has UVW coordinates; otherwise FALSE. In 3ds Max 2.0 and later there is code in the renderer that will automatically turn on the UVW coordinates of the base object if UV's are missing (and needed). The base object has to implement two simple methods to make this work: HasUVW() and SetGenUVW(). Developers are encouraged to put these methods in their objects: it makes using the program easier for the user. If they are not implemented, it doesn't cause any real harm: it will just operate as before and put up the missing UVW's message. Here is how the procedural sphere implements these methods:

BOOL SphereObject::GetGenUVW()
{
    BOOL genUVs;
    Interval v;
    pblock->GetValue(PB_GENUVS, 0, genUVs, v);
    return genUVs;
}
 
void SphereObject::SetGenUVW(BOOL sw)
{
    if (sw==GetGenUVW()) return;
    pblock->SetValue(PB_GENUVS,0, sw);
}

Important Note: The pblock->SetValue() will cause a call to NotifyDependents(FOREVER, PART_TEXMAP, REFMSG_CHANGE), which will invalidate the UVW cache. It is essential that this call be made, so if the 'generate UVW' boolean is not handled by a parameter block, then NotifyDependents() needs to be called explicitly. Also Note: For "modifiable objects" that pass up the pipeline getting modified, such as TriObject, EditTriObject, etc., which cannot generate their own UVWs, but can carry them in their data structures, only this HasUVW() method needs to be implemented. For example, here is the implementation for TriObject: BOOL TriObject::HasUVW() { return mesh.tvFace?1:0; }

Reimplemented from BaseObject.

{ return delegate->HasUVW(); }

SetGenUVW()

void SetGenUVW ( BOOL  sw )

inlineoverridevirtual

This method is called to change the state of its Generate UVW boolean.

If the state changes, the object must send a REFMSG_CHANGE up the pipeline by calling NotifyDependents(). This applies to map channel 1.

Parameters

sw	The new state for the generate UVW flag.

Reimplemented from BaseObject.

{ delegate->SetGenUVW(sw); }

GetSubObjectCenters()

void GetSubObjectCenters ( SubObjAxisCallback *  cb, TimeValue  t, INode *  node, ModContext *  mc  )

inlineoverridevirtual

When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis.

This method specifies the position of the center. The plug-in enumerates its centers and calls the callback cb once for each.

Parameters

cb	The callback object whose methods may be called. See Class SubObjAxisCallback.
t	The time to enumerate the centers.
node	A pointer to the node.
mc	A pointer to the ModContext.

Reimplemented from BaseObject.

{ delegate->GetSubObjectCenters(cb, t, node, mc); }

GetSubObjectTMs()

void GetSubObjectTMs ( SubObjAxisCallback *  cb, TimeValue  t, INode *  node, ModContext *  mc  )

inlineoverridevirtual

When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis.

This method returns the axis system of the reference coordinate system. The plug-in enumerates its TMs and calls the callback cb once for each. See Sub-Object Coordinate Systems.

Parameters

cb	The callback object whose methods may be called.
t	The time to enumerate the TMs.
node	A pointer to the node.
mc	A pointer to the ModContext.

Reimplemented from BaseObject.

{ delegate->GetSubObjectTMs(cb, t, node, mc); }

ChangeTopology()

BOOL ChangeTopology ( )

inlineoverridevirtual

This method asks the question of an object or modifier "Do you change topology"? An object or modifier returns TRUE if it is capable of changing topology when its parameters are being edited; otherwise FALSE.

When an item is selected for editing, and there is a modifier in the pipeline that depends on topology, the system calls this method to see if it may potentially change the topology. If this method returns TRUE the system will put up a warning message indicating that a modifier exists in the stack that depends on topology.

Reimplemented from BaseObject.

{ return delegate->ChangeTopology(); }

ChannelsUsed()

ChannelMask ChannelsUsed ( )

inlineoverridevirtual

These are channels that the modifier needs in order to perform its modification.

This should at least include the channels specified in ChannelsChanged() but may include more. Note that ChannelsUsed() is called many times but the channels returned should not change on the fly.

Returns

The channels required. See Object Channels.

Sample Code:

{ return GEOM_CHANNEL|TOPO_CHANNEL; }

Implements Modifier.

{ return delegate->ChannelsUsed(); }

ChannelsChanged()

ChannelMask ChannelsChanged ( )

inlineoverridevirtual

These are the channels that the modifier actually modifies.

Note that ChannelsChanged() is called many times but the channels returned should not change on the fly.

Returns

The channels that are changed. See Object Channels

Implements Modifier.

{ return delegate->ChannelsChanged(); }

NotifyInputChanged()

void NotifyInputChanged ( const Interval &  changeInt, PartID  partID, RefMessage  message, ModContext *  mc  )

inlineoverridevirtual

This method is called when an item in the modifier stack before this modifier sends a REFMSG_CHANGE message via NotifyDependents().

Consider the following example: Assume the modifier stack contains a Sphere Object, then a Bend, then a Edit Mesh. The Edit Mesh modifier does not have a reference to the Bend or the Sphere because it does not officially depend on these items. However it does depend on them in a certain sense, because it modifies the data that these items produce. So, if they change it may affect the modifier. A modifier may build a cache based on its input object. The modifier needs a way to know when to discard this cache because the input object has changed. Whenever one of the items before this modifier in the stack sends out a REFMSG_CHANGE message via NotifyDependents() to indicate it has changed this method is called. The modifier may respond in a way appropriate to it, for example by discarding its cache of the input object. It is not legal, to issue a NotifyDependent()'s in the NotifyInputChanged() method of a modifier, without checking for reentrancy. Imagine, you have an instanced modifier applied to the same object in the stack. Sending a refmsg from the NotifyInputChanged method will cause an endless loop. Simply putting a guard in, that checks for reentrancy should get rid of the problem.

Parameters

changeInt	This is the interval from the message. It is reserved for future use - now it will always be FOREVER.
partID	This is the partID from the message.
message	This is the message sent.
mc	The ModContext for the pipeline that changed. If a modifier is applied to multiple objects, then there are ModApps in each pipeline that it is applied to. These ModApps are pointing to the same modifier. Consider the following example: Say you apply a Bend modifier to a Sphere, a Cylinder and a Box object. There are three ModApps but only one Bend modifier. Then you go to the Sphere and adjust its Radius. This will cause NotifyInputChanged() to be called on the Bend because the Bend's input changed. However only one of its inputs changed - only the Sphere changed and not the Cylinder or the Box. Therefore NotifyInputChanged() will be called once, and the ModContext passed in will be for the Sphere's changed pipeline. It is possible that all three objects could change at the same time. If an instanced float controller was assigned to the radius, width, and height - one parameter for each object - then the controller was adjusted in the function curve editor, all three items would change. In this case NotifyInputChanged() would be called three times on the Bend. Once for each pipeline, once with each ModContext.

Reimplemented from Modifier.

{ delegate->NotifyInputChanged(changeInt, partID, message, mc); }

ModifyObject()

void ModifyObject ( TimeValue  t, ModContext &  mc, ObjectState *  os, INode *  node  )

inlineoverridevirtual

This is the method that actually modifies the input object.

This method is responsible for altering the object and then updating the validity interval of the object to reflect the validity of the modifier.

Parameters

t	The time at which the modification is being done.
mc	A reference to the ModContext.
os	The object state flowing through the pipeline. This contains a pointer to the object to modify.
node	The node the modifier is applied to. This parameter is always NULL for Object Space Modifiers and non-NULL for World Space Modifiers (Space Warps). This is because a given WSM is only applied to a single node at a time whereas an OSM may be applied to several nodes. This may be used for example by particle system space warps to get the transformation matrix of the node at various times.

See also

The topic on Modifiers in the Programmers Guide.

Implements Modifier.

{ delegate->ModifyObject(t, mc, os, node); }

DependOnTopology()

BOOL DependOnTopology ( ModContext &  mc )

inlineoverridevirtual

Modifiers that place a dependency on topology should return TRUE for this method.

An example would be a modifier that stores a selection set base on vertex indices. This modifier depends on the indices being intact for it to operate correctly.

Parameters

mc	Reference to the ModContext.

Returns

TRUE if the modifier depends on topology; otherwise FALSE.

Reimplemented from Modifier.

{ return delegate->DependOnTopology(mc); }

InputType()

Class_ID InputType ( )

inlineoverridevirtual

This is the type of object that the modifier knows how to modify.

Simple modifiers that just modify points of an object can operate on generic 'Deformable' objects. Deformable objects are any type of object that has points. A modifier could also work on a particular type of object such as a TriObject or PatchObject.

Returns

The Class_ID of the item. You can request any Class_ID for your input type. For example, Class_ID(OMNI_LIGHT_CLASS_ID, 0). See Class IDs defined in plugapi.h>.

Implements Modifier.

    {
        return delegate->InputType();
    }

SaveLocalData()

IOResult SaveLocalData ( ISave *  isave, LocalModData *  ld  )

inlineoverridevirtual

When a 3ds Max file is being saved, this method is called so that the modifier can save the localData structure that is hung off each ModContext.

If the modifier doesn't store any data in the ModContext it can ignore this method.

Parameters

isave	You may use this pointer to call methods of ISave to write data.
ld	Pointer to the LocalModData for the modifier.

Returns

One of the following values: IO_OK, IO_ERROR.

Reimplemented from Modifier.

{ return delegate->SaveLocalData(iSave, ld); }

LoadLocalData()

IOResult LoadLocalData ( ILoad *  iload, LocalModData **  pld  )

inlineoverridevirtual

When a 3ds Max file is being loaded, this method is called so that the modifier can load the LocalModData structure that is hung off each ModContext.

If the modifier doesn't store any data in the ModContext it can ignore this method.

Parameters

iload	You may use this pointer to call methods of ILoad to read data.
pld	A pointer to a pointer in the ModContext. The modifier must set this pointer to point at a new LocalModData derived class.

Returns

One of the following values: IO_OK, IO_ERROR.

Reimplemented from Modifier.

{ return delegate->LoadLocalData(iLoad, pld); }

GetDeformer()

Deformer & GetDeformer ( TimeValue  t, ModContext &  mc, Matrix3 &  mat, Matrix3 &  invmat  )

inlineoverridevirtual

Remarks

This method is used to retrieve the callback object that will handle the deformation.

Parameters:

TimeValue t

Specifies the time the modification is being performed.

ModContext &mc

A reference to the ModContext.

Matrix3& mat

A reference to a matrix that describes the space the modification is supposed to happen in. This is computed from the ModContext matrix and the controllers controlling the gizmo and center of the modifier. The plug-in developers job is simply to transform each point to be deformed by this matrix before it performs its own deformation to the point. After the modifier applies its own deformation to the point, the developer transforms the point by the inverse of this matrix (passed below).

Matrix3& invmat

This is the inverse of the matrix above. See the comment above for how this is used.

Returns

A C++ reference to the deformer callback object.

Reimplemented from MSPluginSimpleMod.

{ return delegate->GetDeformer(t, mc, mat, invmat); }

InvalidateUI()

void InvalidateUI ( )

inlineoverridevirtual

Remarks

This is called if the user interface parameters needs to be updated because the user moved to a new time. The UI controls must display values for the current time.

Example:

If the plug-in uses a parameter map for handling its UI, it may call a method of the parameter map to handle this: pmapParam->Invalidate();

If the plug-in does not use parameter maps, it should call the SetValue() method on each of its controls that display a value, for example the spinner controls. This will cause to the control to update the value displayed. The code below shows how this may be done for a spinner control. Note that ip and pblock are assumed to be initialized interface and parameter block pointers

float newval;

Interval valid=FOREVER;

TimeValue t=ip->GetTime();

// Get the value from the parameter block at the current time.

pblock->GetValue( PB_ANGLE, t, newval, valid );

// Set the value. Note that the notify argument is passed as FALSE.

// This ensures no messages are sent when the value changes.

angleSpin->SetValue( newval, FALSE );

Reimplemented from MSPluginSimpleMod.

{ delegate->InvalidateUI(); }

GetValidity()

Interval GetValidity ( TimeValue  t )

overridevirtual

Remarks

The SimpleModBase class calls this method to retrieve the validity interval of the modifier. The modifier provides this interval by starting an interval at FOREVER and intersecting it with each of its parameters validity intervals.

Parameters:

TimeValue t

The time to compute the validity interval.

Default Implementation:

{return FOREVER;}

Returns

The validity interval of the modifier.

See also

The Advanced Topics section on Intervals.

Reimplemented from MSPluginSimpleMod.

GetModLimits()

BOOL GetModLimits ( TimeValue  t, float &  zmin, float &  zmax, int &  axis  )

inlineoverridevirtual

Remarks

If the effect can be limited (like the way bend/taper/twist/etc. can be limited) then it should specify the min and max limits and the axis that it is limited along. SimpleModBase will then display the limits as part of the Gizmo. If it does not support limits then it should return FALSE or simply not implement this method.

Parameters:

TimeValue t

The time to get the limits.

float &zmin

The min limit.

float &zmax

The max limit.

int &axis

The axis that it is limited along: x=0, y=1, z=2.

Returns

TRUE if limits are supported; otherwise FALSE.

Default Implementation:

{return FALSE;}

Reimplemented from MSPluginSimpleMod.

{ return delegate->GetModLimits(t, zmin,  zmax,  axis); }

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 MSPluginSimpleMod.

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

Member Data Documentation

delegate

SimpleMod* delegate