#include <iskin.h>

Class Description

See also: Class ReferenceTarget, Class ClassDesc2, Class IgizmoBuffer, Hit Test of zoom in direction used in customized zoom mode., Hit Test Flags, Class HitRecord, Class SubObjAxisCallback, Class Sub-Object Coordinate Systems

Description:: This is a simple reference class for plugin gizmos for the skin modifier. This allows developers to create plugin deformers for skin. This class is of super object type REFTARGET and must use the category BonesDefGizmoDeformer for skin to detect it.

If the client of GizmoClass 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 GizmoClass methods when 'i' refers to the parameters maintained by GizmoClass.

Data Members:: Class_ID cid;

The Class ID of the gizmo.

ISkin *bonesMod;

The pointer back to the skin modifier so the gizmo can ask for basic information about the modifier.

IParamBlock2 *pblock_gizmo_data;

The param block provided for the gizmo to store its data.

Inheritance diagram for GizmoClass:

Public Member Functions
	GizmoClass ()

int	NumParamBlocks ()

IParamBlock2 *	GetParamBlock (int i)

IParamBlock2 *	GetParamBlockByID (BlockID id)

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

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

void	DeleteThis ()=0

int	NumSubs ()

Animatable *	SubAnim (int i)

MSTR	SubAnimName (int i)

int	SubNumToRefNum (int subNum)

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

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

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

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

virtual IOResult	Save (ISave *isave)
	Called for saving data. More...

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

virtual int	Display (TimeValue t, GraphicsWindow *gw, Matrix3 tm)

virtual Interval	LocalValidity (TimeValue t)

virtual BOOL	IsEnabled ()

virtual BOOL	IsVolumeBased ()

virtual BOOL	IsInVolume (Point3 p, Matrix3 tm)

virtual Point3	DeformPoint (TimeValue t, int index, Point3 initialP, Point3 p, Matrix3 tm)

virtual void	SetInitialName ()

virtual const MCHAR *	GetName ()

virtual void	SetName (const MCHAR *name)

virtual BOOL	InitialCreation (int count, Point3 p, int numbeOfInstances, int mapTable)

virtual void	PreDeformSetup (TimeValue t)

virtual void	PostDeformSetup (TimeValue t)

virtual IGizmoBuffer *	CopyToBuffer ()

virtual void	PasteFromBuffer (IGizmoBuffer *buffer)

virtual void	Enable (BOOL enable)

virtual BOOL	IsEditing ()

virtual void	EndEditing ()

virtual void	EnableEditing (BOOL enable)

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

virtual void	SelectSubComponent (HitRecord *hitRec, BOOL selected, BOOL all, BOOL invert=FALSE)

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

virtual void	GetSubObjectCenters (SubObjAxisCallback cb, TimeValue t, INode node, Matrix3 tm)

virtual void	GetSubObjectTMs (SubObjAxisCallback cb, TimeValue t, INode node, Matrix3 tm)

virtual void	ClearSelection (int selLevel)

virtual void	SelectAll (int selLevel)

virtual void	InvertSelection (int selLevel)

Public Member Functions inherited from ReferenceTarget
virtual CoreExport void	GetClassName (MSTR &s)
	Retrieves the (localizable) name of the plugin class. More...

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

virtual BOOL	IsRefTarget ()
	Checks if this is a ReferenceTarget. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

CoreExport	ReferenceTarget ()
	Constructor. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

CoreExport bool	EnumRefHierarchy (RefEnumProc &proc, bool includeCustAttribs=true, bool includeIndirectRefs=true, bool includeNonPersistentRefs=true, bool preventDuplicatesViaFlag=true)
	This method provides a general purpose reference enumerator. More...

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

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

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

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

CoreExport	ReferenceMaker ()
	Constructor. More...

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

Public Member Functions inherited from Animatable
virtual void	FreeCaches ()

virtual int	NumChildren ()

virtual Animatable *	ChildAnim (int i)

virtual CoreExport MSTR	NodeName ()

virtual void	EditTrack ()

virtual CoreExport BOOL	SubAnimSetKeyBufferPresent (int subNum)
	returns true if the sub-anim has a "Set Key" buffer present More...

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

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

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

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

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

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

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

