#include <mxsCustomAttributes.h>

Inheritance diagram for MSCustAttrib:

Public Member Functions
ScripterExport	MSCustAttrib ()

ScripterExport	MSCustAttrib (MSCustAttribDef *pc, BOOL loading)

ScripterExport	~MSCustAttrib ()

ScripterExport void	sprin1 (CharStream *s)

ScripterExport HWND	AddRollupPage (HINSTANCE hInst, const MCHAR dlgTemplate, DLGPROC dlgProc, const MCHAR title, LPARAM param=0, DWORD flags=0, int category=ROLLUP_CAT_CUSTATTRIB - 1)

ScripterExport void	DeleteRollupPage (HWND hRollup)

ScripterExport IRollupWindow *	GetRollupWindow ()

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

ReferenceTarget *	get_delegate ()

const MCHAR *	GetName (bool) override

ScripterExport ParamDlg *	CreateParamDlg (HWND hwMtlEdit, IMtlParams *imp)

void	SetName (const MCHAR *newName)

BaseInterface *	GetInterface (Interface_ID id)

void	GetClassName (MSTR &s, bool localized=true) const override
	Retrieves the name of the plugin class. More...

Class_ID	ClassID ()
	Retrieves a constant that uniquely identifies the plugin class. More...

SClass_ID	SuperClassID ()
	Retrieves a constant representing the type of the plugin. More...

void	FreeCaches ()

int	NumSubs ()

Animatable *	SubAnim (int i)

MSTR	SubAnimName (int i, bool localized=true) override

int	NumParamBlocks ()

IParamBlock2 *	GetParamBlock (int i)

IParamBlock2 *	GetParamBlockByID (BlockID id)

BOOL	CanCopyAnim ()

ScripterExport void *	GetInterface (ULONG id)
	Inherited from Animatable. More...

ScripterExport void	DeleteThis ()
	Deletes an instance of this class. More...

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

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

RefResult	NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate)
	Receives and responds to messages. More...

int	NumRefs ()
	Returns the total number of references this ReferenceMaker can hold. More...

RefTargetHandle	GetReference (int i)
	Returns the 'i-th' reference. More...

void	RefDeleted ()
	Called after a references to this is deleted. More...

RefTargetHandle	Clone (RemapDir &remap)
	This method is used by 3ds Max to clone an object. More...

ScripterExport IOResult	Save (ISave *isave)

ScripterExport IOResult	Load (ILoad *iload)
	Called for loading data. More...

ScripterExport int	NumSubTexmaps ()

ScripterExport Texmap *	GetSubTexmap (int i)

ScripterExport void	SetSubTexmap (int i, Texmap *m)

ScripterExport MSTR	GetSubTexmapSlotName (int i, bool localized=true) override

int	MapSlotType (int i)

MSTR	GetSubTexmapTVName (int i, bool localized=true)

ReferenceTarget *	GetRefTarget ()

Public Member Functions inherited from MSPlugin
	MSPlugin ()

virtual	~MSPlugin ()

void	init (MSPluginClass *pClass)

ScripterExport void	gc_trace ()

ScripterExport void	collect ()

void	DeleteThis ()

ScripterExport void	RefDeleted ()

void	init_locals ()

void	call_handler (Value handler, Value *arg_list, int count, TimeValue t, BOOL disable_on_error=FALSE)

Value *	_call_handler (Value handler, Value *arg_list, int count, TimeValue t, BOOL disable_on_error=FALSE)

FPStatus	call_handler (const MCHAR handler_name, FPParams params, FPValue &result, TimeValue t, BOOL disable_on_error=FALSE)

FPStatus	call_handler (Value handler, FPParams params, FPValue &result, TimeValue t, BOOL disable_on_error=FALSE)

void	post_create (ReferenceTarget *me, BOOL loading)

void	call_all_set_handlers ()

void	disable ()

void	enable ()

BOOL	enabled ()

int	get_local_index (Value *prop)

Value *	get_local (int index)

void	set_local (int index, Value *val)

ScripterExport IParamBlock2 *	GetParamBlockByID (BlockID id)

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

ScripterExport RefTargetHandle	clone_from (MSPlugin obj, ReferenceTarget obj_as_ref, RemapDir &remap)

void	RefAdded (RefMakerHandle rm)

void	NotifyTarget (int msg, RefMakerHandle rm)

IOResult	Save (ISave *isave)

IOResult	Load (ILoad *iLoad)

void	post_load (ILoad *iLoad, int which)

void	dump_local_vars_and_externals (int indentLevel)

Public Member Functions inherited from Value
virtual ScripterExport BOOL	is_kind_of (ValueMetaClass *c)

virtual ScripterExport ValueMetaClass *	local_base_class ()

virtual Value *	eval ()

virtual Value *	eval_no_wrapper ()

virtual ScripterExport Value *	apply (Value *arglist, int count, CallContext cc=NULL)

virtual ScripterExport Value *	apply_no_alloc_frame (Value *arglist, int count, CallContext cc=NULL)

virtual void	export_to_scripter ()

virtual Value *	map (node_map &m)

virtual Value *	map_path (PathName *path, node_map &m)

virtual Value *	find_first (BOOL(test_fn)(INode node, int level, const void arg), const void test_arg)

virtual Value *	get_path (PathName *path)

virtual ScripterExport void	sprint (CharStream *stream)

virtual void	prin1 ()

virtual void	print ()

virtual ScripterExport Class_ID	get_max_class_id ()

virtual ScripterExport Value *	delete_vf (Value **arglist, int arg_count)

