SplineShape Class Reference

#include <splshape.h>

Inheritance diagram for SplineShape:

Public Member Functions
CoreExport	SplineShape ()
CoreExport	SplineShape (SplineShape &from)
CoreExport void	SplineShapeInit ()
CoreExport	~SplineShape ()
CoreExport SplineShape &	operator= (SplineShape &from)
void	SetFlag (DWORD fl, BOOL val=TRUE)
void	ClearFlag (DWORD fl)
bool	GetFlag (DWORD fl)
virtual CoreExport int	HitTest (TimeValue t, INode *inode, int type, int crossing, int flags, IPoint2 *p, ViewExp *vpt)
	This method is called to determine if the specified screen point intersects the item.
virtual CoreExport 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.
virtual CoreExport void	Snap (TimeValue t, INode *inode, SnapInfo *snap, IPoint2 *p, ViewExp *vpt)
	Checks the point passed for a snap and updates the SnapInfo structure.
virtual CoreExport int	Display (TimeValue t, INode *inode, ViewExp *vpt, int flags)
	This method displays the shape's generated mesh if necessary.
virtual CoreExport CreateMouseCallBack *	GetCreateMouseCallBack ()
	This method allows the system to retrieve a callback object used in creating an object in the 3D viewports.
virtual CoreExport RefTargetHandle	Clone (RemapDir &remap)
	This method is used by 3ds Max to clone an object.
virtual CoreExport bool	UpdatePerNodeItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer)
CoreExport 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.
CoreExport void	GetWorldBoundBox (TimeValue t, INode *inode, ViewExp *vp, 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).
CoreExport 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().
CoreExport ISubObjType *	GetSubObjType (int i)
	Returns a pointer to the sub-object type for the sub-object whose index is passed.
CoreExport void	XFormHandles (SSXFormProc *xproc, TimeValue t, Matrix3 &partm, Matrix3 &tmAxis)
CoreExport void	XFormVerts (SSXFormProc *xproc, TimeValue t, Matrix3 &partm, Matrix3 &tmAxis)
CoreExport 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.
CoreExport 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.
CoreExport 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.
CoreExport void	TransformStart (TimeValue t)
	This method is called before the first Move(), Rotate() or Scale() call and before a hold is in effect.
CoreExport 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.
CoreExport void	TransformCancel (TimeValue t)
	This method is called when the transform operation is canceled by a right-click and the undo has been canceled.
CoreExport ObjectState	Eval (TimeValue time)
	This method is called to evaluate the object and return the result as an ObjectState.
CoreExport Interval	ObjectValidity (TimeValue t)
	This method returns the validity interval of the object as a whole at the specified time.
CoreExport void	MaybeEnlargeViewportRect (GraphicsWindow *gw, Rect &rect)
	This method allows the object to enlarge its viewport rectangle, if it wants to.
virtual CoreExport void	InitNodeName (MSTR &s)
	This is the default name of the node when it is created.
BOOL	SupportsNamedSubSels ()
	An object that supports sub-object selection can choose to support named sub object selection sets.
CoreExport void	ActivateSubSelSet (MSTR &setName)
	When the user chooses a name from the drop down list this method is called.
CoreExport void	NewSetFromCurSel (MSTR &setName)
	If the user types a new name into the named selection set drop down then this method is called.
CoreExport 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.
CoreExport void	SetupNamedSelDropDown ()
	To support the Edit Named Selections dialog, plug-ins must implement this method.
CoreExport int	NumNamedSelSets ()
	To support the Edit Named Selections dialog, plug-ins must implement this method.
CoreExport MSTR	GetNamedSelSetName (int i)
	To support the Edit Named Selections dialog, plug-ins must implement this method.
CoreExport void	SetNamedSelSetName (int i, MSTR &newName)
	To support the Edit Named Selections dialog, plug-ins must implement this method.
CoreExport void	NewSetByOperator (MSTR &newName, Tab< int > &sets, int op)
	To support the Edit Named Selections dialog, plug-ins must implement this method.
CoreExport BOOL	GetUniqueSetName (MSTR &name)
CoreExport INT_PTR	SelectNamedSet ()
CoreExport void	NSCopy ()
CoreExport void	NSPaste ()
CoreExport SSNamedSelSetList	GetSelSet ()
CoreExport Interval	ConvertValidity (TimeValue t)
CoreExport Interval	ChannelValidity (TimeValue t, int nchan)
	Retrieve the current validity interval for the nchan channel of the object.
CoreExport void	SetChannelValidity (int i, Interval v)
	Sets the validity interval of the specified channel.
CoreExport void	InvalidateChannels (ChannelMask channels)
	This method invalidates the intervals for the given channel mask.
int	IsDeformable ()
	Indicates whether this object is deformable.
CoreExport int	NumPoints ()
	The points of a deformable object are accessed through a virtual array interface.
CoreExport Point3	GetPoint (int i)
	The points of a deformable object are accessed through a virtual array interface.
CoreExport void	SetPoint (int i, const Point3 &p)
	The points of a deformable object are accessed through a virtual array interface.
CoreExport BOOL	IsPointSelected (int i)
	Returns TRUE if the 'i-th' point is selected; otherwise FALSE.
CoreExport void	PointsWereChanged ()
	Informs the object that its points have been deformed, so it can invalidate its cache.
CoreExport void	GetDeformBBox (TimeValue t, Box3 &box, Matrix3 *tm=NULL, BOOL useSel=FALSE)
	This method computes the bounding box in the objects local coordinates or the optional space defined by tm.
CoreExport void	Deform (Deformer *defProc, int useSel)
	This is the method used to deform the object with a deformer.
CoreExport int	CanConvertToType (Class_ID obtype)
	Indicates whether the object can be converted to the specified type.
CoreExport Object *	ConvertToType (TimeValue t, Class_ID obtype)
	This method converts this object to the type specified and returns a pointer it.
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.
CoreExport void	FreeChannels (ChannelMask chan)
	This method deletes the memory associated with the specified channels and set the intervals associated with the channels to invalid (empty).
CoreExport Object *	MakeShallowCopy (ChannelMask channels)
	This method must make a copy of its "shell" and then shallow copy (see below) only the specified channels.
CoreExport void	ShallowCopy (Object *fromOb, ChannelMask channels)
	This method copies the specified channels from the fromOb to this and copies the validity intervals.
CoreExport void	NewAndCopyChannels (ChannelMask channels)
	This method replaces the locked channels with newly allocated copies.
CoreExport DWORD	GetSubselState ()
	For objects that have sub selection levels, this method returns the current selection level of the object.
CoreExport 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).
CoreExport void	GetLocalBoundBox (TimeValue t, INode *inode, ViewExp *vpt, Box3 &box)
	This is the object space bounding box, the box in the object's local coordinates.
CoreExport int	NumberOfVertices (TimeValue t, int curve)
	This method is used by the Summary Info and Object Properties dialogs to inform the user how many vertices or CVs are in the object.
CoreExport int	NumberOfCurves (TimeValue t)
	Returns the number of polygons in the shape at the given time.
CoreExport BOOL	CurveClosed (TimeValue t, int curve)
	This method is called to determine if the specified curve of the shape is closed at the time passed.
CoreExport Point3	InterpCurve3D (TimeValue t, int curve, float param, int ptype=PARAM_SIMPLE)
	This method returns a point interpolated on the entire curve.
CoreExport Point3	TangentCurve3D (TimeValue t, int curve, float param, int ptype=PARAM_SIMPLE)
	This method returns a tangent vector interpolated on the entire curve.
CoreExport float	LengthOfCurve (TimeValue t, int curve)
	Returns the length of the specified curve.
CoreExport int	NumberOfPieces (TimeValue t, int curve)
	Returns the number of sub-curves in a curve.
CoreExport Point3	InterpPiece3D (TimeValue t, int curve, int piece, float param, int ptype=PARAM_SIMPLE)
	This method returns the interpolated point along the specified sub-curve (segment).
CoreExport Point3	TangentPiece3D (TimeValue t, int curve, int piece, float param, int ptype=PARAM_SIMPLE)
	Returns the tangent vector on a sub-curve at the specified 'distance' along the curve.
CoreExport MtlID	GetMatID (TimeValue t, int curve, int piece)
	This method provides access to the material IDs of the shape.
BOOL	CanMakeBezier ()
	This method is called to determine if the shape can be converted to a bezier representation.
CoreExport void	MakeBezier (TimeValue t, BezierShape &shape)
	Creates the bezier representation of the shape.
CoreExport ShapeHierarchy &	OrganizeCurves (TimeValue t, ShapeHierarchy *hier=NULL)
	This method is called to prepare the shape for lofting, extrusion, etc.
CoreExport void	MakePolyShape (TimeValue t, PolyShape &shape, int steps=PSHAPE_BUILTIN_STEPS, BOOL optimize=FALSE)
	Create a PolyShape representation with optional fixed steps.
CoreExport int	MakeCap (TimeValue t, MeshCapInfo &capInfo, int capType)
	This method generates a mesh capping info for the shape.
CoreExport int	MakeCap (TimeValue t, PatchCapInfo &capInfo)
	This method creates a patch cap info out of the shape.
BezierShape &	GetShape ()
CoreExport void	DeleteThis ()
	Deletes an instance of this class.
void	FreeCaches ()
virtual Class_ID	ClassID ()
	Retrieves a constant that uniquely identifies the plugin class.
virtual CoreExport void	GetClassName (MSTR &s, bool localized=true) const override
	Retrieves the name of the plugin class.
CoreExport void *	GetInterface (ULONG id)
virtual CoreExport const MCHAR *	GetObjectName (bool localized=true) const override
CoreExport int	NumSubs ()
CoreExport Animatable *	SubAnim (int i)
	This method returns the ShapeObject's animatable pointer.
CoreExport MSTR	SubAnimName (int i, bool localized=true) override
	This method returns the name of the animatable's name.
CoreExport BOOL	AssignController (Animatable *control, int subAnim)
int	SubNumToRefNum (int subNum)
CoreExport BOOL	SelectSubAnim (int subNum)
CoreExport void	RescaleWorldUnits (float f)
	Implemented by the System.
CoreExport int	RemapRefOnLoad (int iref)
	This method remaps references at load time so that files saved from previous versions of 3ds Max get their references adjusted properly to allow for the new ShapeObject reference.
CoreExport int	NumRefs ()
	The ShapeObject makes 1 reference; this is where it tells the system.
CoreExport RefTargetHandle	GetReference (int i)
	This method allows the ShapeObject to return a pointer to its parameter block.
CoreExport void	CreateContArray ()
CoreExport void	SynchContArray ()
CoreExport void	AllocContArray (int count)
CoreExport void	ReplaceContArray (Tab< Control * > &nc)
CoreExport void	InsertPointConts (int index, int count)
CoreExport void	DeletePointConts (const BitArray &set)
CoreExport void	ReversePointConts (int index, int count, BOOL keepFirst)
CoreExport void	NullPointConts (int index, int count)
CoreExport void	NullPolyPointConts (int poly)
CoreExport void	PlugControllersSel (TimeValue t)
CoreExport BOOL	PlugControl (TimeValue t, int i)
CoreExport void	SetPtCont (int i, Control *c)
CoreExport void	SetPointAnim (TimeValue t, int poly, int vert, Point3 pt)
CoreExport BOOL	CloneVertCont (int from, int to)
CoreExport void	SetRollupPage (IObjParam *ip, BOOL creating)
CoreExport void	RemoveRollupPage (IObjParam *ip)
virtual CoreExport void	BeginEditParams (IObjParam *ip, ULONG flags, Animatable *prev)
	This method allows the ShapeObject to create its new "Rendering" rollup.
virtual CoreExport void	EndEditParams (IObjParam *ip, ULONG flags, Animatable *next)
	Similarly to BeginEditParams, this method allows the ShapeObject to remove its "Rendering" rollup.
CoreExport int	GetSubobjectLevel ()
CoreExport void	SetSubobjectLevel (int level)
CoreExport 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.
CoreExport void	SelectSubComponent (HitRecord *hitRec, BOOL selected, BOOL all, BOOL invert)
	This method is called to change the selection state of the component identified by hitRec.
CoreExport void	ClearSelection (int level)
	This method is called to clear the selection for the given sub-object level.
CoreExport void	SelectAll (int level)
	This method is called to select every element of the given sub-object level.
CoreExport void	InvertSelection (int level)
	This method is called to invert the specified sub-object level.
CoreExport 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.
CoreExport 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.
CoreExport 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).
CoreExport int	SubObjectIndex (HitRecord *hitRec)
	Returns the index of the sub-object element identified by the HitRecord hitRec.
CoreExport void	MultiAttachObject (INodeTab &nodeTab)
CoreExport void	BeginOutlineMove (TimeValue t)
CoreExport void	BeginFilletMove (TimeValue t)
CoreExport void	BeginChamferMove (TimeValue t)
CoreExport void	OutlineMove (TimeValue t, float amount)
CoreExport void	FilletMove (TimeValue t, float amount)
CoreExport void	ChamferMove (TimeValue t, float amount)
CoreExport void	EndMoveModes (TimeValue t, BOOL accept=TRUE)
CoreExport void	EndOutlineMove (TimeValue t, BOOL accept=TRUE)
CoreExport void	EndFilletMove (TimeValue t, BOOL accept=TRUE)
CoreExport void	EndChamferMove (TimeValue t, BOOL accept=TRUE)
CoreExport void	StartOutlineMode ()
CoreExport void	StartFilletMode ()
CoreExport void	StartChamferMode ()
CoreExport void	DoOutline ()
CoreExport void	DoFillet ()
CoreExport void	DoChamfer ()
CoreExport void	StartSegBreakMode ()
CoreExport void	DoSegBreak (ViewExp *vpt, BezierShape *shape, int poly, int seg, IPoint2 p, INode *inode=NULL)
CoreExport void	StartSegRefineMode ()
CoreExport void	DoSegRefine (ViewExp *vpt, BezierShape *shape, int poly, int seg, IPoint2 p, INode *inode=NULL)
CoreExport void	StartCrossInsertMode ()
CoreExport void	DoCrossInsert (ViewExp *vpt, BezierShape *shape, int poly1, int seg1, int poly2, int seg2, IPoint2 p)
CoreExport void	StartVertConnectMode ()
CoreExport void	DoVertConnect (ViewExp *vpt, BezierShape *shape, int poly1, int vert1, int poly2, int vert2)
CoreExport void	StartVertInsertMode (int controlID)
CoreExport int	StartVertInsert (ViewExp *vpt, BezierShape *shape, int poly, int seg, int vert, INode *inode=NULL)
CoreExport void	EndVertInsert (BOOL acceptUndo)
CoreExport void	StartCreateLineMode ()
CoreExport BOOL	StartCreateLine (BezierShape **shape)
CoreExport void	EndCreateLine ()
CoreExport void	StartCrossSectionMode ()
	this has the same effect as pressing the Cross Section button in the Spline's Geometry rollout
CoreExport void	StartCrossSection ()
	should be used before a sequence of calls to DoCrossSection()
CoreExport void	EndCrossSection (BOOL acceptUndo)
	should be used after a sequence of calls to DoCrossSection()
CoreExport BOOL	BooleanStartUp ()
CoreExport void	StartBooleanMode ()
CoreExport void	DoBoolean (int poly2)
CoreExport void	StartTrimMode ()
CoreExport void	StartExtendMode ()
CoreExport void	HandleTrimExtend (ViewExp *vpt, ShapeHitData *hit, IPoint2 &m, int operation)
CoreExport int	GetAttachMat ()
CoreExport void	SetAttachMat (int value)
CoreExport BOOL	GetCondenseMat ()
CoreExport void	SetCondenseMat (BOOL sw)
CoreExport int	DoAttach (INode *node, bool &canUndo)
CoreExport void	DoCrossSection (Tab< int > &splineIndices)
	creates a cross section of the current selected spline or segement with the given spline(s).
CoreExport void	DoVertBreak ()
CoreExport void	DoVertWeld ()
CoreExport void	DoMakeFirst ()
CoreExport void	DoVertDelete ()
CoreExport void	DoSegDelete ()
CoreExport void	DoSegDetach (int sameShape, int copy, int reorient)
CoreExport void	DoSegDivide (int divisions)
CoreExport void	DoPolyClose ()
CoreExport void	DoPolyDetach (int copy, int reorient)
CoreExport void	DoPolyMirror (int type, int copy)
CoreExport void	DoPolyDelete ()
CoreExport void	DoPolyReverse ()
CoreExport void	DoPolyExplode ()
CoreExport void	DoExplodeToObjects ()
CoreExport void	SetBoolOperation (int type)
CoreExport void	SetMirrorOperation (int type)
CoreExport int	GetBoolOperation ()
CoreExport int	GetMirrorOperation ()
CoreExport UI::MouseCursors::ECursors	GetBoolCursorID ()
CoreExport int	GetBoolMirrString (UINT_PTR type)
CoreExport void	SetBooleanButton ()
CoreExport void	SetMirrorButton ()
CoreExport void	ChangeSelVerts (int type)
CoreExport void	ChangeRememberedVert (int type)
CoreExport int	RememberVertThere (HWND hWnd, IPoint2 m)
CoreExport void	SetRememberedVertType (int type)
CoreExport void	ChangeSelSegs (int type)
CoreExport void	ChangeRememberedSeg (int type)
CoreExport int	RememberSegThere (HWND hWnd, IPoint2 m)
CoreExport void	SetRememberedSegType (int type)
CoreExport void	ChangeSelPolys (int type)
CoreExport void	ChangeRememberedPoly (int type)
CoreExport int	RememberPolyThere (HWND hWnd, IPoint2 m)
CoreExport void	SetRememberedPolyType (int type)
CoreExport void	SplineShapeClone (SplineShape *source)
CoreExport int	GetPointIndex (const Tab< Point3 > &vertList, const Point3 &point) const
	this simply performs a linear search through the given list, returning the index of the given point
