SimpleManipulator Class Reference

#include <manipulator.h>

Inheritance diagram for SimpleManipulator:

Public Member Functions
ManipExport	SimpleManipulator ()
ManipExport	SimpleManipulator (INode *pNode)
ManipExport	~SimpleManipulator ()
ManipExport int	NumRefs ()
	Returns the total number of references this ReferenceMaker can hold. More...
ManipExport RefTargetHandle	GetReference (int i)
	Returns the 'i-th' reference. More...
ManipExport RefResult	NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate)
	Receives and responds to messages. More...
ManipExport ObjectState	Eval (TimeValue time)
	This method is called to evaluate the object and return the result as an ObjectState. More...
void	InitNodeName (MSTR &s)
	Implemented by the System. More...
ManipExport Interval	ObjectValidity (TimeValue t)
	This method returns the validity interval of the object as a whole at the specified time. More...
ManipExport void	GetWorldBoundBox (TimeValue t, INode *inode, ViewExp *vpt, Box3 &box)
	This method returns the world space bounding box for Objects (see below for the Sub-object gizmo or Modifiers gizmo version). More...
ManipExport void	GetLocalBoundBox (TimeValue t, INode *inode, ViewExp *vpt, Box3 &box)
ManipExport void	GetDeformBBox (TimeValue t, Box3 &box, Matrix3 *tm, BOOL useSel)
	This method computes the bounding box in the objects local coordinates or the optional space defined by tm. More...
ManipExport void	BeginEditParams (IObjParam *ip, ULONG flags, Animatable *prev)
ManipExport void	EndEditParams (IObjParam *ip, ULONG flags, Animatable *next)
ManipExport void	GetClassName (MSTR &s, bool localized=true) const override
	Retrieves the name of the plugin class. More...
ManipExport int	NumSubs ()
ManipExport Animatable *	SubAnim (int i)
ManipExport MSTR	SubAnimName (int i, bool localized=true) override
ManipExport BaseInterface *	GetInterface (Interface_ID id)
ManipExport int	HitTest (TimeValue t, INode *pNode, int type, int crossing, int flags, IPoint2 *pScreenPoint, ViewExp *pVpt)
ManipExport int	Display (TimeValue t, INode *pNode, ViewExp *pVpt, int flags)
ManipExport void	ClearPolyShapes ()
ManipExport void	AppendPolyShape (PolyShape *pPolyShape, DWORD flags, const Point3 &unselColor, const Point3 &selColor=ColorMan() ->GetColorAsPoint3(kManipulatorsSelected))
ManipExport void	AppendGizmo (GizmoShape *pGizmoShape, DWORD flags, const Point3 &unselColor, const Point3 &selColor=ColorMan() ->GetColorAsPoint3(kManipulatorsSelected))
ManipExport void	AppendMesh (Mesh *pMesh, DWORD flags, const Point3 &unselColor, const Point3 &selColor=ColorMan() ->GetColorAsPoint3(kManipulatorsSelected))
ManipExport void	AppendMarker (MarkerType markerType, Point3 &position, DWORD flags, const Point3 &unselColor, const Point3 &selColor=ColorMan() ->GetColorAsPoint3(kManipulatorsSelected))
ManipExport void	AppendText (const MCHAR *pText, Point3 &position, DWORD flags, const Point3 &unselColor, const Point3 &selColor=ColorMan() ->GetColorAsPoint3(kManipulatorsSelected))
ManipExport MSTR &	GetManipName ()
ManipExport void	SetGizmoScale (float gizmoScale)
ManipExport MSTR &	GetToolTip ()
ManipExport void	SetToolTipWnd (HWND hWnd)
ManipExport void	SetToolTipTimer (UINT timer)
ManipExport UINT	GetToolTipTimer ()
ManipExport HWND	GetToolTipWnd ()
ManipExport IParamBlock2 *	GetPBlock ()
virtual void	UpdateShapes (TimeValue t, MSTR &toolTip)=0
virtual ManipExport void	ManipulatorSelected ()
ManipExport void	SetManipTarget (RefTargetHandle hTarg)
ManipExport RefTargetHandle	GetManipTarget ()
ManipExport void	SetMouseState (MouseState state)
ManipExport MouseState	GetMouseState ()
ManipExport void	OnButtonDown (TimeValue t, ViewExp *pVpt, IPoint2 &m, DWORD flags, ManipHitData *pHitData)
ManipExport void	OnMouseMove (TimeValue t, ViewExp *pVpt, IPoint2 &m, DWORD flags, ManipHitData *pHitData)
ManipExport void	OnButtonUp (TimeValue t, ViewExp *pVpt, IPoint2 &m, DWORD flags, ManipHitData *pHitData)
ManipExport DisplayState	MouseEntersObject (TimeValue t, ViewExp *pVpt, IPoint2 &m, ManipHitData *pHitData)
ManipExport DisplayState	MouseLeavesObject (TimeValue t, ViewExp *pVpt, IPoint2 &m, ManipHitData *pHitData)
ManipExport IPoint2 &	GetTipPos ()
ManipExport void	GetLocalViewRay (ViewExp *pVpt, IPoint2 &m, Ray &viewRay)
ManipExport void	Invalidate ()
BOOL	UseSelectionBrackets ()
	This method allows an object to choose whether or not it will display selection brackets in shaded viewports. More...
ManipExport void	UnRegisterViewChange (BOOL fromDelete=FALSE)
void	RegisterViewChange ()
void	SetResettingFlag (BOOL val)
BOOL	GetResettingFlag ()
ManipExport void	KillToolTip ()
ManipExport Point3	GetUnselectedColor ()
ManipExport BOOL	ActiveViewOnly ()
ManipExport int	GetNumberGizmos ()
ManipExport ManipulatorGizmo *	GetGizmo (int i)
Public Member Functions inherited from Manipulator
ManipExport	Manipulator (INode *pINode)
BOOL	IsManipulator ()
virtual ManipExport bool	AlwaysActive ()
virtual void	OnRButtonDown (TimeValue t, ViewExp *pVpt, IPoint2 &m, DWORD flags, ManipHitData *pHitData)
virtual void	OnRButtonUp (TimeValue t, ViewExp *pVpt, IPoint2 &m, DWORD flags, ManipHitData *pHitData)
virtual INode *	GetINode ()
virtual ManipExport void	DeleteThis ()
Public Member Functions inherited from HelperObject
SClass_ID	SuperClassID () override
	Implemented by the System. More...
int	IsRenderable () override
	Implemented by the System. More...
virtual int	UsesWireColor () override
	Implemented by the System. More...
