SimpleModBase Class Reference

Base class for object space modifiers. More...

#include <simpmod.h>

Inheritance diagram for SimpleModBase:

Public Member Functions
CoreExport	SimpleModBase ()
ChannelMask	ChannelsUsed () override
	These are channels that the modifier needs in order to perform its modification. More...
ChannelMask	ChannelsChanged () override
	These are the channels that the modifier actually modifies. More...
CoreExport void	ModifyObject (TimeValue t, ModContext &mc, ObjectState *os, INode *node) override
	This is the method that actually modifies the input object. More...
Class_ID	InputType () override
	This is the type of object that the modifier knows how to modify. More...
CoreExport Interval	LocalValidity (TimeValue t) override
	This method returns the validity interval of a modifier. More...
CoreExport Matrix3	CompMatrix (TimeValue t, ModContext &mc, Matrix3 &ntm, Interval &valid, BOOL needOffset)
CoreExport void	CompOffset (TimeValue t, Matrix3 &offset, Matrix3 &invoffset)
CoreExport int	HitTest (TimeValue t, INode *inode, int type, int crossing, int flags, IPoint2 *p, ViewExp *vpt, ModContext *mc) override
	This method is used in modifier gizmo hit testing. More...
CoreExport int	Display (TimeValue t, INode *inode, ViewExp *vpt, int flagst, ModContext *mc) override
	When this method is called the plug-in should respond by performing a quick render of the modifier gizmo in viewport using the current TM. More...
CoreExport void	GetWorldBoundBox (TimeValue t, INode *inode, ViewExp *vpt, Box3 &box, ModContext *mc) override
	This method computes the world space bounding box of the modifier gizmo (or any object that when in sub-object mode has a gizmo). More...
CoreExport void	GetSubObjectCenters (SubObjAxisCallback *cb, TimeValue t, INode *node, ModContext *mc) override
	When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis. More...
CoreExport void	GetSubObjectTMs (SubObjAxisCallback *cb, TimeValue t, INode *node, ModContext *mc) override
	When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis. More...
BOOL	ChangeTopology () override
	This method asks the question of an object or modifier "Do you change topology"? An object or modifier returns TRUE if it is capable of changing topology when its parameters are being edited; otherwise FALSE. More...
CoreExport void	Move (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Point3 &val, BOOL localOrigin=FALSE) override
	When this method is called the plug-in should respond by moving its selected sub-object components. More...
CoreExport void	Rotate (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Quat &val, BOOL localOrigin=FALSE) override
	When this method is called the plug-in should respond by rotating its selected sub-object components. More...
CoreExport void	Scale (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Point3 &val, BOOL localOrigin=FALSE) override
	When this method is called the plug-in should respond by scaling its selected sub-object components. More...
int	NumRefs () override
	Returns the total number of references this ReferenceMaker can hold. More...
CoreExport RefTargetHandle	GetReference (int i) override
	Returns the 'i-th' reference. More...
int	NumSubs () override
CoreExport Animatable *	SubAnim (int i) override
CoreExport MSTR	SubAnimName (int i, bool localized=true) override
CoreExport int	SubNumToRefNum (int subNum) override
CoreExport BOOL	AssignController (Animatable *control, int subAnim) override
CoreExport RefResult	NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate) override
	Receives and responds to messages. More...
CreateMouseCallBack *	GetCreateMouseCallBack () override
	This method allows the system to retrieve a callback object used in creating an object in the 3D viewports. More...
CoreExport void	ActivateSubobjSel (int level, XFormModes &modes) override
	When the user changes the selection of the sub-object drop down, this method is called to notify the plug-in. More...
CoreExport void	SimpleModBaseClone (SimpleModBase *smodSource, RemapDir &remap)
	When clients are cloning themselves, they should call this method on the clone to copy SimpleModBase's data. More...
CoreExport void	BeginEditParams (IObjParam *objParam, ULONG flags, Animatable *prev) override
	Clients of SimpleModBase probably want to override these. More...
CoreExport void	EndEditParams (IObjParam *objParam, ULONG flags, Animatable *next) override
virtual Deformer &	GetDeformer (TimeValue t, ModContext &mc, Matrix3 &mat, Matrix3 &invmat)=0
virtual void	InvalidateUI ()
virtual Interval	GetValidity (TimeValue t)
virtual BOOL	GetModLimits (TimeValue t, float &zmin, float &zmax, int &axis)
CoreExport int	NumSubObjTypes () override
	Objects and modifiers that support subobjects have to overwrite this method - as well as GetSubObjType() - and return a class derived from ISubObjType in GetSubObjType(). More...