virtual bool	GetMacroRecorderName (bool used_as_rhs_value, MSTR &objectSpecifiedName)
	This method is called to access the object specified name to use for the Maxscript macrorecorder. More...

CoreExport	Animatable ()
	Constructor. More...

MSTR	ClassName () 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 BOOL	CanDeleteSubAnim (int i)

virtual void	DeleteSubAnim (int i)

virtual DWORD	GetSubAnimCurveColor (int subNum)

virtual BOOL	CanCopyAnim ()

CoreExport int	HasSubElements (int type=0)

virtual int	GetSubFCurveExtents (int subNum, ParamDimensionBase *dim, float &min, float &max, DWORD flags)
	The values max and min should be initialized before calling this function. More...

virtual ParamDimension *	GetParamDimension (int i)

virtual BOOL	SelectSubAnim (int subNum)

virtual BOOL	BypassTreeView ()

virtual BOOL	BypassTrackBar ()

virtual BOOL	BypassPropertyLevel ()

virtual BOOL	InvisibleProperty ()

virtual int	NumKeys ()

virtual TimeValue	GetKeyTime (int index)

virtual int	GetKeyIndex (TimeValue t)

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

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

virtual void	DeleteKeyAtTime (TimeValue t)

virtual BOOL	IsKeyAtTime (TimeValue t, DWORD flags)

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

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

CoreExport void	OpenTreeEntry (int type, DWORD tv)

CoreExport void	CloseTreeEntry (int type, DWORD tv)

CoreExport int	IsTreeEntryOpen (int type, DWORD tv)

CoreExport BOOL	GetSelInTrackView (DWORD tv)

CoreExport void	SetSelInTrackView (DWORD tv, BOOL sel)

CoreExport BOOL	InTrackViewSelSet (int which)

CoreExport void	SetTrackViewSelSet (int which, BOOL inOut)

virtual BOOL	AssignController (Animatable *control, int subAnim)

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

virtual BOOL	CanMakeUnique ()

CoreExport int	EnumAnimTree (AnimEnum animEnum, Animatable client, int subNum)

virtual int	RenderBegin (TimeValue t, ULONG flags=0)

virtual int	RenderEnd (TimeValue t)

virtual CoreExport Interval	GetTimeRange (DWORD flags)

virtual void	EditTimeRange (Interval range, DWORD flags)

virtual void	DeleteTime (Interval iv, DWORD flags)

virtual void	ReverseTime (Interval iv, DWORD flags)

virtual void	ScaleTime (Interval iv, float s)

virtual void	InsertTime (TimeValue ins, TimeValue amount)

virtual BOOL	SupportTimeOperations ()

virtual CoreExport void	MapKeys (TimeMap *map, DWORD flags)

virtual void	DeleteKeys (DWORD flags)

virtual void	DeleteKeyByIndex (int index)

virtual void	SelectKeys (TrackHitTab &sel, DWORD flags)

virtual void	SelectSubKeys (int subNum, TrackHitTab &sel, DWORD flags)

virtual void	SelectSubCurve (int subNum, BOOL sel)

virtual void	SelectKeyByIndex (int i, BOOL sel)

virtual BOOL	IsKeySelected (int i)

virtual void	FlagKey (TrackHitRecord hit)

virtual int	GetFlagKeyIndex ()

virtual int	NumSelKeys ()

virtual void	CloneSelectedKeys (BOOL offset=FALSE)

virtual void	AddNewKey (TimeValue t, DWORD flags)

virtual void	MoveKeys (ParamDimensionBase *dim, float delta, DWORD flags)

virtual void	ScaleKeyValues (ParamDimensionBase *dim, float origin, float scale, DWORD flags)

virtual void	SelectCurve (BOOL sel)

virtual BOOL	IsCurveSelected ()
	Returns TRUE if the function curve is selected; otherwise returns FALSE. More...

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

virtual int	GetSelKeyCoords (TimeValue &t, float &val, DWORD flags)

virtual void	SetSelKeyCoords (TimeValue t, float val, DWORD flags)

virtual int	SetSelKeyCoordsExpr (ParamDimension dim, const MCHAR timeExpr, const MCHAR *valExpr, DWORD flags)