virtual BOOL	NormalAlignVector (TimeValue t, Point3 &pt, Point3 &norm) override
	Objects that don't support the IntersectRay() method (such as helper objects) can implement this method to provide a default vector for use with the normal align command in 3ds Max. More...
Public Member Functions inherited from Object
CoreExport	Object ()
CoreExport	~Object ()
virtual BOOL	CheckObjectIntegrity ()
	This method is used for debugging only. More...
virtual BOOL	HasUVW () override
	Call this method to find out if the object has UVW coordinates. More...
virtual BOOL	HasUVW (int mapChannel) override
	Call this method to find out if the object is has UVW coordinates for the specified mapping channel. More...
virtual Object *	FindBaseObject ()
	It is called to return a pointer to the base object (an object that is not a derived object). More...
virtual BOOL	IsParamSurface ()
	There are several methods used to access a parametric position on the surface of the object. More...
virtual int	NumSurfaces (TimeValue t)
	Returns the number of parametric surfaces within the object. More...
virtual Point3	GetSurfacePoint (TimeValue t, float u, float v, Interval &iv)
	This method needs to be implemented if Object::IsParamSurface() returns TRUE. More...
virtual Point3	GetSurfacePoint (TimeValue t, int surface, float u, float v, Interval &iv)
	This method is used to retrieve a point on the specified surface of the object based on two parameters of the surface, u and v. More...
virtual void	SurfaceClosed (TimeValue t, int surface, BOOL &uClosed, BOOL &vClosed)
	This method allows the object to return flags that indicate whether the parametric surface is closed in the U and V dimensions. More...
virtual BOOL	GetExtendedProperties (TimeValue t, MSTR &prop1Label, MSTR &prop1Data, MSTR &prop2Label, MSTR &prop2Data)
	This method allows an object to return extended Properties fields. More...
CoreExport SvGraphNodeReference	SvTraverseAnimGraph (IGraphObjectManager *gom, Animatable *owner, int id, DWORD flags)
CoreExport bool	SvHandleDoubleClick (IGraphObjectManager *gom, IGraphNode *gNode)
CoreExport MSTR	SvGetName (IGraphObjectManager *gom, IGraphNode *gNode, bool isBeingEdited)
CoreExport 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 void	AddXTCObject (XTCObject *pObj, int priority=0, int branchID=-1)
	This method adds an extension object into the pipeline. More...
CoreExport int	NumXTCObjects ()
	Returns the number of extension objects maintained by this Object. More...
CoreExport XTCObject *	GetXTCObject (int index)
	Returns a pointer to the specified extension object. More...
CoreExport void	RemoveXTCObject (int index)
	Removes the extension object as indicated by the index. More...
CoreExport void	SetXTCObjectPriority (int index, int priority)
	Sets the priority for the extension object whose index is passed. More...
CoreExport int	GetXTCObjectPriority (int index)
	Returns the integer priority number of the extension object whose index is passed. More...
CoreExport void	SetXTCObjectBranchID (int index, int branchID)
	Sets the branch ID of the extension object whose index is passed. More...
CoreExport int	GetXTCObjectBranchID (int index)
	Returns the integer branch ID of the extension object whose index is passed. More...
CoreExport void	MergeAdditionalChannels (Object *from, int branchID)
	This method has to be called whenever the CompoundObject updates a branch (calling Eval() on it). More...
CoreExport void	BranchDeleted (int branchID, bool reorderChannels)
	This method has to be called on the CompoundObject so it can delete the XTCObjects for the specified branch. More...
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. More...
CoreExport void	DeleteAllAdditionalChannels ()
	Implemented by the System. More...
CoreExport void *	GetInterface (ULONG id) override
	Inherited from Animatable. More...
CoreExport BaseInterface *	GetInterface (Interface_ID id) override
	Inherited from Animatable. More...
virtual void	ReduceDisplayCaches ()
	Should reduce any derived display data to save memory, since the node wont be drawn until the user undhides it. More...
virtual bool	NeedGWCacheRebuilt (GraphicsWindow *gw, Material *ma, int numMat)
	This returns whether the Graphics Cache for this object needs to be rebuilt. More...
virtual void	BuildGWCache (GraphicsWindow *gw, Material *ma, int numMat, BOOL threaded)
	This builds the graphics window cached mesh. More...
virtual void	StartStackEval ()
	This are called right before and after a modifier is applied to an object. More...
virtual void	EndStackEval ()
virtual int	DoOwnSelectHilite ()
	If an object wants to draw itself in the 3D viewports in its selected state in some custom manner this method should return nonzero. More...
virtual int	IntersectRay (TimeValue t, Ray &r, float &at, Point3 &norm)
	This method is called to compute the intersection point and surface normal at this intersection point of the ray passed and the object. More...
void	LockObject ()
	Implemented by the System. More...
void	UnlockObject ()
	Implemented by the System. More...
int	IsObjectLocked ()
	Implemented by the System. More...
void	LockChannels (ChannelMask channels)
	Implemented by the System. More...
void	UnlockChannels (ChannelMask channels)
	Implemented by the System. More...
ChannelMask	GetChannelLocks ()
	Implemented by the System. More...
void	SetChannelLocks (ChannelMask channels)
	Implemented by the System. More...
ChannelMask	GetChannelLocks (ChannelMask m)
	Implemented by the System. More...
virtual BOOL	CanCacheObject ()
	This method determines if this object can have channels cached. More...
virtual void	WSStateInvalidate ()
	This is called by a node when the node's world space state has become invalid. More...
virtual BOOL	IsWorldSpaceObject ()
	Returns TRUE if the object as a world space object; otherwise FALSE. More...
CoreExport INode *	GetWorldSpaceObjectNode ()
	Implemented by the System. More...
virtual BOOL	IsParticleSystem ()
	Implemented by the System. More...
CoreExport void	CopyChannelLocks (Object *obj, ChannelMask needChannels)
	Implemented by the System. More...
virtual void	TopologyChanged ()
	Implemented by the System. More...
virtual int	IsDeformable ()
	Indicates whether this object is deformable. More...
virtual int	NumPoints ()
	The points of a deformable object are accessed through a virtual array interface. More...
virtual Point3	GetPoint (int i)
	The points of a deformable object are accessed through a virtual array interface. More...
virtual void	SetPoint (int i, const Point3 &p)
	The points of a deformable object are accessed through a virtual array interface. More...
virtual BOOL	IsPointSelected (int i)
	Returns TRUE if the 'i-th' point is selected; otherwise FALSE. More...
virtual float	PointSelection (int i)
	Returns a floating point weighted point selection if the object supports it. More...