CoreExport ISubObjType *	GetSubObjType (int i) override
	Returns a pointer to the sub-object type for the sub-object whose index is passed. More...
Public Member Functions inherited from Modifier
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...
virtual CoreExport MSTR	GetName (bool localized) const
	Implemented by the System. More...
virtual CoreExport void	SetName (MSTR n)
	Implemented by the System. More...
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...
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 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...
virtual BOOL	DependOnTopology (ModContext &mc)
	Modifiers that place a dependency on topology should return TRUE for this method. More...
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...
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...
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 const MCHAR *	GetObjectName () MAX_SEALED
virtual const MCHAR *	GetObjectName (bool localized) const
virtual CoreExport BOOL	OKToChangeTopology (MSTR &modName)
	Implemented by the System. 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	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 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 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	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 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...
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 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 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	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 ()

Public Attributes
Control *	tmControl
Control *	posControl

Static Public Attributes
static CoreExport IObjParam *	ip
static MoveModBoxCMode *	moveMode
static RotateModBoxCMode *	rotMode
static UScaleModBoxCMode *	uscaleMode
static NUScaleModBoxCMode *	nuscaleMode
static SquashModBoxCMode *	squashMode
static SimpleModBase *	editMod
Static Public Attributes inherited from Animatable
static const AnimHandle	kInvalidAnimHandle = 0

Protected Member Functions
virtual CoreExport	~SimpleModBase ()
	Destructor. This is a base class that is not meant to be instantiated directly. More...
virtual CoreExport void	SetReference (int i, RefTargetHandle rtarg) override
	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 Modifier
static CoreExport bool	GetInputType (ClassDesc *cd, Class_ID &inputType)
	To determine the input type of a modifier, an instance of the modifier needs to be created. 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...
Protected Attributes inherited from BaseObject
MaxSDK::Graphics::RenderItemHandleArray	mRenderItemHandles
Protected Attributes inherited from Animatable
DWORD	aflag
AnimPropertyList	aprops

Detailed Description

Base class for object space modifiers.

Description:

The SimpleModBase class supplies most of the methods needed to implement an object space modifier.

This is a base class that is intended to be derived from, rather than be instantiated directly.

Modifiers that have only one parameter block (see class IParamBlock2) should derive from class SimpleMod2.

To be a 'Simple' modifier, the following assumptions are made:

The modifier only modifies the geometry channel.

The modifier uses an instance of a class derived from Deformer to do the modifying.

The modifier's gizmo is represented as a 3D box that has had the modifier applied to it.

Derived classes that maintains several parameter blocks must overwrite the methods NumSubs(), SubAnim(i), SubAnimName(i), NumRefs(), GetReference(i) and SetReference(i) and call the SimpleModBase methods when 'i' refers to the parameters maintained by SimpleModBase.

When objects derived from SimpleModBase are cloning themselves, they should call this method on the clone to copy SimpleModBase's data:

void SimpleModBaseClone(SimpleModBase *smodSource, RemapDir& remap);

Classes derived from SimpleModBase probably want to override these. If they do, they should call these from within their implementation of these methods.

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

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

Data Members:

Control *tmControl;

Points to the transform controller for the Gizmo.

Control *posControl;

Points to the position controller for the Center.

static IObjParam *ip;

Storage for the interface pointer.

static MoveModBoxCMode *moveMode;

Storage for the move modifier box command mode.

static RotateModBoxCMode *rotMode;

Storage for the rotate modifier box command mode.

static UScaleModBoxCMode *uscaleMode;

Storage for the uniform scale modifier box command mode.

static NUScaleModBoxCMode *nuscaleMode;

Storage for the non-uniform scale modifier box command mode.

static SquashModBoxCMode *squashMode;

Storage for the squash modifier box command mode.

static SimpleModBase *editMod;

Storage for the instance of SimpleModBase that is being edited in the command panel.

Constructor & Destructor Documentation

~SimpleModBase()

virtual CoreExport ~SimpleModBase ( )

protectedvirtual

Destructor. This is a base class that is not meant to be instantiated directly.

SimpleModBase()

CoreExport SimpleModBase

(

)

Member Function Documentation

ChannelsUsed()

ChannelMask ChannelsUsed ( )

inlineoverridevirtual

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

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

Returns

The channels required. See Object Channels.

Sample Code:

{ return GEOM_CHANNEL|TOPO_CHANNEL; }

Implements Modifier.

{ return GEOM_CHANNEL | TOPO_CHANNEL | SELECT_CHANNEL | SUBSEL_TYPE_CHANNEL; }