virtual ScripterExport Value *	clearSelection_vf (Value **arglist, int arg_count)

virtual float	to_float ()

virtual double	to_double ()

virtual const MCHAR *	to_string ()

virtual MSTR	to_mstr ()

virtual MSTR	to_filename ()

virtual int	to_int ()

virtual INT64	to_int64 ()

virtual INT_PTR	to_intptr ()

virtual BOOL	to_bool ()

virtual BitArray &	to_bitarray ()

virtual Point4	to_point4 ()

virtual Point3	to_point3 ()

virtual Point2	to_point2 ()

virtual AColor	to_acolor ()

virtual COLORREF	to_colorref ()

virtual INode *	to_node ()

virtual Ray	to_ray ()

virtual Interval	to_interval ()

virtual Quat	to_quat ()

virtual AngAxis	to_angaxis ()

virtual Matrix3 &	to_matrix3 ()

virtual Box3	to_box3 ()

virtual float *	to_eulerangles ()

virtual Mtl *	to_mtl ()

virtual Texmap *	to_texmap ()

virtual MtlBase *	to_mtlbase ()

virtual Modifier *	to_modifier ()

virtual TimeValue	to_timevalue ()

virtual Control *	to_controller ()

virtual Atmospheric *	to_atmospheric ()

virtual Effect *	to_effect ()

virtual IMultiPassCameraEffect *	to_mpassCamEffect ()

virtual ShadowType *	to_shadowtype ()

virtual FilterKernel *	to_filter ()

virtual INode *	to_rootnode ()

virtual ITrackViewNode *	to_trackviewnode ()

virtual NURBSIndependentPoint *	to_nurbsindependentpoint ()

virtual NURBSPoint *	to_nurbspoint ()

virtual NURBSObject *	to_nurbsobject ()

virtual NURBSControlVertex *	to_nurbscontrolvertex ()

virtual NURBSCurve *	to_nurbscurve ()

virtual NURBSCVCurve *	to_nurbscvcurve ()

virtual NURBSSurface *	to_nurbssurface ()

virtual NURBSTexturePoint *	to_nurbstexturepoint ()

virtual NURBSSet *	to_nurbsset ()

virtual ReferenceTarget *	to_reftarg ()

virtual Mesh *	to_mesh ()

virtual BezierShape *	to_beziershape ()

virtual Thunk *	to_thunk ()

virtual void	to_fpvalue (FPValue &v)

virtual Renderer *	to_renderer ()

virtual Box2 &	to_box2 ()

virtual NURBSTextureSurface *	to_nurbstexturesurface ()

virtual NURBSDisplay *	to_nurbsdisplay ()

virtual TessApprox *	to_tessapprox ()

virtual Value *	widen_to (Value arg, Value *arg_list)

virtual BOOL	comparable (Value *arg)

virtual BOOL	special_case_compare (Value *arg, bool &specialCaseCompareResult)

virtual ScripterExport Value *	deep_copy (HashTable *remapper)

virtual BOOL	is_const ()

virtual ScripterExport Value *	get_property (Value **arg_list, int count)

virtual ScripterExport Value *	set_property (Value **arg_list, int count)

ScripterExport Value *	_get_property (Value *prop)

virtual ScripterExport Value *	_set_property (Value prop, Value val)

virtual Value *	get_container_property (Value prop, Value cur_prop)

virtual Value *	set_container_property (Value prop, Value val, Value *cur_prop)

virtual BOOL	_is_collection ()

virtual BOOL	_is_charstream ()

virtual BOOL	_is_rolloutcontrol ()

virtual BOOL	_is_rolloutthunk ()

virtual BOOL	_is_function ()

virtual BOOL	_is_selection ()

virtual BOOL	_is_thunk ()

virtual BOOL	_is_indirect_thunk ()

virtual SelectionIterator *	selection_iterator ()

virtual void	drop_MAX_refs ()

ScripterExport Value *	make_heap_permanent ()

ScripterExport Value *	make_heap_static ()

ScripterExport Value *	get_heap_ptr ()

ScripterExport Value *	get_stack_heap_ptr ()

ScripterExport Value *	migrate_to_heap ()

ScripterExport Value *	get_live_ptr ()

virtual BOOL	object_supports_case_sensitive_names ()

ScripterExport Value *	_get_property (Value prop, Value prop_name_as_parsed)

ScripterExport Value *	_set_property (Value prop, Value val, Value *prop_name_as_parsed)

virtual ScripterExport Value *	get_case_sensitive_property (Value *arg_list, int count, const TCHAR case_sensitive_name)

virtual ScripterExport Value *	set_case_sensitive_property (Value *arg_list, int count, const TCHAR case_sensitive_name)

ScripterExport Value *	invoke_getter_case_sensitive_property (Value target, getter_vf getter, Value arg_list, int count, const TCHAR case_sensitive_name, const TCHAR *nested_prop_case_sensitive_name)

ScripterExport Value *	invoke_setter_case_sensitive_property (Value target, setter_vf setter, Value arg_list, int count, const TCHAR case_sensitive_name, const TCHAR *nested_prop_case_sensitive_name)

Public Member Functions inherited from Collectable
ScripterExport	Collectable ()

virtual ScripterExport	~Collectable ()

ScripterExport void *	operator new (size_t sz, char flag)

ScripterExport void *	operator new (size_t sz)

ScripterExport void	operator delete (void *val)

ScripterExport void	operator delete (void *val, char flag)

ScripterExport bool	derives_from_Animatable ()

virtual BOOL	derives_from_MAXWrapper ()

ScripterExport void	make_collectable ()