virtual void	AdjustTangents (TrackHitRecord hit, ParamDimensionBase *dim, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, int dx, int dy, DWORD flags)

virtual void	AdjustTangents (TrackHitRecord hit, ParamDimensionBase *dim, float angle, float length, DWORD flags)

virtual CoreExport BOOL	IsAnimated ()

virtual BOOL	CanCopyTrack (Interval iv, DWORD flags)

virtual BOOL	CanPasteTrack (TrackClipObject *cobj, Interval iv, DWORD flags)

virtual TrackClipObject *	CopyTrack (Interval iv, DWORD flags)

virtual void	PasteTrack (TrackClipObject *cobj, Interval iv, DWORD flags)

virtual BOOL	CanCopySubTrack (int subNum, Interval iv, DWORD flags)

virtual BOOL	CanPasteSubTrack (int subNum, TrackClipObject *cobj, Interval iv, DWORD flags)

virtual TrackClipObject *	CopySubTrack (int subNum, Interval iv, DWORD flags)

virtual void	PasteSubTrack (int subNum, TrackClipObject *cobj, Interval iv, DWORD flags)

virtual int	GetTrackVSpace (int lineHeight)

virtual int	HitTestTrack (TrackHitTab &hits, Rect &rcHit, Rect &rcTrack, float zoom, int scroll, DWORD flags)

virtual int	PaintTrack (ParamDimensionBase *dim, HDC hdc, Rect &rcTrack, Rect &rcPaint, float zoom, int scroll, DWORD flags)

virtual int	PaintSubTrack (int subNum, ParamDimensionBase *dim, HDC hdc, Rect &rcTrack, Rect &rcPaint, float zoom, int scroll, DWORD flags)

virtual int	PaintFCurves (ParamDimensionBase *dim, HDC hdc, Rect &rcGraph, Rect &rcPaint, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)

virtual int	HitTestFCurves (ParamDimensionBase *dim, TrackHitTab &hits, Rect &rcHit, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)

virtual int	PaintSubFCurves (int subNum, ParamDimensionBase *dim, HDC hdc, Rect &rcGraph, Rect &rcPaint, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)

virtual int	HitTestSubFCurves (int subNum, ParamDimensionBase *dim, TrackHitTab &hits, Rect &rcHit, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)

virtual void	EditTrackParams (TimeValue t, ParamDimensionBase dim, const MCHAR pname, HWND hParent, IObjParam *ip, DWORD flags)

virtual int	TrackParamsType ()

virtual int	GetFCurveExtents (ParamDimensionBase *dim, float &min, float &max, DWORD flags)
	This method is called to calculate the largest and smallest values of the anim. More...

CoreExport void	AddNoteTrack (NoteTrack *note)

CoreExport void	DeleteNoteTrack (NoteTrack *note, BOOL delNote=TRUE)

CoreExport BOOL	HasNoteTracks ()

CoreExport int	NumNoteTracks ()

CoreExport NoteTrack *	GetNoteTrack (int i)

virtual void	FreeAllBitmaps ()

virtual void	GetSystemNodes (INodeTab &nodes, SysNodeContext Context)

virtual BOOL	IsSubClassOf (Class_ID classID)
	returns true if the animatable has sub-classed off the given class More...

virtual CoreExport void	MouseCycleCompleted (TimeValue t)

virtual CoreExport void	MouseCycleStarted (TimeValue t)

CoreExport bool	SvSaveData (ISave *isave, USHORT id)

CoreExport bool	SvLoadData (ILoad *iLoad)

CoreExport DWORD	SvGetRefIndex ()

CoreExport void	SvSetRefIndex (DWORD i)

CoreExport bool	SvDeleteRefIndex ()

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

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

virtual CoreExport bool	SvCanInitiateLink (IGraphObjectManager gom, IGraphNode gNode)

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

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

virtual CoreExport bool	SvCanSetName (IGraphObjectManager gom, IGraphNode gNode)

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

virtual CoreExport bool	SvCanRemoveThis (IGraphObjectManager gom, IGraphNode gNode)

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

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