virtual BOOL	HasWeights ()
	Returns TRUE if the object has weights for its points that can be set; otherwise FALSE. More...
virtual double	GetWeight (int i)
	Returns the weight of the specified point of the object. More...
virtual void	SetWeight (int i, const double w)
	Sets the weight of the specified point. More...
virtual BOOL	PolygonCount (TimeValue t, int &numFaces, int &numVerts)
	Retreives the number of faces and vertices of the polyginal mesh representation of this object. More...
virtual void	PointsWereChanged ()
	Informs the object that its points have been deformed, so it can invalidate its cache. More...
virtual CoreExport void	Deform (Deformer *defProc, int useSel=0)
	This is the method used to deform the object with a deformer. More...
virtual int	IsMappable ()
	This method lets you know if the ApplyUVWMap() method is available for this object. More...
virtual int	NumMapChannels ()
	Returns the maximum number of channels supported by this type of object. More...
virtual int	NumMapsUsed ()
	Returns the number of maps currently used by this object. More...
virtual void	ApplyUVWMap (int type, float utile, float vtile, float wtile, int uflip, int vflip, int wflip, int cap, const Matrix3 &tm, int channel=1)
	This method may be called to map the object with UVW mapping coordinates. More...
virtual CoreExport int	CanConvertToType (Class_ID obtype)
	Indicates whether the object can be converted to the specified type. More...
virtual CoreExport Object *	ConvertToType (TimeValue t, Class_ID obtype)
	This method converts this object to the type specified and returns a pointer it. More...
virtual Class_ID	PreferredCollapseType ()
	This method allows objects to specify the class that is the best class to convert to when the user collapses the stack. More...
virtual CoreExport void	GetCollapseTypes (Tab< Class_ID > &clist, Tab< MSTR * > &nlist)
	When the user clicks on the Edit Stack button in the modify branch a list of 'Convert To:' types is presented. More...
virtual Object *	CollapseObject ()
	This method is called on the world space cache object when the stack gets collapsed, that lets the pipeline object decide, if it wants to return a different object than itself. More...
virtual DWORD	GetSubselState ()
	For objects that have sub selection levels, this method returns the current selection level of the object. More...
virtual void	SetSubSelState (DWORD s)
	Implemented by the System. More...
CoreExport void	ReadyChannelsForMod (ChannelMask channels)
	Implemented by the System. More...
virtual CoreExport Interval	ChannelValidity (TimeValue t, int nchan)
	Retrieve the current validity interval for the nchan channel of the object. More...
virtual CoreExport void	SetChannelValidity (int nchan, Interval v)
	Sets the validity interval of the specified channel. More...
virtual CoreExport void	InvalidateChannels (ChannelMask channels)
	This method invalidates the intervals for the given channel mask. More...
virtual Object *	MakeShallowCopy (ChannelMask channels)
	This method must make a copy of its "shell" and then shallow copy (see below) only the specified channels. More...
virtual CoreExport void	ShallowCopy (Object *fromOb, ChannelMask channels)
	This method copies the specified channels from the fromOb to this and copies the validity intervals. More...
virtual CoreExport void	FreeChannels (ChannelMask channels)
	This method deletes the memory associated with the specified channels and set the intervals associated with the channels to invalid (empty). More...
virtual CoreExport void	NewAndCopyChannels (ChannelMask channels)
	This method replaces the locked channels with newly allocated copies. More...
virtual CoreExport void	MaybeEnlargeViewportRect (GraphicsWindow *gw, Rect &rect)
	This method allows the object to enlarge its viewport rectangle, if it wants to. More...
CoreExport bool	IsBaseClassOwnedChannel (int nchan)
	Implemented by the System. More...
CoreExport void	UpdateValidity (int nchan, Interval v)
	When a modifier is applied to an object, it needs to include its own validity interval in the interval of the object. More...
Interval	GetNoEvalInterval ()
void	SetNoEvalInterval (Interval iv)
virtual CoreExport void	ReduceCaches (TimeValue t)
	This method give the object the chance to reduce its caches. More...
virtual int	IsConstObject ()
	This is called to determine if this is a construction object or not. More...
virtual int	NumPipeBranches (bool selected=true)
	This method returns the number of pipeline branches combined by the object. More...
virtual Object *	GetPipeBranch (int i, bool selected=true)
	Retrieves sub-object branches from an object that supports branching. More...
virtual INode *	GetBranchINode (TimeValue t, INode *node, int i, bool selected=true)
	When an object has sub-object branches, it is likely that the sub-objects are transformed relative to the object. More...
virtual int	NumberOfContainedShapes ()
	Returns the number of shapes contained inside this object. More...
virtual ShapeObject *	GetContainedShape (TimeValue t, int index)
	This method returns the ShapeObject specified by the index passed at the time specified. More...
virtual void	GetContainedShapeMatrix (TimeValue t, int index, Matrix3 &mat)
	Returns the matrix associated with the shape whose index is passed. More...
virtual BitArray	ContainedShapeSelectionArray ()
	This is used by the lofter. More...
virtual BOOL	IsShapeObject ()
	Returns the number of shapes contained inside this object. 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
CoreExport	BaseObject ()
virtual CoreExport	~BaseObject ()
virtual BOOL	HasViewDependentBoundingBox ()
	This method return true if GetWorldBoundBox returns different boxes for different viewports. More...
virtual void	SetExtendedDisplay (int flags)
	This method is used for storing mode-dependent display attributes. 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 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 void	ForceNotify (Interval &i)
	Notifies dependents of a change. 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 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 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 CoreExport IOResult	Save (ISave *isave)
	Called for saving data. More...