void	make_permanent ()

void	make_static ()

int	is_marked ()

int	is_not_marked ()

int	is_garbage ()

int	is_permanent ()

void	mark_in_use ()

void	unmark_in_use ()

int	has_heap_copy ()

int	is_in_heap ()

int	is_on_stack ()

Public Member Functions inherited from CustAttrib
	CustAttrib ()

virtual const MCHAR *	GetName () MAX_SEALED

virtual bool	CheckCopyAttribTo (ICustAttribContainer *to)

virtual SvGraphNodeReference	SvTraverseAnimGraph (IGraphObjectManager gom, Animatable owner, int id, DWORD flags)

Public Member Functions inherited from ReferenceTarget
virtual BOOL	IsRefTarget ()
	Checks if this is a ReferenceTarget. More...

CoreExport RefResult	TestForLoop (const Interval &refInterval, RefMakerHandle hmaker)
	Tests for a cyclical reference. More...

CoreExport BOOL	HasDependents ()
	Checks if a ReferenceTarget has references. More...

CoreExport BOOL	HasRealDependents ()
	Checks if this has Real (Strong) Dependents. More...

void	BeginDependencyTest ()
	Starts Dependency Test. More...

BOOL	EndDependencyTest ()
	Ends Dependency Test. More...

virtual void	RefAdded (RefMakerHandle rm)
	Called after a reference is made to a target. More...

virtual void	RefAddedUndoRedo (RefMakerHandle rm)
	Called after a reference is made to a target because of undo or redo. More...

virtual void	RefDeletedUndoRedo ()
	Called after a references to this is deleted because of undo or redo. More...

CoreExport RefResult	DeleteAllRefsToMe ()
	Deletes all references to this ReferenceTarget. More...

CoreExport RefResult	TransferReferences (RefTargetHandle oldTarget, BOOL delOld=FALSE)
	Transfers all the references from oldTarget to this. More...

CoreExport int	DoEnumDependents (DependentEnumProc *dep)
	Begins an enumeration that searches back in the dependency network. More...

virtual CoreExport void	BaseClone (ReferenceTarget from, ReferenceTarget to, RemapDir &remap)
	This method copies base class data from an object to its clone. More...

virtual CoreExport RefResult	NotifyDependents (const Interval &changeInt, PartID partID, RefMessage message, SClass_ID sclass=NOTIFY_ALL, BOOL propagate=TRUE, RefTargetHandle hTarg=NULL, NotifyDependentsOption notifyDependentsOption=REFNOTIFY_ALLOW_OPTIMIZATIONS)
	Notify all dependent RefMakers concerned with the message. More...

void	FlagDependents (TimeValue t, PartID which=PART_PUT_IN_FG)
	This sends the REFMSG_FLAGDEPENDENTS message up the pipeline. More...

virtual void	NotifyForeground (TimeValue t)
	This method is called to flag dependents into the FG. More...

virtual void	NotifyTarget (int message, ReferenceMaker *hMaker)
	Sends messages to ReferenceTargets. More...

CoreExport	ReferenceTarget ()
	Constructor. More...

virtual CoreExport RefResult	AutoDelete ()
	Deletes the object when it has no more real dependents. More...

CoreExport RefResult	MaybeAutoDelete ()
	Deletes the object when it has no more real dependents. More...

Public Member Functions inherited from ReferenceMaker
CoreExport RefResult	ReplaceReference (int which, RefTargetHandle newtarg, BOOL delOld=TRUE)
	Used when cloning reference makers. More...

CoreExport RefResult	DeleteAllRefsFromMe ()
	Deletes all references from this ReferenceMaker. More...

CoreExport RefResult	DeleteAllRefs ()
	Deletes all references both to and from this item. More...

CoreExport RefResult	DeleteReference (int i)
	Deletes the specified reference. More...

virtual BOOL	CanTransferReference (int i)
	Tells whether this reference can be transfered. More...

CoreExport ReferenceSaveManager &	GetReferenceSaveManager ()
	Access the ReferenceSaveManager of this ReferenceMaker. More...

virtual int	RemapRefOnLoad (int iref)
	Used to load old files with references. More...

virtual CoreExport void	RescaleWorldUnits (float f)
	Rescale size of all world units in reference hierarchy. More...

virtual CoreExport void	EnumAuxFiles (AssetEnumCallback &assetEnum, DWORD flags)
	Enumerate auxiliary files (e.g. bitmaps) More...

virtual CoreExport void	SaveEnum (SaveEnumProc &sep, BOOL isNodeCall=0)
	The default save enumeration. More...

virtual CoreExport bool	SpecifySaveReferences (ReferenceSaveManager &referenceSaveManager)
	Used to specify reference slot remapping during scene file save. More...

CoreExport int	DoEnumDependents (DependentEnumProc *dep)
	Begins an enumeration that searches back in the dependency network. More...

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

CoreExport int	FindRef (RefTargetHandle rtarg)
	Get the index of the ReferenceTarget. More...

virtual BOOL	IsRefMaker ()
	Tells whether it is a ReferenceMaker. More...

virtual BOOL	IsRealDependency (ReferenceTarget *rtarg)
	Returns whether this is a "real" (strong) dependency or not. More...

virtual BOOL	ShouldPersistWeakRef (RefTargetHandle rtarg)
	Specifies whether a weak reference is to be persisted on a partial load or save. More...

CoreExport	ReferenceMaker ()
	Constructor. More...

CoreExport void	DeleteMe ()
	Deletes an instance of this class. More...

Public Member Functions inherited from Animatable
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 More...