virtual CoreExport bool	SvIsHighlighted (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport COLORREF	SvHighlightColor (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport COLORREF	SvGetSwatchColor (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport bool	SvIsInactive (IGraphObjectManager gom, IGraphNode gNode)

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

virtual CoreExport bool	SvHandleDoubleClick (IGraphObjectManager gom, IGraphNode gNode)

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

virtual CoreExport bool	SvCanSelect (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport bool	SvEditProperties (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport MSTR	SvGetTip (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport MSTR	SvGetRefTip (IGraphObjectManager gom, IGraphNode gNode, IGraphNode *gNodeMaker)

virtual CoreExport bool	SvCanDetach (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport bool	SvDetach (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport MSTR	SvGetRelTip (IGraphObjectManager gom, IGraphNode gNodeTarget, int id, IGraphNode *gNodeMaker)
	Returns a string to be displayed in the tip window in the schematic view for a relationship from "gNodeMaker" to "gNodeTarget"... More...

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

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

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

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

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

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

void	SetAFlag (DWORD mask)

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

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

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

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

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

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

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

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

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

Public Attributes
ISkin *	bonesMod

IParamBlock2 *	pblock_gizmo_data

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

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

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

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

void	BlockEval ()

void	UnblockEval ()

int	Evaluating ()

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

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

Protected Member Functions inherited from Noncopyable
	Noncopyable ()

	~Noncopyable ()

Additional Inherited Members
Static Public Member Functions inherited from 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 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...

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

Protected Attributes inherited from Animatable
DWORD	aflag

AnimPropertyList	aprops

Constructor & Destructor Documentation

GizmoClass ( )

inline

510 { pblock_gizmo_data = NULL; bonesMod = NULL; }

GizmoClass::bonesMod

ISkin * bonesMod

Definition: iskin.h:507

NULL

#define NULL

Definition: autoptr.h:18

GizmoClass::pblock_gizmo_data

IParamBlock2 * pblock_gizmo_data

Definition: iskin.h:508

Member Function Documentation

int NumParamBlocks ( )

inlinevirtual

Remarks: This method returns the number of parameter blocks.

Default Implementation:: { return 1; }

Reimplemented from Animatable.

514 { return 1; }

IParamBlock2* GetParamBlock ( int i )

inlinevirtual

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

Parameters:: int i

The zero based index of the ParamBlock2 to return.

Reimplemented from Animatable.

                 {
                 if (i == 0) return pblock_gizmo_data;
                 else return NULL;
                 }

IParamBlock2* GetParamBlockByID ( BlockID id )

inlinevirtual

Remarks: This method returns a pointer to the ParamBlock2 as specified by the ID passed (or NULL if not available).

Parameters:: BlockID id

The BlockID of the ParamBlock2 instance.

Reimplemented from Animatable.

                 {
                 if (pblock_gizmo_data->ID() == id) return pblock_gizmo_data ;
                  else return  NULL; 
                  }

int NumRefs ( )

inlinevirtual

Returns the total number of references this ReferenceMaker can hold.

The plugin implements this method to indicate the total number of of references it can make. This includes all references whether they are NULL (inactive) or non-NULL (active) at the time when this method is called. A plugin can hold a variable number of references, thus the return value of this method is not to be cached and reused by client code.

Returns: The total number of references this plugin can hold. The default implementation is return 0.

Reimplemented from ReferenceMaker.

536 {return 1;}

RefTargetHandle GetReference ( int i )

inlinevirtual

Returns the 'i-th' reference.

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

Parameters

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

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

Reimplemented from ReferenceMaker.

         {
         if (i==0)
             {
             return (RefTargetHandle)pblock_gizmo_data;
             }
         return NULL;
         }

virtual void SetReference	(	int	i,
		RefTargetHandle	rtarg
	)

inlineprotectedvirtual

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

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

Parameters

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

Reimplemented from ReferenceMaker.

         {
         if (i==0)
             {
             pblock_gizmo_data = (IParamBlock2*)rtarg;
             }
         }

void DeleteThis ( )

pure virtual

Remarks: Self deletion.

Reimplemented from Animatable.

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.

559 {return 1;}

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.

560 { return GetReference(i);}

GizmoClass::GetReference

RefTargetHandle GetReference(int i)

Returns the 'i-th' reference.

Definition: iskin.h:537

MSTR SubAnimName ( int i )

inlinevirtual

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

Returns: The name of the 'i-th' parameter.

Reimplemented from Animatable.

563 {return _M(""); }

_M

#define _M(x)

Used to wrap string literals.

Definition: strbasic.h:67

int SubNumToRefNum ( int subNum )

inlinevirtual

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

Parameters

subNum The anim index to return the corresponding reference index of.

Default Implementation:: { return -1}

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

Reimplemented from Animatable.

565 {return -1;}

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

inlinevirtual

Receives and responds to messages.

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

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

Parameters

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

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

Implements ReferenceMaker.

         {
         return REF_SUCCEED;
         }

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

inlinevirtual

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.

573 {}

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

inlinevirtual

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.

574 {}

virtual IOResult Load ( ILoad * iload )

inlinevirtual

Called for loading data.

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

Parameters

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

Returns

The default implementation is return IO_OK.

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

Reimplemented from ReferenceMaker.

575 {return IO_OK;}

IO_OK

The result was acceptable - no errors.

Definition: maxtypes.h:273

virtual IOResult Save ( ISave * isave )

inlinevirtual

Called for saving data.

Called by the system to allow the plugin to save its data.

Parameters

isave - This pointer may be used to call methods to write data to disk. See the section on Loading and Saving Plug-in Data for an overview of the load/save process.

Returns

The default implementation is return IO_OK.

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

Reimplemented from ReferenceMaker.

576 {return IO_OK;}

IO_OK

The result was acceptable - no errors.

Definition: maxtypes.h:273

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

inlinevirtual

581 {}

virtual int Display	(	TimeValue	t,
		GraphicsWindow *	gw,
		Matrix3	tm
	)

inlinevirtual

583 { return 1;}

virtual Interval LocalValidity ( TimeValue t )

inlinevirtual

584 {return FOREVER;}

FOREVER

#define FOREVER

Definition: interval.h:168

virtual BOOL IsEnabled ( )

inlinevirtual

Remarks: This method returns whether or not this gizmo is active or not.

Default Implementation:: { return TRUE; }

588 { return TRUE; }

virtual BOOL IsVolumeBased ( )

inlinevirtual

Remarks: This method returns whether or not this gizmo is volume based or not. If it is volume based IsInVolume is used to check to see if a point is deformed otherwise a tab list of points is used to determine if a point is affected.

Default Implementation:: { return FALSE; }

594 {return FALSE;}

virtual BOOL IsInVolume	(	Point3	p,
		Matrix3	tm
	)

inlinevirtual

Remarks: If IsVolumBased returns TRUE his function is called to determine if the point is deformed.

Parameters:: Point3 p

The point to be checked in the skinned objects local space.

Matrix3 tm

This matrix will transform the point into world space.

Default Implementation:: { return FALSE; }

604 { return FALSE;}

virtual Point3 DeformPoint	(	TimeValue	t,
		int	index,
		Point3	initialP,
		Point3	p,
		Matrix3	tm
	)

inlinevirtual

Remarks: This method does the actual deformation of the points. Both initial and current point positions are passed in so the deformer has a chance to start from scratch minus the weighted transformation deformation. For instance a joint lattice deformer would want to work with the initial position while a bulge deformer would use the current point position.

Parameters:: TimeValue t

The time of the modification.

int index

Te index of the point into the object.

Point3 initialP

The initial position of the point.

Point3 p

The current deformed position of the point.

Matrix3 tm

The matrix to convert p and initialP into world space.

Default Implementation:: { return p; }

627 {return p;}

virtual void SetInitialName ( )

inlinevirtual

Remarks: This method is called to let the gizmo name it self after creation.

Default Implementation:: { }

632 {}

virtual const MCHAR* GetName ( )

inlinevirtual

Remarks: This method returns the name of he gizmo.

Default Implementation:: { return NULL; }

637 {return NULL;}

NULL

#define NULL

Definition: autoptr.h:18

virtual void SetName ( const MCHAR * name )

inlinevirtual

Remarks: This method sets the name of the gizmo.

Parameters:: THCAR *name

The name to set the gizmo to.

Default Implementation:: { }

645 {}

virtual BOOL InitialCreation	(	int	count,
		Point3 *	p,
		int	numbeOfInstances,
		int *	mapTable
	)

inlinevirtual

Remarks: This method is called when the gizmo is created. A list of points that where selected are passed in world space coordinates. This allows the gizmo to setup whatever initial parameters are needed when it is created. This should return TRUE if it was successful, else FALSE.

Parameters:: int count

The number of points that are to be affected.

Point3 *p

The list of points that where selected when the gizmo was created in world space.

int numbeOfInstances

The number of times that the modifier has been instanced.

int *mapTable

An index list of back into the original point list for the object for *p. This is used so the gizmo can map the points back into the original point list from the object so you can figure out later on where the points are.

Default Implementation:: { return TRUE; }

672 { return TRUE;}

virtual void PreDeformSetup ( TimeValue t )

inlinevirtual

Remarks: This method is called before the actual deformation loop to allow the plug-in to create any temporary data it may need.

Parameters:: TimeValue t

The time of the modification.

Default Implementation:: { }

682 {}

virtual void PostDeformSetup ( TimeValue t )

inlinevirtual

Remarks: This method is called after the actual deformation loop to allow the plug-in to create any temporary data it may need.

Parameters:: TimeValue t

The time of the modification.

Default Implementation:: { }

690 {}

virtual IGizmoBuffer* CopyToBuffer ( )

inlinevirtual

Remarks: This method will ask the plugin to create a copy buffer of its current parameters. The plugin needs to allocate the memory for this buffer. The skin modifier will take care of the destruction of this memory.

Default Implementation:: { return NULL; }

697 { return NULL;}

NULL

#define NULL

Definition: autoptr.h:18

virtual void PasteFromBuffer ( IGizmoBuffer * buffer )

inlinevirtual

Remarks: This method is called when the user paste data to the gizmo. The gizmo needs to cast his pointer into its copy class and the use the data to paste into it.

Parameters:: IGizmoBuffer *buffer

The buffer to paste from.

Default Implementation:: { }

706 {}

virtual void Enable ( BOOL enable )

inlinevirtual

Remarks: This sets the current to gizmo to be enabled or disabled.

Parameters:: BOOL enable

TRUE to enable; FALSE to disable.

Default Implementation:: { }

714 {}

virtual BOOL IsEditing ( )

inlinevirtual

Remarks: This method returns whether the user is in the edit mode for the gizmo. When this is TRUE the gizmo will get its HitTest, SelectSubComponents, Move, SetSubObjectCenters, SetObjectTMs, ClearSelection, SelectAll, and InvertSelections will be passed from skin to the gizmo.

Default Implementation:: { return FALSE; }

721 { return FALSE;}

virtual void EndEditing ( )

inlinevirtual

Remarks: This is called when the system wants the gizmo to stop editing.

Default Implementation:: { }

725 {}

virtual void EnableEditing ( BOOL enable )

inlinevirtual

Remarks: When the skin modifier wants the gizmo to disable any controls that are not used outside the sub object mode this function is called. This gives the gizmo a chance to disable/hide any UI elements that it does not want the user to manipulate when out of the subobject mode.

Parameters:: BOOL enable

TRUE to enable; FALSE to disable.

Default Implementation:: { }

735 {}

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

inlinevirtual

Remarks: This method is called to determine if the specified screen point intersects the item. The method returns nonzero if the item was hit; otherwise 0. This method differs from its BaseObject version in that this is based a TM which is the matrix that transfroms the skin modifier into world space.

Parameters:: TimeValue t

The time to perform the hit test.

INode* inode

A pointer to the node to test.

int type

The type of hit testing to perform. See Scene and Node Hit Test Types. for details.

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

IPoint2 *p

The screen point to test.

ViewExp *vpt

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

ModContext* mc

A pointer to the modifier context.

Matrix3 tm

The transform matrix to transform the skin into world space.

Returns: Nonzero if the item was hit; otherwise 0.

Default Implementation:: { return 0; }

765 {return 0;}

virtual void SelectSubComponent	(	HitRecord *	hitRec,
		BOOL	selected,
		BOOL	all,
		BOOL	invert = `FALSE`
	)

inlinevirtual

Remarks: This method is called to change the selection state of the component identified by hitRec.

Parameters:: HitRecord *hitRec

Identifies the component whose selected state should be set. See Class HitRecord .

BOOL selected

TRUE if the item should be selected; FALSE if the item should be de-selected.

BOOL all

TRUE if all components in the HitRecord chain should be selected; FALSE if only the top-level HitRecord should be selected. (A HitRecord contains a Next() pointer; typically you want to do whatever you're doing to all the Next()'s until Next() returns NULL).

BOOL invert=FALSE

This is set to TRUE when all is also set to TRUE and the user is holding down the Shift key while region selecting in select mode. This indicates the items hit in the region should have their selection state inverted.

Default Implementation:: { }

787 {}

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

inlinevirtual

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

Parameters:: TimeValue t

The time of the transformation.

Matrix3& partm

The 'parent' transformation matrix. This matrix represents a transformation that would take points in the modifier's space and convert them into world space points. This is constructed as the node's transformation matrix times the inverse of the ModContext's transformation matrix. The node whose transformation is used is the node the user clicked on in the scene - modifiers can be instanced so there could be more than one node.

Matrix3& tmAxis

The matrix that represents the axis system. This is the space in which the transformation is taking place.

Point3& val

This value is a vector with X, Y, and Z representing the movement along each axis.

Matrix3 tm

The transform matrix.

BOOL localOrigin=FALSE

When TRUE the transformation is occurring about the sub-object's local origin.

Default Implementation:: { }

813 {}

virtual void GetSubObjectCenters	(	SubObjAxisCallback *	cb,
		TimeValue	t,
		INode *	node,
		Matrix3	tm
	)

inlinevirtual

Remarks: When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis. This method specifies the position of the center. The plug-in enumerates its centers and calls the callback cb once for each. This method differs from its BaseObject version in that this is based a TM which is the matrix that transfroms the skin modifier into world space.

Parameters:: SubObjAxisCallback *cb

The callback object whose methods may be called. See Class SubObjAxisCallback.

TimeValue t

The time to enumerate the centers.

INode *node

A pointer to the node.

Matrix3 tm

The transform matrix to transform the skin into world space.

Default Implementation:: { }

833 {}

virtual void GetSubObjectTMs	(	SubObjAxisCallback *	cb,
		TimeValue	t,
		INode *	node,
		Matrix3	tm
	)

inlinevirtual

Remarks: When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis. This method returns the axis system of the reference coordinate system. The plug-in enumerates its TMs and calls the callback cb once for each. See Sub-Object Coordinate Systems. This method differs from its BaseObject version in that this is based a TM which is the matrix that transfroms the skin modifier into world space.

Parameters:: SubObjAxisCallback *cb

The callback object whose methods may be called.

TimeValue t

The time to enumerate the TMs.

INode *node

A pointer to the node.

Matrix3 tm

The transform matrix to transform the skin into world space.

Default Implementation:: { }

853 {}

virtual void ClearSelection ( int selLevel )

inlinevirtual

Remarks: This method is called to clear the selection for the given sub-object level. All sub-object elements of this type should be deselected. This will be called when the user chooses Select None from the 3ds Max Edit menu.

Parameters:: int selLevel

Specifies the selection level to clear.

Default Implementation:: {}

862 {}

virtual void SelectAll ( int selLevel )

inlinevirtual

Remarks: This method is called to select every element of the given sub-object level. This will be called when the user chooses Select All from the Edit menu.

Parameters:: int selLevel

Specifies the selection level to select.

Default Implementation:: {}

871 {}

virtual void InvertSelection ( int selLevel )

inlinevirtual

Remarks: This method is called to invert the specified sub-object level. If the element is selected it should be deselected. If it's deselected it should be selected. This will be called when the user chooses Select Invert from the Edit menu.

Parameters:: int selLevel

Specifies the selection level to invert.

Default Implementation:: {}

881 {}

Member Data Documentation

ISkin* bonesMod

IParamBlock2* pblock_gizmo_data

GizmoClass Class Reference

Class Description

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation