This is the class from which you may derive Object Space and Space Warp (World Space) Modifier plug-ins. More...

#include <object.h>

Inheritance diagram for Modifier:

Public Member Functions
CoreExport	Modifier ()

CoreExport	~Modifier ()

virtual MSTR	GetName () MAX_SEALED

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

virtual void	ForceNotify (Interval &i)
	Notifies dependents of a change. More...

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

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

CoreExport bool	SvCanSetName (IGraphObjectManager gom, IGraphNode gNode)

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

CoreExport bool	SvHandleDoubleClick (IGraphObjectManager gom, IGraphNode gNode)

CoreExport COLORREF	SvHighlightColor (IGraphObjectManager gom, IGraphNode gNode)

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

CoreExport MultiSelectCallback *	SvGetMultiSelectCallback (IGraphObjectManager gom, IGraphNode gNode)

CoreExport bool	SvCanSelect (IGraphObjectManager gom, IGraphNode gNode)

CoreExport bool	SvCanInitiateLink (IGraphObjectManager gom, IGraphNode gNode)

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

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

CoreExport bool	SvCanRemoveThis (IGraphObjectManager gom, IGraphNode gNode)

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

Modifier Name Access
virtual CoreExport MSTR	GetName (bool localized) const
	Implemented by the System. More...

virtual CoreExport void	SetName (MSTR n)
	Implemented by the System. More...

Modifier Stack Access
void	DisableModApps ()
	This method is used internally. More...

void	EnableModApps ()
	This method is used internally. More...

void	DisableMod ()
	Implemented by the System. More...

void	EnableMod ()
	Implemented by the System. More...

int	IsEnabled ()
	Implemented by the System. More...

void	DisableModInViews ()
	Implemented by the System. More...

void	EnableModInViews ()
	Implemented by the System. More...

int	IsEnabledInViews ()
	Implemented by the System. More...

void	DisableModInRender ()
	Implemented by the System. More...

void	EnableModInRender ()
	Implemented by the System. More...

int	IsEnabledInRender ()
	Implemented by the System. More...

Validity Intervals

virtual CoreExport Interval	LocalValidity (TimeValue t)
	This method returns the validity interval of a modifier. More...

InputType, ChannelsUsed, and ChannelsChanged
virtual ChannelMask	ChannelsUsed ()=0
	These are channels that the modifier needs in order to perform its modification. More...

virtual ChannelMask	ChannelsChanged ()=0
	These are the channels that the modifier actually modifies. More...

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

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

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

virtual Class_ID	InputType ()=0
	This is the type of object that the modifier knows how to modify. More...

Notification of Input Changed
virtual void	NotifyInputChanged (const Interval &changeInt, PartID partID, RefMessage message, ModContext *mc)
	This method is called when an item in the modifier stack before this modifier sends a REFMSG_CHANGE message via NotifyDependents(). More...

Object Modification

virtual void	ModifyObject (TimeValue t, ModContext &mc, ObjectState os, INode node)=0
	This is the method that actually modifies the input object. More...

Topology Dependence
virtual BOOL	DependOnTopology (ModContext &mc)
	Modifiers that place a dependency on topology should return TRUE for this method. More...

Loading and Saving Methods
virtual IOResult	SaveLocalData (ISave isave, LocalModData ld)
	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. More...

virtual IOResult	LoadLocalData (ILoad iload, LocalModData *pld)
	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. More...

CoreExport IOResult	Save (ISave *isave)
	Implemented by the System. More...

CoreExport IOResult	Load (ILoad *iload)
	Implemented by the System. More...

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

ModContext Enumeration
CoreExport void	EnumModContexts (ModContextEnumProc *proc)
	Implemented by the System. More...

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

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

Self-node determination
CoreExport INode *	GetNodeFromModData (LocalModData *data, int &index)
	This function allows modifiers to find the nodes they are modifying. More...

CoreExport INode *	GetNodeFromModContext (ModContext *mc, int &index)
	This function allows modifiers to find the nodes they are modifying. More...

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)
	Inherited from Animatable. More...

virtual CoreExport BaseInterface *	GetInterface (Interface_ID id)
	Inherited from Animatable. More...

CoreExport	BaseObject ()

virtual CoreExport	~BaseObject ()

virtual BOOL	HasViewDependentBoundingBox ()
	This method return true if GetWorldBoundBox returns different boxes for different viewports. More...

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

virtual void	SetExtendedDisplay (int flags)
	This method is used for storing mode-dependent display attributes. More...

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