virtual BOOL	SetKeyBufferPresent ()
	returns true if there is a "Set Key" buffer present More...

virtual CoreExport void	SubAnimCommitSetKeyBuffer (TimeValue t, int subNum)
	Commit any "Set Key" buffers on the given sub-anim. More...

virtual void	CommitSetKeyBuffer (TimeValue t)
	Commit any "Set Key" buffers. More...

virtual CoreExport void	SubAnimRevertSetKeyBuffer (int subNum)
	Revert any "Set Key" buffers on the given sub-anim. More...

virtual void	RevertSetKeyBuffer ()
	Revert any "Set Key" buffers. More...

virtual LRESULT CALLBACK	TrackViewWinProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
	This function is obsolete. More...

virtual bool	IsParamBlockDesc2Used (ParamBlockDesc2 *desc)
	Returns true if the passed description is being used. More...

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

CoreExport	Animatable ()
	Constructor. More...

virtual void	GetClassName (MSTR &s) MAX_SEALED

MSTR	ClassName (bool localized=true) const
	Returns the name of the plugin class. More...

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

CoreExport AnimProperty *	FindProperty (DWORD id)
	Find any property. More...

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

CoreExport AppDataChunk *	GetAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
	Retrieves the application/plugin specific (custom) data stored with an Animatable. More...

CoreExport BOOL	RemoveAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
	Deletes the application/plugin specific (custom) data stored with an Animatable. More...

CoreExport void	ClearAllAppData ()
	Deletes all application/plugin specific (custom) data stored with an Animatable. More...

virtual MSTR	SubAnimName (int i) MAX_SEALED

virtual BOOL	CanDeleteSubAnim (int i)

virtual void	DeleteSubAnim (int i)

virtual DWORD	GetSubAnimCurveColor (int subNum)

virtual int	SubNumToRefNum (int subNum)

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

virtual ParamDimension *	GetParamDimension (int i)

virtual BOOL	SelectSubAnim (int subNum)

virtual BOOL	BypassTreeView ()

virtual BOOL	BypassTrackBar ()

virtual BOOL	BypassPropertyLevel ()

virtual BOOL	InvisibleProperty ()

virtual int	NumKeys ()

virtual TimeValue	GetKeyTime (int index)

virtual int	GetKeyIndex (TimeValue t)

virtual BOOL	GetNextKeyTime (TimeValue t, DWORD flags, TimeValue &nt)

virtual void	CopyKeysFromTime (TimeValue src, TimeValue dst, DWORD flags)

virtual void	DeleteKeyAtTime (TimeValue t)

virtual BOOL	IsKeyAtTime (TimeValue t, DWORD flags)

virtual int	GetKeyTimes (Tab< TimeValue > &times, Interval range, DWORD flags)

virtual int	GetKeySelState (BitArray &sel, Interval range, DWORD flags)

CoreExport void	OpenTreeEntry (int type, DWORD tv)

CoreExport void	CloseTreeEntry (int type, DWORD tv)

CoreExport int	IsTreeEntryOpen (int type, DWORD tv)

CoreExport BOOL	GetSelInTrackView (DWORD tv)

CoreExport void	SetSelInTrackView (DWORD tv, BOOL sel)

CoreExport BOOL	InTrackViewSelSet (int which)

CoreExport void	SetTrackViewSelSet (int which, BOOL inOut)

virtual BOOL	AssignController (Animatable *control, int subAnim)

virtual BOOL	CanAssignController (int subAnim)
	Return true if we can reassign the subanim specified. More...

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

virtual BOOL	IsSubCurveSelected (int subNum)
	Returns the selected state of the sub-curve whose index is passed. More...

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

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

virtual CoreExport void	MouseCycleCompleted (TimeValue t)

virtual CoreExport void	MouseCycleStarted (TimeValue t)

CoreExport bool	SvSaveData (ISave *isave, USHORT id)

CoreExport bool	SvLoadData (ILoad *iLoad)

CoreExport DWORD	SvGetRefIndex ()

CoreExport void	SvSetRefIndex (DWORD i)

CoreExport bool	SvDeleteRefIndex ()

CoreExport SvGraphNodeReference	SvStdTraverseAnimGraph (IGraphObjectManager gom, Animatable owner, int id, DWORD flags)