CoreExport void	DeleteSpline (int poly)
CoreExport void	InsertSpline (Spline3D *spline, int poly)
CoreExport void	Reverse (int poly, BOOL keepFirst=FALSE)
CoreExport void	DeleteKnot (int poly, int index)
CoreExport void	AddKnot (int poly, SplineKnot &k, int where=-1)
CoreExport BOOL	Append (int poly, Spline3D *spline, BOOL weldCoincidentFirstVertex=TRUE)
CoreExport BOOL	Prepend (int poly, Spline3D *spline, BOOL weldCoincidentLastVertex=TRUE)
CoreExport void	ReplaceSpline (int poly, Spline3D *spline)
CoreExport BOOL	DeleteSelVerts (int poly)
CoreExport BOOL	DeleteSelSegs (int poly)
CoreExport void	MakeFirst (int poly, int index)
CoreExport void	SetOptimize (BOOL sw)
CoreExport void	SetAdaptive (BOOL sw)
CoreExport void	SetSteps (int n)
CoreExport void	RecordTopologyTags ()
CoreExport void	RecordTopology ()
CoreExport void	ResolveTopoChanges (BezierShape *shape=NULL, int bindTrackingOptions=1)
CoreExport void	FixupControllerTopo (SplineShape *ss)
CoreExport void	RefreshSelType ()
CoreExport void	UpdateSelectDisplay ()
CoreExport void	SetSelDlgEnables ()
CoreExport void	SetOpsDlgEnables ()
CoreExport void	SetSurfDlgEnables ()
CoreExport void	SetSoftSelDlgEnables (HWND hSoftSel=NULL)
CoreExport void	SelectionChanged ()
CoreExport BOOL	MaybeSelectSingleSpline (BOOL makeUndo=FALSE)
CoreExport void	SetFCLimit ()
CoreExport int	GetSelMatIndex ()
CoreExport void	SetSelMatIndex (int index)
CoreExport void	SelectByMat (int index, BOOL clear)
CoreExport void	InvalidateSurfaceUI ()
CoreExport IOResult	Save (ISave *isave)
	Implemented by the System.
CoreExport IOResult	Load (ILoad *iload)
	Implemented by the System.
CoreExport void	StartBindMode ()
CoreExport void	DoBind (int poly1, int vert1, int poly2, int vert2)
CoreExport void	DoUnBind ()
CoreExport void	DoHide ()
CoreExport void	DoUnhide ()
CoreExport void	DoCycleVerts ()
CoreExport void	StartRefineConnectMode ()
CoreExport void	EndRefineConnectMode ()
CoreExport void	DoRefineConnect (ViewExp *vpt, BezierShape *shape, int poly, int seg, IPoint2 p, INode *inode=NULL)
CoreExport void	DoVertFuse ()
CoreExport void	StartCopyTangentMode ()
	this has the same effect as pressing the Copy button in the "Tangent" section of the Spline UI, when in Vertex sub-object mode
CoreExport void	StartPasteTangentMode ()
	this has the same effect as pressing the Paste button in the "Tangent" section of the Spline UI, when in Vertex sub-object mode
CoreExport void	StartPasteTangent ()
	should be used before a call to PasteTangent()
CoreExport void	EndPasteTangent ()
	should be used following a call to PasteTangent()
CoreExport BOOL	CopyTangent (int poly, int vert)
	copy the given tangent
CoreExport BOOL	PasteTangent (int poly, int vert)
	paste the given tangent.
CoreExport void	StartCommandMode (splineCommandMode mode)
CoreExport void	ButtonOp (splineButtonOp opcode)
CoreExport void	GetUIParam (splineUIParam uiCode, int &ret)
CoreExport void	SetUIParam (splineUIParam uiCode, int val)
CoreExport void	GetUIParam (splineUIParam uiCode, float &ret)
CoreExport void	SetUIParam (splineUIParam uiCode, float val)
bool	Editing ()
CoreExport DWORD	GetSelLevel ()
CoreExport void	SetSelLevel (DWORD level)
CoreExport void	LocalDataChanged ()
CoreExport BitArray	GetVertSel ()
CoreExport BitArray	GetSegmentSel ()
CoreExport BitArray	GetSplineSel ()
CoreExport void	SelectBySegment (BOOL interactive=TRUE)
CoreExport void	SelectBySpline (BOOL interactive=TRUE)
CoreExport void	SetVertSel (BitArray &set, ISplineSelect *imod, TimeValue t)
CoreExport void	SetSegmentSel (BitArray &set, ISplineSelect *imod, TimeValue t)
CoreExport void	SetSplineSel (BitArray &set, ISplineSelect *imod, TimeValue t)
CoreExport GenericNamedSelSetList &	GetNamedVertSelList ()
CoreExport GenericNamedSelSetList &	GetNamedSegmentSelList ()
CoreExport GenericNamedSelSetList &	GetNamedSplineSelList ()
CoreExport MtlID	GetNextAvailMtlID (ModContext *mc)
CoreExport BOOL	HasFaceSelection (ModContext *mc)
CoreExport void	SetSelFaceMtlID (ModContext *mc, MtlID id, BOOL bResetUnsel=FALSE)
CoreExport int	GetSelFaceUniqueMtlID (ModContext *mc)
CoreExport int	GetSelFaceAnyMtlID (ModContext *mc)
CoreExport int	GetMaxMtlID (ModContext *mc)
CoreExport void	InvalidateGeomCache ()
	This method is very important - It causes the ShapeObject to flush its cached rendering mesh.
CoreExport int	UseEdgeDists ()
CoreExport void	SetUseEdgeDists (int useSoftSelections)
CoreExport int	UseSoftSelections ()
CoreExport void	SetUseSoftSelections (int useSoftSelections)
CoreExport void	InvalidateVertexWeights ()
CoreExport void	UpdateVertexDists ()
CoreExport void	UpdateEdgeDists ()
CoreExport void	UpdateVertexWeights ()
virtual CoreExport BaseInterface *	GetInterface (Interface_ID iid) override
virtual CoreExport void *	GetInterface (ULONG id) override
Public Member Functions inherited from ShapeObject
CoreExport	ShapeObject ()
CoreExport	~ShapeObject ()
virtual CoreExport BaseInterface *	GetInterface (Interface_ID iid) override
virtual CoreExport void *	GetInterface (ULONG id) override
virtual CoreExport unsigned long	GetObjectDisplayRequirement () const override
virtual CoreExport bool	PrepareDisplay (const MaxSDK::Graphics::UpdateDisplayContext &prepareDisplayContext) override
virtual CoreExport bool	UpdatePerNodeItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer) override
virtual BOOL	IsShapeObject () override
	Returns the number of shapes contained inside this object.
virtual int	IntersectRay (TimeValue t, Ray &ray, float &at, Point3 &norm) override
	Computes the intersection point of the ray passed and the shape.
virtual void	InitNodeName (MSTR &s) override
	This is the default name of the node when it is created.
SClass_ID	SuperClassID () override
	Retrieves a constant representing the type of the plugin.
virtual CoreExport int	IsRenderable () override
	Indicates whether the object may be rendered.
virtual CoreExport void	CopyBaseData (ShapeObject &from)
	In order to simplify things for subclasses of ShapeObject, this method is now available.
CoreExport float	GetThickness (TimeValue t, Interval &ivalid)
	Implemented by the System.
float	GetThickness (TimeValue t)
CoreExport int	GetSides (TimeValue t, Interval &ivalid)
	This method returns the number of sides for the cross-section of the rendering mesh version of the shape for the specified time.
int	GetSides (TimeValue t)
CoreExport float	GetAngle (TimeValue t, Interval &ivalid)
	This method returns the angle that the cross-section of the rendering mesh will be rotated to, for the specified time.
float	GetAngle (TimeValue t)
CoreExport float	GetViewportThickness ()
	This method returns the thickness of the viewport version of the rendering mesh.
CoreExport int	GetViewportSides ()
	This method returns the number of sides for the cross-section for the viewport version of the rendering mesh.
CoreExport float	GetViewportAngle ()
	This method returns the angle that the cross-section of the viewport version of the rendering mesh will be rotated to.
CoreExport BOOL	GetRenderable ()
	Implemented by the System.
CoreExport BOOL	GetGenUVs ()
	Implemented by the System.
CoreExport BOOL	GetDispRenderMesh ()
	This method returns TRUE if the "Display Render Mesh" switch is on.
CoreExport BOOL	GetUseViewport ()
	This method returns TRUE if the "Use Viewport Settings" switch is on.
CoreExport BOOL	GetViewportOrRenderer ()
	This method returns the value of the Viewport/Render switch and either returns GENMESH_VIEWPORT or GENMESH_RENDER.
CoreExport void	SetThickness (TimeValue t, float thick)
	Implemented by the System.
CoreExport void	SetSides (TimeValue t, int s)
	This method allows you to set the number of sides for the rendering mesh version of the shape for the specified time.
CoreExport void	SetAngle (TimeValue t, float a)
	This method allows you to set the cross-section rotation angle for the rendering mesh version of the shape, in degrees, for the specified time.
CoreExport void	SetViewportThickness (float thick)
CoreExport void	SetViewportSides (int s)
	This method allows you to set the number of sides for the viewport version of the rendering mesh.
CoreExport void	SetViewportAngle (float a)
	This method allows you to set the angle that the cross-section of the viewport version of the rendering mesh will be rotated to, in degrees.
CoreExport void	SetRenderable (BOOL sw)
	Implemented by the System.
CoreExport void	SetGenUVs (BOOL sw)
	Implemented by the System.
CoreExport void	SetDispRenderMesh (BOOL sw)
	This method allows you to turn the "Display Render Mesh" switch on or off.
CoreExport void	SetUseViewport (BOOL sw)
	This method allows you to turn the "Use Viewport Settings" switch on or off.
CoreExport void	SetViewportOrRenderer (BOOL sw)
	This method allows you to set the value of the Viewport/Render switch.
virtual CoreExport Mesh *	GetRenderMesh (TimeValue t, INode *inode, View &view, BOOL &needDelete) override
	This method should be implemented by all renderable GeomObjects.
virtual CoreExport void	GetRenderMeshInfo (TimeValue t, INode *inode, View &view, int &nverts, int &nfaces)
	Returns information on the rendering mesh.
virtual CoreExport void	GenerateMesh (TimeValue t, int option, Mesh *mesh)
	This method will generate a mesh based on either the viewport or rendering parameters for the specified time.
virtual int	NumberOfVertices (TimeValue t, int curve=-1)
	This method is used by the Summary Info and Object Properties dialogs to inform the user how many vertices or CVs are in the object.
virtual int	NumberOfCurves (TimeValue t)=0
	Returns the number of polygons in the shape at the given time.
virtual BOOL	CurveClosed (TimeValue t, int curve)=0
	This method is called to determine if the specified curve of the shape is closed at the time passed.
virtual Point3	InterpCurve3D (TimeValue t, int curve, float param, int ptype=PARAM_SIMPLE)=0
	This method returns a point interpolated on the entire curve.
virtual Point3	TangentCurve3D (TimeValue t, int curve, float param, int ptype=PARAM_SIMPLE)=0
	This method returns a tangent vector interpolated on the entire curve.
virtual float	LengthOfCurve (TimeValue t, int curve)=0
	Returns the length of the specified curve.
virtual int	NumberOfPieces (TimeValue t, int curve)=0
	Returns the number of sub-curves in a curve.
virtual Point3	InterpPiece3D (TimeValue t, int curve, int piece, float param, int ptype=PARAM_SIMPLE)=0
	This method returns the interpolated point along the specified sub-curve (segment).
virtual Point3	TangentPiece3D (TimeValue t, int curve, int piece, float param, int ptype=PARAM_SIMPLE)=0
	Returns the tangent vector on a sub-curve at the specified 'distance' along the curve.
virtual MtlID	GetMatID (TimeValue t, int curve, int piece)
	This method provides access to the material IDs of the shape.
virtual BOOL	CanMakeBezier ()
	This method is called to determine if the shape can be converted to a bezier representation.
virtual void	MakeBezier (TimeValue t, BezierShape &shape)
	Creates the bezier representation of the shape.
virtual ShapeHierarchy &	OrganizeCurves (TimeValue t, ShapeHierarchy *hier=NULL)=0
	This method is called to prepare the shape for lofting, extrusion, etc.
virtual void	MakePolyShape (TimeValue t, PolyShape &shape, int steps=PSHAPE_BUILTIN_STEPS, BOOL optimize=FALSE)=0
	Create a PolyShape representation with optional fixed steps.
virtual int	MakeCap (TimeValue t, MeshCapInfo &capInfo, int capType)=0
	This method generates a mesh capping info for the shape.
virtual int	MakeCap (TimeValue t, PatchCapInfo &capInfo)
	This method creates a patch cap info out of the shape.
virtual BOOL	AttachShape (TimeValue t, INode *thisNode, INode *attachNode, BOOL weldEnds=FALSE, float weldThreshold=0.0f)
	This method is called to attach the shape of attachNode to thisNode at the specified time.
virtual BOOL	HasUVW () override
	Call this method to find out if the object has UVW coordinates.
virtual BOOL	HasUVW (int mapChannel) override
	Call this method to find out if the object is has UVW coordinates for the specified mapping channel.
virtual void	SetGenUVW (BOOL sw) override
	This method is called to change the state of its Generate UVW boolean.
virtual void	SetGenUVW (int mapChannel, BOOL sw) override
	This method is called to change the state of its Generate UVW boolean for the specified mapping channel.
virtual CoreExport IOResult	Save (ISave *isave) override
	Implemented by the System.
virtual CoreExport IOResult	Load (ILoad *iload) override
	Implemented by the System.
virtual CoreExport bool	SpecifySaveReferences (ReferenceSaveManager &referenceSaveManager) override
	Implemented by the System.
virtual CoreExport Class_ID	PreferredCollapseType () override
	Implemented by the System.
virtual CoreExport BOOL	GetExtendedProperties (TimeValue t, MSTR &prop1Label, MSTR &prop1Data, MSTR &prop2Label, MSTR &prop2Data) override
	Implemented by the System.
virtual CoreExport void	RescaleWorldUnits (float f) override
	Implemented by the System.
virtual CoreExport RefResult	NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate) override
	This method will notify the Shape Object of changes in values in its parameter block.
virtual CoreExport RefTargetHandle	GetReference (int i) override
	This method allows the ShapeObject to return a pointer to its parameter block.
virtual CoreExport Animatable *	SubAnim (int i) override
	This method returns the ShapeObject's animatable pointer.
virtual CoreExport MSTR	SubAnimName (int i, bool localized=true) override
	This method returns the name of the animatable's name.
CoreExport ParamDimension *	GetParameterDim (int pbIndex)
	This method returns the parameter dimension of the parameter whose index is passed.
CoreExport MSTR	GetParameterName (int pbIndex, bool localized=true)
	This method returns the name of the parameter whose index is passed.
virtual CoreExport int	RemapRefOnLoad (int iref) override
	This method remaps references at load time so that files saved from previous versions of 3ds Max get their references adjusted properly to allow for the new ShapeObject reference.
virtual int	NumRefs () override
	The ShapeObject makes 1 reference; this is where it tells the system.
virtual int	NumSubs () override
CoreExport void	BeginEditParams (IObjParam *objParam, ULONG flags, Animatable *prev) override
	This method allows the ShapeObject to create its new "Rendering" rollup.
CoreExport void	EndEditParams (IObjParam *objParam, ULONG flags, Animatable *next) override
	Similarly to BeginEditParams, this method allows the ShapeObject to remove its "Rendering" rollup.
CoreExport Interval	GetShapeObjValidity (TimeValue t)
	This method gets the validity interval for the ShapeObject's internal parameters only.
CoreExport int	Display (TimeValue t, INode *inode, ViewExp *vpt, int flags) override
	This method displays the shape's generated mesh if necessary.
virtual CoreExport int	HitTest (TimeValue t, INode *inode, int type, int crossing, int flags, IPoint2 *p, ViewExp *vpt) override
	This method is called to determine if the specified screen point intersects the item.
virtual CoreExport int	HitTest (TimeValue t, INode *inode, int type, int crossing, int flags, IPoint2 *p, ViewExp *vpt, ModContext *mc) override
	This method is used in modifier gizmo hit testing.
virtual CoreExport Box3	GetBoundingBox (TimeValue t, Matrix3 *tm=NULL)
	This method returns a bounding box for the shape, if it's active, if the "Display Render Mesh" switch is on.
virtual CoreExport void	InvalidateGeomCache ()
	This method is very important - It causes the ShapeObject to flush its cached rendering mesh.
int	SetProperty (ULONG id, void *data)
	Associates data passed in to given id.
void *	GetProperty (ULONG id)
	Retrieves data associated with id.
CoreExport BOOL	GetUsePhysicalScaleUVs ()
	Queries whether if real world texture size is used or not.
CoreExport void	SetUsePhysicalScaleUVs (BOOL flag)
	Sets whether real world texture size is used or not.
CoreExport BOOL	GetTwistCorrect ()
	Queries the twist correction switch.
CoreExport void	SetTwistCorrect (BOOL flag)
	Sets the twist correction switch.
CoreExport BOOL	GetCap ()
	Queries the main capping switch.
CoreExport void	SetCap (BOOL flag)
	Sets the main capping switch.
CoreExport BOOL	GetQuadCap ()
	Queries the quad capping switch.
CoreExport void	SetQuadCap (BOOL flag)
	Sets the quad capping switch.
CoreExport int	GetCapSegments (TimeValue t, Interval &ivalid)
	Get/Set the cap segments count.
int	GetCapSegments (TimeValue t)
CoreExport void	SetCapSegments (TimeValue t, int count)
	Sets the cap segments value for the specified time.
CoreExport float	GetSphereCap (TimeValue t, Interval &ivalid)
	Get/Set the sphere capping value used in quad capping.
float	GetSphereCap (TimeValue t)
CoreExport void	SetSphereCap (TimeValue t, float value)
	Sets the sphere capping value (0-1).
Public Member Functions inherited from GeomObject
virtual void	InitNodeName (MSTR &s) override
	This is the default name of the node when it is created.
SClass_ID	SuperClassID () override
	Retrieves a constant representing the type of the plugin.
virtual int	IsRenderable () override
	Indicates whether the object may be rendered.
virtual int	IsInstanceDependent ()
	If an object creates different meshes depending on the particular instance (view-dependent) it should return nonzero; otherwise 0.
virtual CoreExport Mesh *	GetRenderMesh (TimeValue t, INode *inode, View &view, BOOL &needDelete)
	This method should be implemented by all renderable GeomObjects.