virtual void	Snap (TimeValue t, INode inode, SnapInfo snap, IPoint2 p, ViewExp vpt)
	Checks the point passed for a snap and updates the SnapInfo structure. More...

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

virtual void	GetLocalBoundBox (TimeValue t, INode inode, ViewExp vp, Box3 &box)
	This is the object space bounding box, the box in the object's local coordinates. More...

virtual CreateMouseCallBack *	GetCreateMouseCallBack ()=0
	This method allows the system to retrieve a callback object used in creating an object in the 3D viewports. More...

virtual const MCHAR *	GetObjectName () MAX_SEALED

virtual const MCHAR *	GetObjectName (bool localized) const

virtual CoreExport BOOL	OKToChangeTopology (MSTR &modName)
	Implemented by the System. More...

virtual BOOL	ChangeTopology ()
	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. More...

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

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

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

virtual void	Move (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Point3 &val, BOOL localOrigin=FALSE)
	When this method is called the plug-in should respond by moving its selected sub-object components. More...

virtual void	Rotate (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Quat &val, BOOL localOrigin=FALSE)
	When this method is called the plug-in should respond by rotating its selected sub-object components. More...

virtual void	Scale (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Point3 &val, BOOL localOrigin=FALSE)
	When this method is called the plug-in should respond by scaling its selected sub-object components. More...

virtual void	TransformStart (TimeValue t)
	This method is called before the first Move(), Rotate() or Scale() call and before a hold is in effect. More...

virtual void	TransformHoldingStart (TimeValue t)
	This method is called before the first Move(), Rotate() or Scale() call and after a hold is in effect. More...

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

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

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

virtual int	HitTest (TimeValue t, INode inode, int type, int crossing, int flags, IPoint2 p, ViewExp vpt, ModContext mc)
	This method is used in modifier gizmo hit testing. More...

virtual int	Display (TimeValue t, INode inode, ViewExp vpt, int flags, ModContext *mc)
	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. More...

virtual void	GetWorldBoundBox (TimeValue t, INode inode, ViewExp vpt, Box3 &box, ModContext *mc)
	This method computes the world space bounding box of the modifier gizmo (or any object that when in sub-object mode has a gizmo). More...

virtual void	CloneSelSubComponents (TimeValue t)
	This method is called to make a copy of the selected sub-object components of the item. More...

virtual void	AcceptCloneSelSubComponents (TimeValue t)
	This method is called when the user mouses up after shift-cloning a sub-object selection. More...

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

virtual void	ClearSelection (int selLevel)
	This method is called to clear the selection for the given sub-object level. More...

virtual void	SelectAll (int selLevel)
	This method is called to select every element of the given sub-object level. More...

virtual void	InvertSelection (int selLevel)
	This method is called to invert the specified sub-object level. More...

virtual int	SubObjectIndex (HitRecord *hitRec)
	Returns the index of the sub-object element identified by the HitRecord hitRec. More...

virtual void	ActivateSubobjSel (int level, XFormModes &modes)
	When the user changes the selection of the sub-object drop down, this method is called to notify the plug-in. More...

virtual BOOL	SupportsNamedSubSels ()
	An object that supports sub-object selection can choose to support named sub object selection sets. More...

virtual void	ActivateSubSelSet (MSTR &setName)
	When the user chooses a name from the drop down list this method is called. More...

virtual void	NewSetFromCurSel (MSTR &setName)
	If the user types a new name into the named selection set drop down then this method is called. More...

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

virtual void	SetupNamedSelDropDown ()
	To support the Edit Named Selections dialog, plug-ins must implement this method. More...

virtual int	NumNamedSelSets ()
	To support the Edit Named Selections dialog, plug-ins must implement this method. More...

virtual MSTR	GetNamedSelSetName (int i)
	To support the Edit Named Selections dialog, plug-ins must implement this method. More...

virtual void	SetNamedSelSetName (int i, MSTR &newName)
	To support the Edit Named Selections dialog, plug-ins must implement this method. More...

virtual void	NewSetByOperator (MSTR &newName, Tab< int > &sets, int op)
	To support the Edit Named Selections dialog, plug-ins must implement this method. More...

virtual void	GetSubObjectCenters (SubObjAxisCallback cb, TimeValue t, INode node, ModContext *mc)
	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. More...

virtual void	GetSubObjectTMs (SubObjAxisCallback cb, TimeValue t, INode node, ModContext *mc)
	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. More...