virtual CoreExport bool	SvCanInitiateLink (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport bool	SvCanConcludeLink (IGraphObjectManager gom, IGraphNode gNode, IGraphNode *gNodeChild)

virtual CoreExport MSTR	SvGetName (IGraphObjectManager gom, IGraphNode gNode, bool isBeingEdited)

virtual CoreExport bool	SvCanSetName (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport bool	SvSetName (IGraphObjectManager gom, IGraphNode gNode, const MSTR &name)

virtual CoreExport bool	SvCanRemoveThis (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport bool	SvRemoveThis (IGraphObjectManager gom, IGraphNode gNode)
	Called when the user deletes this object in the schematic view... More...

virtual CoreExport bool	SvIsSelected (IGraphObjectManager gom, IGraphNode gNode)
	Returns true if the object is selected in its schematic view. More...

virtual CoreExport bool	SvIsHighlighted (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport COLORREF	SvHighlightColor (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport COLORREF	SvGetSwatchColor (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport bool	SvIsInactive (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport bool	SvLinkChild (IGraphObjectManager gom, IGraphNode gNodeThis, IGraphNode *gNodeChild)

virtual CoreExport bool	SvHandleDoubleClick (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport MultiSelectCallback *	SvGetMultiSelectCallback (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport bool	SvCanSelect (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"... More...

virtual CoreExport bool	SvCanDetachRel (IGraphObjectManager gom, IGraphNode gNodeTarget, int id, IGraphNode *gNodeMaker)
	Returns true if this object can respond to the SvDetachRel(...) method... More...

virtual CoreExport bool	SvDetachRel (IGraphObjectManager gom, IGraphNode gNodeTarget, int id, IGraphNode *gNodeMaker)
	Detach this relationship. More...

virtual CoreExport bool	SvHandleRelDoubleClick (IGraphObjectManager gom, IGraphNode gNodeTarget, int id, IGraphNode *gNodeMaker)
	Called when this relationship is double-clicked in the schematic view... More...

CoreExport ICustAttribContainer *	GetCustAttribContainer ()
	This method returns a pointer to the custom attributes container interface class. More...

CoreExport void	AllocCustAttribContainer ()
	This method allocates space for a custom attributes container. More...

CoreExport void	DeleteCustAttribContainer ()
	This method deletes space used by a custom attributes container. More...

void	SetAFlag (DWORD mask)

void	ClearAFlag (DWORD mask)
	Clears one or more bits in the Animatable flags. More...

bool	TestAFlag (DWORD mask) const
	Tests one or more bits in the Animatable flags. More...

void	SetAFlagEx (DWORD mask)
	Sets one or more bits in the Animatable extended flags. More...

void	ClearAFlagEx (DWORD mask)
	Clears one or more bits in the Animatable extended flags. More...

bool	TestAFlagEx (DWORD mask) const
	Tests one or more bits in the Animatable extended flags. More...

CoreExport bool	TestFlagBit (int index)
	Tests the specified flag bit. More...

CoreExport void	SetFlagBit (int index, bool newValue=true)
	Sets the specified flag bit. More...

CoreExport void	ClearFlagBit (int index)
	Clears the specified flag bit. More...

Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Public Member Functions inherited from ISubMap
virtual	~ISubMap ()

virtual int	SubTexmapOn (int i)

virtual MSTR	GetSubTexmapSlotName (int i) MAX_SEALED

CoreExport MSTR	GetSubTexmapTVName (int i, bool localized=true)

virtual BOOL	SetDlgThing (ParamDlg *dlg)

CoreExport void	CopySubTexmap (HWND hwnd, int ifrom, int ito)

Public Attributes
IObjParam *	cip

IMtlParams *	mip

MSTR	name

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

Static Public Attributes
static MAX_DEPRECATED MSAutoMParamDlg *	masterMDlg

static MSAutoMParamDlg *	mainMDlg

Static Public Attributes inherited from Collectable
static CRITICAL_SECTION	heap_update

static Collectable *	collectable_list

static Collectable *	permanent_list

static free_mem *	free_list [GC_NUM_SUBLISTS]

static size_t	heap_allocated

static size_t	heap_size

static ScripterExport collectable_state	state

static ScripterExport bool	fullCollectNextHoldFlush

static bool	gc_light

static bool	in_gc

static HANDLE	hGCCompletedEvent

Static Public Attributes inherited from Animatable
static const AnimHandle	kInvalidAnimHandle = 0

Protected Member Functions
virtual void	SetReference (int i, RefTargetHandle rtarg)
	Stores a ReferenceTarget as its 'i-th' reference`. More...

Protected Member Functions inherited from ReferenceTarget
virtual CoreExport int	DoEnumDependentsImpl (DependentEnumProc *dep)
	Method to perform an enumeration on a ReferenceTarget. More...

virtual CoreExport	~ReferenceTarget ()=0
	Destructor. More...

Protected Member Functions inherited from ReferenceMaker
virtual CoreExport	~ReferenceMaker ()=0
	Destructor. More...

void	BlockEval ()
	Validates a given reference link between this reference maker and its reference target. More...

void	UnblockEval ()
	Validates a given reference link between this reference maker and its reference target. More...

int	Evaluating ()
	Validates a given reference link between this reference maker and its reference target. More...

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

Protected Member Functions inherited from Animatable
virtual CoreExport	~Animatable ()=0
	Destructor. More...

Protected Member Functions inherited from Noncopyable
	Noncopyable ()

	~Noncopyable ()

Additional Inherited Members
Static Public Member Functions inherited from Collectable
static ScripterExport void	for_all_values (void(map_fn)(Value val), ValueMapper mapper=NULL, ValueMetaClass c=NULL)

static void	mark ()

static void	sweep ()

static void	setup (size_t)

static ScripterExport void	gc ()

static void	coalesce_free_list ()

static void	close_down ()

static void	drop_maxwrapper_refs ()

static ScripterExport void	push_alloc_stack_frame ()

static ScripterExport void	pop_alloc_stack_frame ()

static ScripterExport ULONGLONG	get_num_values_created ()

static ScripterExport bool	validate_value_linkages ()

Static Public Member Functions inherited from Animatable
static CoreExport BOOL	IsDeleted (Animatable *anim)
	Debug method to determine whether an object has been deleted. More...

static CoreExport AnimHandle	GetHandleByAnim (Animatable *anim)
	Get the unique handle for an Animatable object. More...

static CoreExport Animatable *	GetAnimByHandle (AnimHandle handle)
	Get an Animatable object from its unique handle. More...

static CoreExport AnimHandle	GetNextHandle ()
	Get the unique handle for the next Animatable object to be created. More...

static CoreExport void	EnumerateAllAnimatables (EnumAnimList &enumProcObject)
	Enumerator to enumerate across all animatables. More...

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

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

static CoreExport bool	RegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
	Registers a callback proc that is called when an AppDataChunk is read from a scene file. More...

static CoreExport bool	UnRegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
	Unregisters a callback proc that is called when an AppDataChunk is read from a scene file. More...

static CoreExport int	RequestFlagBit ()
	Requests an unique flag bit index. More...

static CoreExport void	ReleaseFlagBit (int index)
	Releases the flag bit index. More...

static CoreExport void	ClearFlagBitInAllAnimatables (int index)
	Clears the specified flag bit in all Animatables. More...

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

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

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

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

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

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

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

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

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

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

static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...

static UtilExport void	operator delete (void ptr, void placement_ptr)
	Placement delete operator. More...

static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...

static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...

static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Protected Attributes inherited from Animatable
DWORD	aflag

AnimPropertyList	aprops

Static Protected Attributes inherited from Value
static ScripterExport Value *	keyarg_marker_value

Constructor & Destructor Documentation

◆ MSCustAttrib() [1/2]

ScripterExport MSCustAttrib ( )

inline

114 : cip(NULL), mip(NULL) { }

NULL

#define NULL

Definition: autoptr.h:18

MSCustAttrib::mip

IMtlParams * mip

Definition: mxsCustomAttributes.h:111

MSCustAttrib::cip

IObjParam * cip

Definition: mxsCustomAttributes.h:107

◆ MSCustAttrib() [2/2]

ScripterExport MSCustAttrib	(	MSCustAttribDef *	pc,
		BOOL	loading
	)

◆ ~MSCustAttrib()

ScripterExport ~MSCustAttrib ( )

inline

116 { DeleteAllRefsFromMe(); }

ReferenceMaker::DeleteAllRefsFromMe

CoreExport RefResult DeleteAllRefsFromMe()

Deletes all references from this ReferenceMaker.

Member Function Documentation

◆ sprin1()

ScripterExport void sprin1 ( CharStream * s )

virtual

Reimplemented from Value.

◆ AddRollupPage()

ScripterExport HWND AddRollupPage	(	HINSTANCE	hInst,
		const MCHAR *	dlgTemplate,
		DLGPROC	dlgProc,
		const MCHAR *	title,
		LPARAM	param = `0`,
		DWORD	flags = `0`,
		int	category = `ROLLUP_CAT_CUSTATTRIB - 1`
	)

virtual

Implements MSPlugin.

◆ DeleteRollupPage()

ScripterExport void DeleteRollupPage ( HWND hRollup )

virtual

Implements MSPlugin.

◆ GetRollupWindow()

ScripterExport IRollupWindow* GetRollupWindow ( )

virtual

Implements MSPlugin.

◆ RollupMouseMessage()

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

virtual

Implements MSPlugin.

◆ get_delegate()

ReferenceTarget* get_delegate ( )

inlinevirtual

Implements MSPlugin.

131 { return NULL; } // no delegates in MSCustAttribs

◆ GetName()

const MCHAR* GetName ( bool localized )

inlineoverridevirtual

Remarks: A CustAttrib plugin can implement this method in order to provide the name that gets displayed in the TrackView and the name that is used internally.

Parameters:: bool localized

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

Default Implementation:: { return "Custom Attribute";}

Reimplemented from CustAttrib.

134 { return name; }

MSCustAttrib::name

MSTR name

Definition: mxsCustomAttributes.h:112

◆ CreateParamDlg()

ScripterExport ParamDlg* CreateParamDlg	(	HWND	hwMtlEdit,
		IMtlParams *	imp
	)

virtual

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

Parameters:: HWND hwMtlEdit

The window handle of the materials editor.

IMtlParams *imp

The interface pointer for calling methods in 3ds Max.

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

Default Implementation:: {return NULL;}

Reimplemented from CustAttrib.

◆ SetName()

void SetName ( const MCHAR * newName )

inline

137 { name = newName ; }

◆ GetInterface() [1/2]

BaseInterface* GetInterface ( Interface_ID id )

virtual

Reimplemented from Value.

◆ GetClassName()

void GetClassName	(	MSTR &	s,
		bool	localized = `true`
	)		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 ReferenceTarget.

146 { s = localized ? pc->class_name->to_string() : pc->nonLocalized_class_name->to_string(); }

MSPluginClass::class_name

Value * class_name

Definition: mxsPlugin.h:136

MSPluginClass::nonLocalized_class_name

Value * nonLocalized_class_name

Definition: mxsPlugin.h:137

MSPlugin::pc

MSPluginClass * pc

Definition: mxsPlugin.h:352

Value::to_string

virtual const MCHAR * to_string()

Definition: value.h:178

◆ ClassID()

Class_ID ClassID ( )

inlinevirtual

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

147 { return pc->class_id; }

MAXClass::class_id

Class_ID class_id

Definition: mxsobjects.h:541

◆ SuperClassID()

SClass_ID SuperClassID ( )

inlinevirtual

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

148 { return pc->sclass_id; }

MAXClass::sclass_id

SClass_ID sclass_id

Definition: mxsobjects.h:542

◆ FreeCaches()

void FreeCaches ( )

inlinevirtual

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

149 { }

◆ NumSubs()

int NumSubs ( )

inlinevirtual

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

150 { return pblocks.Count(); }

MSPlugin::pblocks

Tab< IParamBlock2 * > pblocks

Definition: mxsPlugin.h:357

Tab::Count

int Count() const

Retrieves the number of items in the Tab.

Definition: tab.h:219

◆ SubAnim()

Animatable* SubAnim ( int i )

inlinevirtual

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

151 { return pblocks[i]; }

◆ 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 Animatable.

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

◆ NumParamBlocks()

int NumParamBlocks ( )

inlinevirtual

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

163 { return pblocks.Count(); }

◆ GetParamBlock()

IParamBlock2* GetParamBlock ( int i )

inlinevirtual

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

Parameters

i	The zero based index of the ParamBlock2 to return.

Default Implementation:: { return NULL; }

Reimplemented from Animatable.

164 { return pblocks[i]; }

◆ GetParamBlockByID()

IParamBlock2* GetParamBlockByID ( BlockID id )

inlinevirtual

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

165 { return MSPlugin::GetParamBlockByID(id); }

MSPlugin::GetParamBlockByID

ScripterExport IParamBlock2 * GetParamBlockByID(BlockID id)

◆ CanCopyAnim()

BOOL CanCopyAnim ( )

inlinevirtual

Remarks: In addition to SubNumToRefNum(), if an anim doesn't want to be copied (via Track View or the Edit Modifier Stack 'Copy' button) it can return FALSE from this method, otherwise it can use the default implementation to return TRUE.

Default Implementation:: {return TRUE;}

Reimplemented from Animatable.

166 { return FALSE; }

◆ GetInterface() [2/2]

ScripterExport void* GetInterface ( ULONG id )

virtual

Inherited from Animatable.

Returns a pointer to the interface.

Parameters

id	- The id of the interface.

Returns: A Pointer to the Interface

Reimplemented from ReferenceTarget.

◆ DeleteThis()

ScripterExport void DeleteThis ( )

virtual

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

◆ BeginEditParams()

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

virtual

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

◆ EndEditParams()

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

virtual

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

◆ NotifyRefChanged()

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

inlinevirtual

Receives and responds to messages.

A plugin which makes references must implement a method to receive and respond to messages broadcast by its dependents. This is done by implementing NotifyRefChanged(). The plugin developer usually implements this method as a switch statement where each case is one of the messages the plugin needs to respond to. The Method StdNotifyRefChanged calls this, which can change the partID to new value. If it doesn't depend on the particular message& partID, it should return REF_DONTCARE.

For developer that need to update a dialog box with data about an object you reference note the following related to this method: This method may be called many times. For instance, say you have a dialog box that displays data about an object you reference. This method will get called many time during the drag operations on that object. If you updated the display every time you'd wind up with a lot of 'flicker' in the dialog box. Rather than updating the dialog box each time, you should just invalidate the window in response to the NotifyRefChanged() call. Then, as the user drags the mouse your window will still receive paint messages. If the scene is complex the user may have to pause (but not let up on the mouse) to allow the paint message to go through since they have a low priority. This is the way many windows in 3ds Max work.

Parameters

changeInt	- This is the interval of time over which the message is active. Currently, all plug-ins will receive FOREVER for this interval, with the exception of REFMSG_FLAGDEPENDENTS notifications. In that case, changeInt.Start() is the timepoint to perform the dependency test.
hTarget	- This is the handle of the reference target the message was sent by. The reference maker uses this handle to know specifically which reference target sent the message.
partID	- This contains information specific to the message passed in. Some messages don't use the partID at all. See the section List of Reference Messages for more information about the meaning of the partID for some common messages.
message	- The message parameters passed into this method is the specific message which needs to be handled.
propagate	- If called through ReferenceMaker::NotifyDependents(), the value of 'propagate' passed to it. Used if calling NotifyDependents() from within NotifyRefChanged().

Returns: The return value from this method is of type RefResult. This is usually REF_SUCCEED indicating the message was processed. Sometimes, the return value may be REF_STOP. This return value is used to stop the message from being propagated to the dependents of the item.

Implements ReferenceMaker.

                     { 
                         if (!(pc->mpc_flags & MPC_REDEFINITION))
                             return ((MSPlugin*)this)->NotifyRefChanged(changeInt, hTarget, partID, message, propagate); 
                         else
                             return REF_SUCCEED;
                     }

◆ NumRefs()

int NumRefs ( )

inlinevirtual

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

183 { return pblocks.Count(); }

◆ GetReference()

RefTargetHandle GetReference ( int i )

inlinevirtual

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

184 { return pblocks[i]; }

◆ SetReference()

virtual void SetReference	(	int	i,
		RefTargetHandle	rtarg
	)

inlineprotectedvirtual

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

                     { 
                         if (i >= pblocks.Count())
                             pblocks.SetCount(i+1); 
                         pblocks[i] = (IParamBlock2*)rtarg; 
                     }

◆ RefDeleted()

void RefDeleted ( )

inlinevirtual

Called after a references to this is deleted.

This is called after deleting a reference to a reference target, in the case that the target was not deleted. When the last strong reference to a ReferenceTarget is removed, the ReferenceTarget is deleted, the destructor is called, and the memory cleared.

Reimplemented from ReferenceTarget.

193 { MSPlugin::RefDeleted(); }

MSPlugin::RefDeleted

ScripterExport void RefDeleted()

◆ Clone()

RefTargetHandle Clone ( RemapDir & remap )

virtual

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)));

}

};

MSCustAttrib::Clone
RefTargetHandle Clone(RemapDir &remap)
This method is used by 3ds Max to clone an object.

ReferenceMaker::GetReference
virtual CoreExport RefTargetHandle GetReference(int i)
Returns the 'i-th' reference.

ReferenceMaker::ReplaceReference
CoreExport RefResult ReplaceReference(int which, RefTargetHandle newtarg, BOOL delOld=TRUE)
Used when cloning reference makers.

ReferenceTarget
A scene entity that is being owned and listened to by other scene entities.
Definition: ref.h:1844

ReferenceTarget::BaseClone
virtual CoreExport void BaseClone(ReferenceTarget *from, ReferenceTarget *to, RemapDir &remap)
This method copies base class data from an object to its clone.

RemapDir
For remapping references during a Clone.
Definition: ref.h:830

RemapDir::CloneRef
virtual RefTargetHandle CloneRef(RefTargetHandle oldTarg)
Creates a clone of a reference target only if it hasn't been cloned already.

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

◆ Save()

ScripterExport IOResult Save ( ISave * isave )

virtual

Reimplemented from Value.

◆ Load()

ScripterExport IOResult Load ( ILoad * iload )

virtual

Called for loading data.

Called by the system to allow the plug-in to load its data. See the section on Loading and Saving Plug-in Data for an overview of the load - save process.

Parameters

iload - This interface pointer may be used to call methods to read data from disk.

Returns

The default implementation is return IO_OK.

IO_OK means the result was acceptable, with no errors.
IO_ERROR This should be returned if an error occurred.

Reimplemented from ReferenceMaker.

◆ NumSubTexmaps()

ScripterExport int NumSubTexmaps ( )

virtual

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

Default Implementation:: { return 0; }

Reimplemented from ISubMap.

◆ GetSubTexmap()

ScripterExport Texmap* GetSubTexmap ( int i )

virtual

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

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

Parameters:: int i

Specifies the texmap to return.

Default Implementation:: { return NULL; }

Reimplemented from ISubMap.

◆ SetSubTexmap()

ScripterExport void SetSubTexmap	(	int	i,
		Texmap *	m
	)

virtual

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

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

Parameters:: int i

The index of the storage for the texmap.

Texmap *m

The texmap to store.

Default Implementation:: {}

Reimplemented from ISubMap.

◆ GetSubTexmapSlotName()

ScripterExport MSTR GetSubTexmapSlotName	(	int	i,
		bool	localized = `true`
	)

overridevirtual

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

Parameters:: int i

Specifies the slot whose name is returned. bool localized

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

Default Implementation:: The default implementation returns an empty ("") string.

Reimplemented from ISubMap.

◆ MapSlotType()

int MapSlotType ( int i )

inlinevirtual

Remarks: In the Coordinates rollup in the user interface for a texture map are two options. These options are Texture or Environment. The slot type is one of these two options, texture coordinates or environment coordinates. There are a variety of texture coordinate types. There are the type assigned to the object and the environment type (Spherical, Cylindrical, Shrink-wrap, Screen). This method is used to determine the type required by the particular sub-texture. This is either texture coordinates (MAPSLOT_TEXTURE) or environment coordinates (MAPSLOT_ENVIRON).

Parameters:: int i

The index of the sub-texture whose slot type to return.

Returns: See Map Slot Types.

Default Implementation:: { return MAPSLOT_TEXTURE; }

Implements ISubMap.

204 { UNUSED_PARAM(i); return MAPSLOT_TEXTURE; }

UNUSED_PARAM

#define UNUSED_PARAM(x)

Definition: BuildWarnings.h:18

MAPSLOT_TEXTURE

#define MAPSLOT_TEXTURE

A slot that holds a texture map.

Definition: ISubMap.h:26

◆ GetSubTexmapTVName()

MSTR GetSubTexmapTVName	(	int	i,
		bool	localized = `true`
	)

inline

205 { return GetSubTexmapSlotName(i, localized); }

MSCustAttrib::GetSubTexmapSlotName

ScripterExport MSTR GetSubTexmapSlotName(int i, bool localized=true) override

◆ GetRefTarget()

ReferenceTarget* GetRefTarget ( )

inlinevirtual

Remarks: Implemented by the System.

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

Implements ISubMap.

206 { return this; }

Member Data Documentation

◆ cip

IObjParam* cip

◆ masterMDlg

MAX_DEPRECATED MSAutoMParamDlg* masterMDlg

static

Deprecated:: This has been deprecated as of 3ds Max 2022, please use mainMDlg instead [insensitive language]

◆ mainMDlg

MSAutoMParamDlg* mainMDlg

static

◆ mip

IMtlParams* mip

◆ name

MSTR name

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ MSCustAttrib() [1/2]

◆ MSCustAttrib() [2/2]

◆ ~MSCustAttrib()

Member Function Documentation

◆ sprin1()

◆ AddRollupPage()

◆ DeleteRollupPage()

◆ GetRollupWindow()

◆ RollupMouseMessage()

◆ get_delegate()

◆ GetName()

◆ CreateParamDlg()

◆ SetName()

◆ GetInterface() [1/2]

◆ GetClassName()

◆ ClassID()

◆ SuperClassID()

◆ FreeCaches()

◆ NumSubs()

◆ SubAnim()

◆ SubAnimName()

◆ NumParamBlocks()

◆ GetParamBlock()

◆ GetParamBlockByID()

◆ CanCopyAnim()

◆ GetInterface() [2/2]

◆ DeleteThis()

◆ BeginEditParams()

◆ EndEditParams()

◆ NotifyRefChanged()

◆ NumRefs()

◆ GetReference()

◆ SetReference()

◆ RefDeleted()

◆ Clone()

◆ Save()

◆ Load()

◆ NumSubTexmaps()

◆ GetSubTexmap()

◆ SetSubTexmap()

◆ GetSubTexmapSlotName()

◆ MapSlotType()

◆ GetSubTexmapTVName()

◆ GetRefTarget()

Member Data Documentation

◆ cip

◆ masterMDlg

◆ mainMDlg

◆ mip

◆ name