virtual CoreExport IOResult	Load (ILoad *iload)
	Called for loading data. 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 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 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	SvCanInitiateLink (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvCanConcludeLink (IGraphObjectManager *gom, IGraphNode *gNode, IGraphNode *gNodeChild)
virtual CoreExport bool	SvCanSetName (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvSetName (IGraphObjectManager *gom, IGraphNode *gNode, const MSTR &name)
virtual CoreExport bool	SvCanRemoveThis (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvRemoveThis (IGraphObjectManager *gom, IGraphNode *gNode)
	Called when the user deletes this object in the schematic view... More...
virtual CoreExport bool	SvIsHighlighted (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport COLORREF	SvGetSwatchColor (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvIsInactive (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvLinkChild (IGraphObjectManager *gom, IGraphNode *gNodeThis, IGraphNode *gNodeChild)
virtual CoreExport bool	SvEditProperties (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport MSTR	SvGetTip (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport MSTR	SvGetRefTip (IGraphObjectManager *gom, IGraphNode *gNode, IGraphNode *gNodeMaker)
virtual CoreExport bool	SvCanDetach (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvDetach (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport MSTR	SvGetRelTip (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Returns a string to be displayed in the tip window in the schematic view for a relationship from "gNodeMaker" to "gNodeTarget"... More...
virtual CoreExport bool	SvCanDetachRel (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Returns true if this object can respond to the SvDetachRel(...) method... More...
virtual CoreExport bool	SvDetachRel (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Detach this relationship. More...
virtual CoreExport bool	SvHandleRelDoubleClick (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Called when this relationship is double-clicked in the schematic view... More...
CoreExport ICustAttribContainer *	GetCustAttribContainer ()
	This method returns a pointer to the custom attributes container interface class. More...
CoreExport void	AllocCustAttribContainer ()
	This method allocates space for a custom attributes container. More...
CoreExport void	DeleteCustAttribContainer ()
	This method deletes space used by a custom attributes container. More...
void	SetAFlag (DWORD mask)
void	ClearAFlag (DWORD mask)
	Clears one or more bits in the Animatable flags. More...
bool	TestAFlag (DWORD mask) const
	Tests one or more bits in the Animatable flags. More...
void	SetAFlagEx (DWORD mask)
	Sets one or more bits in the Animatable extended flags. More...
void	ClearAFlagEx (DWORD mask)
	Clears one or more bits in the Animatable extended flags. More...
bool	TestAFlagEx (DWORD mask) const
	Tests one or more bits in the Animatable extended flags. More...
CoreExport bool	TestFlagBit (int index)
	Tests the specified flag bit. More...
CoreExport void	SetFlagBit (int index, bool newValue=true)
	Sets the specified flag bit. More...
CoreExport void	ClearFlagBit (int index)
	Clears the specified flag bit. More...
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()
Public Member Functions inherited from ISimpleManipulator
	VFN_0 (clearPolyShapes, ClearPolyShapes)
	VFN_6 (appendMesh, FPAppendMeshEx, TYPE_MESH, TYPE_INT, TYPE_POINT3_BV, TYPE_POINT3_BV, TYPE_bool, TYPE_INT)
	VFN_5 (appendGizmo, FPAppendGizmoEx, TYPE_INTERFACE, TYPE_INT, TYPE_POINT3_BV, TYPE_POINT3_BV, TYPE_bool)
	VFN_6 (appendMarker, FPAppendMarkerEx, TYPE_ENUM, TYPE_POINT3_BV, TYPE_INT, TYPE_POINT3_BV, TYPE_POINT3_BV, TYPE_bool)
	VFN_6 (appendText, FPAppendTextEx, TYPE_STRING, TYPE_POINT3_BV, TYPE_INT, TYPE_POINT3_BV, TYPE_POINT3_BV, TYPE_bool)
	VFN_2 (updateShapes, UpdateShapes, TYPE_TIMEVALUE, TYPE_TSTR_BR)
	FN_2 (getLocalViewRay, TYPE_RAY_BV, FPGetLocalViewRayEx, TYPE_POINT2_BV, TYPE_bool)
	RO_PROP_FN (getMouseState, GetMouseState, TYPE_ENUM)
ManipExport Ray	FPGetLocalViewRay (Point2 &m)
ManipExport void	FPAppendMesh (Mesh *pMesh, DWORD flags, Point3 &unselColor, Point3 &selColor)
ManipExport void	FPAppendGizmo (FPInterface *pGizmo, DWORD flags, Point3 &unselColor, Point3 &selColor)
ManipExport void	FPAppendMarker (int markerType, Point3 &position, DWORD flags, Point3 &unselColor, Point3 &selColor)
ManipExport void	FPAppendText (const MCHAR *pText, Point3 &position, DWORD flags, Point3 &unselColor, Point3 &selColor)
ManipExport Ray	FPGetLocalViewRayEx (Point2 &m, bool applyUIScaling)
ManipExport void	FPAppendMeshEx (Mesh *pMesh, DWORD flags, Point3 &unselColor, Point3 &selColor, bool applyUIScaling, int gizmoSize)
ManipExport void	FPAppendGizmoEx (FPInterface *pGizmo, DWORD flags, Point3 &unselColor, Point3 &selColor, bool applyUIScaling)
ManipExport void	FPAppendMarkerEx (int markerType, Point3 &position, DWORD flags, Point3 &unselColor, Point3 &selColor, bool applyUIScaling)
ManipExport void	FPAppendTextEx (const MCHAR *pText, Point3 &position, DWORD flags, Point3 &unselColor, Point3 &selColor, bool applyUIScaling)
ManipExport FPInterfaceDesc *	GetDesc ()
Public Member Functions inherited from FPMixinInterface
	FPMixinInterface ()
virtual LifetimeType	LifetimeControl ()
virtual CoreExport bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
CoreExport	~FPMixinInterface ()
virtual FPInterfaceDesc *	GetDescByID (Interface_ID id)
virtual Interface_ID	GetID ()
Public Member Functions inherited from FPInterface
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPParams *params)
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)
virtual CoreExport FunctionID	FindFn (const MCHAR *name)
virtual CoreExport BOOL	IsEnabled (FunctionID actionID)
virtual CoreExport BOOL	IsChecked (FunctionID actionID)
virtual CoreExport BOOL	IsVisible (FunctionID actionID)
virtual CoreExport FunctionID	GetIsEnabled (FunctionID actionID)
virtual CoreExport FunctionID	GetIsChecked (FunctionID actionID)
virtual CoreExport FunctionID	GetIsVisible (FunctionID actionID)
virtual ActionTable *	GetActionTable ()
virtual void	EnableActions (BOOL onOff)
Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor. More...
virtual BaseInterface *	AcquireInterface ()
virtual void	ReleaseInterface ()
virtual void	DeleteInterface ()
virtual BaseInterface *	CloneInterface (void *remapDir=nullptr)

Static Public Attributes
static ManipExport const int	kNoneSelected
Static Public Attributes inherited from Animatable
static const AnimHandle	kInvalidAnimHandle = 0
Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface

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

Protected Attributes
int	mDispSelectedIndex
MSTR	mToolTip
float	mGizmoScale
IParamBlock2 *	mpPblock
Interval	mValid
RefTargetHandle	mhTarget
MouseState	mState
BOOL	mActiveViewOnly
BOOL	mResetting
Protected Attributes inherited from Manipulator
INode *	mpINode
Protected Attributes inherited from BaseObject
MaxSDK::Graphics::RenderItemHandleArray	mRenderItemHandles
Protected Attributes inherited from Animatable
DWORD	aflag
AnimPropertyList	aprops
Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > *	interfaceNotifyCBs

Additional Inherited Members
Public Types inherited from ISimpleManipulator
enum	{   clearPolyShapes , appendPolyShape , appendMesh , getMouseState ,   getLocalViewRay , updateShapes , onMouseMove , appendGizmo ,   appendMarker , appendText , getGizmoSize , setGizmoSize }
enum	{ mouseState , markerType }
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }
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...

Detailed Description

See also

Class Manipulator, Class ISimpleManipulator, Class PolyShape, Class GizmoShape, Class ReferenceTarget, Class IParamBlock2, Class INode, Class Mesh, Class Point3, Class Point2, Class ViewExp, Class IColorManager, Class Ray, Class ManipHitData, Enum MarkerType

Description:

The SimpleManipulator class provides a framework for implementing many common manipulators. It provides the following services:

It supports an arbitrary number of gizmos made from PolyShape and/or Mesh objects.

It creates and maintains tool tips in the viewport.

It does hit testing, display and bounding box computations of the gizmos.

It maintains an IParamBlock2 for the parameters of the Manipulator.

This class maintains a pointer to a parameter block. If the client of SimpleManipulator uses a single parameter block then SimpleManipulator can manage all the methods associated with SubAnims and References for the client.

If the client of SimpleManipulator maintains several parameter blocks then the client must implement the methods NumSubs(), SubAnim(i), SubAnimName(i), NumRefs(), GetReference(i) and SetReference(i) and call the SimpleManipulator methods when 'i' refers to the parameters maintained by SimpleManipulator.

Samples of Manipulators can be found in the SDK, /MAXSDK/SAMPLES/MANIPULATORS.

The Function Publishing interface to SimpleManipulators is defined as:

#define SIMPLE_MANIP_INTERFACE Interface_ID(0x617c41d4, 0x6af06a5f)

The following functions are not part of this class but are available for use with it in the making of gizmo objects:

Constructor & Destructor Documentation

SimpleManipulator() [1/2]

ManipExport SimpleManipulator

(

)

Remarks

Constructor.

SimpleManipulator() [2/2]

ManipExport SimpleManipulator

(

INode *

pNode

)

Remarks

Constructor.

~SimpleManipulator()

ManipExport ~SimpleManipulator

(

)

Remarks

Destructor.

Member Function Documentation

NumRefs()

ManipExport int NumRefs ( )

virtual

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 MSSimpleManipulatorXtnd, and MSPluginSimpleManipulator.

GetReference()

ManipExport RefTargetHandle GetReference ( int  i )

virtual

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 MSSimpleManipulatorXtnd, and MSPluginSimpleManipulator.

SetReference()

virtual ManipExport void SetReference ( int  i, RefTargetHandle  rtarg  )

protectedvirtual

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 MSSimpleManipulatorXtnd, and MSPluginSimpleManipulator.

NotifyRefChanged()

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

virtual

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

Eval()

ManipExport ObjectState Eval ( TimeValue  t )

virtual

This method is called to evaluate the object and return the result as an ObjectState.

When the system has a pointer to an object it doesn't know if it's a procedural object or a derived object. So it calls Eval() on it and gets back an ObjectState. A derived object managed by the system may have to call Eval() on its input for example. A plug-in (like a procedural object) typically just returns itself. A plug-in that does not just return itself is the Morph Object (/MAXSDK/SAMPLES/OBJECTS/MORPHOBJ.CPP). This object uses a morph controller to compute a new object and fill in an ObjectState which it returns.

Parameters

t	Specifies the time to evaluate the object.

Returns

The result of evaluating the object as an ObjectState.

Sample Code:

Typically this method is implemented as follows:

{ return ObjectState(this); }

Implements Object.

InitNodeName()

void InitNodeName ( MSTR &  s )

inlinevirtual

Implemented by the System.

Sets the default node name to "Helper".

Reimplemented from HelperObject.

{s = GetObjectName(true);}

ObjectValidity()

ManipExport Interval ObjectValidity ( TimeValue  t )

virtual

This method returns the validity interval of the object as a whole at the specified time.

Parameters

t	The time to compute the validity interval.

Returns

The validity interval of the object, including that queried from the base class.

Reimplemented from Object.

GetWorldBoundBox()

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

virtual

This method returns the world space bounding box for Objects (see below for the Sub-object gizmo or Modifiers gizmo version).

The bounding box returned by this method does not need to be precise. It should however be calculated rapidly. The object can handle this by transforming the 8 points of its local bounding box into world space and take the minimums and maximums of the result. Although this isn't necessarily the tightest bounding box of the objects points in world space, it is close enough.

Parameters

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

Reimplemented from BaseObject.

Reimplemented in MSSimpleManipulatorXtnd.

GetLocalBoundBox()

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

virtual

Remarks

Used Internally.

Returns the object space bounding box of the manipulator in the object's local coordinates.

Parameters:

TimeValue t

The time to retrieve the bounding box.

INode* inode

The node that is being manipulated by the manipulator.

ViewExp* vp

An interface that may be used to call methods associated with the viewports.

Box3& box

The bounding box is returned here.

Implements Manipulator.

Reimplemented in MSSimpleManipulatorXtnd.

GetDeformBBox()

ManipExport void GetDeformBBox ( TimeValue  t, Box3 &  box, Matrix3 *  tm, BOOL  useSel  )

virtual

This method computes the bounding box in the objects local coordinates or the optional space defined by tm.

Note: If you are looking for a precise bounding box, use this method and pass in the node's object TM (INode::GetObjectTM()) as the matrix.

Parameters

t	The time to compute the box.
box	A reference to a box the result is stored in.
tm	This is an alternate coordinate system used to compute the box. If the tm is not NULL this matrix should be used in the computation of the result.
useSel	If TRUE, the bounding box of selected sub-elements should be computed; otherwise the entire object should be used.

Reimplemented from Object.

BeginEditParams()

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

virtual

Remarks

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

Parameters

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

Reimplemented from Animatable.

Reimplemented in MSSimpleManipulatorXtnd, and MSPluginSimpleManipulator.

EndEditParams()

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

virtual

Remarks

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

Parameters

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

Reimplemented from Animatable.

Reimplemented in MSSimpleManipulatorXtnd, and MSPluginSimpleManipulator.

GetClassName()

ManipExport void GetClassName ( MSTR &  s, bool  localized = true  ) const

inlineoverridevirtual

Retrieves the name of the plugin class.

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

Parameters

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

Reimplemented from ReferenceTarget.

Reimplemented in MSSimpleManipulatorXtnd, and MSPluginSimpleManipulator.

{s = GetObjectName(localized);}

NumSubs()

ManipExport int NumSubs ( )

inlinevirtual

Remarks

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

Returns

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

Default Implementation:

{ return 0; }

Reimplemented from Animatable.

Reimplemented in MSSimpleManipulatorXtnd, and MSPluginSimpleManipulator.

{ return 1; }

SubAnim()

ManipExport Animatable* SubAnim ( int  i )

inlinevirtual

Remarks

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

Parameters

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

Default Implementation:

{ return NULL };

Reimplemented from Animatable.

Reimplemented in MSSimpleManipulatorXtnd, and MSPluginSimpleManipulator.

{ UNUSED_PARAM(i); return mpPblock; }

SubAnimName()

ManipExport 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 MSSimpleManipulatorXtnd, and MSPluginSimpleManipulator.

GetInterface()

ManipExport BaseInterface* GetInterface ( Interface_ID  id )

virtual

Remarks

Returns a pointer to the interface whose ID is specified.

Parameters:

Interface_ID id

The ID of the interface to return.

Default Implementation:

{ return NULL; }

Reimplemented from FPMixinInterface.

HitTest()

ManipExport int HitTest ( TimeValue  t, INode *  pNode, int  type, int  crossing, int  flags, IPoint2 *  pScreenPoint, ViewExp *  pVpt  )

virtual

Remarks

This method is called to determine if the specified screen point intersects the manipulator. The method returns nonzero if the item was hit; otherwise 0. This is like the normal HitTest() method in the BaseObject class. The difference is that it needs to log it hits in the viewport SubObjectHitList. It does this using the ManipHitData class defined in Manipulator.h.

Parameters:

TimeValue t

The time to perform the hit test.

INode* pNode

A pointer to the node to test.

int type

The type of hit testing to perform. See Scene and Node Hit Test Types. int crossing

The state of the crossing setting. If TRUE crossing selection is on.

int flags

The hit test flags. See Scene and Node Hit Testing Flags IPoint2 *pScreenPoint

Points to the screen point to test.

ViewExp *pVpt

An interface that may be used to call methods associated with the viewports.

Returns

Nonzero if the item was hit; otherwise 0.

Implements Manipulator.

Reimplemented in MSSimpleManipulatorXtnd.

Display()

ManipExport int Display ( TimeValue  t, INode *  pNode, ViewExp *  pVpt, int  flags  )

virtual

Remarks

This method lines the BaseObject::Display() method and displays the manipulator object.

Parameters:

TimeValue t

The time to display the object.

INode* pNode

Points to the node that is being manipulated by the manipulator.

ViewExp *pVpt

An interface that may be used to call methods associated with the viewports.

int flags

See Display Flags.

Returns

The return value is not currently used.

Implements Manipulator.

Reimplemented in MSSimpleManipulatorXtnd.

ClearPolyShapes()

ManipExport void ClearPolyShapes ( )

virtual

Remarks

Implemented by the system.

Removes all of the current gizmos in the manipulator. This is normally called at the top of UpdateShapes() to clear out any previous gizmos before creating new ones.

Implements ISimpleManipulator.

AppendPolyShape()

ManipExport void AppendPolyShape ( PolyShape *  pPolyShape, DWORD  flags, const Point3 &  unselColor, const Point3 &  selColor = ColorMan() ->GetColorAsPoint3(kManipulatorsSelected)  )

virtual

Remarks

Implemented by the system.

This method adds a new PolyShape gizmo to the manipulator. The shape is defined in the local coordinates of the node that owns the manipulator.

Parameters:

PolyShape* pPolyShape

A pointer to the poly shape to add.

DWORD flags = 0

The flags can have one or more of the following values:

kGizmoDontDisplay;

Tells the gizmo not to display. It will still hit test it.

kGizmoDontHitTest;

Tells the gizmo not to hit test. It will still display.

kGizmoScaleToViewport;

Tells the gizmo to scale itself to have a constant size in the viewport. In this case, the system uses the ManipulatorGizmo::mGizmoSize to determine how big the manipulator should be. It interprets mGizmoSize as pixels it this case. This flag only applies to mesh gizmo currently.

Point3& unselColor = GetUIColor(COLOR_SEL_GIZMOS)

The color of the gizmo when unselected.

Point3& selColor = GetSubSelColor()

The color of the gizmo when selected.

Implements ISimpleManipulator.

AppendGizmo()

ManipExport void AppendGizmo ( GizmoShape *  pGizmoShape, DWORD  flags, const Point3 &  unselColor, const Point3 &  selColor = ColorMan() ->GetColorAsPoint3(kManipulatorsSelected)  )

virtual

Remarks

Implemented by the system.

This method adds a new GIzmoShape to the manipulator. The shape is defined in the local coordinates of the node that owns the manipulator.

Parameters:

GizmoShape* pGizmoShape

A pointer to the gizmo shape to add.

DWORD flags = 0

The flags can have one or more of the following values:

kGizmoDontDisplay;

Tells the gizmo not to display. It will still hit test it.

kGizmoDontHitTest;

Tells the gizmo not to hit test. It will still display.

kGizmoScaleToViewport;

Tells the gizmo to scale itself to have a constant size in the viewport. In this case, the system uses the ManipulatorGizmo::mGizmoSize to determine how big the manipulator should be. It interprets mGizmoSize as pixels it this case. This flag only applies to mesh gizmo currently.

Point3& unselColor = GetUIColor(COLOR_SEL_GIZMOS)

The color of the gizmo when unselected.

Point3& selColor = GetSubSelColor()

The color of the gizmo when selected.

Implements ISimpleManipulator.

AppendMesh()

ManipExport void AppendMesh ( Mesh *  pMesh, DWORD  flags, const Point3 &  unselColor, const Point3 &  selColor = ColorMan() ->GetColorAsPoint3(kManipulatorsSelected)  )

virtual

Remarks

Implemented by the system.

This method adds a new Mesh to the manipulator. The shape is defined in the local coordinates of the node that owns the manipulator.

Parameters:

Mesh* pMesh

A pointer to the mesh to add.

DWORD flags = 0

The flags can have one or more of the following values:

kGizmoDontDisplay;

Tells the gizmo not to display. It will still hit test it.

kGizmoDontHitTest;

Tells the gizmo not to hit test. It will still display.

kGizmoScaleToViewport;

Tells the gizmo to scale itself to have a constant size in the viewport. In this case, the system uses the ManipulatorGizmo::mGizmoSize to determine how big the manipulator should be. It interprets mGizmoSize as pixels it this case. This flag only applies to mesh gizmo currently.

Point3& unselColor = GetUIColor(COLOR_SEL_GIZMOS)

The color of the gizmo when unselected.

Point3& selColor = GetSubSelColor()

The color of the gizmo when selected.

Implements ISimpleManipulator.

AppendMarker()

ManipExport void AppendMarker ( MarkerType  markerType, Point3 &  position, DWORD  flags, const Point3 &  unselColor, const Point3 &  selColor = ColorMan() ->GetColorAsPoint3(kManipulatorsSelected)  )

virtual

Remarks

Implemented by the system.

This method adds a new Marker to the manipulator. The shape is defined in the local coordinates of the node that owns the manipulator.

Parameters:

MarkerType markerType

The marker type for marker gizmos. See the MarkerType enum.

Point3& position

The position of the marker.

DWORD flags = 0

The flags can have one or more of the following values:

kGizmoDontDisplay;

Tells the gizmo not to display. It will still hit test it.

kGizmoDontHitTest;

Tells the gizmo not to hit test. It will still display.

kGizmoScaleToViewport;

Tells the gizmo to scale itself to have a constant size in the viewport. In this case, the system uses the ManipulatorGizmo::mGizmoSize to determine how big the manipulator should be. It interprets mGizmoSize as pixels it this case. This flag only applies to mesh gizmo currently.

Point3& unselColor = GetUIColor(COLOR_SEL_GIZMOS)

The color of the gizmo when unselected.

Point3& selColor = GetSubSelColor()

The color of the gizmo when selected.

Implements ISimpleManipulator.

AppendText()

ManipExport void AppendText ( const MCHAR *  pText, Point3 &  position, DWORD  flags, const Point3 &  unselColor, const Point3 &  selColor = ColorMan() ->GetColorAsPoint3(kManipulatorsSelected)  )

virtual

Remarks

Implemented by the system.

This method adds a new Text to the manipulator. The shape is defined in the local coordinates of the node that owns the manipulator.

Parameters:

MCHAR* pText

The text string to add.

Point3& position

The position of the text.

DWORD flags = 0

The flags can have one or more of the following values:

kGizmoDontDisplay;

Tells the gizmo not to display. It will still hit test it.

kGizmoDontHitTest;

Tells the gizmo not to hit test. It will still display.

kGizmoScaleToViewport;

Tells the gizmo to scale itself to have a constant size in the viewport. In this case, the system uses the ManipulatorGizmo::mGizmoSize to determine how big the manipulator should be. It interprets mGizmoSize as pixels it this case. This flag only applies to mesh gizmo currently.

Point3& unselColor = GetUIColor(COLOR_SEL_GIZMOS)

The color of the gizmo when unselected.

Point3& selColor = GetSubSelColor()

The color of the gizmo when selected.

Implements ISimpleManipulator.

GetManipName()

ManipExport MSTR& GetManipName ( )

inlinevirtual

Remarks

Implemented by the system.

This method returns the manipulator name.

Implements Manipulator.

{return mToolTip; }

SetGizmoScale()

ManipExport void SetGizmoScale ( float  gizmoScale )

inline

Remarks

Implemented by the system.

This method allows you to set the scale of the gizmo.

Parameters:

float gizmoScale

The scale factor.

{ mGizmoScale = gizmoScale; }

GetToolTip()

ManipExport MSTR& GetToolTip ( )

inline

Remarks

Implemented by the system.

This method returns the tooltip string. Used internally.

Default Implementation:

{ return mToolTip; }

{ return mToolTip; }

SetToolTipWnd()

ManipExport void SetToolTipWnd ( HWND  hWnd )

inline

Remarks

Implemented by the system.

Used internally.

{ mToolTipWnd = hWnd; }

SetToolTipTimer()

ManipExport void SetToolTipTimer ( UINT  timer )

inline

Remarks

Implemented by the system.

Used internally.

{ mToolTipTimer = timer; }

GetToolTipTimer()

ManipExport UINT GetToolTipTimer ( )

inline

Remarks

Implemented by the system.

Used internally.

{ return mToolTipTimer; }

GetToolTipWnd()

ManipExport HWND GetToolTipWnd ( )

inline

Remarks

Implemented by the system.

Used internally.

{ return mToolTipWnd; }

GetPBlock()

ManipExport IParamBlock2* GetPBlock ( )

inline

Remarks

Implemented by the system.

This method returns a pointer to the parameter block.

Default Implementation:

{ return mpPblock; }

These must be implemented in the sub-class of SimpleManipulator

{ return mpPblock; }

UpdateShapes()

virtual void UpdateShapes ( TimeValue  t, MSTR &  toolTip  )

pure virtual

Remarks

This method gets called whenever the manipulator needs to update its gizmos. This is implemented by the manipulator to create the gizmos based on the current state of the node being manipulated.

Parameters:

TimeValue t

The time at which to update the shape.

MSTR& toolTip

The tool tip text to update.

Implements ISimpleManipulator.

Implemented in MSSimpleManipulatorXtnd, and MSPluginSimpleManipulator.

ManipulatorSelected()

virtual ManipExport void ManipulatorSelected ( )

inlinevirtual

Remarks

Implemented by the system.

Used internally.

Default Implementation:

{}

{};

SetManipTarget()

ManipExport void SetManipTarget

(

RefTargetHandle

hTarg

)

Remarks

Implemented by the system.

This tells the SimpleManipulator to make a reference to hTarg. This is normally called in the contructor of a manipulator to set a reference to whatever is being manipulated.

Parameters:

RefTargetHandle hTarg

The handle to the reference target.

GetManipTarget()

ManipExport RefTargetHandle GetManipTarget ( )

inline

Remarks

This method returns the handle to the manipulator reference target.

Default Implementation:

{ return mhTarget; }

{ return mhTarget; }

SetMouseState()

ManipExport void SetMouseState ( MouseState  state )

inline

Remarks

This method sets the state of the mouse.

Parameters:

MouseState state

One of the following values:

kMouseIdle

The mouse is idle, manipulator not active and the mouse is not over it.

kMouseDragging

The mouse is currently dragging the manipulator.

kMouseOverManip

The mouse is over the manipulator, but it is not being dragged.

Default Implementation:

{ mState = state; }

{ mState = state; }

GetMouseState()

ManipExport MouseState GetMouseState ( )

inlinevirtual

Remarks

Implemented by the system.

This method returns the state of the mouse, which is one of the following values: kMouseIdle, kMouseDragging, or kMouseOverManip.

Default Implementation:

{ return mState; }

Implements ISimpleManipulator.

{ return mState; }

OnButtonDown()

ManipExport void OnButtonDown ( TimeValue  t, ViewExp *  pVpt, IPoint2 &  m, DWORD  flags, ManipHitData *  pHitData  )

virtual

Remarks

Implemented by the system.

This method gets called when the mouse buttons is pressed within the manipulator context. Used internally.

Parameters:

TimeValue t

The time to display the object.

ViewExp* pVpt

An interface that may be used to call methods associated with the viewports.

IPoint2& m

The location of the tooltip.

DWORD flags

Not used, should be set to 0.

ManipHitData* pHitData

A pointer to the hitdata containing information on which manipulator was hit.

Reimplemented from Manipulator.

Reimplemented in MSSimpleManipulatorXtnd, and MSPluginSimpleManipulator.

OnMouseMove()

ManipExport void OnMouseMove ( TimeValue  t, ViewExp *  pVpt, IPoint2 &  m, DWORD  flags, ManipHitData *  pHitData  )

virtual

Remarks

This method gets called when the mouse is pressed down and moves within the manipulator context. It is the method that does the actual manipulator. It is up to the manipulator code to turn the mouse position into a new value for the parameter(s) being manipulated. It also updates the tooltip with the current value of the parameter.

Parameters:

TimeValue t

The time to display the object.

ViewExp* pVpt

An interface that may be used to call methods associated with the viewports.

IPoint2& m

The location of the tooltip.

DWORD flags

Not used, should be set to 0.

ManipHitData* pHitData

A pointer to the hitdata containing information on which manipulator was hit.

Reimplemented from Manipulator.

Reimplemented in MSSimpleManipulatorXtnd, and MSPluginSimpleManipulator.

OnButtonUp()

ManipExport void OnButtonUp ( TimeValue  t, ViewExp *  pVpt, IPoint2 &  m, DWORD  flags, ManipHitData *  pHitData  )

virtual

Remarks

Implemented by the system.

This method gets called when the mouse buttons is released within the manipulator context. Used internally.

Parameters:

TimeValue t

The time to display the object.

ViewExp* pVpt

An interface that may be used to call methods associated with the viewports.

IPoint2& m

The location of the tooltip.

DWORD flags

Not used, should be set to 0.

ManipHitData* pHitData

A pointer to the hitdata containing information on which manipulator was hit.

Reimplemented from Manipulator.

Reimplemented in MSSimpleManipulatorXtnd, and MSPluginSimpleManipulator.

MouseEntersObject()

ManipExport DisplayState MouseEntersObject ( TimeValue  t, ViewExp *  pVpt, IPoint2 &  m, ManipHitData *  pHitData  )

virtual

Remarks

Implemented by the system.

This method gets called when the mouse enters the manipulator object. Used interlally.

Parameters:

TimeValue t

The time to display the object.

ViewExp* pVpt

An interface that may be used to call methods associated with the viewports.

IPoint2& m

The location of the tooltip.

ManipHitData* pHitData

A pointer to the hitdata containing information on which manipulator was hit.

Returns

The display state indicating whether no redraw, a full redraw, or a post redraw is needed.

Reimplemented from Manipulator.

MouseLeavesObject()

ManipExport DisplayState MouseLeavesObject ( TimeValue  t, ViewExp *  pVpt, IPoint2 &  m, ManipHitData *  pHitData  )

virtual

Remarks

Implemented by the system.

This method gets called when the mouse leaves the manipulator object. Used internally.

Parameters:

TimeValue t

The time to display the object.

ViewExp* pVpt

An interface that may be used to call methods associated with the viewports.

IPoint2& m

The location of the tooltip.

ManipHitData* pHitData

A pointer to the hitdata containing information on which manipulator was hit.

Returns

The display state indicating whether no redraw, a full redraw, or a post redraw is needed.

Reimplemented from Manipulator.

GetTipPos()

ManipExport IPoint2& GetTipPos ( )

inline

Remarks

Implemented by the system.

This method returns the position of the tooltip. Used internally.

Default Implementation:

{ return mToolTipPos; }

{ return mToolTipPos; }

GetLocalViewRay()

ManipExport void GetLocalViewRay ( ViewExp *  pVpt, IPoint2 &  m, Ray &  viewRay  )

virtual

Remarks

This method is normally called from a manipualtor's OnMouseMove method. It computes a ray that passes through the given mouse point in the given viewport. The result is in the local coordinates of the node owning the manipulator.

Parameters:

ViewExp* pVpt

An interface that may be used to call methods associated with the viewports.

IPoint2& m

The screen coordinate.

Ray& viewRay

The returned local view ray.

Implements ISimpleManipulator.

Invalidate()

ManipExport void Invalidate ( )

inline

Remarks

This method invalidates the validity interval.

Default Implementation:

{ mValid = NEVER; }

{ mValid = NEVER; }

UseSelectionBrackets()

BOOL UseSelectionBrackets ( )

inlinevirtual

This method allows an object to choose whether or not it will display selection brackets in shaded viewports.

The method will return FALSE if no selection brackets are displayed or TRUE if it does display selection brackets.

Reimplemented from Object.

{ return FALSE; }

UnRegisterViewChange()

ManipExport void UnRegisterViewChange

(

BOOL

fromDelete = FALSE

)

Remarks

This method unregisters the notifications so changes in the view are no longer registered.

RegisterViewChange()

void RegisterViewChange

(

)

SetResettingFlag()

void SetResettingFlag ( BOOL  val )

inline

Remarks

Used internally.

{ mResetting = val; }

GetResettingFlag()

BOOL GetResettingFlag ( )

inline

Remarks

Used internally.

{ return mResetting; }

KillToolTip()

ManipExport void KillToolTip

(

)

Remarks

This method will destroy the tooltip and its timer and cleans up.

GetUnselectedColor()

ManipExport Point3 GetUnselectedColor

(

)

Remarks

This method returns the color of the gizmo when unselected.

ActiveViewOnly()

ManipExport BOOL ActiveViewOnly ( )

inline

{ return mActiveViewOnly; }

GetNumberGizmos()

ManipExport int GetNumberGizmos

(

)

Remarks

This method returns the number of gizmos defined.

GetGizmo()

ManipExport ManipulatorGizmo* GetGizmo

(

int

i

)

Remarks

This method returns the specified gizmo.

Member Data Documentation

kNoneSelected

ManipExport const int kNoneSelected

static

mDispSelectedIndex

int mDispSelectedIndex

protected

mToolTip

MSTR mToolTip

protected

mGizmoScale

float mGizmoScale

protected

mpPblock

IParamBlock2* mpPblock

protected

mValid

Interval mValid

protected

mhTarget

RefTargetHandle mhTarget

protected

mState

MouseState mState

protected

mActiveViewOnly

BOOL mActiveViewOnly

protected

mResetting

BOOL mResetting

protected