ChannelsChanged()

ChannelMask ChannelsChanged ( )

inlineoverridevirtual

These are the channels that the modifier actually modifies.

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

Returns

The channels that are changed. See Object Channels

Implements Modifier.

{ return GEOM_CHANNEL; }

ModifyObject()

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

overridevirtual

This is the method that actually modifies the input object.

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

Parameters

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

See also

The topic on Modifiers in the Programmers Guide.

Implements Modifier.

InputType()

Class_ID InputType ( )

inlineoverridevirtual

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

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

Returns

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

Implements Modifier.

{ return defObjectClassID; }

LocalValidity()

CoreExport Interval LocalValidity ( TimeValue  t )

overridevirtual

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

CompMatrix()

CoreExport Matrix3 CompMatrix	(	TimeValue	t,
		ModContext &	mc,
		Matrix3 &	ntm,
		Interval &	valid,
		BOOL	needOffset
	)

CompOffset()

CoreExport void CompOffset	(	TimeValue	t,
		Matrix3 &	offset,
		Matrix3 &	invoffset
	)

HitTest()

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

overridevirtual

This method is used in modifier gizmo hit testing.

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

Parameters

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

Returns

Nonzero if the item was hit; otherwise 0.

Reimplemented from BaseObject.

Display()

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

overridevirtual

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

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

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

Parameters

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

Returns

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

Reimplemented from BaseObject.

GetWorldBoundBox()

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

overridevirtual

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

Parameters

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

Reimplemented from BaseObject.

GetSubObjectCenters()

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

overridevirtual

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

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

Parameters

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

Reimplemented from BaseObject.

GetSubObjectTMs()

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

overridevirtual

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

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

Parameters

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

Reimplemented from BaseObject.

ChangeTopology()

BOOL ChangeTopology ( )

inlineoverridevirtual

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

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

Reimplemented from BaseObject.

{ return FALSE; }

Move()

CoreExport void Move ( TimeValue  t, Matrix3 &  partm, Matrix3 &  tmAxis, Point3 &  val, BOOL  localOrigin = FALSE  )

overridevirtual

When this method is called the plug-in should respond by moving its selected sub-object components.

Parameters

t	The time of the transformation.
partm	The 'parent' transformation matrix. This matrix represents a transformation that would take points in the modifier's space and convert them into world space points. This is constructed as the node's transformation matrix times the inverse of the ModContext's transformation matrix. The node whose transformation is used is the node the user clicked on in the scene - modifiers can be instanced so there could be more than one node.
tmAxis	The matrix that represents the axis system. This is the space in which the transformation is taking place.
val	This value is a vector with X, Y, and Z representing the movement along each axis.
localOrigin	When TRUE the transformation is occurring about the sub-object's local origin.

Reimplemented from BaseObject.

Rotate()

CoreExport void Rotate ( TimeValue  t, Matrix3 &  partm, Matrix3 &  tmAxis, Quat &  val, BOOL  localOrigin = FALSE  )

overridevirtual

When this method is called the plug-in should respond by rotating its selected sub-object components.

Parameters

t	The time of the transformation.
partm	The 'parent' transformation matrix. This matrix represents a transformation that would take points in the modifier's space and convert them into world space points. This is constructed as the node's transformation matrix times the inverse of the ModContext's transformation matrix. The node whose transformation is used is the node the user clicked on in the scene - modifiers can be instanced so there could be more than one node.
tmAxis	The matrix that represents the axis system. This is the space in which the transformation is taking place.
val	The amount to rotate the selected components.
localOrigin	When TRUE the transformation is occurring about the sub-object's local origin. Note: This information may be passed onto a transform controller (if there is one) so they may avoid generating 0 valued position keys for rotation and scales. For example if the user is rotating an item about anything other than its local origin then it will have to translate in addition to rotating to achieve the result. If a user creates an object, turns on the animate button, and rotates the object about the world origin, and then plays back the animation, the object does not do what the was done interactively. The object ends up in the same position, but it does so by both moving and rotating. Therefore both a position and a rotation key are created. If the user performs a rotation about the local origin however there is no need to create a position key since the object didn't move (it only rotated). So a transform controller can use this information to avoid generating 0 valued position keys for rotation and scales.

Reimplemented from BaseObject.

Scale()

CoreExport void Scale ( TimeValue  t, Matrix3 &  partm, Matrix3 &  tmAxis, Point3 &  val, BOOL  localOrigin = FALSE  )

overridevirtual