virtual void	NotifyPreCollapse (INode node, IDerivedObject derObj, int index)
	This method is called before a modifier or object is collapsed. More...

virtual void	NotifyPostCollapse (INode node, Object obj, IDerivedObject *derObj, int index)
	This method is called after a modifier or object is collapsed. More...

virtual int	NumSubObjTypes ()
	Objects and modifiers that support subobjects have to overwrite this method - as well as GetSubObjType() - and return a class derived from ISubObjType in GetSubObjType(). More...

virtual ISubObjType *	GetSubObjType (int i)
	Returns a pointer to the sub-object type for the sub-object whose index is passed. More...

virtual CoreExport int	GetSubObjectLevel ()
	This method returns an integer which indicates the current sub-object level of the modifier or base object. More...

virtual BOOL	HasUVW ()
	Call this method to find out if the object has UVW coordinates. More...

virtual BOOL	HasUVW (int mapChannel)
	Call this method to find out if the object is has UVW coordinates for the specified mapping channel. More...

virtual void	SetGenUVW (BOOL sw)
	This method is called to change the state of its Generate UVW boolean. More...

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

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

Public Member Functions inherited from ReferenceTarget
virtual CoreExport void	GetClassName (MSTR &s, bool localized=true) const override
	Retrieves the name of the plugin class. More...

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	RefDeleted ()
	Called after a references to this is deleted. 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 RefTargetHandle	Clone (RemapDir &remap)
	This method is used by 3ds Max to clone an object. 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...

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

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

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 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 CoreExport void	DeleteThis ()
	Deletes an instance of this class. More...

virtual void	GetClassName (MSTR &s) MAX_SEALED

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

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

virtual void	BeginEditParams (IObjParam ip, ULONG flags, Animatable prev=NULL)

virtual void	EndEditParams (IObjParam ip, ULONG flags, Animatable next=NULL)

virtual CoreExport void	ReleaseInterface (ULONG id, void *i)

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 int	NumSubs ()

virtual Animatable *	SubAnim (int i)

virtual MSTR	SubAnimName (int i) MAX_SEALED

virtual CoreExport MSTR	SubAnimName (int i, bool localized)

virtual BOOL	CanDeleteSubAnim (int i)

virtual void	DeleteSubAnim (int i)

virtual DWORD	GetSubAnimCurveColor (int subNum)

virtual int	SubNumToRefNum (int subNum)

virtual BOOL	CanCopyAnim ()

CoreExport int	HasSubElements (int type=0)

virtual int	GetSubFCurveExtents (int subNum, ParamDimensionBase *dim, float &min, float &max, DWORD flags)
	The values max and min should be initialized before calling this function. 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)

virtual int	NumParamBlocks ()

virtual IParamBlock2 *	GetParamBlockByID (short id)

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"... 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 ()

Static Public Member Functions
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. More...

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

Friends
class	ModNameRestore

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

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 RefResult	NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate)=0
	Receives and responds to messages. More...

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