virtual int	NumberOfRenderMeshes ()
	Objects may supply multiple render meshes ( e.g.
virtual Mesh *	GetMultipleRenderMesh (TimeValue t, INode *inode, View &view, BOOL &needDelete, int meshNumber)
	For multiple render meshes, this method must be implemented.
virtual void	GetMultipleRenderMeshTM (TimeValue t, INode *inode, View &view, int meshNumber, Matrix3 &meshTM, Interval &meshTMValid)
	For multiple render meshes, this method must be implemented.
virtual CoreExport PatchMesh *	GetRenderPatchMesh (TimeValue t, INode *inode, View &view, BOOL &needDelete)
	This method provides a patch mesh representation of the object for use by the renderer.
CoreExport Class_ID	PreferredCollapseType () override
	This method allows objects to specify the class that is the best class to convert to when the user collapses the stack.
virtual BOOL	CanDoDisplacementMapping ()
	Returns TRUE if this object can do displacement mapping; otherwise FALSE.
Public Member Functions inherited from Object
CoreExport	Object ()
CoreExport	~Object ()
virtual BOOL	CheckObjectIntegrity ()
	This method is used for debugging only.
virtual BOOL	HasUVW () override
	Call this method to find out if the object has UVW coordinates.
virtual BOOL	HasUVW (int mapChannel) override
	Call this method to find out if the object is has UVW coordinates for the specified mapping channel.
virtual Object *	FindBaseObject ()
	It is called to return a pointer to the base object (an object that is not a derived object).
virtual BOOL	IsParamSurface ()
	There are several methods used to access a parametric position on the surface of the object.
virtual int	NumSurfaces (TimeValue t)
	Returns the number of parametric surfaces within the object.
virtual Point3	GetSurfacePoint (TimeValue t, float u, float v, Interval &iv)
	This method needs to be implemented if Object::IsParamSurface() returns TRUE.
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.
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.
virtual BOOL	GetExtendedProperties (TimeValue t, MSTR &prop1Label, MSTR &prop1Data, MSTR &prop2Label, MSTR &prop2Data)
	This method allows an object to return extended Properties fields.
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.
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.
CoreExport int	NumXTCObjects ()
	Returns the number of extension objects maintained by this Object.
CoreExport XTCObject *	GetXTCObject (int index)
	Returns a pointer to the specified extension object.
CoreExport void	RemoveXTCObject (int index)
	Removes the extension object as indicated by the index.
CoreExport void	SetXTCObjectPriority (int index, int priority)
	Sets the priority for the extension object whose index is passed.
CoreExport int	GetXTCObjectPriority (int index)
	Returns the integer priority number of the extension object whose index is passed.
CoreExport void	SetXTCObjectBranchID (int index, int branchID)
	Sets the branch ID of the extension object whose index is passed.
CoreExport int	GetXTCObjectBranchID (int index)
	Returns the integer branch ID of the extension object whose index is passed.
CoreExport void	MergeAdditionalChannels (Object *from, int branchID)
	This method has to be called whenever the CompoundObject updates a branch (calling Eval() on it).
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.
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.
CoreExport void	DeleteAllAdditionalChannels ()
	Implemented by the System.
virtual BOOL	UseSelectionBrackets ()
	This method allows an object to choose whether or not it will display selection brackets in shaded viewports.
virtual BOOL	IsManipulator ()
CoreExport void *	GetInterface (ULONG id) override
CoreExport BaseInterface *	GetInterface (Interface_ID id) override
virtual void	ReduceDisplayCaches ()
	Should reduce any derived display data to save memory, since the node wont be drawn until the user undhides it.
virtual bool	NeedGWCacheRebuilt (GraphicsWindow *gw, Material *ma, int numMat)
	This returns whether the Graphics Cache for this object needs to be rebuilt.
virtual void	BuildGWCache (GraphicsWindow *gw, Material *ma, int numMat, BOOL threaded)
	This builds the graphics window cached mesh.
virtual void	StartStackEval ()
	This are called right before and after a modifier is applied to an object.
virtual void	EndStackEval ()
virtual int	UsesWireColor ()
	This method determines if the object color is used for display.
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.
virtual BOOL	NormalAlignVector (TimeValue t, Point3 &pt, Point3 &norm)
	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.
void	LockObject ()
	Implemented by the System.
void	UnlockObject ()
	Implemented by the System.
int	IsObjectLocked ()
	Implemented by the System.
void	LockChannels (ChannelMask channels)
	Implemented by the System.
void	UnlockChannels (ChannelMask channels)
	Implemented by the System.
ChannelMask	GetChannelLocks ()
	Implemented by the System.
void	SetChannelLocks (ChannelMask channels)
	Implemented by the System.
ChannelMask	GetChannelLocks (ChannelMask m)
	Implemented by the System.
virtual BOOL	CanCacheObject ()
	This method determines if this object can have channels cached.
virtual void	WSStateInvalidate ()
	This is called by a node when the node's world space state has become invalid.
virtual BOOL	IsWorldSpaceObject ()
	Returns TRUE if the object as a world space object; otherwise FALSE.
CoreExport INode *	GetWorldSpaceObjectNode ()
	Implemented by the System.
virtual BOOL	IsParticleSystem ()
	Implemented by the System.
CoreExport void	CopyChannelLocks (Object *obj, ChannelMask needChannels)
	Implemented by the System.
virtual void	TopologyChanged ()
	Implemented by the System.
virtual float	PointSelection (int i)
	Returns a floating point weighted point selection if the object supports it.
virtual BOOL	HasWeights ()
	Returns TRUE if the object has weights for its points that can be set; otherwise FALSE.
virtual double	GetWeight (int i)
	Returns the weight of the specified point of the object.
virtual void	SetWeight (int i, const double w)
	Sets the weight of the specified point.
virtual BOOL	PolygonCount (TimeValue t, int &numFaces, int &numVerts)
	Retreives the number of faces and vertices of the polyginal mesh representation of this object.
virtual int	IsMappable ()
	This method lets you know if the ApplyUVWMap() method is available for this object.
virtual int	NumMapChannels ()
	Returns the maximum number of channels supported by this type of object.
virtual int	NumMapsUsed ()
	Returns the number of maps currently used by this object.
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.
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.
virtual void	SetSubSelState (DWORD s)
	Implemented by the System.
CoreExport void	ReadyChannelsForMod (ChannelMask channels)
	Implemented by the System.
CoreExport bool	IsBaseClassOwnedChannel (int nchan)
	Implemented by the System.
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.
Interval	GetNoEvalInterval ()
void	SetNoEvalInterval (Interval iv)
virtual CoreExport void	ReduceCaches (TimeValue t)
	This method give the object the chance to reduce its caches.
virtual int	IsConstObject ()
	This is called to determine if this is a construction object or not.
virtual int	NumPipeBranches (bool selected=true)
	This method returns the number of pipeline branches combined by the object.
virtual Object *	GetPipeBranch (int i, bool selected=true)
	Retrieves sub-object branches from an object that supports branching.
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.
virtual int	NumberOfContainedShapes ()
	Returns the number of shapes contained inside this object.
virtual ShapeObject *	GetContainedShape (TimeValue t, int index)
	This method returns the ShapeObject specified by the index passed at the time specified.
virtual void	GetContainedShapeMatrix (TimeValue t, int index, Matrix3 &mat)
	Returns the matrix associated with the shape whose index is passed.
virtual BitArray	ContainedShapeSelectionArray ()
	This is used by the lofter.
Public Member Functions inherited from BaseObject
virtual CoreExport unsigned long	GetObjectDisplayRequirement () const
virtual CoreExport bool	PrepareDisplay (const MaxSDK::Graphics::UpdateDisplayContext &prepareDisplayContext)
virtual CoreExport bool	UpdatePerNodeItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer)
virtual CoreExport bool	UpdatePerViewItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::UpdateViewContext &viewContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer)
virtual CoreExport const MaxSDK::Graphics::RenderItemHandleArray &	GetRenderItems () const
virtual CoreExport void *	GetInterface (ULONG id) override
virtual CoreExport BaseInterface *	GetInterface (Interface_ID id) override
CoreExport	BaseObject ()
virtual CoreExport	~BaseObject ()
virtual BOOL	HasViewDependentBoundingBox ()
	This method return true if GetWorldBoundBox returns different boxes for different viewports.
virtual void	SetExtendedDisplay (int flags)
	This method is used for storing mode-dependent display attributes.
	__declspec (deprecated) virtual const MCHAR *GetObjectName() MAX_SEALED
virtual CoreExport BOOL	OKToChangeTopology (MSTR &modName)
	Implemented by the System.
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.
virtual void	ForceNotify (Interval &i)
	Notifies dependents of a change.
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.
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.
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.
virtual void	TransformHoldingStart (TimeValue t)
	This method is called before the first Move(), Rotate() or Scale() call and after a hold is in effect.
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.
virtual void	CloneSelSubComponents (TimeValue t)
	This method is called to make a copy of the selected sub-object components of the item.
virtual void	AcceptCloneSelSubComponents (TimeValue t)
	This method is called when the user mouses up after shift-cloning a sub-object selection.
virtual void	NotifyPreCollapse (INode *node, IDerivedObject *derObj, int index)
	This method is called before a modifier or object is collapsed.
virtual void	NotifyPostCollapse (INode *node, Object *obj, IDerivedObject *derObj, int index)
	This method is called after a modifier or object is collapsed.
virtual CoreExport int	GetSubObjectLevel ()
	This method returns an integer which indicates the current sub-object level of the modifier or base object.
Public Member Functions inherited from ReferenceTarget
CoreExport void	GetClassName (MSTR &s, bool localized=true) const override
	Retrieves the name of the plugin class.
CoreExport SClass_ID	SuperClassID () override
	Retrieves a constant representing the type of the plugin.
BOOL	IsRefTarget () override
	Checks if this is a ReferenceTarget.
CoreExport RefResult	TestForLoop (const Interval &refInterval, RefMakerHandle hmaker)
	Tests for a cyclical reference.
CoreExport BOOL	HasDependents ()
	Checks if a ReferenceTarget has references.
CoreExport BOOL	HasRealDependents ()
	Checks if this has Real (Strong) Dependents.
void	BeginDependencyTest ()
	Starts Dependency Test.
BOOL	EndDependencyTest ()
	Ends Dependency Test.
virtual void	RefAdded (RefMakerHandle rm)
	Called after a reference is made to a target.
virtual void	RefAddedUndoRedo (RefMakerHandle rm)
	Called after a reference is made to a target because of undo or redo.
	__declspec (deprecated) virtual void RefDeleted() final
virtual void	RefDeleted (ReferenceMaker *oldOwner)
	Called after a reference to this is deleted.
	__declspec (deprecated) virtual void RefDeletedUndoRedo() final
virtual void	RefDeletedUndoRedo (RefMakerHandle oldOwner)
	Called after a reference to this is deleted because of undo or redo.
CoreExport RefResult	DeleteAllRefsToMe () override
	Deletes all references to this ReferenceTarget.
CoreExport RefResult	TransferReferences (RefTargetHandle oldTarget, BOOL delOld=FALSE)
	Transfers all the references from oldTarget to this.
CoreExport int	DoEnumDependents (DependentEnumProc *dep)
	Begins an enumeration that searches back in the dependency network.
virtual CoreExport void	BaseClone (ReferenceTarget *from, ReferenceTarget *to, RemapDir &remap)
	This method copies base class data from an object to its clone.
CoreExport RefResult	NotifyDependents (const Interval &changeInt, PartID partID, RefMessage message, SClass_ID sclass=NOTIFY_ALL, BOOL propagate=TRUE, RefTargetHandle hTarg=nullptr, NotifyDependentsOption notifyDependentsOption=REFNOTIFY_ALLOW_OPTIMIZATIONS) override
	Notify all dependent RefMakers concerned with the message.
void	FlagDependents (TimeValue t, PartID which=PART_PUT_IN_FG)
	This sends the REFMSG_FLAGDEPENDENTS message up the pipeline.
virtual void	NotifyForeground (TimeValue t)
	This method is called to flag dependents into the FG.
virtual void	NotifyTarget (int message, ReferenceMaker *hMaker)
	Sends messages to ReferenceTargets.
CoreExport	ReferenceTarget ()
	Constructor.
virtual CoreExport RefResult	AutoDelete ()
	Deletes the object when it has no more real dependents.
CoreExport RefResult	MaybeAutoDelete ()
	Deletes the object when it has no more real dependents.
Public Member Functions inherited from ReferenceMaker
void	GetClassName (MSTR &s, bool localized=true) const override
	Retrieves the name of the plugin class.
CoreExport SClass_ID	SuperClassID () override
	Retrieves a constant representing the type of the plugin.
CoreExport RefResult	ReplaceReference (int which, RefTargetHandle newtarg, BOOL delOld=TRUE)
	Used when cloning reference makers.
CoreExport RefResult	DeleteAllRefsFromMe ()
	Deletes all references from this ReferenceMaker.
CoreExport RefResult	DeleteAllRefs ()
	Deletes all references both to and from this item.
CoreExport RefResult	DeleteReference (int i)
	Deletes the specified reference.
virtual BOOL	CanTransferReference (int i)
	Tells whether this reference can be transfered.
CoreExport ReferenceSaveManager &	GetReferenceSaveManager ()
	Access the ReferenceSaveManager of this ReferenceMaker.
virtual CoreExport IOResult	Save (ISave *isave, ChannelMask)
	Access the ReferenceSaveManager of this ReferenceMaker.
virtual CoreExport IOResult	Load (ILoad *iload, ChannelMask)
	Access the ReferenceSaveManager of this ReferenceMaker.
CoreExport void	EnumAuxFiles (AssetEnumCallback &assetEnum, DWORD flags) override
	Enumerate auxiliary files (e.g. bitmaps)
virtual CoreExport void	SaveEnum (SaveEnumProc &sep, BOOL isNodeCall=0)
	The default save enumeration.
CoreExport int	DoEnumDependents (DependentEnumProc *dep)
	Begins an enumeration that searches back in the dependency network.
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.
CoreExport int	FindRef (RefTargetHandle rtarg)
	Get the index of the ReferenceTarget.
BOOL	IsRefMaker () override
	Tells whether it is a ReferenceMaker.
virtual BOOL	IsRealDependency (ReferenceTarget *rtarg)
	Returns whether this is a "real" (strong) dependency or not.
virtual BOOL	ShouldPersistWeakRef (RefTargetHandle rtarg)
	Specifies whether a weak reference is to be persisted on a partial load or save.
CoreExport	ReferenceMaker ()
	Constructor.
CoreExport void	DeleteMe ()
	Deletes an instance of this class.
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
virtual BOOL	SetKeyBufferPresent ()
	returns true if there is a "Set Key" buffer present
virtual CoreExport void	SubAnimCommitSetKeyBuffer (TimeValue t, int subNum)
	Commit any "Set Key" buffers on the given sub-anim.
virtual void	CommitSetKeyBuffer (TimeValue t)
	Commit any "Set Key" buffers.
virtual CoreExport void	SubAnimRevertSetKeyBuffer (int subNum)
	Revert any "Set Key" buffers on the given sub-anim.
virtual void	RevertSetKeyBuffer ()
	Revert any "Set Key" buffers.
virtual LRESULT CALLBACK	TrackViewWinProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
	This function is obsolete.
virtual BOOL	IsRefMaker ()
	Tells whether it is a ReferenceMaker.
virtual bool	IsParamBlockDesc2Used (ParamBlockDesc2 *desc)
	Returns true if the passed description is being used.
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.
CoreExport	Animatable ()
	Constructor.
MSTR	ClassName (bool localized=true) const
	Returns the name of the plugin class.
virtual CoreExport void	ReleaseInterface (ULONG id, void *i)
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.
CoreExport AnimProperty *	FindProperty (DWORD id)
	Find any property.
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.
CoreExport AppDataChunk *	GetAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
	Retrieves the application/plugin specific (custom) data stored with an Animatable.
CoreExport BOOL	RemoveAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
	Deletes the application/plugin specific (custom) data stored with an Animatable.
CoreExport void	ClearAllAppData ()
	Deletes all application/plugin specific (custom) data stored with an Animatable.
	__declspec (deprecated) virtual MSTR SubAnimName(int i) MAX_SEALED
virtual BOOL	CanDeleteSubAnim (int i)
virtual void	DeleteSubAnim (int i)
virtual DWORD	GetSubAnimCurveColor (int subNum)
virtual BOOL	CanCopyAnim ()
CoreExport int	HasSubElements (int type=0)
virtual int	GetSubFCurveExtents (int subNum, ParamDimensionBase *dim, float &min, float &max, DWORD flags)
	The values max and min should be initialized before calling this function.