When this method is called the plug-in should respond by scaling its selected sub-object components.

Parameters

t	The time of the transformation.
partm	The 'parent' transformation matrix. This matrix represents a transformation that would take points in the modifier's space and convert them into world space points. This is constructed as the node's transformation matrix times the inverse of the ModContext's transformation matrix. The node whose transformation is used is the node the user clicked on in the scene - modifiers can be instanced so there could be more than one node.
tmAxis	The matrix that represents the axis system. This is the space in which the transformation is taking place.
val	This value is a vector with X, Y, and Z representing the scale along X, Y, and Z respectively.
localOrigin	When TRUE the transformation is occurring about the sub-object's local origin. See the note above in the Rotate method. The following methods may be used to receive notification about the starting and ending phases of transforming the item when in sub-object selection.

Reimplemented from BaseObject.

NumRefs()

int NumRefs ( )

inlineoverridevirtual

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.

Reimplemented in SimpleMod2, and SimpleMod.

{ return 2; }

GetReference()

CoreExport RefTargetHandle GetReference ( int  i )

overridevirtual

Returns the 'i-th' reference.

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

Parameters

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

Returns

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

Reimplemented from ReferenceMaker.

Reimplemented in SimpleMod2, and SimpleMod.

SetReference()

virtual CoreExport void SetReference ( int  i, RefTargetHandle  rtarg  )

overrideprotectedvirtual

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

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

Parameters

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

Reimplemented from ReferenceMaker.

Reimplemented in SimpleMod2, SimpleMod, MSSimpleModXtnd, and MSPluginSimpleMod.

NumSubs()

int NumSubs ( )

inlineoverridevirtual

Remarks

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

Returns

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

Default Implementation:

{ return 0; }

Reimplemented from Animatable.

Reimplemented in SimpleMod2, and SimpleMod.

{ return 2; }

SubAnim()

CoreExport Animatable* SubAnim ( int  i )

overridevirtual

Remarks

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

Parameters

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

Default Implementation:

{ return NULL };

Reimplemented from Animatable.

Reimplemented in SimpleMod2, and SimpleMod.

SubAnimName()

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

overridevirtual

Remarks

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

Parameters

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

Returns

The name of the 'i-th' parameter.

Reimplemented from Animatable.

Reimplemented in SimpleMod2, and SimpleMod.

SubNumToRefNum()

CoreExport int SubNumToRefNum ( int  subNum )

overridevirtual

Remarks

This method is used for copying and pasting in the track view. It converts an anim index to a reference index or returns -1 if there is no correspondence. If a client does not wish an anim to be copied or pasted then it can return -1 even if there is a corresponding reference num.

Parameters

subNum

The anim index to return the corresponding reference index of.

Default Implementation:

{ return -1}

Returns

The reference index corresponding to the anim index passed. Return -1 if there is no correspondence.

Reimplemented from Animatable.

Reimplemented in SimpleMod2, and SimpleMod.

AssignController()

CoreExport BOOL AssignController ( Animatable *  control, int  subAnim  )

overridevirtual

Remarks

This method is called to assign the controller to the sub-anim whose index is passed.

Parameters

control	The controller to assign.
subAnim	The index of the sub-anim to assign the controller to.

Default Implementation:

{ return FALSE; }

Returns

Returns TRUE if the controller was assigned; otherwise FALSE.

Reimplemented from Animatable.

NotifyRefChanged()

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

overridevirtual

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.

Reimplemented in SimpleMod.

GetCreateMouseCallBack()

CreateMouseCallBack* GetCreateMouseCallBack ( )

inlineoverridevirtual

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

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

Returns

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

Implements BaseObject.

{ return nullptr; }

ActivateSubobjSel()

CoreExport void ActivateSubobjSel ( int  level, XFormModes &  modes  )

overridevirtual

When the user changes the selection of the sub-object drop down, this method is called to notify the plug-in.

This method should provide instances of a class derived from CommandMode to support move, rotate, non-uniform scale, uniform scale, and squash modes. These modes replace their object mode counterparts however the user still uses the move/rotate/scale tool buttons in the toolbar to activate them. If a certain level of sub-object selection does not support one or more of the modes NULL may be passed. If NULL is specified the corresponding toolbar button will be grayed out.

Parameters

level	The sub-object selection level the command modes should be set to support. A level of 0 indicates object level selection. If level is greater than or equal to 1 the index refers to the types registered by the object in the order they appeared in the list when registered by Interface::RegisterSubObjectTypes(). See Class Interface.
modes	The command modes to support

Sample Code:

void SimpleModBase::ActivateSubobjSel(int level, XFormModes& modes)
{
    switch ( level ) {
        case 1:                                   // Modifier box
            modes = XFormModes(moveMode,rotMode,nuscaleMode,uscaleMode,squashMode,NULL);
            break;
        case 2:                                   // Modifier Center
            modes = XFormModes(moveMode,NULL,NULL,NULL,NULL,NULL);
            break;
    }
    NotifyDependents(FOREVER,PART_DISPLAY,REFMSG_CHANGE);
}

See also

Class XFormModes.

Reimplemented from BaseObject.

SimpleModBaseClone()

CoreExport void SimpleModBaseClone	(	SimpleModBase *	smodSource,
		RemapDir &	remap
	)

When clients are cloning themselves, they should call this method on the clone to copy SimpleModBase's data.

Parameters:

SimpleModBase *smodSource

Specifies the SimpleModBase that is being cloned.

RemapDir& remap

The RemapDir.

BeginEditParams()

CoreExport void BeginEditParams ( IObjParam *  objParam, ULONG  flags, Animatable *  prev  )

overridevirtual

Clients of SimpleModBase probably want to override these.

If they do they should call these from within their methods.

Reimplemented from Animatable.

EndEditParams()

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

overridevirtual

Remarks

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

Parameters

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

Reimplemented from Animatable.

GetDeformer()

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

pure virtual

Remarks

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

Parameters:

TimeValue t

Specifies the time the modification is being performed.

ModContext &mc

A reference to the ModContext.

Matrix3& mat

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

Matrix3& invmat

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

Returns

A C++ reference to the deformer callback object.

Implemented in MSSimpleModXtnd, and MSPluginSimpleMod.

InvalidateUI()

virtual void InvalidateUI ( )

inlinevirtual

Remarks

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

Example:

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

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

float newval;

Interval valid=FOREVER;

TimeValue t=ip->GetTime();

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

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

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

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

angleSpin->SetValue( newval, FALSE );

Reimplemented in MSSimpleModXtnd, and MSPluginSimpleMod.

{}

GetValidity()

virtual Interval GetValidity ( TimeValue  t )

inlinevirtual

Remarks

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

Parameters:

TimeValue t

The time to compute the validity interval.

Default Implementation:

{return FOREVER;}

Returns

The validity interval of the modifier.

See also

The Advanced Topics section on Intervals.

Reimplemented in MSSimpleModXtnd, and MSPluginSimpleMod.

{ return FOREVER; }

GetModLimits()

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

inlinevirtual

Remarks

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

Parameters:

TimeValue t

The time to get the limits.

float &zmin

The min limit.

float &zmax

The max limit.

int &axis

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

Returns

TRUE if limits are supported; otherwise FALSE.

Default Implementation:

{return FALSE;}

Reimplemented in MSSimpleModXtnd, and MSPluginSimpleMod.

{ return FALSE; }

NumSubObjTypes()

CoreExport int NumSubObjTypes ( )

overridevirtual

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

Developers can use the GenSubObjType for convenience. If the parameter passed into GetSubObjType is -1, the system requests a ISubObjType, for the current SubObjectLevel that flows up the modifier stack. If the subobject selection of the modifier or base object does not affect the subobj selection that flows up the stack, the method must return NULL. See meshsel.cpp for a sample implementation.

Returns

The number of sub-object types supported by the object or modifier.

Reimplemented from BaseObject.

GetSubObjType()

CoreExport ISubObjType* GetSubObjType ( int  i )

overridevirtual

Returns a pointer to the sub-object type for the sub-object whose index is passed.

If the parameter i passed is -1 the system requests an ISubObjType for the current SubObjectLevel that flows up the modifier stack. If the subobject selection of the modifier or base object does not affect the sub-object selection that flows up the stack NULL must be returned. See the sample code in /MAXSDK/SAMPLES/MODIFIERS/MESHSEL.CPP.

Parameters

i	The zero based index of the sub-object type to get. See the remarks above.

Returns

The sub-object type. See Class ISubObjType.

Reimplemented from BaseObject.

Member Data Documentation

tmControl

Control* tmControl

posControl

Control* posControl

ip

CoreExport IObjParam* ip

static

moveMode

MoveModBoxCMode* moveMode

static

rotMode

RotateModBoxCMode* rotMode

static

uscaleMode

UScaleModBoxCMode* uscaleMode

static

nuscaleMode

NUScaleModBoxCMode* nuscaleMode

static

squashMode

SquashModBoxCMode* squashMode

static

editMod

SimpleModBase* editMod

static