virtual CoreExport void	SetReference (int i, RefTargetHandle rtarg)
	Stores a ReferenceTarget as its 'i-th' reference`. 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 ()

Protected Attributes inherited from BaseObject
MaxSDK::Graphics::RenderItemHandleArray	mRenderItemHandles

Protected Attributes inherited from Animatable
DWORD	aflag

AnimPropertyList	aprops

Detailed Description

This is the class from which you may derive Object Space and Space Warp (World Space) Modifier plug-ins.

This class is subclassed off of BaseObject so the modifier can put up a graphical representation in the viewport to use as a gizmo.

See also: Class BaseObject, Class ObjectState, Class ModContext, Class ModContextEnumProc,; Class Interval, Class ISave, Class ILoad, Class Class_ID

Constructor & Destructor Documentation

◆ Modifier()

CoreExport Modifier ( )

◆ ~Modifier()

CoreExport ~Modifier ( )

Member Function Documentation

◆ GetName() [1/2]

virtual MSTR GetName ( )

inlinevirtual

Note: This method has been deprecated in terms of implementation as of 3ds Max 2022. Plugin developers should implement GetName(bool localized) const instead. This method can no longer be overriden and calls to it are now forwarded to the function that replaced it with a "bool localized" value of true. This is done so that plugin developers who do not localize their plugins don't have to update all the places where they call this method. Plugin developers who do localize their plugins should analyze the places where they call this method to decide what value to pass it for the "bool localized" parameter.

See also: Modifier::GetName(bool localized) const

     {
         return GetName(true);
     }

◆ GetName() [2/2]

virtual CoreExport MSTR GetName ( bool localized ) const

virtual

Implemented by the System.

Returns the name of the modifier.

Parameters

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.

◆ SetName()

virtual CoreExport void SetName ( MSTR n )

virtual

Implemented by the System.

Sets the name of the modifier to the name passed.

Parameters

n	Specifies the name to set.

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

Reimplemented in SimpleOSMToWSMMod2, SimpleOSMToWSMMod, WSModifier, and OSModifier.

5367 { return OSM_CLASS_ID; }

OSM_CLASS_ID

#define OSM_CLASS_ID

Object-space modifier (Modifier) super-class ID.

Definition: plugapi.h:406

◆ DisableModApps()

void DisableModApps ( )

inline

This method is used internally.

5374 { NotifyDependents(FOREVER,PART_OBJ,REFMSG_DISABLE); }

ReferenceTarget::NotifyDependents

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.

REFMSG_DISABLE

#define REFMSG_DISABLE

Used Internally.

Definition: ref.h:270

PART_OBJ

const PartID PART_OBJ

Combination of PART_TOPO and PART_GEOM.

Definition: ref.h:90

FOREVER

#define FOREVER

Definition: interval.h:168

◆ EnableModApps()

void EnableModApps ( )

inline

This method is used internally.

5376 { NotifyDependents(FOREVER,PART_OBJ,REFMSG_ENABLE); }

REFMSG_ENABLE

#define REFMSG_ENABLE

Used Internally.

Definition: ref.h:272

◆ DisableMod()

void DisableMod ( )

inline

Implemented by the System.

This disables the modifier in the history browser (modifier stack).

                       { 
         SetAFlag(A_MOD_DISABLED);
         NotifyDependents(FOREVER, (PART_ALL|PART_OBJECT_TYPE),REFMSG_CHANGE); 
     }

◆ EnableMod()

void EnableMod ( )

inline

Implemented by the System.

This enables the modifier in the history browser (modifier stack).

                      {      
         ClearAFlag(A_MOD_DISABLED);
         NotifyDependents(FOREVER, (PART_ALL|PART_OBJECT_TYPE), REFMSG_CHANGE); 
     }

◆ IsEnabled()

int IsEnabled ( )

inline

Implemented by the System.

This returns the status (enabled or disabled) of the modifier in the history browser.

Returns: Nonzero if enabled; otherwise 0.

5396 { return !TestAFlag(A_MOD_DISABLED); }

Animatable::TestAFlag

bool TestAFlag(DWORD mask) const

Tests one or more bits in the Animatable flags.

Definition: Animatable.h:312

◆ DisableModInViews()

void DisableModInViews ( )

inline

Implemented by the System.

Disables the modifier in the viewports (it remains active in the renderer unless DisableMod() above is used).

                              { 
         SetAFlag(A_MOD_DISABLED_INVIEWS);
         NotifyDependents(FOREVER, (PART_ALL|PART_OBJECT_TYPE), REFMSG_CHANGE); 
     }

◆ EnableModInViews()

void EnableModInViews ( )

inline

Implemented by the System.

Enables the modifier in the viewports.

                             {      
         ClearAFlag(A_MOD_DISABLED_INVIEWS);
         NotifyDependents(FOREVER,(PART_ALL|PART_OBJECT_TYPE), REFMSG_CHANGE); 
     }

◆ IsEnabledInViews()

int IsEnabledInViews ( )

inline

Implemented by the System.

Returns nonzero if the modifier is enabled in the view ports; otherwise zero.

5415 { return !TestAFlag(A_MOD_DISABLED_INVIEWS); }

◆ DisableModInRender()

void DisableModInRender ( )

inline

Implemented by the System.

This turns off the modifier in the renderer

                               { 
         SetAFlag(A_MOD_DISABLED_INRENDER);
         NotifyDependents(FOREVER,(PART_ALL|PART_OBJECT_TYPE), REFMSG_CHANGE); 
     }

◆ EnableModInRender()

void EnableModInRender ( )

inline

Implemented by the System.

This turns on the modifier in the renderer

                              {      
         ClearAFlag(A_MOD_DISABLED_INRENDER);
         NotifyDependents(FOREVER,(PART_ALL|PART_OBJECT_TYPE), REFMSG_CHANGE); 
     }

◆ IsEnabledInRender()

int IsEnabledInRender ( )

inline

Implemented by the System.

This returns the status (enabled or disabled) of the modifier in the renderer.

Returns: Nonzero if enabled; otherwise 0.

5437 { return !TestAFlag(A_MOD_DISABLED_INRENDER); }

◆ LocalValidity()

virtual CoreExport Interval LocalValidity ( TimeValue t )

virtual

This method returns the validity interval of a modifier.

It is simply the combination of the validity of all the modifier's parameters. It's used to determine when to cache in the pipeline, but is not directly responsible for determining when ModifyObject() is called. ModifyObject() is called when the pipeline needs to be evaluated either because someone sent a REFMSG_CHANGE message or the validity of the object does not include the current time.

If a modifier is not animated it's OK to simply return FOREVER from: this method. In the case where the modifier changes because a user changes a non-animated control in the user interface (for instance a check box), you can cause reevaluation by notifying your dependents of the change, i.e.:
NotifyDependents(FOREVER, PART_ALL, REFMSG_CHANGE);

Parameters

t	The time to calculate the Interval.

See also: Advanced Topics on Intervals.

Reimplemented in SimpleModBase, SimpleWSMMod, MSPluginSimpleMeshMod, MSModifierXtnd, and MSPluginModifier.

◆ ChannelsUsed()

virtual ChannelMask ChannelsUsed ( )

pure virtual

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

TOPO_CHANNEL
const ChannelMask TOPO_CHANNEL
The topology channel - the face or polygon structures.
Definition: channels.h:44

GEOM_CHANNEL
const ChannelMask GEOM_CHANNEL
The vertices of the object.
Definition: channels.h:47

Implemented in SimpleModBase, SimpleWSMMod, MSSimpleModXtnd, MSPluginSimpleMeshMod, MSModifierXtnd, and MSPluginModifier.

◆ ChannelsChanged()

virtual ChannelMask ChannelsChanged ( )

pure virtual

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

Implemented in SimpleModBase, SimpleWSMMod, MSSimpleModXtnd, MSPluginSimpleMeshMod, MSModifierXtnd, and MSPluginModifier.

◆ ChangesSelType()

virtual bool ChangesSelType ( )

inlinevirtual

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.

The default implementation indicates that it changes the selection type, if the SUBSEL_TYPE_CHANNEL is part of ChannelsChanged(). Note that ChannelsChanged() can not dynamically changed for various reasons.

5491 { return ChannelsChanged()&SUBSEL_TYPE_CHANNEL ? true : false;}

Modifier::ChannelsChanged

virtual ChannelMask ChannelsChanged()=0

These are the channels that the modifier actually modifies.

SUBSEL_TYPE_CHANNEL

const ChannelMask SUBSEL_TYPE_CHANNEL

The current level of selection.

Definition: channels.h:65

◆ TotalChannelsUsed()

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.

◆ TotalChannelsChanged()

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.

◆ InputType()

virtual Class_ID InputType ( )

pure virtual

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

Implemented in SimpleModBase, SimpleWSMMod, MSSimpleModXtnd, MSPluginSimpleMeshMod, MSModifierXtnd, and MSPluginModifier.

◆ NotifyInputChanged()

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

inlinevirtual

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 in MSSimpleModXtnd, MSPluginSimpleMeshMod, MSModifierXtnd, and MSPluginModifier.

5565 {}

◆ ModifyObject()

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

pure virtual

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.

Implemented in SimpleModBase, SimpleWSMMod, MSSimpleModXtnd, MSPluginSimpleMeshMod, MSModifierXtnd, and MSPluginModifier.

◆ DependOnTopology()

virtual BOOL DependOnTopology ( ModContext & mc )

inlinevirtual

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 in MSSimpleModXtnd, MSPluginSimpleMeshMod, MSModifierXtnd, and MSPluginModifier.

5602 {return FALSE;}

◆ GetInputType()

static CoreExport bool GetInputType	(	ClassDesc *	cd,
		Class_ID &	inputType
	)

static

To determine the input type of a modifier, an instance of the modifier needs to be created.

If the input type for a large number of modifiers are gathered (for example, when opening the modifier panel modifier dropdown list), creating an instance of each modifier is slow. This method creates an instance of the modifier if needed, and caches the input type. Later requests are satisfied via the cached value.

Parameters

cd	[in] The classdesc of the modifier. Valid superclasses are OSM_CLASS_ID and WSM_CLASS_ID.
inputType	[out] The input type of the modifier. See InputType() for a list of the valid values.

Returns: true if a modifier class with the specified SClass_ID and Class_ID was found, and the output inputType was set to a valid value.

◆ ForceNotify()

virtual void ForceNotify ( Interval & i )

inlinevirtual

Notifies dependents of a change.

Reimplemented from BaseObject.

5619 {NotifyDependents(i,ChannelsChanged(),REFMSG_CHANGE );}

◆ SaveLocalData()

virtual IOResult SaveLocalData	(	ISave *	isave,
		LocalModData *	ld
	)

inlinevirtual

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 in MSSimpleModXtnd, MSModifierXtnd, and MSPluginModifier.

5630 { return IO_OK; }

IO_OK

@ IO_OK

The result was acceptable - no errors.

Definition: maxtypes.h:282

◆ LoadLocalData()

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

inlinevirtual

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 in MSSimpleModXtnd, MSModifierXtnd, and MSPluginModifier.

5639 { return IO_OK; }

◆ Save()

CoreExport IOResult Save ( ISave * isave )

virtual

Implemented by the System.

This method handles saving the modifier name. This method should be called by the derived class BEFORE it saves any chunks. See the sample code below.

Parameters

isave You may use this pointer to call methods of ISave to write data.

Returns: One of the following values: IO_OK, IO_ERROR.

Sample Code:: IOResult DispMod::Save(ISave *isave)

{

// First save the modifier name by calling the base class version.

Modifier::Save(isave);

// Then save this modifiers data.

isave->BeginChunk(BMIO_CHUNK);

bi.Save(isave);

isave->EndChunk();

return IO_OK;

}

ISave
Definition: ioapi.h:186

ISave::BeginChunk
virtual void BeginChunk(USHORT id)=0

ISave::EndChunk
virtual void EndChunk()=0

Modifier::Save
CoreExport IOResult Save(ISave *isave)
Implemented by the System.

IOResult
IOResult
Definition: maxtypes.h:280

Reimplemented from ReferenceMaker.

◆ Load()

CoreExport IOResult Load ( ILoad * iload )

virtual

Implemented by the System.

Parameters

iload You may use this pointer to call methods of ILoad to read data.

Returns: One of the following values: IO_OK, IO_ERROR.

Reimplemented from ReferenceMaker.

◆ ShouldCollapseOnSave()

virtual bool ShouldCollapseOnSave ( )

inlinevirtual

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.

Returns: Flag indicating whether this modifier should be saved in a collapsed state for the specified save version.

5673 { return false; }

◆ EnumModContexts()

CoreExport void EnumModContexts ( ModContextEnumProc * proc )

Implemented by the System.

This method will call the callback object proc method once for each application of the modifier.

Parameters

proc	The callback object whose proc method is called.

See also: Class ModContextEnumProc.

◆ GetIDerivedObject()

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.

Parameters

mc	Points to the ModContext for the modifier.
derObj	A pointer to the IDerivedObject is returned here.
modIndex	The zero based index of the modifier in the derived object is returned here.

◆ CopyAdditionalChannels()

virtual CoreExport void CopyAdditionalChannels	(	Object *	fromObj,
		Object *	toObj
	)

inlinevirtual

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.

Parameters

fromObj
toObj

5704 { toObj->CopyAdditionalChannels(fromObj);}

Object::CopyAdditionalChannels

CoreExport void CopyAdditionalChannels(Object *from, bool deleteOld=true, bool bShallowCopy=false)

This method copies all extension objects from the "from" object into the current object.

◆ GetNodeFromModData()

CoreExport INode* GetNodeFromModData	(	LocalModData *	data,
		int &	index
	)

This function allows modifiers to find the nodes they are modifying.

Normally, object-space modifiers don't have information on the node being modified. Modifiers may want to have the node's transform or material, for example, so it is necessary to search through the modifier stack to find the node. This method performs that operation.

In the Modifier::ModifyObject method, after constructing the LocalModData and placing it in ModContext.localData, call GetNodeFromModData to get the node that is being modified. The returned INode pointer can be cached in the LocalModData so that it is readily available for later use.

Parameters

data	The LocalModData pointer
index	The index of the node in the list of ReferenceMakers returned by DoEnumDependents, considering only nodes.

Returns: The node being modified (nullptr if none found)

◆ GetNodeFromModContext()

CoreExport INode* GetNodeFromModContext	(	ModContext *	mc,
		int &	index
	)

This function allows modifiers to find the nodes they are modifying.

Normally, object-space modifiers don't have information on the node being modified. Modifiers may want to have the node's transform or material, for example, so it is necessary to search through the modifier stack to find the node. This method performs that operation.

In the Modifier::ModifyObject method, call GetNodeFromModContext to get the node that is being modified. The returned INode pointer can be cached in the LocalModData so that it is readily available for later use.

Parameters

mc	The ModContext pointer
index	The index of the node in the list of ReferenceMakers returned by DoEnumDependents, considering only nodes.

Returns: The node being modified (nullptr if none found)

◆ SvTraverseAnimGraph()

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

virtual

Remarks: This method is available in release 3.0 and later only.

This method traverses the graph of objects in the 3ds Max scene, adding desired objects to the schematic view. Developers can specialize this behaviour by overriding this method and adding whatever objects are interesting to the schematic view. Objects are added to the schematic view by calling IGraphObjectManager::AddAnimatable(...). Reference lines are added to the schematic view by calling IGraphObjectManager::AddReference(...). Implementers of this method should call it recursively to process other objects in the scene.

See Class IGraphObjectManager.

Parameters

gom	Points to the schematic view window manager.
owner	The owning animatable.
id	This is usually the sub-anim number (but can actually be any value the developer chooses).
flags	See Flags for AddAnimatable() and SvTravereseAnimGraph().

Returns: A SvGraphNodeReference object.

Reimplemented from Animatable.

Reimplemented in SimpleWSMMod.

◆ SvGetName()

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

virtual

Remarks: Returns the name of the object as it appears in the schematic view.

Parameters

gom	Points to the schematic view window manager.
gNode	Points to this node in the schematic view.
isBeingEdited	TRUE if the item is being edited; FALSE if not.

Default Implementation:: {

Animatable *owner;

int subNum;

MSTR name;

owner = gNode->GetOwner();

subNum = gNode->GetID();

name = owner->SubAnimName(subNum);

return name;

}

Animatable
Definition: Animatable.h:118

Animatable::SubAnimName
virtual MSTR SubAnimName(int i) MAX_SEALED
Definition: Animatable.h:650

WStr
Definition: strclass.h:738

Reimplemented from Animatable.

◆ SvCanSetName()

CoreExport bool SvCanSetName	(	IGraphObjectManager *	gom,
		IGraphNode *	gNode
	)

virtual

Remarks: Return true to permit the object's name to be edited in the schematic view.

Parameters

gom	Points to the schematic view window manager.
gNode	Points to this node in the schematic view.

Default Implementation:: { return false; }

Reimplemented from Animatable.

◆ SvSetName()

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

virtual

Remarks: Called when the user changes the name of the object in the schematic view.

Parameters

gom<	Points to the schematic view window manager.
gNode	Points to this node in the schematic view.
name	The new name to set.

Returns: TRUE if the name was changed; FALSE if not.

Reimplemented from Animatable.

◆ SvHandleDoubleClick()

CoreExport bool SvHandleDoubleClick	(	IGraphObjectManager *	gom,
		IGraphNode *	gNode
	)

virtual

Remarks: This method is available in release 3.0 and later only.

This method is called when this node is double-clicked in the schematic view.

Parameters

gom	Points to the schematic view window manager.
gNode	Points to the node in the schematic view.

Returns: true is handled; false if not interested in the event.

Default Implementation:: { return false; }

Reimplemented from Animatable.

◆ SvHighlightColor()

CoreExport COLORREF SvHighlightColor	(	IGraphObjectManager *	gom,
		IGraphNode *	gNode
	)

virtual

Remarks: This method is available in release 3.0 and later only.

Returns the highlight color for this node. The highlight color is used to outline nodes in the schematic view when SvIsHighlighted(...) returns true.

Parameters

gom	Points to the schematic view window manager.
gNode	Points to this node in the schematic view.

Returns: See COLORREF-DWORD format.

Default Implementation:: { return gom->SvGetUIColor(SV_UICLR_PLUGIN_HIGHLIGHT); }

Reimplemented from Animatable.

◆ SvIsSelected()

CoreExport bool SvIsSelected	(	IGraphObjectManager *	gom,
		IGraphNode *	gNode
	)

virtual

Returns true if the object is selected in its schematic view.

Reimplemented from Animatable.

◆ SvGetMultiSelectCallback()

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

virtual

Remarks: This method is called before a multiple select/deselect operation in the schematic view. Returns a callback used to perform the (de)selection. May return NULL if this object cannot be selected in some principle editor outside the schematic view.

Parameters

gom	Points to the schematic view window manager.
gNode	Points to the node in the schematic view.

Returns: A pointer to the callback object. See Class MultiSelectCallback.

Default Implementation:: { return NULL; }

Reimplemented from Animatable.

◆ SvCanSelect()

CoreExport bool SvCanSelect	(	IGraphObjectManager *	gom,
		IGraphNode *	gNode
	)

virtual

Remarks: Returns true if this object can be selected in some editor (viewport, material editor, plug-in specific editor, etc.). Selection is actually accomplished by via the SvGetMultiSelectCallback(...) mechanism described above.

Parameters

gom	Points to the schematic view window manager.
gNode	Points to the node in the schematic view.

Default Implementation:: { return false; }

Reimplemented from Animatable.

◆ SvCanInitiateLink()

CoreExport bool SvCanInitiateLink	(	IGraphObjectManager *	gom,
		IGraphNode *	gNode
	)

virtual

Remarks: Returns true if this animatable can be the initiator of a link operation in the schematic view.

Parameters

gom	Points to the schematic view window manager.
gNode	Points to this node in the schematic view.

Reimplemented from Animatable.

◆ SvCanConcludeLink()

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

virtual

Remarks: Returns true if this animatable can be the receiver (parent) of a link operation in the schematic view.

Parameters

gom	Points to the schematic view window manager.
gNode	Points to this node in the schematic view.
gNodeChild	Points to the child node in the schematic view.

Default Implementation:: { return false; }

Reimplemented from Animatable.

◆ SvLinkChild()

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

virtual

Remarks: This method is called to link this object to the gNodeChild passed.

Parameters

gom	Points to the schematic view window manager.
gNodeThis	Points to this node in the schematic view.
gNodeChild	Points to the child node in the schematic view.

Returns: true if linked; false if not.

Default Implementation:: { return false; }

Reimplemented from Animatable.

◆ SvCanRemoveThis()

CoreExport bool SvCanRemoveThis	(	IGraphObjectManager *	gom,
		IGraphNode *	gNode
	)

virtual

Remarks: This method is available in release 3.0 and later only.

Return true if this object can be removed in the schematic view; false if not.

Parameters

gom	Points to the schematic view window manager.
gNode	Points to this node in the schematic view.

Default Implementation:: { return false; }

Reimplemented from Animatable.

◆ SvRemoveThis()

CoreExport bool SvRemoveThis	(	IGraphObjectManager *	gom,
		IGraphNode *	gNode
	)

virtual

Called when the user deletes this object in the schematic view...

Parameters

gom	Points to the schematic view window manager.
gNode	Points to this node in the schematic view.

Returns: true if deleted; false if not.

Reimplemented from Animatable.

Friends And Related Function Documentation

◆ ModNameRestore

friend class ModNameRestore

friend

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Modifier()

◆ ~Modifier()

Member Function Documentation

◆ GetName() [1/2]

◆ GetName() [2/2]

◆ SetName()

◆ SuperClassID()

◆ DisableModApps()

◆ EnableModApps()

◆ DisableMod()

◆ EnableMod()

◆ IsEnabled()

◆ DisableModInViews()

◆ EnableModInViews()

◆ IsEnabledInViews()

◆ DisableModInRender()

◆ EnableModInRender()

◆ IsEnabledInRender()

◆ LocalValidity()

◆ ChannelsUsed()

◆ ChannelsChanged()

◆ ChangesSelType()

◆ TotalChannelsUsed()

◆ TotalChannelsChanged()

◆ InputType()

◆ NotifyInputChanged()

◆ ModifyObject()

◆ DependOnTopology()

◆ GetInputType()

◆ ForceNotify()

◆ SaveLocalData()

◆ LoadLocalData()

◆ Save()

◆ Load()

◆ ShouldCollapseOnSave()

◆ EnumModContexts()

◆ GetIDerivedObject()

◆ CopyAdditionalChannels()

◆ GetNodeFromModData()

◆ GetNodeFromModContext()

◆ SvTraverseAnimGraph()

◆ SvGetName()

◆ SvCanSetName()

◆ SvSetName()

◆ SvHandleDoubleClick()

◆ SvHighlightColor()

◆ SvIsSelected()

◆ SvGetMultiSelectCallback()

◆ SvCanSelect()

◆ SvCanInitiateLink()

◆ SvCanConcludeLink()

◆ SvLinkChild()

◆ SvCanRemoveThis()

◆ SvRemoveThis()

Friends And Related Function Documentation

◆ ModNameRestore