virtual ParamDimension *	GetParamDimension (int i)
virtual BOOL	BypassTreeView ()
virtual BOOL	BypassTrackBar ()
virtual BOOL	BypassPropertyLevel ()
virtual BOOL	InvisibleProperty ()
virtual int	NumKeys ()
virtual TimeValue	GetKeyTime (int index)
virtual int	GetKeyIndex (TimeValue t)
virtual BOOL	GetNextKeyTime (TimeValue t, DWORD flags, TimeValue &nt)
virtual void	CopyKeysFromTime (TimeValue src, TimeValue dst, DWORD flags)
virtual void	DeleteKeyAtTime (TimeValue t)
virtual BOOL	IsKeyAtTime (TimeValue t, DWORD flags)
virtual int	GetKeyTimes (Tab< TimeValue > &times, Interval range, DWORD flags)
virtual int	GetKeySelState (BitArray &sel, Interval range, DWORD flags)
CoreExport void	OpenTreeEntry (int type, DWORD tv)
CoreExport void	CloseTreeEntry (int type, DWORD tv)
CoreExport int	IsTreeEntryOpen (int type, DWORD tv)
CoreExport BOOL	GetSelInTrackView (DWORD tv)
CoreExport void	SetSelInTrackView (DWORD tv, BOOL sel)
CoreExport BOOL	InTrackViewSelSet (int which)
CoreExport void	SetTrackViewSelSet (int which, BOOL inOut)
virtual BOOL	CanAssignController (int subAnim)
	Return true if we can reassign the subanim specified.
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.
virtual BOOL	IsSubCurveSelected (int subNum)
	Returns the selected state of the sub-curve whose index is passed.
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.
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
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...
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"...
virtual CoreExport bool	SvCanDetachRel (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Returns true if this object can respond to the SvDetachRel(...) method...
virtual CoreExport bool	SvDetachRel (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Detach this relationship.
virtual CoreExport bool	SvHandleRelDoubleClick (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Called when this relationship is double-clicked in the schematic view...
CoreExport ICustAttribContainer *	GetCustAttribContainer ()
	This method returns a pointer to the custom attributes container interface class.
CoreExport void	AllocCustAttribContainer ()
	This method allocates space for a custom attributes container.
CoreExport void	DeleteCustAttribContainer ()
	This method deletes space used by a custom attributes container.
void	SetAFlag (DWORD mask)
void	ClearAFlag (DWORD mask)
	Clears one or more bits in the Animatable flags.
bool	TestAFlag (DWORD mask) const
	Tests one or more bits in the Animatable flags.
void	SetAFlagEx (DWORD mask)
	Sets one or more bits in the Animatable extended flags.
void	ClearAFlagEx (DWORD mask)
	Clears one or more bits in the Animatable extended flags.
bool	TestAFlagEx (DWORD mask) const
	Tests one or more bits in the Animatable extended flags.
CoreExport bool	TestFlagBit (int index)
	Tests the specified flag bit.
CoreExport void	SetFlagBit (int index, bool newValue=true)
	Sets the specified flag bit.
CoreExport void	ClearFlagBit (int index)
	Clears the specified flag bit.
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Static Public Member Functions
static CoreExport void	InitSplineShapeAutoConnectControls ()
static CoreExport void	SetUseEndPointAutoConnect (UINT i)
static CoreExport UINT	GetUseEndPointAutoConnect ()
static CoreExport void	SetPromptForEndPointAutoConnect (UINT i)
static CoreExport UINT	GetPromptForEndPointAutoConnect ()
static CoreExport void	SetEndPointAutoWeldThreshold (float f)
static CoreExport float	GetEndPointAutoWeldThreshold ()
Static Public Member Functions inherited from Animatable
static CoreExport BOOL	IsDeleted (Animatable *anim)
	Debug method to determine whether an object has been deleted.
static CoreExport AnimHandle	GetHandleByAnim (Animatable *anim)
	Get the unique handle for an Animatable object.
static CoreExport Animatable *	GetAnimByHandle (AnimHandle handle)
	Get an Animatable object from its unique handle.
static CoreExport AnimHandle	GetNextHandle ()
	Get the unique handle for the next Animatable object to be created.
static CoreExport void	EnumerateAllAnimatables (EnumAnimList &enumProcObject)
	Enumerator to enumerate across all animatables.
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.
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.
static CoreExport bool	RegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
	Registers a callback proc that is called when an AppDataChunk is read from a scene file.
static CoreExport bool	UnRegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
	Unregisters a callback proc that is called when an AppDataChunk is read from a scene file.
static CoreExport void	ClearAFlagInAllAnimatables (DWORD mask)
	Clears one or more bits in the Animatable flags in all Animatables.
static CoreExport void	ClearAFlagExInAllAnimatables (DWORD mask)
	Clears one or more bits in the Animatable extended flags in all Animatables.
static CoreExport int	RequestFlagBit ()
	Requests an unique flag bit index.
static CoreExport void	ReleaseFlagBit (int index)
	Releases the flag bit index.
static CoreExport void	ClearFlagBitInAllAnimatables (int index)
	Clears the specified flag bit in all Animatables.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.

Public Attributes
SingleRefMakerSplineNode *	noderef
SingleRefMakerSplineMtl *	mtlref
BezierShape	shape
int	steps
BOOL	showVertNumbers
BOOL	SVNSelectedOnly
DWORD	esFlags
NamedVertSelSetList	vselSet
NamedSegSelSetList	sselSet
NamedPolySelSetList	pselSet
PointControllerContainer *	pointCtrlContainer
Tab< Control * >	cont
BOOL	showVerts
BOOL	showSelected
BOOL	smoothRefineConnect
BOOL	closedRefineConnect
BOOL	bindFirst
BOOL	bindLast
BOOL	rConnect
BOOL	useAreaSelect
float	areaSelect
SplineKnot	knotPoint1
SplineKnot	knotPoint2
int	startSegRC
int	startSegSplineRC
int	startSplineRC
int	endSegRC
int	endSegSplineRC
int	endSplineRC
Tab< Point3 >	pointList

Static Public Attributes
static IObjParam *	ip
static SplineShape *	editObj
static SSBindCMode *	bindMode
static SSRefineConnectCMode *	refineConnectMode
Static Public Attributes inherited from Animatable
static const AnimHandle	kInvalidAnimHandle = 0

Protected Member Functions
virtual CoreExport bool	IsRequiresLegacyDisplayMode () const
CoreExport RefResult	NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate)
	This method will notify the Shape Object of changes in values in its parameter block.
virtual CoreExport void	SetReference (int i, RefTargetHandle rtarg)
	This method sets the ShapeObject's parameter block pointer.
virtual CoreExport bool	IsRequiresLegacyDisplayMode () const
virtual CoreExport void	SetReference (int i, RefTargetHandle rtarg) override
	This method sets the ShapeObject's parameter block pointer.
Protected Member Functions inherited from ReferenceTarget
CoreExport int	DoEnumDependentsImpl (DependentEnumProc *dep) override
	Method to perform an enumeration on a ReferenceTarget.
virtual CoreExport	~ReferenceTarget ()=0
	Destructor.
Protected Member Functions inherited from ReferenceMaker
virtual CoreExport	~ReferenceMaker ()=0
	Destructor.
void	BlockEval ()
	Validates a given reference link between this reference maker and its reference target.
void	UnblockEval ()
	Validates a given reference link between this reference maker and its reference target.
int	Evaluating ()
	Validates a given reference link between this reference maker and its reference target.
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.
Protected Member Functions inherited from Animatable
virtual CoreExport	~Animatable ()=0
	Destructor.
Protected Member Functions inherited from Noncopyable
	Noncopyable ()
	~Noncopyable ()

Protected Attributes
BOOL	drawTicks
BOOL	generalUIDisplayed
Protected Attributes inherited from BaseObject
MaxSDK::Graphics::RenderItemHandleArray	mRenderItemHandles
Protected Attributes inherited from Animatable
DWORD	aflag
AnimPropertyList	aprops

Friends
class	SSXFormProc
class	SSOutlineCMode
class	SSFilletCMode
class	SSChamferCMode
class	SSSegBreakCMode
class	SSSegRefineCMode
class	SSCrossInsertCMode
class	SSVertConnectCMode
class	SSVertInsertCMode
class	SSCreateLineCMode
class	SSCrossSectionCMode
class	SSBooleanCMode
class	SSTrimCMode
class	SSExtendCMode
class	SSCopyTangentCMode
class	SSPasteTangentCMode
class	SSOutlineMouseProc
class	SSFilletMouseProc
class	SSChamferMouseProc
class	SSSegBreakMouseProc
class	SSSegRefineMouseProc
class	SSCrossInsertMouseProc
class	SSVertConnectMouseProc
class	SSVertInsertMouseProc
class	SSCreateLineMouseProc
class	SSBooleanMouseProc
class	SSTrimMouseProc
class	SSExtendMouseProc
class	SplineShapeRestore
class	SSRightMenu
class	SSMBackspaceUser
class	SSIBackspaceUser
class	SSPickSplineAttach
class	SSAttachHitByName
class	SplineShapeClassDesc
class	SplineModSubModSelectionProcessor
class	SSBindMouseProc
class	SSBindCMode
class	SSRefineConnectMouseProc
class	SSRefineConnectCMode
class	SSActionCallback
INT_PTR CALLBACK	SplineGenDlgProc (HWND hDlg, UINT message, WPARAM wParam, LPARAM lParam)
INT_PTR CALLBACK	SplineSelectDlgProc (HWND hDlg, UINT message, WPARAM wParam, LPARAM lParam)
INT_PTR CALLBACK	SplineOpsDlgProc (HWND hDlg, UINT message, WPARAM wParam, LPARAM lParam)
INT_PTR CALLBACK	SplineSurfDlgProc (HWND hDlg, UINT message, WPARAM wParam, LPARAM lParam)
INT_PTR CALLBACK	SelectByDlgProc (HWND hDlg, UINT message, WPARAM wParam, LPARAM lParam)

Detailed Description

See also

Class ShapeObject, Class BezierShape, Shapes and Splines.

Description:

Defines a spline object class. The SplineShape is the object that flows down the 3ds Max geometry pipeline. This class is a container for the BezierShape shape. All methods of this class are implemented by the system.

Spline Shape plug-ins use a Super Class ID of SHAPE_CLASS_ID.

Data Members:

BezierShape shape;

The shapes of this SplineShape.

Constructor & Destructor Documentation

SplineShape() [1/2]

CoreExport SplineShape

(

)

Remarks

Constructor. Initialize the member variables.

SplineShape() [2/2]

CoreExport SplineShape

(

SplineShape &

from

)

~SplineShape()

CoreExport ~SplineShape

(

)

Remarks

Destructor.

Member Function Documentation

IsRequiresLegacyDisplayMode()

virtual CoreExport bool IsRequiresLegacyDisplayMode ( ) const

protectedvirtual

Reimplemented from ShapeObject.

NotifyRefChanged()

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

protectedvirtual

This method will notify the Shape Object of changes in values in its parameter block.

The ShapeObject's parameter block is reference number zero. If subclasses implement this method, they should pass any messages referring to the ShapeObject's parameter block to it. For example:

If this isn't one of our references, pass it on to the ShapeObject...

if(hTarget == GetReference(0))

return ShapeObject::NotifyRefChanged(

changeInt, hTarget, partID, message);

This is a vital part of the mechanism; When a parameter in the parameter block changes, the ShapeObject must be able to flush its cached mesh which will no longer be valid.

Parameters

changeInt	This is the interval of time over which the message is active.
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 Reference Messages for more information about the meaning of the partID for some common messages.
message	The msg parameter passed into this method is the specific message which needs to be handled. See Reference Messages.
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.

Reimplemented from ShapeObject.

SplineShapeInit()

CoreExport void SplineShapeInit

(

)

operator=()

CoreExport SplineShape & operator=

(

SplineShape &

from

)

SetFlag()

void SetFlag ( DWORD  fl, BOOL  val = TRUE  )

inline

{ if (val) esFlags |= fl; else esFlags &= ~fl; }

ClearFlag()

void ClearFlag ( DWORD  fl )

inline

{ esFlags &= (~fl); }

GetFlag()

bool GetFlag ( DWORD  fl )

inline

{ return (esFlags&fl) ? TRUE : FALSE; }

HitTest() [1/2]

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

virtual

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.

Parameters

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

Returns

Nonzero if the item was hit; otherwise 0.

Reimplemented from ShapeObject.

HitTest() [2/2]

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

virtual

This method is used in modifier gizmo hit testing.

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

Parameters

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

Returns

Nonzero if the item was hit; otherwise 0.

Reimplemented from ShapeObject.

Snap()

virtual CoreExport void Snap ( TimeValue  t, INode *  inode, SnapInfo *  snap, IPoint2 *  p, ViewExp *  vpt  )

virtual

Checks the point passed for a snap and updates the SnapInfo structure.

Note

Developers wanting to find snap points on an Editable Mesh object should see the method XmeshSnap::Snap() in /MAXSDK/SAMPLES/SNAPS/XMESH/XMESH.CPP.

Parameters

t	The time to check.
inode	The node to check.
snap	The snap info structure to update.
p	The screen point to check.
vpt	An interface pointer that may be used to call methods associated with the viewports.

Reimplemented from BaseObject.

Display() [1/2]

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

virtual

This method displays the shape's generated mesh if necessary.

Objects derived from ShapeObject will want to have the ShapeObject code display the rendering mesh in the viewport; this method will do that for them. Simply set the viewport transform and call this method. An example from the SplineShape code: int SplineShape::Display(TimeValue t, INode inode, ViewExp vpt, int flags)

{

Eval(t);

GraphicsWindow *gw = vpt->getGW();

gw->setTransform(inode->GetObjectTM(t));

ShapeObject::Display(t, inode, vpt, flags);

...

}

If the ShapeObject's "Display Render Mesh" switch is off, it will do nothing. Otherwise, it will display the proper mesh as specified by its parameter block.

Parameters

t	The time to display the object.
inode	The node to display.
vpt	An interface pointer that may be used to call methods associated with the viewports.
flags	See Display Flags.

Returns

The return value is not currently used.

Reimplemented from ShapeObject.

GetCreateMouseCallBack()

virtual CoreExport CreateMouseCallBack * GetCreateMouseCallBack ( )

virtual

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

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

Returns

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

Implements BaseObject.

Clone()

virtual CoreExport RefTargetHandle Clone ( RemapDir &  remap )

virtual

This method is used by 3ds Max to clone an object.

See also

CloneRefHierarchy(), class RemapDir This method is called by 3ds Max to have the plugin clone itself. The plug-in's implementation of this method should copy both the data structure and all the data residing in the data structure of this reference target. The plugin should clone all its references as well. Also, the plug-in's implementation of this method must call BaseClone(). In order for classes derived from this class to clone cleanly, the Clone method should just create the new instance, and then call an implementation of BaseClone that clones the references and copies any other necessary data. For example:

class MyDerivedPlugin
    : public MyBasePlugin
{
    const int MY_REFERENCE = 1;
 
    ReferenceTarget* Clone(RemapDir& remap)
    {
        ReferenceTarget* result = new MyDerivedPlugin();
        BaseClone(this, result, remap);
        return result;
    }
 
    void BaseClone(ReferenceTarget* from, ReferenceTarget* to, RemapDir& remap)
    {
        if (!to || !from || from == to)
            return;    
        MyBasePlugin::BaseClone(from, to, remap);
        to->ReplaceReference(MY_REFERENCE, remap->CloneRef(from->GetReference(MY_REFERENCE)));
    }
};

This method should not be directly called by plug-ins. Instead, either RemapDir::CloneRef() or CloneRefHierachy() should be used to perform cloning. These methods ensure that the mapping from the original object to the clone is added to the RemapDir used for cloning, which may be used during backpatch operations

Note

See the remarks in method BaseClone() below.

Parameters

remap

- A RemapDir instance used for remapping references during a Clone.

Returns

A pointer to the cloned item.

Reimplemented from ReferenceTarget.

UpdatePerNodeItems()

virtual CoreExport bool UpdatePerNodeItems ( const MaxSDK::Graphics::UpdateDisplayContext &  updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &  nodeContext, MaxSDK::Graphics::IRenderItemContainer &  targetRenderItemContainer  )

virtual

Reimplemented from ShapeObject.

Display() [2/2]

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

virtual

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

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

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

Parameters

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

Returns

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

Reimplemented from BaseObject.

GetWorldBoundBox() [1/2]

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

virtual

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

Parameters

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

Reimplemented from BaseObject.

NumSubObjTypes()

CoreExport int NumSubObjTypes ( )

virtual

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

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

Returns

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

Reimplemented from BaseObject.

GetSubObjType()

CoreExport ISubObjType * GetSubObjType ( int  i )

virtual

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

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

Parameters

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

Returns

The sub-object type. See Class ISubObjType.

Reimplemented from BaseObject.

XFormHandles()

CoreExport void XFormHandles	(	SSXFormProc *	xproc,
		TimeValue	t,
		Matrix3 &	partm,
		Matrix3 &	tmAxis
	)

XFormVerts()

CoreExport void XFormVerts	(	SSXFormProc *	xproc,
		TimeValue	t,
		Matrix3 &	partm,
		Matrix3 &	tmAxis
	)

Move()

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

virtual

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

Parameters

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

Reimplemented from BaseObject.

Rotate()

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

virtual

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

Parameters

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

Reimplemented from BaseObject.

Scale()

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

virtual

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

Parameters

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

Reimplemented from BaseObject.

TransformStart()

CoreExport void TransformStart ( TimeValue  t )

virtual

This method is called before the first Move(), Rotate() or Scale() call and before a hold is in effect.

Parameters

t	The current time when this method is called.

Reimplemented from BaseObject.

TransformFinish()

CoreExport void TransformFinish ( TimeValue  t )

virtual

This method is called after the user has completed the Move(), Rotate() or Scale() operation and the undo object has been accepted.

Parameters

t	The current time when this method is called.

Reimplemented from BaseObject.

TransformCancel()

CoreExport void TransformCancel ( TimeValue  t )

virtual

This method is called when the transform operation is canceled by a right-click and the undo has been canceled.

Parameters

t	The current time when this method is called.

Reimplemented from BaseObject.

Eval()

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

ObjectValidity()

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

MaybeEnlargeViewportRect()

CoreExport void MaybeEnlargeViewportRect ( GraphicsWindow *  gw, Rect &  rect  )

virtual

This method allows the object to enlarge its viewport rectangle, if it wants to.

The system will call this method for all objects when calculating the viewport rectangle; the object can enlarge the rectangle if desired. This is used by the Editable Spline code to allow extra room for vertex serial numbers, which can extend outside the normal bounding rectangle.

Parameters

gw	Points to the GraphicsWindow associated with the viewport.
rect	The enlarged rectangle is returned here.

Default Implementation:

{}

Sample Code:

void SplineShape::MaybeEnlargeViewportRect(GraphicsWindow *gw, Rect &rect)
{
    if(!showVertNumbers)
        return;
    MCHAR dummy[256];
    SIZE size;
    int maxverts = -1;
    for(int i = 0; i < shape.splineCount; ++i) {
        int verts = shape.splines[i]->KnotCount();
        if(verts > maxverts)
            maxverts = verts;
    }
    sprintf(dummy,"%d",maxverts);
    gw->getTextExtents(dummy, &size);
    rect.SetW(rect.w() + size.cx);
    rect.SetY(rect.y() - size.cy);
    rect.SetH(rect.h() + size.cy);
}

Reimplemented from Object.

InitNodeName()

virtual CoreExport void InitNodeName ( MSTR &  s )

virtual

This is the default name of the node when it is created.

Parameters

s	The default name of the node is stored here.

Reimplemented from ShapeObject.

SupportsNamedSubSels()

BOOL SupportsNamedSubSels ( )

inlinevirtual

An object that supports sub-object selection can choose to support named sub object selection sets.

Methods in the interface passed to objects allow them to add items to the sub-object selection set drop down list. A modifier that wishes to support this capability maintains its list of named sub-object selections. When a user enters the sub-object selection mode, the modifier adds its named selection sets into the drop down (using Interface::AppendSubObjectNamedSelSet()).

Returns

true if the plug-in supports named sub-object selection sets, false otherwise.

Reimplemented from BaseObject.

{return TRUE;}

ActivateSubSelSet()

CoreExport void ActivateSubSelSet ( MSTR &  setName )

virtual

When the user chooses a name from the drop down list this method is called.

The plug-in should respond by selecting the set identified by the name passed.

Parameters

setName

The name of the set to select.

Reimplemented from BaseObject.

NewSetFromCurSel()

CoreExport void NewSetFromCurSel ( MSTR &  setName )

virtual

If the user types a new name into the named selection set drop down then this method is called.

The plug-in should respond by creating a new set and give it the specified name.

Parameters

setName

The name for the selection set.

Reimplemented from BaseObject.

RemoveSubSelSet()

CoreExport void RemoveSubSelSet ( MSTR &  setName )

virtual

If the user selects a set from the drop down and then chooses Remove Named Selections from the Edit menu this method is called.

The plug-in should respond by removing the specified selection set.

Parameters

setName

The selection set to remove.

Reimplemented from BaseObject.

SetupNamedSelDropDown()

CoreExport void SetupNamedSelDropDown ( )

virtual

To support the Edit Named Selections dialog, plug-ins must implement this method.

It is called to rebuild the named selection set drop down list. This is usually done by calling Interface::ClearSubObjectNamedSelSets() followed by calls to Interface:: AppendSubObjectNamedSelSet().

Reimplemented from BaseObject.

NumNamedSelSets()

CoreExport int NumNamedSelSets ( )

virtual

To support the Edit Named Selections dialog, plug-ins must implement this method.

Returns

the number of named selection sets.

Reimplemented from BaseObject.

GetNamedSelSetName()

CoreExport MSTR GetNamedSelSetName ( int  i )

virtual

To support the Edit Named Selections dialog, plug-ins must implement this method.

Parameters

i	The index of the selection set whose name is returned.

Returns

the name of the 'i-th' named selection set.

Reimplemented from BaseObject.

SetNamedSelSetName()

CoreExport void SetNamedSelSetName ( int  i, MSTR &  newName  )

virtual

To support the Edit Named Selections dialog, plug-ins must implement this method.

It sets the name of the selection set whose index is passed to the name passed. Note: Developers need to implement Undo / Redo for modifications to their named selection sets.

Parameters

i	The index of the selection set whose name is to be set.
newName	The new name for the selection set the plug-in should store.

Reimplemented from BaseObject.

NewSetByOperator()

CoreExport void NewSetByOperator ( MSTR &  newName, Tab< int > &  sets, int  op  )

virtual

To support the Edit Named Selections dialog, plug-ins must implement this method.

The user may bring up the Edit Named Selections dialog via the Edit / Edit Named Selection ... command. This dialog allows the user to create new selection sets using 'boolean' operations to the sets including 'Combine', 'Subtract (A-B)', 'Subtract (B-A)' and 'Intersection'. This method is called on the plug-in to generate a new selection set via one of these operations. This method assumes the developer will append a new seleciton set with the name passed. This will result in two sets with identical names. Then the system will call RemoveSubSelSet() afterwards, so that the first one that is found (the old one, since the new one was appended) will be deleted. Note: Developers need to implement Undo / Redo for modifications to their named selection sets. See /MAXSDK/SAMPLES/MODIFIERS/MESHSEL.CPP for an example.

Parameters

newName	The new name for the selection set is passed here.
sets	A table of the selection sets to operate on. There are sets.Count() sets in the table.
op	One of the following values defined in Arguments for BaseObject::NewSetByOperator()

Reimplemented from BaseObject.

GetUniqueSetName()

CoreExport BOOL GetUniqueSetName

(

MSTR &

name

)

SelectNamedSet()

CoreExport INT_PTR SelectNamedSet

(

)

NSCopy()

CoreExport void NSCopy

(

)

NSPaste()

CoreExport void NSPaste

(

)

GetSelSet()

CoreExport SSNamedSelSetList GetSelSet

(

)

ConvertValidity()

CoreExport Interval ConvertValidity

(

TimeValue

t

)

ChannelValidity()

CoreExport Interval ChannelValidity ( TimeValue  t, int  nchan  )

virtual

Retrieve the current validity interval for the nchan channel of the object.

Note

Most procedural objects won't implement this method since they don't have individual channels. Developers wanting to get the validity interval for a procedural object should use Object::ObjectValidity() instead.

Parameters

t	The time to retrieve the validity interval of the channel.
nchan	Specifies the channel to return the validity interval of. See Object Channels.

Returns

The validity interval of the specified channel.

Reimplemented from Object.

SetChannelValidity()

CoreExport void SetChannelValidity ( int  nchan, Interval  v  )

virtual

Sets the validity interval of the specified channel.

Parameters

nchan	Specifies the channel. See Object Channels.
v	The validity interval for the channel.

Reimplemented from Object.

InvalidateChannels()

CoreExport void InvalidateChannels ( ChannelMask  channels )

virtual

This method invalidates the intervals for the given channel mask.

This just sets the validity intervals to empty (calling SetEmpty() on the interval).

Parameters

channels

Specifies the channels to invalidate.

Reimplemented from Object.

IsDeformable()

int IsDeformable ( )

inlinevirtual

Indicates whether this object is deformable.

A deformable object is simply an object with points that can be modified. Deformable objects must implement the generic deformable object methods (NumPoints(), GetPoint(i), SetPoint(i), Deform()). A deformable object is simply an object with points that can be modified. These points can be stored in any form the object wants. They are accessed through a virtual array interface with methods to get and set the 'i-th' point. If an object has tangents for instance, it would convert them to and from points as necessary. For example, a simple Bezier spline object that stored its control handles relative to the knot would convert them to be absolute when GetPoint() was called with 'i' specifying one of the control points. When the control point is later set, the object can convert it back to be relative to its knot. At this point it could also apply any constraints that it may have, such as maintaining a degree of continuity. The idea is that the entity calling GetPoint(i) and SetPoint(i) doesn't care what the point represents. It will simply apply some function to the point.

Note

The Deformable object methods only need to be implemented if the object returns TRUE from this method.

Returns

Return nonzero if the object is deformable and implements the generic deformable object methods; otherwise 0.

Reimplemented from Object.

{ return 1; }  

NumPoints()

CoreExport int NumPoints ( )

virtual

The points of a deformable object are accessed through a virtual array interface.

This method specifies the number of points in the object. The meaning of 'points' is defined by the object. A TriObject uses the vertices as the points for example. b>

Returns

The number of points in the object.

Reimplemented from Object.

GetPoint()

CoreExport Point3 GetPoint ( int  i )

virtual

The points of a deformable object are accessed through a virtual array interface.

This method returns the 'i-th' point of the object.

Note

If your plug-in is a modifier and you want to operate on the selected points of the object you are modifying, you can't tell which points are selected unless you know the type of object. If it is a generic deformable object there is no way of knowing since the way the object handles selection is up to it. Therefore, if you want to operate on selected points of a generic deformable object, use a Deformer.

Parameters

i	Specifies which point should be returned.

Returns

The 'i-th' point of the object.

Reimplemented from Object.

SetPoint()

CoreExport void SetPoint ( int  i, const Point3 &  p  )

virtual

The points of a deformable object are accessed through a virtual array interface.

This method stores the 'i-th' point of the object.

Parameters

i	The index of the point to store.
p	The point to store.

Reimplemented from Object.

IsPointSelected()

CoreExport BOOL IsPointSelected ( int  i )

virtual

Returns TRUE if the 'i-th' point is selected; otherwise FALSE.

Parameters

i	The zero based index of the point to check.

Reimplemented from Object.

PointsWereChanged()

CoreExport void PointsWereChanged ( )

virtual

Informs the object that its points have been deformed, so it can invalidate its cache.

A developer who uses the GetPoint() / SetPoint() approach to modifying an object will call PointsWereChanged() to invalidate the object's cache. For example, if a modifier calls SetPoint(), when it is finished it should call this method so the object can invalidate and/or update its bounding box and any other data it might cache.

Reimplemented from Object.

GetDeformBBox()

CoreExport void GetDeformBBox ( TimeValue  t, Box3 &  box, Matrix3 *  tm = NULL, BOOL  useSel = FALSE  )

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.

Deform()

CoreExport void Deform ( Deformer *  defProc, int  useSel  )

virtual

This is the method used to deform the object with a deformer.

The developer should loop through the object's points calling the defProc for each point (or each selected point if useSel is nonzero). The Deform() method is mostly a convenience. Modifiers can implement a 'Deformer' callback object which is passed to the Deform() method. The object then iterates through its points calling their deformer's callback for each point. The only difference between using the Deform() method as opposed to iterating through the points is that the Deform() method should respect sub-object selection. For example, the TriObject's implementation of Deform() iterates through its vertices, if the TriObject's selection level is set to vertex then it only calls the Deformer's callback for vertices that are selected. This way modifiers can be written that can be applied only to selection sets without any specific code to check selected points. The default implementation of this method just iterates through all points using GetPoint(i) and SetPoint(i). If an object supports sub-object selection sets then it should override this method.

Parameters

defProc	A pointer to an instance of the Deformer class. This is the callback object that actually performs the deformation.
useSel	A flag to indicate if the object should use the selected points only. If nonzero the selected points are used; otherwise all the points of the object are used.

Default Implementation:

void Object::Deform(Deformer *defProc,int useSel)
{
    int nv = NumPoints();
    for (int i=0; i<nv; i++)
        SetPoint(i,defProc->Map(i,GetPoint(i)));
    PointsWereChanged();
}

Sample Code:

This code shows the TriObject implementation of this method. Note how it looks at the useSel parameter to only call the selected points if required.

void TriObject::Deform(Deformer *defProc,int useSel)
{
    int nv = NumPoints();
    int i;
    if ( useSel ) {
        BitArray sel = mesh.VertexTempSel();
        float *vssel = mesh.getVSelectionWeights ();
        if (vssel) {
            for (i=0; i<nv; i++) {
                if(sel[i]) {
                    SetPoint(i,defProc->Map(i,GetPoint(i)));
                    continue;
                }
                if (vssel[i]==0) continue;
                Point3 & A = GetPoint(i);
                Point3 dir = defProc->Map(i,A) - A;
                SetPoint(i,A+vssel[i]*dir);
            }
        }
        else {
            for (i=0; i<nv; i++) if (sel[i])
                SetPoint(i,defProc->Map(i,GetPoint(i)));
        }
    }
    else {
        for (i=0; i<nv; i++)
            SetPoint(i,defProc->Map(i,GetPoint(i)));
    }
    PointsWereChanged();
}

Reimplemented from Object.

CanConvertToType()

CoreExport int CanConvertToType ( Class_ID  obtype )

virtual

Indicates whether the object can be converted to the specified type.

If the object returns nonzero to indicate it can be converted to the specified type, it must handle converting to and returning an object of that type from ConvertToType(). Note that all overrides of this method should either call _super::CanConvertToType or test to see if obtype == anyObjectClassID. If true, the method should return true.

See also

Class ObjectConverter for additional details on converting objects between types.

Parameters

obtype

The Class_ID of the type of object to convert to. See Class Class_ID, Class IDs defined in plugapi.h.

Returns

Nonzero if the object can be converted to the specified type; otherwise 0.

Reimplemented from Object.

ConvertToType()

CoreExport Object * ConvertToType ( TimeValue  t, Class_ID  obtype  )

virtual

This method converts this object to the type specified and returns a pointer it.

Note that if ConvertToType() returns a new object it should be a completely different object with no ties (pointers or references) to the original. Note that all overrides of this method should either call _super::ConvertToType or test to see if obtype == anyObjectClassID. If true, the object should return itself.

See also

class ObjectConverter for additional details on converting objects between types.

The following is an issue that developers of world space modifiers need to

be aware of if the world space modifier specifies anything but generic deformable objects as its input type. In other words, if a world space modifier, in its implementation of Modifier::InputType(), doesn't specifically return defObjectClassID then the following issue regarding the 3ds Max pipeline needs to be considered. Developers of other plug-ins that don't meet this condition don't need to be concerned with this issue.

World space modifiers that work on anything other than generic deformable

objects are responsible for transforming the points of the object they modify into world space using the ObjectState TM. To understand why this is necessary, consider how 3ds Max applies the node transformation to the object flowing down the pipeline.

In the geometry pipeline architecture, the node in the scene has its

transformation applied to the object in the pipeline at the transition between the last object space modifier and the first world space modifier. The node transformation is what places the object in the scene – thus this is what puts the object in world space. The system does this by transforming the points of the object in the pipeline by the node transformation. This is only possible however for deformable objects. Deformable objects are those that support the Object::IsDeformable(), NumPoints(), GetPoint() and SetPoint() methods. These deformable objects can be deformed by the system using these methods, and thus the system can modify the points to put them in world space itself.

If a world space modifier does not specify that it works on deformable

objects, the system is unable to transform the points of the object into world space. What it does instead is apply the transformation to the ObjectState TM. In this case, a world space modifier is responsible for transforming the points of the object into world space itself, and then setting the ObjectState TM to the identity. There is an example of this in the sample code for the Bomb space warp. The Bomb operates on TriObjects and implements InputType() as { return Class_ID(TRIOBJ_CLASS_ID,0); }. Since it doesn't specifically return defObjectClassID, it is thus responsible for transforming the points of the object into world space itself. It does this in its implementation of ModifyObject() as follows:

if (os->GetTM())
{
    Matrix3 tm = *(os->GetTM());
    for (int i=0; i<triOb->mesh.getNumVerts(); i++) {
        triOb->mesh.verts[i] = triOb->mesh.verts[i] *tm;
    }
    os->obj->UpdateValidity(GEOM_CHAN_NUM,os->tmValid());
    os->SetTM(NULL,FOREVER);
}

As the code above shows, the Bomb checks if the ObjectState TM is non-NULL. If it is, the points of the object are still not in world space and thus must be transformed. It does this by looping through the points of the TriObject and multiplying each point by the ObjectState TM. When it is done, it sets the ObjectState TM to NULL to indicate the points are now in world space. This ensure that any later WSMs will not transform the points with this matrix again.

For the Bomb world space modifier this is not a problem since it specifies

in its implementation of ChannelsChanged() that it will operate on the geometry channel (GEOM_CHANNEL). Certain world space modifiers may not normally specify GEOM_CHANNEL in their implementation of ChannelsChanged(). Consider the camera mapping world space modifier. Its function is to apply mapping coordinates to the object it is applied to. Thus it would normally only specify TEXMAP_CHANNEL for ChannelsChanged(). However, since it operates directly on TriObjects, just like the Bomb, the system cannot transform the points into world space, and therefore the camera mapping modifier must do so in its implementation of ModifyObject(). But since it is actually altering the points of the object by putting them into world space it is altering the geometry channel. Therefore, it should really specify GEOM_CHANNEL | TEXMAP_CHANNEL in its implementation of ChannelsChanged(). If it didn't do this, but went ahead and modified the points of the object anyway, it would be transforming not copies of the points, but the original points stored back in an earlier cache or even the base object.

This is the issue developers need to be aware of. To state this in simple

terms then: Any world space modifier that needs to put the points of the object into world space (since it doesn't implement InputType() as defObjectClassID) needs to specify GEOM_CHANNEL in its implementation of ChannelsChanged().

Parameters

t	The time at which to convert.
obtype	The Class_ID of the type of object to convert to. See Class Class_ID, Class IDs defined in plugapi.h.

Returns

A pointer to an object of type obtype.

Default Implementation:

{ return NULL; }

Sample Code:

The following code shows how a TriObject can be retrieved from a node. Note on the code that if you call ConvertToType() on an object and it returns a pointer other than itself, you are responsible for deleting that object.

// Retrieve the TriObject from the node
int deleteIt;
TriObject *triObject = GetTriObjectFromNode(ip->GetSelNode(0),deleteIt);
// Use the TriObject if available
if (!triObject) return;
// ...
// Delete it when done...
if (deleteIt) triObject->DeleteMe();
 
// Return a pointer to a TriObject given an INode or return NULL
// if the node cannot be converted to a TriObject
TriObject *Utility::GetTriObjectFromNode(INode *node, int &deleteIt)
{
    deleteIt = FALSE;
    Object *obj = node->EvalWorldState(0).obj;
    if (obj->CanConvertToType(Class_ID(TRIOBJ_CLASS_ID, 0))) {
        TriObject *tri = (TriObject *) obj->ConvertToType(0,Class_ID(TRIOBJ_CLASS_ID, 0));
// Note that the TriObject should only be deleted
// if the pointer to it is not equal to the object
// pointer that called ConvertToType()
        if (obj != tri) 
            deleteIt = TRUE;
        return tri;
    }
    else {
        return NULL;
    }
}

Reimplemented from Object.

GetCollapseTypes()

CoreExport void GetCollapseTypes ( Tab< Class_ID > &  clist, Tab< MSTR * > &  nlist  )

virtual

When the user clicks on the Edit Stack button in the modify branch a list of 'Convert To:' types is presented.

The use may click on one of these choices to collapse the object into one of these types (for instance, an Editable Mesh or an Editable NURBS object). This method returns a list of Class_IDs and descriptive strings that specify the allowable types of objects that this object may be collapsed into. Note: Most plug-ins call the base class method in Object in their implementation of this method. The base class implementation provided by Object checks if the object can convert to both an editable mesh and an editable spline. If it can, these are added to the allowable types.

Parameters

clist	The table of allowable Class_IDs.
nlist	The table of pointers to strings that correspond to the table of Class_IDs above.

Sample Code:

void SphereObject::GetCollapseTypes(Tab<Class_ID> &clist,Tab<MSTR*>&nlist)
{
    Object::GetCollapseTypes(clist, nlist);
    Class_ID id = EDITABLE_SURF_CLASS_ID;
    MSTR *name = new MSTR(GetString(IDS_SM_NURBS_SURFACE));
    clist.Append(1,&id);
    nlist.Append(1,&name);
}

Reimplemented from Object.

FreeChannels()

CoreExport void FreeChannels ( ChannelMask  channels )

virtual

This method deletes the memory associated with the specified channels and set the intervals associated with the channels to invalid (empty).

Parameters

channels

Specifies the channels to free.

Reimplemented from Object.

MakeShallowCopy()

CoreExport Object * MakeShallowCopy ( ChannelMask  channels )

virtual

This method must make a copy of its "shell" and then shallow copy (see below) only the specified channels.

It must also copy the validity intervals of the copied channels, and invalidate the other intervals.

Parameters

channels

The channels to copy.

Returns

A pointer to the shallow copy of the object.

Reimplemented from Object.

ShallowCopy()

CoreExport void ShallowCopy ( Object *  fromOb, ChannelMask  channels  )

virtual

This method copies the specified channels from the fromOb to this and copies the validity intervals.

A plug-in needs to copy the specified channels from the specified object fromOb to itself by just copying pointers (not actually copying the data). No new memory is typically allocated, this method is just copying the pointers.

Parameters

fromOb	Object to copy the channels from.
channels	Channels to copy.

Reimplemented from Object.

NewAndCopyChannels()

CoreExport void NewAndCopyChannels ( ChannelMask  channels )

virtual

This method replaces the locked channels with newly allocated copies.

It will only be called if the channel is locked.

Parameters

channels

The channels to be allocate and copy.

Reimplemented from Object.

GetSubselState()

CoreExport DWORD GetSubselState ( )

virtual

For objects that have sub selection levels, this method returns the current selection level of the object.

For example, a TriObject has the following selection levels: object, vertex, face, edge. Other object types may have different selection levels. The only standard is that a value of 0 indicates object level. b>

Returns

The current selection level of the object.

Reimplemented from Object.

GetWorldBoundBox() [2/2]

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

GetLocalBoundBox()

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

virtual

This is the object space bounding box, the box in the object's local coordinates.

The system expects that requesting the object space bounding box will be fast.

Parameters

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

Reimplemented from BaseObject.

NumberOfVertices()

CoreExport int NumberOfVertices ( TimeValue  t, int  curve  )

virtual

This method is used by the Summary Info and Object Properties dialogs to inform the user how many vertices or CVs are in the object.

The method is passed a TimeValue and a curve index; if the curve index is <0, the function should return the number of vertices/CVs in the entire shape. Otherwise, it should return the number of vertices/CVs in the specified curve.

Parameters

t	The time at which the number of vertices is to be computed.
curve	The curve index. See note above.

Reimplemented from ShapeObject.

NumberOfCurves()

CoreExport int NumberOfCurves ( TimeValue  t )

virtual

Returns the number of polygons in the shape at the given time.

Parameters

t	The time to check.

Returns

the number of polygons in the shape.

Implements ShapeObject.

CurveClosed()

CoreExport BOOL CurveClosed ( TimeValue  t, int  curve  )

virtual

This method is called to determine if the specified curve of the shape is closed at the time passed.

Parameters

t	The time to check.
curve	The index of the curve to check.

Returns

TRUE if the curve is closed; otherwise FALSE.

Implements ShapeObject.

InterpCurve3D()

CoreExport Point3 InterpCurve3D ( TimeValue  t, int  curve, float  param, int  ptype = PARAM_SIMPLE  )

virtual

This method returns a point interpolated on the entire curve.

This method returns the point but you don't know which segment the point falls on. See method InterpPiece3D().

Parameters

t	The time to evaluate.
curve	The index of the curve to evaluate.
param	The 'distance' along the curve where 0 is the start and 1 is the end.
ptype	The parameter type for spline interpolation. See Parameter types for shape interpolation.

Returns

The interpolated point on the curve.

Implements ShapeObject.

TangentCurve3D()

CoreExport Point3 TangentCurve3D ( TimeValue  t, int  curve, float  param, int  ptype = PARAM_SIMPLE  )

virtual

This method returns a tangent vector interpolated on the entire curve.

Also see method TangentPiece3D().

Parameters

t	The time at which to evaluate the curve.
curve	The index of the curve to evaluate.
param	The 'distance' along the curve where 0.0 is the start and 1.0 is the end.
ptype	The parameter type for spline interpolation. See Parameter types for shape interpolation.

Returns

The tangent vector

Implements ShapeObject.

LengthOfCurve()

CoreExport float LengthOfCurve ( TimeValue  t, int  curve  )

virtual

Returns the length of the specified curve.

Note: This method makes no allowance for non-uniform scaling in the object transform. To do that, see the following code fragment (os is the ObjectState with the shape object and xfm is the NodeTM of the shape object node).

if (os.obj->SuperClassID() == SHAPE_CLASS_ID)
{
    ShapeObject *sobj;
    sobj = (ShapeObject *) os.obj;
    int cct = sobj->NumberOfCurves(ip->GetTime());
    PolyShape workShape;
    sobj->MakePolyShape(ip->GetTime(), workShape);
    workShape.Transform(xfm);
    float len = 0.0f;
    for (int i=0; i<cct; i++)
        len += workShape.lines[i].CurveLength();
}

Parameters

t	The time at which to compute the length.
curve	The index of the curve.

Implements ShapeObject.

NumberOfPieces()

CoreExport int NumberOfPieces ( TimeValue  t, int  curve  )

virtual

Returns the number of sub-curves in a curve.

Parameters

t	The time at which to check.
curve	The index of the curve.

Implements ShapeObject.

InterpPiece3D()

CoreExport Point3 InterpPiece3D ( TimeValue  t, int  curve, int  piece, float  param, int  ptype = PARAM_SIMPLE  )

virtual

This method returns the interpolated point along the specified sub-curve (segment).

For example consider a shape that is a single circle with four knots. If you called this method with curve=0 and piece=0 and param=0.0 you'd get back the point at knot 0. If you passed the same parameters except param=1.0 you'd get back the point at knot 1.

Parameters

t	The time to evaluate the sub-curve.
curve	The curve to evaluate.
piece	The segment to evaluate.
param	The position along the curve to return where 0.0 is the start and 1.0 is the end.
ptype	The parameter type for spline interpolation. See Parameter types for shape interpolation.

Returns

The point in world space.

Implements ShapeObject.

TangentPiece3D()

CoreExport Point3 TangentPiece3D ( TimeValue  t, int  curve, int  piece, float  param, int  ptype = PARAM_SIMPLE  )

virtual

Returns the tangent vector on a sub-curve at the specified 'distance' along the curve.

Parameters

t	The time to evaluate the sub-curve.
curve	The curve to evaluate.
piece	The sub-curve (segment) to evaluate.
param	The position along the curve to return where 0 is the start and 1 is the end.
ptype	The parameter type for spline interpolation. See Parameter types for shape interpolation.

Returns

The tangent vector.

Implements ShapeObject.

GetMatID()

CoreExport MtlID GetMatID ( TimeValue  t, int  curve, int  piece  )

virtual

This method provides access to the material IDs of the shape.

It returns the material ID of the specified segment of the specified curve of this shape at the time passed. There is a default implementation so there is no need to implement this method if the shape does not support material IDs. Note: typedef unsigned short MtlID;

Parameters

t	The time to evaluate the sub-curve.
curve	The zero based index of the curve to evaluate.
piece	The sub-curve (segment) to evaluate.

Reimplemented from ShapeObject.

CanMakeBezier()

BOOL CanMakeBezier ( )

inlinevirtual

This method is called to determine if the shape can be converted to a bezier representation.

Returns

TRUE if the shape can turn into a bezier representation; otherwise FALSE.

Reimplemented from ShapeObject.

{ return TRUE; }

MakeBezier()

CoreExport void MakeBezier ( TimeValue  t, BezierShape &  shape  )

virtual

Creates the bezier representation of the shape.

Parameters

t	The time to convert.
shape	The bezier representation is stored here.

Reimplemented from ShapeObject.

OrganizeCurves()

CoreExport ShapeHierarchy & OrganizeCurves ( TimeValue  t, ShapeHierarchy *  hier = NULL  )

virtual

This method is called to prepare the shape for lofting, extrusion, etc.

This methods looks at the shape organization, and puts together a shape hierarchy. This provides information on how the shapes are nested.

Parameters

t	The time to organize the curves.
hier	This class provides information about the hierarchy. See Class ShapeHierarchy.

Implements ShapeObject.

MakePolyShape()

CoreExport void MakePolyShape ( TimeValue  t, PolyShape &  shape, int  steps = PSHAPE_BUILTIN_STEPS, BOOL  optimize = FALSE  )

virtual

Create a PolyShape representation with optional fixed steps.

Parameters

t	The time to make the PolyShape.
shape	The PolyShape representation is stored here.
steps	The number of steps between knots. Values >=0 indicates the use of fixed steps: PSHAPE_BUILTIN_STEPS Use the shape's built-in steps/adaptive settings (default). PSHAPE_ADAPTIVE_STEPS Force adaptive steps.
optimize	If TRUE intermediate steps are removed from linear segments.

Implements ShapeObject.

MakeCap() [1/2]

CoreExport int MakeCap ( TimeValue  t, MeshCapInfo &  capInfo, int  capType  )

virtual

This method generates a mesh capping info for the shape.

Parameters

t	The time to create the cap info.
capInfo	The cap info to update.
capType	See Shape Capping Types.

Returns

Nonzero if the cap info was generated; otherwise zero.

Implements ShapeObject.

MakeCap() [2/2]

CoreExport int MakeCap ( TimeValue  t, PatchCapInfo &  capInfo  )

virtual

This method creates a patch cap info out of the shape.

Only implement this method if CanMakeBezier() returns TRUE.

Parameters

t	The time to create the cap info.
capInfo	The cap info to update.

Returns

Nonzero if the cap info was generated; otherwise zero.

Reimplemented from ShapeObject.

GetShape()

BezierShape & GetShape ( )

inline

Remarks

Returns the BezierShape data member maintained by this class.

{ return shape; }

DeleteThis()

CoreExport void DeleteThis ( )

virtual

Deletes an instance of this class.

3ds Max calls this method when it needs to delete a plugin object (an instance of a class derived from Animatable). Similarly, plugins that need to delete instances of an Animatable or a class directly derived from it via an Animatable pointer, should call this method instead of calling directly operator delete. Following these rules will ensure that the same memory manager is used to allocate and deallocate the object. The default implementation of this method deletes the object. Plugin instances that never need to be deleted from the heap can overwrite this method to do nothing.

Note

See the method ClassDesc::Create() for details on how Max allocates plugin objects.

See ReferenceMaker::DeleteMe() and ReferenceTarget::MaybeAutoDelete() for information on how plugin instances are deleted by the system.

Remarks

See Memory Management.

See also

Required DLL Functions, Class ClassDesc.

Reimplemented from Animatable.

FreeCaches()

void FreeCaches ( )

inlinevirtual

Remarks

This is called to delete any item that can be rebuilt. For example, the procedural sphere object has a mesh that it caches. It could call Mesh::FreeAll() on the mesh from this method. This will free the vertex/face/uv arrays. If the sphere is ever evaluated again it can just rebuild the mesh. If an object (like a sphere) has modifiers applied to it, and those modifiers are not animated, then the result of the pipeline is cached in the node. So there is no reason for the sphere to also have a cache of its representation. Therefore when this method is called, the sphere can free the data of the mesh.

Default Implementation:

{}

Reimplemented from Animatable.

{ shape.InvalidateGeomCache(); }

ClassID()

virtual Class_ID ClassID ( )

inlinevirtual

Retrieves a constant that uniquely identifies the plugin class.

This method must return the unique ID for the plugin class. If two ClassIDs conflict, the system will only load the first conflicting one it finds. A program (gencid.exe) is provided to generate unique class id values.

Returns

A class id that uniquely identifies a plugin class

See also

Class ClassID, class ID definitions in plugapi.h.

Reimplemented from Animatable.

{ return splineShapeClassID; }

GetClassName()

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

overridevirtual

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.

GetInterface() [1/3]

CoreExport void * GetInterface ( ULONG  id )

virtual

Remarks

This method provides a mechanism for extending the class in the future. In 3ds Max 4.0 there are new interfaces that are accessed by passing an id to this method and it will respond by returning the corresponding interface pointer.

This method has been used however for a different purpose. It currently is used to determine if an object is of a particular class. With controllers for example, there is one base class Control, however there are many super classes (CTRL_FLOAT_CLASS_ID, CTRL_SCALE_CLASS_ID, etc.). If you wanted to find out if a given Animatable was a controller you would need to compare its SuperClassID to all the known types and only if it wasn't one of the known types could you be sure it wasn't a controller. Having to do this is inconvenient for a developer.

Instead the Control class implements this method. It looks at the id, and if it matches a predefined constant I_CONTROL, it returns its this pointer. In this way, given any Animatable, it is easy to find out if it is a controller by simply asking for the control interface. There is a macro that does this:

#define GetControlInterface(anim)
((Control*)anim-\>GetInterface(I_CONTROL))

A plug-in developer may use this macro as follows:

Control *c = GetControlInterface(anim);

This will either be NULL or a pointer to a valid controller.

Note: Plug-in defined interfaces should be greater than the following value:

#define I_USERINTERFACE 0x0000ffff

If a plug-in implements this method for its own purposes, it would, in general, switch on the id and if it is not aware of the id it would call this method on the base class. Otherwise it could respond to the id as it needed. See the sample code below for the how the Control class implements this method.

Parameters

id	The id of the interface.

Default Implementation:

{ return NULL; }

Sample Code:

The following is the Control class implementation of this method. It looks at the id passed, and if it matches I_CONTROL it returns its this pointer. Otherwise it calls the base class method.

void* Control::GetInterface(ULONG id)
{
    if (id==I_CONTROL) {
        return this;
    }
    else {
        return Animatable::GetInterface(id);
    }
}

Reimplemented from ShapeObject.

GetObjectName()

virtual CoreExport const MCHAR * GetObjectName ( bool  localized = true ) const

overridevirtual

Returns

the name that will appear in the modifier stack.

Parameters

localized

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

Reimplemented from BaseObject.

NumSubs()

CoreExport int NumSubs ( )

virtual

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

SubAnim()

CoreExport Animatable * SubAnim ( int  i )

virtual

This method returns the ShapeObject's animatable pointer.

Derived classes implementing this method must pass on references to index 0 to the ShapeObject. For example:: Animatable* SomeShape::SubAnim(int i) {

if(i == 0) return ShapeObject::SubAnim(i);

}

Parameters

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

Reimplemented from ShapeObject.

SubAnimName()

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

overridevirtual

This method returns the name of the animatable's name.

Derived classes implementing this method must pass on references to index 0 to the ShapeObject. For example: MSTR SomeShape::SubAnimName(int i, bool localized) {

if (i == 0) return ShapeObject::SubAnimName(i, localized);

}

Parameters

i	This is the index of the sub-anim's name to return.
localized	If true, then the sub-anim name returned is localized.

Reimplemented from ShapeObject.

AssignController()

CoreExport BOOL AssignController ( Animatable *  control, int  subAnim  )

virtual

Remarks

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

Parameters

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

Default Implementation:

{ return FALSE; }

Returns

Returns TRUE if the controller was assigned; otherwise FALSE.

Reimplemented from Animatable.

SubNumToRefNum()

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.

{return subNum;}

SelectSubAnim()

CoreExport BOOL SelectSubAnim ( int  subNum )

virtual

Remarks

This method is available in release 2.0 and later only.

When a user is in Track View in Edit Keys mode and clicks on the green triangle of a controller then this method will be called on the client with the appropriate sub number that corresponds to it. For instance, the Editable Mesh object implements this to allow the user to select vertices that are animated from the Track View.

Parameters

subNum

The index of the sub-anim that was clicked on.

Returns

TRUE if implemented; otherwise FALSE. (Track View will call RedrawViewports() if something returns TRUE from this method).

Default Implementation:

{return FALSE;}

Reimplemented from Animatable.

RescaleWorldUnits()

CoreExport void RescaleWorldUnits ( float  f )

virtual

Implemented by the System.

Objects derived from this class which have RescaleWorldUnits methods implemented need to call this method. The following example is the SplineShape implementation of this method from core.

void SplineShape::RescaleWorldUnits(float f)
{
    if (TestAFlag(A_WORK1))
        return;
// Call the base class's rescale (this sets the A_WORK1 flag)
    ShapeObject::RescaleWorldUnits(f);
// Now rescale stuff inside our data structures
    Matrix3 stm = ScaleMatrix(Point3(f, f, f));
    shape.Transform(stm);
}

Note that the A_WORK1 flags is tested first to be sure it isn't processing the rescale twice. The code then calls ShapeObject::RescaleWorldUnits, which sets the A_WORK1 flag and performs the necessary rescale methods for all references for the object, and scales the renderable thickness value.

Parameters

f	The parameter to scale.

Reimplemented from ShapeObject.

RemapRefOnLoad()

CoreExport int RemapRefOnLoad ( int  iref )

virtual

This method remaps references at load time so that files saved from previous versions of 3ds Max get their references adjusted properly to allow for the new ShapeObject reference.

If derived classes implement this method, they must properly pass on the call to the ShapeObject's code. An example from the SplineShape code:

int SplineShape::RemapRefOnLoad(int iref) {
// Have the ShapeObject do its thing first...
iref = ShapeObject::RemapRefOnLoad(iref); 
 if(loadRefVersion == ES_REF_VER_0)
return iref+1;
 return iref;
}\

Note that the SplineShape first calls ShapeObject's remapper, then applies its remapping operation to the index returned by the ShapeObject code. IMPORTANT NOTE: For this remapping to operate properly, the derived class MUST call ShapeObject::Save as the first thing in its Save() method, and must call ShapeObject::Load as the first thing in its Load() method. This allows the ShapeObject to determine file versions and the need for remapping references.

Parameters

iref	The input index of the reference.

Returns

The output index of the reference.

Reimplemented from ShapeObject.

NumRefs()

CoreExport int NumRefs ( )

virtual

The ShapeObject makes 1 reference; this is where it tells the system.

Any derived classes implementing this method must take this into account when returning the number of references they make. A good idea is to implement NumRefs in derived classes as: Int SomeShape::NumRefs() {

return myNumRefs + ShapeObject::NumRefs();

}

Reimplemented from ShapeObject.

GetReference()

CoreExport RefTargetHandle GetReference ( int  i )

virtual

This method allows the ShapeObject to return a pointer to its parameter block.

Any subclasses implementing this method must pass on the call if it indicates the ShapeObject's reference. For example:

>RefTargetHandle SomeShape::GetReference(int i) {
    If(i == 0) return ShapeObject::GetReference(i);
}

Parameters

i	The reference handle to retrieve.

Returns

The handle to the Reference Target.

Reimplemented from ShapeObject.

SetReference()

virtual CoreExport void SetReference ( int  i, RefTargetHandle  rtarg  )

protectedvirtual

This method sets the ShapeObject's parameter block pointer.

Any subclasses implementing this method must pass on the call to the ShapeObject if it refers to index 0. For example: void SomeShape::SetReference(int i, RefTargetHandle rtarg) {

if(i == 0) ShapeObject::SetReference(i, rtarg);

}

Parameters

i	The virtual array index of the reference to store.
rtarg	The reference handle to store.

Reimplemented from ShapeObject.

CreateContArray()

CoreExport void CreateContArray

(

)

SynchContArray()

CoreExport void SynchContArray

(

)

AllocContArray()

CoreExport void AllocContArray

(

int

count

)

ReplaceContArray()

CoreExport void ReplaceContArray

(

Tab< Control * > &

nc

)

InsertPointConts()

CoreExport void InsertPointConts	(	int	index,
		int	count
	)

DeletePointConts()

CoreExport void DeletePointConts

(

const BitArray &

set

)

ReversePointConts()

CoreExport void ReversePointConts	(	int	index,
		int	count,
		BOOL	keepFirst
	)

NullPointConts()

CoreExport void NullPointConts	(	int	index,
		int	count
	)

NullPolyPointConts()

CoreExport void NullPolyPointConts

(

int

poly

)

PlugControllersSel()

CoreExport void PlugControllersSel

(

TimeValue

t

)

PlugControl()

CoreExport BOOL PlugControl	(	TimeValue	t,
		int	i
	)

SetPtCont()

CoreExport void SetPtCont	(	int	i,
		Control *	c
	)

SetPointAnim()

CoreExport void SetPointAnim	(	TimeValue	t,
		int	poly,
		int	vert,
		Point3	pt
	)

CloneVertCont()

CoreExport BOOL CloneVertCont	(	int	from,
		int	to
	)

SetRollupPage()

CoreExport void SetRollupPage	(	IObjParam *	ip,
		BOOL	creating
	)

RemoveRollupPage()

CoreExport void RemoveRollupPage

(

IObjParam *

ip

)

BeginEditParams()

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

virtual

This method allows the ShapeObject to create its new "Rendering" rollup.

To use it, the derived class simply calls it first thing in its own BeginEditParams method. An example from the SplineShape code:

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

{

ShapeObject::BeginEditParams(ip, flags, prev);

...

}

Parameters

objParam	The interface pointer passed to the plug-in.
flags	The flags passed along to the plug-in in Animatable::BeginEditParams().
prev	The pointer passed to the plug-in in Animatable::BeginEditParams().

Reimplemented from ShapeObject.

EndEditParams()

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

virtual

Similarly to BeginEditParams, this method allows the ShapeObject to remove its "Rendering" rollup.

A derived class simply calls this first thing in its own EndEditParams. An example from the SplineShape code:

void SplineShape::EndEditParams( IObjParam *ip, ULONG flags,Animatable
 *next )
{
ShapeObject::EndEditParams(ip, flags, next);
// ...
}

Parameters

objParam	The interface pointer passed to the plug-in.
flags	The flags passed along to the plug-in in Animatable::BeginEditParams().
next	The pointer passed to the plug-in in Animatable::EndEditParams().

Reimplemented from ShapeObject.

GetSubobjectLevel()

CoreExport int GetSubobjectLevel

(

)

SetSubobjectLevel()

CoreExport void SetSubobjectLevel

(

int

level

)

ActivateSubobjSel()

CoreExport void ActivateSubobjSel ( int  level, XFormModes &  modes  )

virtual

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

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

Parameters

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

Sample Code:

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

See also

Class XFormModes.

Reimplemented from BaseObject.

SelectSubComponent()

CoreExport void SelectSubComponent ( HitRecord *  hitRec, BOOL  selected, BOOL  all, BOOL  invert  )

virtual

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

Parameters

hitRec	Identifies the component whose selected state should be set. See Class HitRecord .
selected	TRUE if the item should be selected; FALSE if the item should be de-selected.
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).
invert	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

Reimplemented from BaseObject.

ClearSelection()

CoreExport void ClearSelection ( int  selLevel )

virtual

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

selLevel

Specifies the selection level to clear.

Reimplemented from BaseObject.

SelectAll()

CoreExport void SelectAll ( int  selLevel )

virtual

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 3ds Max Edit menu.

Parameters

selLevel

Specifies the selection level to select.

Reimplemented from BaseObject.

InvertSelection()

CoreExport void InvertSelection ( int  selLevel )

virtual

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 3ds Max Edit menu.

Parameters

selLevel

Specifies the selection level to invert.

Reimplemented from BaseObject.

GetSubObjectCenters()

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

virtual

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

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

Parameters

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

Reimplemented from BaseObject.

GetSubObjectTMs()

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

virtual

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

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

Parameters

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

Reimplemented from BaseObject.

ShowEndResultChanged()

CoreExport void ShowEndResultChanged ( BOOL  showEndResult )

virtual

This method notifies the BaseObject that the end result display has been switched (the "Show End Result" button has been toggled).

Sometimes this is needed for display changes. This method is implemented in Edit Mesh, which uses it as shown below: void EditMeshMod::ShowEndResultChanged(BOOL showEndResult) {

NotifyDependents(FOREVER, PART_DISPLAY, REFMSG_CHANGE);

}

This allows the Edit Mesh modifier to update itself in repsonse to a user click of the "Show End Result" button in the modifier panel.

Parameters

showEndResult

TRUE if Show End Result is on; FALSE if off.

Reimplemented from BaseObject.

SubObjectIndex()

CoreExport int SubObjectIndex ( HitRecord *  hitRec )

virtual

Returns the index of the sub-object element identified by the HitRecord hitRec.

See Class HitRecord. The sub-object index identifies a sub-object component. The relationship between the index and the component is established by the modifier. For example an edit modifier may allow the user to select a group of faces and these groups of faces may be identified as group 0, group 1, group 2, etc. Given a hit record that identifies a face, the edit modifier's implementation of this method would return the group index that the face belonged to.

Reimplemented from BaseObject.

MultiAttachObject()

CoreExport void MultiAttachObject

(

INodeTab &

nodeTab

)

BeginOutlineMove()

CoreExport void BeginOutlineMove

(

TimeValue

t

)

BeginFilletMove()

CoreExport void BeginFilletMove

(

TimeValue

t

)

BeginChamferMove()

CoreExport void BeginChamferMove

(

TimeValue

t

)

OutlineMove()

CoreExport void OutlineMove	(	TimeValue	t,
		float	amount
	)

FilletMove()

CoreExport void FilletMove	(	TimeValue	t,
		float	amount
	)

ChamferMove()

CoreExport void ChamferMove	(	TimeValue	t,
		float	amount
	)

EndMoveModes()

CoreExport void EndMoveModes	(	TimeValue	t,
		BOOL	accept = TRUE
	)

EndOutlineMove()

CoreExport void EndOutlineMove	(	TimeValue	t,
		BOOL	accept = TRUE
	)

EndFilletMove()

CoreExport void EndFilletMove	(	TimeValue	t,
		BOOL	accept = TRUE
	)

EndChamferMove()

CoreExport void EndChamferMove	(	TimeValue	t,
		BOOL	accept = TRUE
	)

StartOutlineMode()

CoreExport void StartOutlineMode

(

)

StartFilletMode()

CoreExport void StartFilletMode

(

)

StartChamferMode()

CoreExport void StartChamferMode

(

)

DoOutline()

CoreExport void DoOutline

(

)

DoFillet()

CoreExport void DoFillet

(

)

DoChamfer()

CoreExport void DoChamfer

(

)

StartSegBreakMode()

CoreExport void StartSegBreakMode

(

)

DoSegBreak()

CoreExport void DoSegBreak	(	ViewExp *	vpt,
		BezierShape *	shape,
		int	poly,
		int	seg,
		IPoint2	p,
		INode *	inode = NULL
	)

StartSegRefineMode()

CoreExport void StartSegRefineMode

(

)

DoSegRefine()

CoreExport void DoSegRefine	(	ViewExp *	vpt,
		BezierShape *	shape,
		int	poly,
		int	seg,
		IPoint2	p,
		INode *	inode = NULL
	)

StartCrossInsertMode()

CoreExport void StartCrossInsertMode

(

)

DoCrossInsert()

CoreExport void DoCrossInsert	(	ViewExp *	vpt,
		BezierShape *	shape,
		int	poly1,
		int	seg1,
		int	poly2,
		int	seg2,
		IPoint2	p
	)

StartVertConnectMode()

CoreExport void StartVertConnectMode

(

)

DoVertConnect()

CoreExport void DoVertConnect	(	ViewExp *	vpt,
		BezierShape *	shape,
		int	poly1,
		int	vert1,
		int	poly2,
		int	vert2
	)

StartVertInsertMode()

CoreExport void StartVertInsertMode

(

int

controlID

)

StartVertInsert()

CoreExport int StartVertInsert	(	ViewExp *	vpt,
		BezierShape *	shape,
		int	poly,
		int	seg,
		int	vert,
		INode *	inode = NULL
	)

EndVertInsert()

CoreExport void EndVertInsert

(

BOOL

acceptUndo

)

StartCreateLineMode()

CoreExport void StartCreateLineMode

(

)

StartCreateLine()

CoreExport BOOL StartCreateLine

(

BezierShape **

shape

)

EndCreateLine()

CoreExport void EndCreateLine

(

)

StartCrossSectionMode()

CoreExport void StartCrossSectionMode

(

)

this has the same effect as pressing the Cross Section button in the Spline's Geometry rollout

StartCrossSection()

CoreExport void StartCrossSection

(

)

should be used before a sequence of calls to DoCrossSection()

EndCrossSection()

CoreExport void EndCrossSection

(

BOOL

acceptUndo

)

should be used after a sequence of calls to DoCrossSection()

BooleanStartUp()

CoreExport BOOL BooleanStartUp

(

)

StartBooleanMode()

CoreExport void StartBooleanMode

(

)

DoBoolean()

CoreExport void DoBoolean

(

int

poly2

)

StartTrimMode()

CoreExport void StartTrimMode

(

)

StartExtendMode()

CoreExport void StartExtendMode

(

)

HandleTrimExtend()

CoreExport void HandleTrimExtend	(	ViewExp *	vpt,
		ShapeHitData *	hit,
		IPoint2 &	m,
		int	operation
	)

GetAttachMat()

CoreExport int GetAttachMat ( )

virtual

Remarks

Returns the attach material setting. One of the following values:

ATTACHMAT_IDTOMAT

Match material IDs to material.

ATTACHMAT_MATTOID

Match Material to Material IDs.

ATTACHMAT_NEITHER

Do not modify Material IDs or Material.

Implements AttachMatDlgUser.

SetAttachMat()

CoreExport void SetAttachMat ( int  value )

virtual

Remarks

Sets the attach material value.

Parameters:

int value

One of the following values:

ATTACHMAT_IDTOMAT

Match material IDs to material.

ATTACHMAT_MATTOID

Match Material to Material IDs.

ATTACHMAT_NEITHER

Do not modify Material IDs or Material.

Implements AttachMatDlgUser.

GetCondenseMat()

CoreExport BOOL GetCondenseMat ( )

virtual

Remarks

Returns the condense material and IDs settings.

Implements AttachMatDlgUser.

SetCondenseMat()

CoreExport void SetCondenseMat ( BOOL  sw )

virtual

Remarks

Sets the condense material and IDs setting.

Parameters:

BOOL sw

TRUE for on; FALSE for off.

Implements AttachMatDlgUser.

DoAttach()

CoreExport int DoAttach	(	INode *	node,
		bool &	canUndo
	)

DoCrossSection()

CoreExport void DoCrossSection

(

Tab< int > &

splineIndices

)

creates a cross section of the current selected spline or segement with the given spline(s).

This can be called multiple times in sequence, once for each section in the cross section.

DoVertBreak()

CoreExport void DoVertBreak

(

)

DoVertWeld()

CoreExport void DoVertWeld

(

)

DoMakeFirst()

CoreExport void DoMakeFirst

(

)

DoVertDelete()

CoreExport void DoVertDelete

(

)

DoSegDelete()

CoreExport void DoSegDelete

(

)

DoSegDetach()

CoreExport void DoSegDetach	(	int	sameShape,
		int	copy,
		int	reorient
	)

DoSegDivide()

CoreExport void DoSegDivide

(

int

divisions

)

DoPolyClose()

CoreExport void DoPolyClose

(

)

DoPolyDetach()

CoreExport void DoPolyDetach	(	int	copy,
		int	reorient
	)

DoPolyMirror()

CoreExport void DoPolyMirror	(	int	type,
		int	copy
	)

DoPolyDelete()

CoreExport void DoPolyDelete

(

)

DoPolyReverse()

CoreExport void DoPolyReverse

(

)

DoPolyExplode()

CoreExport void DoPolyExplode

(

)

DoExplodeToObjects()

CoreExport void DoExplodeToObjects

(

)

SetBoolOperation()

CoreExport void SetBoolOperation ( int  type )

inline

{ boolType = type; }

SetMirrorOperation()

CoreExport void SetMirrorOperation ( int  type )

inline

{ mirrorType = type; }

GetBoolOperation()

CoreExport int GetBoolOperation ( )

inline

{ return boolType; }

GetMirrorOperation()

CoreExport int GetMirrorOperation ( )

inline

{ return mirrorType; }

GetBoolCursorID()

CoreExport UI::MouseCursors::ECursors GetBoolCursorID

(

)

GetBoolMirrString()

CoreExport int GetBoolMirrString

(

UINT_PTR

type

)

SetBooleanButton()

CoreExport void SetBooleanButton

(

)

SetMirrorButton()

CoreExport void SetMirrorButton

(

)

ChangeSelVerts()

CoreExport void ChangeSelVerts

(

int

type

)

ChangeRememberedVert()

CoreExport void ChangeRememberedVert

(

int

type

)

RememberVertThere()

CoreExport int RememberVertThere	(	HWND	hWnd,
		IPoint2	m
	)

SetRememberedVertType()

CoreExport void SetRememberedVertType

(

int

type

)

ChangeSelSegs()

CoreExport void ChangeSelSegs

(

int

type

)

ChangeRememberedSeg()

CoreExport void ChangeRememberedSeg

(

int

type

)

RememberSegThere()

CoreExport int RememberSegThere	(	HWND	hWnd,
		IPoint2	m
	)

SetRememberedSegType()

CoreExport void SetRememberedSegType

(

int

type

)

ChangeSelPolys()

CoreExport void ChangeSelPolys

(

int

type

)

ChangeRememberedPoly()

CoreExport void ChangeRememberedPoly

(

int

type

)

RememberPolyThere()

CoreExport int RememberPolyThere	(	HWND	hWnd,
		IPoint2	m
	)

SetRememberedPolyType()

CoreExport void SetRememberedPolyType

(

int

type

)

SplineShapeClone()

CoreExport void SplineShapeClone

(

SplineShape *

source

)

GetPointIndex()

CoreExport int GetPointIndex	(	const Tab< Point3 > &	vertList,
		const Point3 &	point
	)		const

this simply performs a linear search through the given list, returning the index of the given point

DeleteSpline()

CoreExport void DeleteSpline

(

int

poly

)

InsertSpline()

CoreExport void InsertSpline	(	Spline3D *	spline,
		int	poly
	)

Reverse()

CoreExport void Reverse	(	int	poly,
		BOOL	keepFirst = FALSE
	)

DeleteKnot()

CoreExport void DeleteKnot	(	int	poly,
		int	index
	)

AddKnot()

CoreExport void AddKnot	(	int	poly,
		SplineKnot &	k,
		int	where = -1
	)

Append()

CoreExport BOOL Append	(	int	poly,
		Spline3D *	spline,
		BOOL	weldCoincidentFirstVertex = TRUE
	)

Prepend()

CoreExport BOOL Prepend	(	int	poly,
		Spline3D *	spline,
		BOOL	weldCoincidentLastVertex = TRUE
	)

ReplaceSpline()

CoreExport void ReplaceSpline	(	int	poly,
		Spline3D *	spline
	)

DeleteSelVerts()

CoreExport BOOL DeleteSelVerts

(

int

poly

)

DeleteSelSegs()

CoreExport BOOL DeleteSelSegs

(

int

poly

)

MakeFirst()

CoreExport void MakeFirst	(	int	poly,
		int	index
	)

SetOptimize()

CoreExport void SetOptimize

(

BOOL

sw

)

SetAdaptive()

CoreExport void SetAdaptive

(

BOOL

sw

)

SetSteps()

CoreExport void SetSteps

(

int

n

)

RecordTopologyTags()

CoreExport void RecordTopologyTags

(

)

RecordTopology()

CoreExport void RecordTopology

(

)

ResolveTopoChanges()

CoreExport void ResolveTopoChanges	(	BezierShape *	shape = NULL,
		int	bindTrackingOptions = 1
	)

FixupControllerTopo()

CoreExport void FixupControllerTopo

(

SplineShape *

ss

)

RefreshSelType()

CoreExport void RefreshSelType

(

)

UpdateSelectDisplay()

CoreExport void UpdateSelectDisplay

(

)

SetSelDlgEnables()

CoreExport void SetSelDlgEnables

(

)

SetOpsDlgEnables()

CoreExport void SetOpsDlgEnables

(

)

SetSurfDlgEnables()

CoreExport void SetSurfDlgEnables

(

)

SetSoftSelDlgEnables()

CoreExport void SetSoftSelDlgEnables

(

HWND

hSoftSel = NULL

)

SelectionChanged()

CoreExport void SelectionChanged

(

)

MaybeSelectSingleSpline()

CoreExport BOOL MaybeSelectSingleSpline

(

BOOL

makeUndo = FALSE

)

SetFCLimit()

CoreExport void SetFCLimit

(

)

GetSelMatIndex()

CoreExport int GetSelMatIndex

(

)

SetSelMatIndex()

CoreExport void SetSelMatIndex

(

int

index

)

SelectByMat()

CoreExport void SelectByMat	(	int	index,
		BOOL	clear
	)

InvalidateSurfaceUI()

CoreExport void InvalidateSurfaceUI

(

)

Save()

CoreExport IOResult Save ( ISave *  isave )

virtual

Implemented by the System.

This method handles the storage of the data contained within the ShapeObject. In order to properly store this information, classes which subclass off of ShapeObject need to call this methods before storing their information.

Parameters

isave

An interface for saving data. See Class ISave.

Reimplemented from ShapeObject.

Load()

CoreExport IOResult Load ( ILoad *  iload )

virtual

Implemented by the System.

This method handles the loading of the data contained within the ShapeObject. In order to properly load this information, classes which subclass off of ShapeObject need to call this methods before loading their information.

Parameters

iload

An interface for loading data. See Class ILoad.

Reimplemented from ShapeObject.

StartBindMode()

CoreExport void StartBindMode

(

)

DoBind()

CoreExport void DoBind	(	int	poly1,
		int	vert1,
		int	poly2,
		int	vert2
	)

DoUnBind()

CoreExport void DoUnBind

(

)

DoHide()

CoreExport void DoHide

(

)

DoUnhide()

CoreExport void DoUnhide

(

)

DoCycleVerts()

CoreExport void DoCycleVerts

(

)

StartRefineConnectMode()

CoreExport void StartRefineConnectMode

(

)

EndRefineConnectMode()

CoreExport void EndRefineConnectMode

(

)

DoRefineConnect()

CoreExport void DoRefineConnect	(	ViewExp *	vpt,
		BezierShape *	shape,
		int	poly,
		int	seg,
		IPoint2	p,
		INode *	inode = NULL
	)

DoVertFuse()

CoreExport void DoVertFuse

(

)

StartCopyTangentMode()

CoreExport void StartCopyTangentMode

(

)

this has the same effect as pressing the Copy button in the "Tangent" section of the Spline UI, when in Vertex sub-object mode

StartPasteTangentMode()

CoreExport void StartPasteTangentMode

(

)

this has the same effect as pressing the Paste button in the "Tangent" section of the Spline UI, when in Vertex sub-object mode

StartPasteTangent()

CoreExport void StartPasteTangent

(

)

should be used before a call to PasteTangent()

EndPasteTangent()

CoreExport void EndPasteTangent

(

)

should be used following a call to PasteTangent()

CopyTangent()

CoreExport BOOL CopyTangent	(	int	poly,
		int	vert
	)

copy the given tangent

PasteTangent()

CoreExport BOOL PasteTangent	(	int	poly,
		int	vert
	)

paste the given tangent.

This should be preceeded by a call to StartPasteTangent() and followed by EndPasteTangent()

StartCommandMode()

CoreExport void StartCommandMode ( splineCommandMode  mode )

virtual

Remarks

Begins the specified interactive command mode.

Parameters:

splineCommandMode mode

The mode to begin. One of the following values:

ScmCreateLine

ScmAttach

ScmInsert

ScmConnect

ScmRefine

ScmFillet

ScmChamfer

ScmBind

ScmRefineConnect

ScmOutline

ScmTrim

ScmExtend

ScmBreak

ScmUnion

ScmCrossInsert

Implements ISplineOps.

ButtonOp()

CoreExport void ButtonOp ( splineButtonOp  opcode )

virtual

Remarks

Performs the same operation as a button press inside the Editable Spline UI.

Parameters:

splineButtonOp opcode

The button operation to execute. One of the following values:

SopHide

SopUnhideAll

SopDelete

SopDetach

SopDivide

SopBreak

SopCycle

SopUnbind

SopWeld

SopMakeFirst

SopAttachMultiple

SopExplode

SopReverse

SopClose

SopUnion

SopSubstract

SopIntersect

SopMirrorHoriz

SopMirrorVert

SopMirrorBoth

SopSelectByID

SopFuse

Implements ISplineOps.

GetUIParam() [1/2]

CoreExport void GetUIParam ( splineUIParam  uiCode, int &  ret  )

virtual

Remarks

This method is available in release 4.0 and later only.

This method allows you to get the edit spline parameters from the command panel. Currently not in use.

Parameters:

splineUIParam uiCode

This enum is currently empty.

int &ret

The returned value.

Default Implementation:

{ }

Reimplemented from ISplineOps.

SetUIParam() [1/2]

CoreExport void SetUIParam ( splineUIParam  uiCode, int  val  )

virtual

Remarks

This method is available in release 4.0 and later only.

This method allows you to set the edit spline parameters from the command panel. Currently not in use.

Parameters:

splineUIParam uiCode

This enum is currently empty.

int val

The value to set.

Default Implementation:

{ }

Reimplemented from ISplineOps.

GetUIParam() [2/2]

CoreExport void GetUIParam ( splineUIParam  uiCode, float &  ret  )

virtual

Remarks

This method is available in release 4.0 and later only.

This method allows you to get the edit spline parameters from the command panel. Currently not in use.

Parameters:

splineUIParam uiCode

This enum is currently empty.

float &ret

The returned value.

Default Implementation:

{ }

Reimplemented from ISplineOps.

SetUIParam() [2/2]

CoreExport void SetUIParam ( splineUIParam  uiCode, float  val  )

virtual

Remarks

This method is available in release 4.0 and later only.

This method allows you to set the edit spline parameters from the command panel. Currently not in use.

Parameters:

splineUIParam uiCode

This enum is currently empty.

float val

The value to set.

Default Implementation:

{ }

Reimplemented from ISplineOps.

Editing()

bool Editing ( )

inline

Remarks

This method is available in release 4.0 and later only.

This method will return TRUE if the SplineShape object or Edit Spline modifier is active in the command panel.

Default Implementation:

{ return (ip && (editObj==this)) ? TRUE : FALSE; }

{ return (ip && (editObj==this)) ? TRUE : FALSE; }

GetSelLevel()

CoreExport DWORD GetSelLevel ( )

virtual

Remarks

Returns a value indicating the current selection level of the modifier. One of the following values:

SS_VERTEX

SS_SEGMENT

SS_SPLINE

SS_OBJECT

Implements ISplineSelect.

SetSelLevel()

CoreExport void SetSelLevel ( DWORD  level )

virtual

Remarks

Sets the current level of selection of the modifier.

Parameters:

DWORD level

The level to set. One of the following values:

SS_VERTEX

SS_SEGMENT

SS_SPLINE

SS_OBJECT

Implements ISplineSelect.

LocalDataChanged()

CoreExport void LocalDataChanged ( )

virtual

Remarks

This method must be called when the selection level of the modifier is changed. Developers can use the methods of ISplineSelect to get and set the actual selection data. When a developers does set any of these selection sets this method must be called when done.

Implements ISplineSelect.

GetVertSel()

CoreExport BitArray GetVertSel ( )

virtual

Remarks

Returns a BitArray that reflects the current vertex selection. There is one bit for each vertex. Bits that are 1 indicate the vertex is selected.

Implements ISplineSelectData.

GetSegmentSel()

CoreExport BitArray GetSegmentSel ( )

virtual

Remarks

Returns a BitArray that reflects the current segment selection. There is one bit for each segment. Bits that are 1 indicate the segment is selected.

Implements ISplineSelectData.

GetSplineSel()

CoreExport BitArray GetSplineSel ( )

virtual

Remarks

Returns a BitArray that reflects the current spline selection. There is one bit for each spline. Bits that are 1 indicate the spline is selected.

Implements ISplineSelectData.

SelectBySegment()

CoreExport void SelectBySegment

(

BOOL

interactive = TRUE

)

Remarks

This method is available in release 4.0 and later only.

This method operates in vertex level only, and sets the vertex selection set based on the segments that are selected. Any vertex which is part of a selected segment will be selected.

Parameters:

BOOL interactive

If set to FALSE, an Undo object is not created and the method does not initiate a redraw.

SelectBySpline()

CoreExport void SelectBySpline

(

BOOL

interactive = TRUE

)

Remarks

This method is available in release 4.0 and later only.

This method operates in vertex and segment level only, and sets the vertex or segment selection set based on the splines that are selected. If in vertex mode, any vertex which is part of a selected spline will be selected. If in segment mode, any segment whcich is part of a selected spline will be selected.

Parameters:

BOOL interactive

If set to FALSE, an Undo object is not created and the method does not initiate a redraw.

SetVertSel()

CoreExport void SetVertSel ( BitArray &  set, ISplineSelect *  imod, TimeValue  t  )

virtual

Remarks

Sets the vertex selection of the modifier.

Parameters:

BitArray &set

There is one bit for each vertex. Bits that are 1 indicate the vertex should be selected.

ISplineSelect *imod

Points to the ISplineSelect instance (generally this is a modifier).

TimeValue t

The current time at which the call is made.

Implements ISplineSelectData.

SetSegmentSel()

CoreExport void SetSegmentSel ( BitArray &  set, ISplineSelect *  imod, TimeValue  t  )

virtual

Remarks

Sets the segment selection of the modifier.

Parameters:

BitArray &set

There is one bit for each vertex. Bits that are 1 indicate the segment should be selected.

ISplineSelect *imod

Points to the ISplineSelect instance (generally this is a modifier).

TimeValue t

The current time at which the call is made.

Implements ISplineSelectData.

SetSplineSel()

CoreExport void SetSplineSel ( BitArray &  set, ISplineSelect *  imod, TimeValue  t  )

virtual

Remarks

Sets the spline selection of the modifier.

Parameters:

BitArray &set

There is one bit for each spline. Bits that are 1 indicate the spline should be selected.

ISplineSelect *imod

Points to the ISplineSelect instance (generally this is a modifier).

TimeValue t

The current time at which the call is made.

Implements ISplineSelectData.

GetNamedVertSelList()

CoreExport GenericNamedSelSetList & GetNamedVertSelList ( )

virtual

Remarks

Returns a reference to a class used for manipulating the lists of vertex level named selection sets associated with this modifier.

Implements ISplineSelectData.

GetNamedSegmentSelList()

CoreExport GenericNamedSelSetList & GetNamedSegmentSelList ( )

virtual

Remarks

Returns a reference to a class used for manipulating the lists of segment level named selection sets associated with this modifier.

Implements ISplineSelectData.

GetNamedSplineSelList()

CoreExport GenericNamedSelSetList & GetNamedSplineSelList ( )

virtual

Remarks

Returns a reference to a class used for manipulating the lists of spline level named selection sets associated with this modifier.

Implements ISplineSelectData.

GetNextAvailMtlID()

CoreExport MtlID GetNextAvailMtlID ( ModContext *  mc )

virtual

Remarks

This method returns a material ID that is currently not used by the object. If the current face selection share one single MtlDI that is not used by any other faces, you should use it.

Implements ISubMtlAPI.

HasFaceSelection()

CoreExport BOOL HasFaceSelection ( ModContext *  mc )

virtual

Remarks

This method indicates if you are active in the modifier panel and have an active face selection. Return TRUE if so, otherwise FALSE.

Implements ISubMtlAPI.

SetSelFaceMtlID()

CoreExport void SetSelFaceMtlID ( ModContext *  mc, MtlID  id, BOOL  bResetUnsel = FALSE  )

virtual

Remarks

This method sets the selected faces to the specified material ID..

Parameters:

MtlID id

The material id to set for the selected faces.

BOOL bResetUnsel = FALSE

If TRUE, then you should set the remaining unselected face material IDs to 0.

Implements ISubMtlAPI.

GetSelFaceUniqueMtlID()

CoreExport int GetSelFaceUniqueMtlID ( ModContext *  mc )

virtual

Remarks

This method returns the material ID of the selected face(s). If multiple faces are selected they should all have the same MtlID – otherwise you should return -1. If faces other than the selected share the same material ID, then return -1.

Implements ISubMtlAPI.

GetSelFaceAnyMtlID()

CoreExport int GetSelFaceAnyMtlID ( ModContext *  mc )

virtual

Remarks

This method returns the material ID of the selected face(s). If multiple faces are selected they should all have the same MtlID, otherwise return -1.

Implements ISubMtlAPI.

GetMaxMtlID()

CoreExport int GetMaxMtlID ( ModContext *  mc )

virtual

Remarks

This method returns the highest MtlID on the object.

Implements ISubMtlAPI.

InvalidateGeomCache()

CoreExport void InvalidateGeomCache ( )

virtual

This method is very important - It causes the ShapeObject to flush its cached rendering mesh.

Most objects have their own "InvalidateGeomCache" methods; simply call this when a shape derived from ShapeObject changes and it will ensure that the rendering mesh is regenerated the next time it is evaluated. Failure to call this method will result in improper rendering mesh updates.

Reimplemented from ShapeObject.

UseEdgeDists()

CoreExport int UseEdgeDists

(

)

SetUseEdgeDists()

CoreExport void SetUseEdgeDists

(

int

useSoftSelections

)

UseSoftSelections()

CoreExport int UseSoftSelections

(

)

SetUseSoftSelections()

CoreExport void SetUseSoftSelections

(

int

useSoftSelections

)

InvalidateVertexWeights()

CoreExport void InvalidateVertexWeights

(

)

UpdateVertexDists()

CoreExport void UpdateVertexDists

(

)

UpdateEdgeDists()

CoreExport void UpdateEdgeDists

(

)

UpdateVertexWeights()

CoreExport void UpdateVertexWeights

(

)

InitSplineShapeAutoConnectControls()

static CoreExport void InitSplineShapeAutoConnectControls ( )

static

SetUseEndPointAutoConnect()

static CoreExport void SetUseEndPointAutoConnect ( UINT  i )

static

GetUseEndPointAutoConnect()

static CoreExport UINT GetUseEndPointAutoConnect ( )

static

SetPromptForEndPointAutoConnect()

static CoreExport void SetPromptForEndPointAutoConnect ( UINT  i )

static

GetPromptForEndPointAutoConnect()

static CoreExport UINT GetPromptForEndPointAutoConnect ( )

static

SetEndPointAutoWeldThreshold()

static CoreExport void SetEndPointAutoWeldThreshold ( float  f )

static

GetEndPointAutoWeldThreshold()

static CoreExport float GetEndPointAutoWeldThreshold ( )

static

GetInterface() [2/3]

virtual CoreExport BaseInterface * GetInterface ( Interface_ID  id )

overridevirtual

Remarks

Returns a pointer to the Base Interface for the interface ID passed. The default implementation of this method retrieves this information from the ClassDesc for the plug-in.

Any future object-based interfaces should be allocated unique Interface_IDs (you can use Gencid.exe for this) and made available through this call.

The default implementation of GetInterface(Interface_ID) looks up a standalone interface of the given ID on the object's ClassDesc. This gives access to standalone interfaces via any of a plug-in's objects, without having to dig around for the ClassDesc, so you should fall back to calling the default implementation if you don't recognize an ID in your implementation of GetInterface(Interface_ID).

Parameters

id	The unique ID of the interface to get. See Class Interface_ID.

Reimplemented from ShapeObject.

GetInterface() [3/3]

virtual CoreExport void * GetInterface ( ULONG  id )

overridevirtual

Remarks

This method provides a mechanism for extending the class in the future. In 3ds Max 4.0 there are new interfaces that are accessed by passing an id to this method and it will respond by returning the corresponding interface pointer.

This method has been used however for a different purpose. It currently is used to determine if an object is of a particular class. With controllers for example, there is one base class Control, however there are many super classes (CTRL_FLOAT_CLASS_ID, CTRL_SCALE_CLASS_ID, etc.). If you wanted to find out if a given Animatable was a controller you would need to compare its SuperClassID to all the known types and only if it wasn't one of the known types could you be sure it wasn't a controller. Having to do this is inconvenient for a developer.

Instead the Control class implements this method. It looks at the id, and if it matches a predefined constant I_CONTROL, it returns its this pointer. In this way, given any Animatable, it is easy to find out if it is a controller by simply asking for the control interface. There is a macro that does this:

#define GetControlInterface(anim)
((Control*)anim-\>GetInterface(I_CONTROL))

A plug-in developer may use this macro as follows:

Control *c = GetControlInterface(anim);

This will either be NULL or a pointer to a valid controller.

Note: Plug-in defined interfaces should be greater than the following value:

#define I_USERINTERFACE 0x0000ffff

If a plug-in implements this method for its own purposes, it would, in general, switch on the id and if it is not aware of the id it would call this method on the base class. Otherwise it could respond to the id as it needed. See the sample code below for the how the Control class implements this method.

Parameters

id	The id of the interface.

Default Implementation:

{ return NULL; }

Sample Code:

The following is the Control class implementation of this method. It looks at the id passed, and if it matches I_CONTROL it returns its this pointer. Otherwise it calls the base class method.

void* Control::GetInterface(ULONG id)
{
    if (id==I_CONTROL) {
        return this;
    }
    else {
        return Animatable::GetInterface(id);
    }
}

Reimplemented from ShapeObject.

Friends And Related Function Documentation

SSXFormProc

friend class SSXFormProc

friend

SSOutlineCMode

friend class SSOutlineCMode

friend

SSFilletCMode

friend class SSFilletCMode

friend

SSChamferCMode

friend class SSChamferCMode

friend

SSSegBreakCMode

friend class SSSegBreakCMode

friend

SSSegRefineCMode

friend class SSSegRefineCMode

friend

SSCrossInsertCMode

friend class SSCrossInsertCMode

friend

SSVertConnectCMode

friend class SSVertConnectCMode

friend

SSVertInsertCMode

friend class SSVertInsertCMode

friend

SSCreateLineCMode

friend class SSCreateLineCMode

friend

SSCrossSectionCMode

friend class SSCrossSectionCMode

friend

SSBooleanCMode

friend class SSBooleanCMode

friend

SSTrimCMode

friend class SSTrimCMode

friend

SSExtendCMode

friend class SSExtendCMode

friend

SSCopyTangentCMode

friend class SSCopyTangentCMode

friend

SSPasteTangentCMode

friend class SSPasteTangentCMode

friend

SSOutlineMouseProc

friend class SSOutlineMouseProc

friend

SSFilletMouseProc

friend class SSFilletMouseProc

friend

SSChamferMouseProc

friend class SSChamferMouseProc

friend

SSSegBreakMouseProc

friend class SSSegBreakMouseProc

friend

SSSegRefineMouseProc

friend class SSSegRefineMouseProc

friend

SSCrossInsertMouseProc

friend class SSCrossInsertMouseProc

friend

SSVertConnectMouseProc

friend class SSVertConnectMouseProc

friend

SSVertInsertMouseProc

friend class SSVertInsertMouseProc

friend

SSCreateLineMouseProc

friend class SSCreateLineMouseProc

friend

SSBooleanMouseProc

friend class SSBooleanMouseProc

friend

SSTrimMouseProc

friend class SSTrimMouseProc

friend

SSExtendMouseProc

friend class SSExtendMouseProc

friend

SplineShapeRestore

friend class SplineShapeRestore

friend

SSRightMenu

friend class SSRightMenu

friend

SSMBackspaceUser

friend class SSMBackspaceUser

friend

SSIBackspaceUser

friend class SSIBackspaceUser

friend

SSPickSplineAttach

friend class SSPickSplineAttach

friend

SSAttachHitByName

friend class SSAttachHitByName

friend

SplineShapeClassDesc

friend class SplineShapeClassDesc

friend

SplineModSubModSelectionProcessor

friend class SplineModSubModSelectionProcessor

friend

SSBindMouseProc

friend class SSBindMouseProc

friend

SSBindCMode

friend class SSBindCMode

friend

SSRefineConnectMouseProc

friend class SSRefineConnectMouseProc

friend

SSRefineConnectCMode

friend class SSRefineConnectCMode

friend

SSActionCallback

friend class SSActionCallback

friend

SplineGenDlgProc

INT_PTR CALLBACK SplineGenDlgProc ( HWND  hDlg, UINT  message, WPARAM  wParam, LPARAM  lParam  )

friend

SplineSelectDlgProc

INT_PTR CALLBACK SplineSelectDlgProc ( HWND  hDlg, UINT  message, WPARAM  wParam, LPARAM  lParam  )

friend

SplineOpsDlgProc

INT_PTR CALLBACK SplineOpsDlgProc ( HWND  hDlg, UINT  message, WPARAM  wParam, LPARAM  lParam  )

friend

SplineSurfDlgProc

INT_PTR CALLBACK SplineSurfDlgProc ( HWND  hDlg, UINT  message, WPARAM  wParam, LPARAM  lParam  )

friend

SelectByDlgProc

INT_PTR CALLBACK SelectByDlgProc ( HWND  hDlg, UINT  message, WPARAM  wParam, LPARAM  lParam  )

friend

Member Data Documentation

drawTicks

BOOL drawTicks

protected

generalUIDisplayed

BOOL generalUIDisplayed

protected

ip

IObjParam* ip

static

editObj

SplineShape* editObj

static

noderef

SingleRefMakerSplineNode* noderef

mtlref

SingleRefMakerSplineMtl* mtlref

shape

BezierShape shape

steps

int steps

showVertNumbers

BOOL showVertNumbers

SVNSelectedOnly

BOOL SVNSelectedOnly

esFlags

DWORD esFlags

vselSet

NamedVertSelSetList vselSet

sselSet

NamedSegSelSetList sselSet

pselSet

NamedPolySelSetList pselSet

pointCtrlContainer

PointControllerContainer* pointCtrlContainer

cont

Tab<Control*> cont

showVerts

BOOL showVerts

showSelected

BOOL showSelected

smoothRefineConnect

BOOL smoothRefineConnect

closedRefineConnect

BOOL closedRefineConnect

bindFirst

BOOL bindFirst

bindLast

BOOL bindLast

rConnect

BOOL rConnect

useAreaSelect

BOOL useAreaSelect

areaSelect

float areaSelect

knotPoint1

SplineKnot knotPoint1

knotPoint2

SplineKnot knotPoint2

startSegRC

int startSegRC

startSegSplineRC

int startSegSplineRC

startSplineRC

int startSplineRC

endSegRC

int endSegRC

endSegSplineRC

int endSegSplineRC

endSplineRC

int endSplineRC

pointList

Tab<Point3> pointList

bindMode

SSBindCMode* bindMode

static

refineConnectMode

SSRefineConnectCMode* refineConnectMode

static