This reference page is linked to from the following overview topics: Object Plug-ins, Plug-in Base Classes, Deformable Objects, Mappable Objects, Primitive Pipeline Objects, Simple Modifiers, Principal Classes, Using setHitCode and setHitDistance.

Detailed Description

See also:: Class GeomObject, Class IPatchOps, Class IPatchSelect, Class IPatchSelectData, Class ISubMtlAPI, Class AttachMatDlgUser, Class PatchMesh, Class Patch, Class Mesh, Class TessApprox, Working with Patches.

class PatchObject : public GeomObject, IPatchOps, IPatchSelect, IPatchSelectData, ISubMtlAPI, AttachMatDlgUser

Description:: This class is the base class for the creation of Patch objects. This class stores an instance of a PatchMesh that holds all the Patches that make up this patch object. This class also maintains a Mesh cache. All methods of this class are implemented by the system.

Data Members:: PatchMesh patch;

The patch mesh for this patch object.

Mesh mesh;

The Mesh cache.

BOOL meshValid;

Indicates if the mesh cache is valid.

BOOL showMesh;

Indicates if the mesh is shown in the viewports

GenericNamedSelSetList vselSet;

This data member is available in release 3.0 and later only.

Vertex level named selection sets.

GenericNamedSelSetList eselSet;

This data member is available in release 3.0 and later only.

Edge level named selection sets.

GenericNamedSelSetList pselSet;

This data member is available in release 3.0 and later only.

Patch level named selection sets.

int patchSelSubType;

This data member is available in release 4.0 and later only.

The sub-object selection level, defined by;

PO_PATCH

Patch sub-object level. When SetSubobjectLevel(PO_PATCH) is called, both the PatchMesh selection

level and patchSelSubType are set to PO_PATCH.

PO_ELEMENT

Element sub-object level. When SetSubobjectLevel(PO_ELEMENT) is called, the PatchMesh selection level is set to PO_PATCH and patchSelSubType is set to PO_ELEMENT.

#include <patchobj.h>

Inheritance diagram for PatchObject:

[legend]

List of all members.

Public Member Functions
void	CopyValidity (PatchObject *fromOb, ChannelMask channels)
RefResult	NotifyRefChanged (Interval changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message)
	Receives and responds to messages.
CoreExport	PatchObject ()
CoreExport	PatchObject (PatchObject &from)
CoreExport void	PatchObjectInit ()
CoreExport	~PatchObject ()
virtual CoreExport bool	RequiresSupportForLegacyDisplayMode () const
virtual CoreExport bool	UpdateDisplay (unsigned long renderItemCategories, const MaxSDK::Graphics::MaterialRequiredStreams &materialRequiredStreams, TimeValue t)
CoreExport PatchObject &	operator= (PatchObject &from)
void	SetFlag (DWORD fl, BOOL val=TRUE)
void	ClearFlag (DWORD fl)
bool	GetFlag (DWORD fl)
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.
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.
CoreExport int	Display (TimeValue t, INode inode, ViewExp vpt, int flags)
	This is called by the system to have the item display itself (perform a quick render in viewport, using the current TM).
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.
CoreExport CreateMouseCallBack *	GetCreateMouseCallBack ()
	This method allows the system to retrieve a callback object used in creating an object in the 3D viewports.
CoreExport RefTargetHandle	Clone (RemapDir &remap)
	This method is used by 3ds Max to clone an object.
CoreExport int	Display (TimeValue t, INode inode, ViewExp vpt, int flags, ModContext *mc)
CoreExport void	GetWorldBoundBox (TimeValue t, INode inode, ViewExp vp, Box3 &box, ModContext *mc)
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 Interval	ObjectValidity (TimeValue t)
	This method returns the validity interval of the object as a whole at the specified time.
CoreExport BOOL	GetExtendedProperties (TimeValue t, MSTR &prop1Label, MSTR &prop1Data, MSTR &prop2Label, MSTR &prop2Data)
	This method allows an object to return extended Properties fields.
CoreExport BOOL	PolygonCount (TimeValue t, int &numFaces, int &numVerts)
	Retreives the number of faces and vertices of the polyginal mesh representation of this object.
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.
CoreExport void	TopologyChanged ()
CoreExport Interval	ConvertValidity (TimeValue t)
virtual 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.
virtual BOOL	IsParamSurface ()
	There are several methods used to access a parametric position on the surface of the object.
CoreExport Point3	GetSurfacePoint (TimeValue t, float u, float v, Interval &iv)
	This method needs to be implemented if Object::IsParamSurface() returns TRUE.
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.
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 int	IntersectRay (TimeValue t, Ray &ray, float &at, Point3 &norm)
	This method is called to compute the intersection point and surface normal at this intersection point of the ray passed and the object.
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	IsInstanceDependent ()
	If an object creates different meshes depending on the particular instance (view-dependent) it should return nonzero; otherwise 0.
CoreExport Mesh *	GetRenderMesh (TimeValue t, INode *inode, View &view, BOOL &needDelete)
	This method should be implemented by all renderable GeomObjects.
CoreExport PatchMesh &	GetPatchMesh (TimeValue t)
CoreExport Mesh &	GetMesh (TimeValue t)
virtual CoreExport void	DeleteThis ()
	Deletes an instance of this class.
virtual void	FreeCaches ()
virtual Class_ID	ClassID ()
	Retrieves a constant that uniquely identifies the plugin class.
CoreExport BOOL	IsSubClassOf (Class_ID classID)
	returns true if the animatable has sub-classed off the given class
virtual CoreExport void	GetClassName (MSTR &s)
	Retrieves the name of the plugin class.
CoreExport void *	GetInterface (ULONG id)
	Inherited from Animatable.
virtual CoreExport MCHAR *	GetObjectName ()
int	NumSubs ()
CoreExport Animatable *	SubAnim (int i)
CoreExport MSTR	SubAnimName (int i)
CoreExport BOOL	AssignController (Animatable *control, int subAnim)
int	SubNumToRefNum (int subNum)
CoreExport BOOL	SelectSubAnim (int subNum)
CoreExport BOOL	HasControllers (BOOL assertCheck=TRUE)
CoreExport void	RescaleWorldUnits (float f)
	Rescale size of all world units in reference hierarchy.
int	NumRefs ()
	Returns the total number of references this ReferenceMaker can hold.
CoreExport RefTargetHandle	GetReference (int i)
	Returns the 'i-th' reference.
CoreExport int	RemapRefOnLoad (int iref)
	Used to load old files with references.
CoreExport void	PlugControllersSel (TimeValue t)
CoreExport void	AllocVertContArray (int count)
CoreExport void	AllocVecContArray (int count)
CoreExport void	AllocContArrays (int vertCount, int vecCount)
CoreExport void	ReplaceVertContArray (Tab< Control * > &nc)
CoreExport void	ReplaceVecContArray (Tab< Control * > &nc)
CoreExport void	ReplaceContArrays (Tab< Control * > &vertnc, Tab< Control * > &vecnc)
CoreExport BOOL	PlugVertControl (TimeValue t, int i)
CoreExport BOOL	PlugVecControl (TimeValue t, int i)
CoreExport void	SetVertAnim (TimeValue t, int point, Point3 pt)
CoreExport void	SetVecAnim (TimeValue t, int point, Point3 pt)
CoreExport void	SetVertCont (int i, Control *c)
CoreExport void	SetVecCont (int i, Control *c)
CoreExport IOResult	Save (ISave *isave)
	Called for saving data.
CoreExport IOResult	Load (ILoad *iload)
	Called for loading data.
virtual CoreExport void	UpdatePatchMesh (TimeValue t)
CoreExport void	PrepareMesh (TimeValue t)
CoreExport Mesh &	GetUnrelaxedMesh (TimeValue t)
CoreExport BOOL	ShowLattice ()
CoreExport BOOL	ShowVerts ()
CoreExport void	SetShowLattice (BOOL sw)
CoreExport void	SetShowVerts (BOOL sw)
CoreExport void	SetMeshSteps (int steps)
CoreExport int	GetMeshSteps ()
CoreExport void	SetMeshStepsRender (int steps)
CoreExport int	GetMeshStepsRender ()
CoreExport BOOL	Relaxing ()
CoreExport void	SetRelax (BOOL v)
CoreExport void	SetRelaxViewports (BOOL v)
CoreExport void	SetRelaxValue (float v)
CoreExport void	SetRelaxIter (int v)
CoreExport void	SetRelaxBoundary (BOOL v)
CoreExport void	SetRelaxSaddle (BOOL v)
BOOL	GetRelax ()
BOOL	GetRelaxViewports ()
float	GetRelaxValue ()
int	GetRelaxIter ()
BOOL	GetRelaxBoundary ()
BOOL	GetRelaxSaddle ()
CoreExport void	SetShowInterior (BOOL si)
CoreExport BOOL	GetShowInterior ()
CoreExport void	SetUsePatchNormals (BOOL usePatchNorm)
CoreExport BOOL	GetUsePatchNormals ()
CoreExport void	SetAdaptive (BOOL sw)
CoreExport BOOL	GetAdaptive ()
CoreExport void	SetViewTess (TessApprox tess)
CoreExport TessApprox	GetViewTess ()
CoreExport void	SetProdTess (TessApprox tess)
CoreExport TessApprox	GetProdTess ()
CoreExport void	SetDispTess (TessApprox tess)
CoreExport TessApprox	GetDispTess ()
CoreExport BOOL	GetViewTessNormals ()
CoreExport void	SetViewTessNormals (BOOL use)
CoreExport BOOL	GetProdTessNormals ()
CoreExport void	SetProdTessNormals (BOOL use)
CoreExport BOOL	GetViewTessWeld ()
CoreExport void	SetViewTessWeld (BOOL weld)
CoreExport BOOL	GetProdTessWeld ()
CoreExport void	SetProdTessWeld (BOOL weld)
CoreExport void	InvalidateMesh ()
CoreExport void	InvalidateRelaxedMesh ()
virtual CoreExport void	BeginEditParams (IObjParam ip, ULONG flags, Animatable prev)
virtual CoreExport void	EndEditParams (IObjParam ip, ULONG flags, Animatable next)
CoreExport int	GetSubobjectLevel ()
CoreExport int	GetSubobjectType ()
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 int	SubObjectIndex (HitRecord *hitRec)
	Returns the index of the sub-object element identified by the HitRecord hitRec.
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)
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.
int	NeedUseSubselButton ()
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 selLevel)
	This method is called to clear the selection for the given sub-object level.
CoreExport void	SelectAll (int selLevel)
	This method is called to select every element of the given sub-object level.
CoreExport void	InvertSelection (int selLevel)
	This method is called to invert the specified sub-object level.
CoreExport void	PatchSelChanged ()
CoreExport void	InvalidateSurfaceUI ()
CoreExport void	InvalidateOpsUI ()
CoreExport void	ChangeRememberedPatch (int type)
CoreExport void	ChangeSelPatches (int type)
CoreExport int	RememberPatchThere (HWND hWnd, IPoint2 m)
CoreExport void	SetRememberedPatchType (int type)
CoreExport void	ChangeRememberedVert (int type)
CoreExport void	ChangeSelVerts (int type)
CoreExport int	RememberVertThere (HWND hWnd, IPoint2 m)
CoreExport void	SetRememberedVertType (int type)
CoreExport void	XFormVerts (POXFormProc *xproc, TimeValue t, Matrix3 &partm, Matrix3 &tmAxis)
CoreExport void	XFormHandles (POXFormProc *xproc, TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, int handleIndex)
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 t)
	This method is called to evaluate the object and return the result as an ObjectState.
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	SelectNamedSet ()
CoreExport void	NSCopy ()
CoreExport void	NSPaste ()
CoreExport GenericNamedSelSetList &	GetSelSet ()
CoreExport void	RefreshSelType ()
CoreExport void	SetNumSelLabel ()
CoreExport void	SetSelDlgEnables ()
CoreExport void	SetOpsDlgEnables ()
CoreExport void	SetSurfDlgEnables ()
CoreExport void	SetSoftSelDlgEnables (HWND hSoftSel=NULL)
CoreExport int	GetAttachMat ()
CoreExport void	SetAttachMat (int value)
CoreExport BOOL	GetCondenseMat ()
CoreExport void	SetCondenseMat (BOOL sw)
CoreExport void	DoAttach (INode node, PatchMesh attPatch, bool &canUndo)
CoreExport void	SetTessUI (HWND hDlg, TessApprox *tess)
CoreExport void	DoDeleteSelected (BOOL interactive=TRUE)
CoreExport void	DoBreak (BOOL interactive=TRUE)
CoreExport void	ResolveTopoChanges ()
CoreExport void	DeletePatchParts (BitArray &delVerts, BitArray &delPatches)
CoreExport void	CreateContArrays ()
CoreExport void	SynchContArrays ()
CoreExport int	GetSelMatIndex ()
CoreExport void	SetSelMatIndex (int index)
CoreExport void	SelectByMat (int index, BOOL clear)
CoreExport DWORD	GetSelSmoothBits (DWORD &invalid)
CoreExport DWORD	GetUsedSmoothBits ()
CoreExport void	SelectBySmoothGroup (DWORD bits, BOOL clear)
CoreExport void	SetSelSmoothBits (DWORD bits, DWORD which)
CoreExport void	SetPropagate (BOOL sw)
CoreExport BOOL	GetPropagate ()
CoreExport void	DoPatchAdd (int type)
CoreExport void	DoSubdivide (int level)
CoreExport void	DoPatchDetach (int copy, int reorient)
CoreExport void	DoVertWeld ()
CoreExport void	DoVertWeld (int fromVert, int toVert)
CoreExport void	DoEdgeWeld ()
CoreExport void	StartCopyTangentMode ()
CoreExport void	StartPasteTangentMode ()
CoreExport void	StartPasteTangent ()
CoreExport void	EndPasteTangent ()
CoreExport BOOL	CopyTangent (int vec)
CoreExport BOOL	PasteTangent (int vec)
CoreExport void	DoHide (int type)
CoreExport void	DoUnHide ()
CoreExport void	DoPatchHide ()
CoreExport void	DoVertHide ()
CoreExport void	DoEdgeHide ()
CoreExport void	DoAddHook (int vert1, int seg1)
CoreExport void	DoRemoveHook ()
CoreExport void	DoExtrude (TimeValue t)
CoreExport void	BeginExtrude (TimeValue t)
CoreExport void	EndExtrude (TimeValue t, BOOL accept=TRUE)
CoreExport void	Extrude (TimeValue t, float amount, BOOL useLocalNorm)
CoreExport void	DoFlipNormals (int patchIndex=-1)
CoreExport void	DoUnifyNormals ()
CoreExport void	DoBevel (TimeValue t)
CoreExport void	BeginBevel (TimeValue t)
CoreExport void	EndBevel (TimeValue t, BOOL accept=TRUE)
CoreExport void	Bevel (TimeValue t, float amount, BOOL smoothStart, BOOL smoothEnd)
CoreExport void	DoPatchSmooth (int type)
CoreExport void	CreateVertex (Point3 pt, int &newIndex)
CoreExport void	CreatePatch (int vertIndx1, int vertIndx2, int vertIndx3)
CoreExport void	CreatePatch (int vertIndx1, int vertIndx2, int vertIndx3, int vertIndx4)
CoreExport void	StartCommandMode (patchCommandMode mode)
CoreExport void	ButtonOp (patchButtonOp opcode)
CoreExport void	GetUIParam (patchUIParam uiCode, int &ret)
CoreExport void	SetUIParam (patchUIParam uiCode, int val)
CoreExport void	GetUIParam (patchUIParam uiCode, float &ret)
CoreExport void	SetUIParam (patchUIParam uiCode, float val)
bool	Editing ()
CoreExport DWORD	GetSelLevel ()
CoreExport void	SetSelLevel (DWORD level)
CoreExport void	LocalDataChanged ()
CoreExport BitArray	GetVecSel ()
CoreExport BitArray	GetVertSel ()
CoreExport BitArray	GetEdgeSel ()
CoreExport BitArray	GetPatchSel ()
CoreExport void	SetVecSel (BitArray &set, IPatchSelect *imod, TimeValue t)
CoreExport void	SetVertSel (BitArray &set, IPatchSelect *imod, TimeValue t)
CoreExport void	SetEdgeSel (BitArray &set, IPatchSelect *imod, TimeValue t)
CoreExport void	SetPatchSel (BitArray &set, IPatchSelect *imod, TimeValue t)
CoreExport GenericNamedSelSetList &	GetNamedVecSelList ()
CoreExport GenericNamedSelSetList &	GetNamedVertSelList ()
CoreExport GenericNamedSelSetList &	GetNamedEdgeSelList ()
CoreExport GenericNamedSelSetList &	GetNamedPatchSelList ()
CoreExport Color	GetVertColor (int mp=0, bool *differs=NULL)
CoreExport void	SetVertColor (Color clr, int mp=0)
CoreExport void	SelectVertByColor (VertColor clr, int deltaR, int deltaG, int deltaB, BOOL add, BOOL sub, int mp=0)
CoreExport Color	GetPatchColor (int mp=0, bool *differs=NULL)
CoreExport void	SetPatchColor (Color clr, int mp=0)
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	ChangeMappingTypeLinear (BOOL linear)
CoreExport void	ShrinkSelection (int type)
CoreExport void	GrowSelection (int type)
CoreExport void	SelectEdgeRing ()
CoreExport void	SelectEdgeLoop ()
CoreExport void	SelectOpenEdges ()
CoreExport void	DoCreateShape ()
CoreExport int	UseEdgeDists ()
CoreExport void	SetUseEdgeDists (int useSoftSelections)
CoreExport int	UseSoftSelections ()
CoreExport void	SetUseSoftSelections (int useSoftSelections)
CoreExport void	InvalidateVertexWeights ()
CoreExport void	ToggleShadedFaces ()
CoreExport void	UpdateVertexDists ()
CoreExport void	UpdateEdgeDists ()
CoreExport void	UpdateVertexWeights ()
CoreExport Point3	VertexNormal (int vIndex)
Public Attributes
static HWND	hOpsPanel
static HWND	hSurfPanel
static HWND	hSoftSelPanel
static BOOL	rsOps
static BOOL	rsSurf
int	loadRefVersion
Interval	geomValid
Interval	topoValid
Interval	texmapValid
Interval	selectValid
ChannelMask	validBits
PatchMesh	patch
int	patchSelSubType
MasterPointControl *	masterCont
Tab< Control * >	vertCont
Tab< Control * >	vecCont
PatchMesh *	rememberedPatch
int	rememberedIndex
int	rememberedData
BOOL	doingHandles
BOOL	showMesh
BOOL	propagate
BOOL	inExtrude
BOOL	inBevel
BOOL	inPatchCreate
DWORD	epFlags
BOOL	copyTanLength
BOOL	tangentCopied
Point3	copiedTangent
GenericNamedSelSetList	hselSet
GenericNamedSelSetList	vselSet
GenericNamedSelSetList	eselSet
GenericNamedSelSetList	pselSet
SingleRefMakerPatchNode *	noderef
SingleRefMakerPatchMtl *	mtlref
Static Public Attributes
static HWND	hSelectPanel
static BOOL	rsSel
static MoveModBoxCMode *	moveMode
static RotateModBoxCMode *	rotMode
static UScaleModBoxCMode *	uscaleMode
static NUScaleModBoxCMode *	nuscaleMode
static SquashModBoxCMode *	squashMode
static SelectModBoxCMode *	selectMode
static EP_BindCMode *	bindMode
static EP_ExtrudeCMode *	extrudeMode
static EP_NormalFlipCMode *	normalFlipMode
static EP_BevelCMode *	bevelMode
static EP_CreateVertCMode *	createVertMode
static EP_CreatePatchCMode *	createPatchMode
static EP_VertWeldCMode *	vertWeldMode
static EP_CopyTangentCMode *	copyTangentMode
static EP_PasteTangentCMode *	pasteTangentMode
static BOOL	settingViewportTess
static BOOL	settingDisp
static ISpinnerControl *	uSpin
static ISpinnerControl *	vSpin
static ISpinnerControl *	edgeSpin
static ISpinnerControl *	angSpin
static ISpinnerControl *	distSpin
static ISpinnerControl *	mergeSpin
static ISpinnerControl *	matSpin
static ISpinnerControl *	matSpinSel
static ISpinnerControl *	weldSpin
static ISpinnerControl *	targetWeldSpin
static ISpinnerControl *	stepsSpin
static ISpinnerControl *	stepsRenderSpin
static ISpinnerControl *	relaxSpin
static ISpinnerControl *	relaxIterSpin
static POPickPatchAttach	pickCB
static BOOL	patchUIValid
static BOOL	opsUIValid
static int	attachMat
static BOOL	condenseMat
static int	pickBoxSize
static int	weldBoxSize
static IObjParam *	ip
static PatchObject *	editObj
Protected Member Functions
virtual CoreExport void	SetReference (int i, RefTargetHandle rtarg)
	Stores a ReferenceTarget as its 'i-th' reference`.
Friends
class	PatchObjectRestore
class	POXFormProc
class	POPickPatchAttach

Constructor & Destructor Documentation

CoreExport PatchObject ( )

Remarks:: Constructor.

CoreExport PatchObject ( PatchObject & from )

CoreExport ~PatchObject ( )

Remarks:: Destructor.

Member Function Documentation

void CopyValidity	(	PatchObject *	fromOb,
		ChannelMask	channels
	)

Search for all occurrences

RefResult NotifyRefChanged	(	Interval	changeInt,
		RefTargetHandle	hTarget,
		PartID &	partID,
		RefMessage	message
	)		`[virtual]`

Search for all occurrences

Receives and responds to messages.

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

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

Parameters:

changeInt	- This is the interval of time over which the message is active. Currently, all plug-ins will receive FOREVER for this interval.
hTarget	- This is the handle of the reference target the message was sent by. The reference maker uses this handle to know specifically which reference target sent the message.
partID	- This contains information specific to the message passed in. Some messages don't use the partID at all. See the section List of Reference Messages for more information about the meaning of the partID for some common messages.
message	- The message parameters passed into this method is the specific message which needs to be handled.

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

Implements ReferenceMaker.

CoreExport void PatchObjectInit ( )

Search for all occurrences

virtual CoreExport bool RequiresSupportForLegacyDisplayMode ( ) const [virtual]

Search for all occurrences

Reimplemented from BaseObject.

virtual CoreExport bool UpdateDisplay	(	unsigned long	renderItemCategories,
		const MaxSDK::Graphics::MaterialRequiredStreams &	materialRequiredStreams,
		TimeValue	t
	)		`[virtual]`

Search for all occurrences

Reimplemented from BaseObject.

CoreExport PatchObject& operator= ( PatchObject & from )

void SetFlag	(	DWORD	fl,
		BOOL	val = `TRUE`
	)		`[inline]`

Search for all occurrences

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

This method sets or clears the status of the Show End Result flag.

Parameters:: DWORD fl

The flag you wish to set or clear. Currently the only flag defined is the Show End Result flag EP_DISP_RESULT.

BOOL val

Specifies if the given flag should be set or cleared.

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

void ClearFlag ( DWORD fl ) [inline]

Search for all occurrences

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

This method clears the status of the Show End Result flag.

Parameters:: DWORD fl

The flag you wish to set or clear. Currently the only flag defined is the Show End Result flag EP_DISP_RESULT.

{ epFlags &= (~fl); }

bool GetFlag ( DWORD fl ) [inline]

Search for all occurrences

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

This methods allows you to obtain the status of the Show End Result flag.

Parameters:: DWORD fl

The flag you wish to set or clear. Currently the only flag defined is the Show End Result flag EP_DISP_RESULT.

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

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

Search for all occurrences

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

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

Search for all occurrences

This method is used in modifier gizmo hit testing.

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

Parameters:

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

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

Reimplemented from BaseObject.

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

Search for all occurrences

This is called by the system to have the item display itself (perform a quick render in viewport, using the current TM).

Note: For this method to be called the object's validity interval must be invalid at the specified time t. If the interval is valid, the system may not call this method since it thinks the display is already valid.

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

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

Search for all occurrences

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.

CoreExport CreateMouseCallBack* GetCreateMouseCallBack ( ) [virtual]

Search for all occurrences

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.

CoreExport RefTargetHandle Clone ( RemapDir & remap ) [virtual]

Search for all occurrences

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.

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

Search for all occurrences

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

This method is used to display the gizmo version of the patch mesh.

Parameters:: TimeValue t

The time to display the object.

INode* inode

The node to display.

ViewExp* vpt

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

int flags

The display flags. See the List of Display Flags for more information.

ModContext* mc

A pointer to the modifiers ModContext.

Reimplemented from BaseObject.

CoreExport void GetWorldBoundBox	(	TimeValue	t,
		INode *	inode,
		ViewExp *	vp,
		Box3 &	box,
		ModContext *	mc
	)		`[virtual]`

Search for all occurrences

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

This method returns the world space bounding box for the gizmo version of the patch mesh.

Parameters:: TimeValue t

The time to compute the bounding box.

INode* inode

The node to calculate the bounding box for.

ViewExp* vpt

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

Box3& box

The bounding box which was computed.

ModContext* mc

A pointer to the modifiers ModContext.

Reimplemented from BaseObject.

CoreExport int NumSubObjTypes ( ) [virtual]

Search for all occurrences

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.

CoreExport ISubObjType* GetSubObjType ( int i ) [virtual]

Search for all occurrences

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.

CoreExport Interval ObjectValidity ( TimeValue t ) [virtual]

Search for all occurrences

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.

Default Implementation:: { return FOREVER; }

Returns:: The validity interval of the object.

Reimplemented from Object.

CoreExport BOOL GetExtendedProperties	(	TimeValue	t,
		MSTR &	prop1Label,
		MSTR &	prop1Data,
		MSTR &	prop2Label,
		MSTR &	prop2Data
	)		`[virtual]`

Search for all occurrences

This method allows an object to return extended Properties fields.

It is called when the Object Properties dialog is being prepared. If you don't want to display any extended properties, simply return FALSE. To display extended property fields, place the field label in the appropriate label string and the display value in a formatted string. Two fields are supplied, each with a label and a data string; if only using one, make the second label field and data field blank (""). Return TRUE to indicate you have filled in the fields. The properties dialog will display your returned values.

Parameters:

t	The time at which the strings are requested.
prop1Label	The string for the property 1 label.
prop1Data	The formatted data string to appear as property 1.
prop2Label	The string for the property 2 label.
prop2Data	The formatted data string to appear as property 2.

Returns:: TRUE if this method is implemented and the fields are filled in; otherwise FALSE.

Reimplemented from Object.

CoreExport BOOL PolygonCount	(	TimeValue	t,
		int &	numFaces,
		int &	numVerts
	)		`[virtual]`

Search for all occurrences

Retreives the number of faces and vertices of the polyginal mesh representation of this object.

If this method returns FALSE then this functionality is not supported. Note: Plug-In developers should use the global function GetPolygonCount(Object*, int&, int&) to retrieve the number f vertices and faces in an arbitrary object.

Parameters:

t	The time at which to compute the number of faces and vertices.
numFaces	The number of faces is returned here.
numVerts	The number of vertices is returned here.

Returns:: TRUE if the method is fully implemented; otherwise FALSE.

Reimplemented from Object.

CoreExport Interval ChannelValidity	(	TimeValue	t,
		int	nchan
	)		`[virtual]`

Search for all occurrences

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

Returns:: The validity interval of the specified channel.

Reimplemented from Object.

CoreExport void SetChannelValidity	(	int	nchan,
		Interval	v
	)		`[virtual]`

Search for all occurrences

Sets the validity interval of the specified channel.

Parameters:

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

Reimplemented from Object.

CoreExport void InvalidateChannels ( ChannelMask channels ) [virtual]

Search for all occurrences

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.

CoreExport void TopologyChanged ( ) [virtual]

Search for all occurrences

Reimplemented from Object.

CoreExport Interval ConvertValidity ( TimeValue t )

Search for all occurrences

virtual int IsDeformable ( ) [inline, virtual]

Search for all occurrences

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

CoreExport int NumPoints ( ) [virtual]

Search for all occurrences

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.

CoreExport Point3 GetPoint ( int i ) [virtual]

Search for all occurrences

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.

CoreExport void SetPoint	(	int	i,
		const Point3 &	p
	)		`[virtual]`

Search for all occurrences

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.

CoreExport BOOL IsPointSelected ( int i ) [virtual]

Search for all occurrences

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.

CoreExport void PointsWereChanged ( ) [virtual]

Search for all occurrences

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.

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

Search for all occurrences

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.

CoreExport void Deform	(	Deformer *	defProc,
		int	useSel
	)		`[virtual]`

Search for all occurrences

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.

virtual BOOL IsParamSurface ( ) [inline, virtual]

Search for all occurrences

There are several methods used to access a parametric position on the surface of the object.

If this method returns TRUE then Object::GetSurfacePoint() will be called to return a point on the surface that corresponds to the u and v parameters passed to it. If this method returns FALSE then it is assumed the object does not support returning a point on the surface based on parameteric values. For sample code see /MAXSDK/SAMPLES/OBJECTS/SPHERE.CPP. If the object has several parametric surfaces then a second version of GetSurfacePoint() with an integer which specifies which surface will be called.

Reimplemented from Object.

{return TRUE;}

CoreExport Point3 GetSurfacePoint	(	TimeValue	t,
		float	u,
		float	v,
		Interval &	iv
	)		`[virtual]`

Search for all occurrences

This method needs to be implemented if Object::IsParamSurface() returns TRUE.

This method is used to retrieve a point on the surface of the object based on two parameters of the surface, u and v. Note: This method assumes there is a single parametric surface. If there is more than 1 (NumSurfaces() returns > 1, use the GetSurface() method below which allows for multiple surfaces.

Parameters:

t	The time to retrieve the point.
u	The parameter along the horizontal axis of the surface.
v	The parameter along the vertical axis of the surface.
iv	This interval is updated based on the interval of the surface parameter.

Reimplemented from Object.

virtual int IsMappable ( ) [inline, virtual]

Search for all occurrences

This method lets you know if the ApplyUVWMap() method is available for this object.

This is used by things like the UVW mapping modifier, so that it can determine which objects can have their mapping modified. Returns nonzero if the object is mappable; otherwise zero.

Reimplemented from Object.

{ return 1; }

virtual int NumMapChannels ( ) [inline, virtual]

Search for all occurrences

Returns the maximum number of channels supported by this type of object.

TriObjects for instance return MAX_MESHMAPS which is currently set to 100.

Reimplemented from Object.

{ return patch.NumMapChannels (); }

virtual int NumMapsUsed ( ) [inline, virtual]

Search for all occurrences

Returns the number of maps currently used by this object.

This is at least 1+(highest channel in use). This is used so a plug-in that does something to all map channels doesn't always have to do it to every channel up to MAX_MESHMAPS but rather only to this value.

Reimplemented from Object.

{ return patch.getNumMaps(); }

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`
	)		`[inline, virtual]`

Search for all occurrences

This method may be called to map the object with UVW mapping coordinates.

If the object returns nonzero from IsMappable() then this method should be implemented.

Parameters:

type	The mapping type. One of the following values: MAP_PLANAR MAP_CYLINDRICAL MAP_SPHERICAL MAP_BALL MAP_BOX
utile	Number of tiles in the U direction.
vtile	Number of tiles in the V direction.
wtile	Number of tiles in the W direction.
uflip	If nonzero the U values are mirrored.
vflip	If nonzero the V values are mirrored.
wflip	If nonzero the W values are mirrored.
cap	This is used with MAP_CYLINDRICAL. If nonzero, then any face normal that is pointing more vertically than horizontally will be mapped using planar coordinates.
tm	This defines the mapping space. As each point is mapped, it is multiplied by this matrix, and then it is mapped.
channel	This indicates which channel the mapping is applied to. See List of Mapping Channel Index Values.

Reimplemented from Object.

                                                                                      {
                patch.ApplyUVWMap(type,utile,vtile,wtile,uflip,vflip,wflip,cap,tm,channel); }

CoreExport int CanConvertToType ( Class_ID obtype ) [virtual]

Search for all occurrences

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

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, List of Class_IDs.

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

Default Implementation:: { return 0; }

Reimplemented from Object.

CoreExport Object* ConvertToType	(	TimeValue	t,
		Class_ID	obtype
	)		`[virtual]`

Search for all occurrences

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.

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 (PART_GEOM). Certain world space modifiers may not normally specify PART_GEOM 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 PART_TEXMAP 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 PART_GEOM | PART_TEXMAP 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 PART_GEOM 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, List of Class_IDs.

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.

CoreExport void GetCollapseTypes	(	Tab< Class_ID > &	clist,
		Tab< MSTR * > &	nlist
	)		`[virtual]`

Search for all occurrences

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.

CoreExport void FreeChannels ( ChannelMask channels ) [virtual]

Search for all occurrences

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.

CoreExport Object* MakeShallowCopy ( ChannelMask channels ) [virtual]

Search for all occurrences

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.

CoreExport void ShallowCopy	(	Object *	fromOb,
		ChannelMask	channels
	)		`[virtual]`

Search for all occurrences

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.

CoreExport void NewAndCopyChannels ( ChannelMask channels ) [virtual]

Search for all occurrences

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.

CoreExport DWORD GetSubselState ( ) [virtual]

Search for all occurrences

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.

CoreExport int IntersectRay	(	TimeValue	t,
		Ray &	r,
		float &	at,
		Point3 &	norm
	)		`[virtual]`

Search for all occurrences

This method is called to compute the intersection point and surface normal at this intersection point of the ray passed and the object.

Parameters:

t	The time to compute the intersection.
r	Ray to intersect. See Class Ray.
at	The point of intersection.
norm	Surface normal at the point of intersection.

Returns:: Nonzero if a point of intersection was found; otherwise 0.

See also:: The Mesh class implementation of this method.

Reimplemented from Object.

CoreExport void GetWorldBoundBox	(	TimeValue	t,
		INode *	inode,
		ViewExp *	vp,
		Box3 &	box
	)		`[virtual]`

Search for all occurrences

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.

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

Search for all occurrences

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.

CoreExport int IsInstanceDependent ( ) [virtual]

Search for all occurrences

If an object creates different meshes depending on the particular instance (view-dependent) it should return nonzero; otherwise 0.

Reimplemented from GeomObject.

CoreExport Mesh* GetRenderMesh	(	TimeValue	t,
		INode *	inode,
		View &	view,
		BOOL &	needDelete
	)		`[virtual]`

Search for all occurrences

This method should be implemented by all renderable GeomObjects.

It provides a mesh representation of the object for use by the renderer. Primitives that already have a mesh cached can just return a pointer to it (and set needDelete to FALSE). Implementations of this method which take a long time should periodically call View::CheckForRenderAbort() to see if the user has canceled the render. If canceled, the function can either return NULL, or return a non null pointer with the appropriate value for needDelete. (If needDelete is TRUE a non-null mesh will be deleted.)

Parameters:

t	The time to get the mesh.
inode	The node in the scene.
view	If the renderer calls this method it will pass the view information here. See Class View.
needDelete	Set to TRUE if the renderer should delete the mesh, FALSE otherwise.

Returns:: A pointer to the mesh object.

Reimplemented from GeomObject.

CoreExport PatchMesh& GetPatchMesh ( TimeValue t )

Search for all occurrences

CoreExport Mesh& GetMesh ( TimeValue t )

Search for all occurrences

virtual CoreExport void DeleteThis ( ) [virtual]

Search for all occurrences

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

See also:: Plugin DLL Functions, Class ClassDesc.

Reimplemented from Animatable.

virtual void FreeCaches ( ) [inline, virtual]

Search for all occurrences

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.

{patch.InvalidateGeomCache(); }

virtual Class_ID ClassID ( ) [inline, virtual]

Search for all occurrences

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, List of Class IDs.

Reimplemented from Animatable.

{ return Class_ID(PATCHOBJ_CLASS_ID,0); }

CoreExport BOOL IsSubClassOf ( Class_ID classID ) [virtual]

Search for all occurrences

returns true if the animatable has sub-classed off the given class

If an object is a sub-class of a particular class, it will have a different ClassID() because it is a different class. This method allows an object to indicate that it is a sub-class of a particular class and therefore can be treated as one. For example, a class could be derived from TriObject. This derived class would have a different ClassID() then the TriObject's class ID however it still can be treated (cast) as a TriObject because it is derived from TriObject. Note the default implelementation: a class is considered to also be a subclass of itself.

Parameters:

classID The Class_ID of the item that this class is a sub-class of.

Returns:: TRUE if this class is a sub-class of classID; otherwise FALSE.

Default Implementation:: {return classID==ClassID();}

Reimplemented from Animatable.

virtual CoreExport void GetClassName ( MSTR & s ) [virtual]

Search for all occurrences

Retrieves the name of the plugin class.

This name is usually used internally for debugging purposes. 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

Reimplemented from ReferenceTarget.

CoreExport void* GetInterface ( ULONG id ) [virtual]

Search for all occurrences

Inherited from Animatable.

Returns a pointer to the interface.

Parameters:

id	- The id of the interface.

Returns:: A Pointer to the Interface

Reimplemented from Object.

virtual CoreExport MCHAR* GetObjectName ( ) [virtual]

Search for all occurrences

Returns:: the name that will appear in the history browser (modifier stack).

Reimplemented from BaseObject.

int NumSubs ( ) [inline, virtual]

Search for all occurrences

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

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

Default Implementation:: { return 0; }

Reimplemented from Animatable.

{ return 1; }   // Just tell it about the master point controller

CoreExport Animatable* SubAnim ( int i ) [virtual]

Search for all occurrences

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

Parameters:

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

Default Implementation:: { return NULL };

Reimplemented from Animatable.

CoreExport MSTR SubAnimName ( int i ) [virtual]

Search for all occurrences

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

Parameters:

i	The index of the parameter name to return

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

Reimplemented from Animatable.

CoreExport BOOL AssignController	(	Animatable *	control,
		int	subAnim
	)		`[virtual]`

Search for all occurrences

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.

int SubNumToRefNum ( int subNum ) [inline, virtual]

Search for all occurrences

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

CoreExport BOOL SelectSubAnim ( int subNum ) [virtual]

Search for all occurrences

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.

CoreExport BOOL HasControllers ( BOOL assertCheck = TRUE )

Search for all occurrences

CoreExport void RescaleWorldUnits ( float f ) [virtual]

Search for all occurrences

Rescale size of all world units in reference hierarchy.

This method is available in release 2.0 and later only. Must call ClearAFlagInHierarchy(rm, A_WORK1) or ClearAFlagInAllAnimatables(A_WORK1) before doing this on a reference hierarchy. This may be implemented to rescale the size of all world units in a reference hierarchy. Developers must call

        if (TestAFlag(A_WORK1))
            return;
        SetAFlag(A_WORK1);

before doing this on a reference hierarchy.

Parameters:

f	- The scale factor.

Reimplemented from ReferenceMaker.

int NumRefs ( ) [inline, virtual]

Search for all occurrences

Returns the total number of references this ReferenceMaker can hold.

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

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

Reimplemented from ReferenceMaker.

{return vertCont.Count() + vecCont.Count() + 1;}    // vert conts + vec conts + master

CoreExport RefTargetHandle GetReference ( int i ) [virtual]

Search for all occurrences

Returns the 'i-th' reference.

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

Parameters:

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

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

Reimplemented from ReferenceMaker.

virtual CoreExport void SetReference	(	int	i,
		RefTargetHandle	rtarg
	)		`[protected, virtual]`

Search for all occurrences

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

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

Parameters:

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

Reimplemented from ReferenceMaker.

CoreExport int RemapRefOnLoad ( int iref ) [virtual]

Search for all occurrences

Used to load old files with references.

Implement this if you have added or deleted references and are loading an old file that needs to have its references remapped. This method is used when you have modified a ReferenceMaker to add or delete references, and are loading old files. It gets called during the reference mapping process, after the Load() method is called. You determine what version is loading in the Load(), and store the version in a variable which you can look at in RemapRefOnLoad() to determine how to remap references. The default implementation of this method just returns the same value it is passed, so you don't need to implement it unless you have added or deleted references from your class. This method makes it a lot easier to load old files when the reference topology has changed.

Parameters:

iref	- The input index of the reference.

Returns:: The output index of the reference.

Reimplemented from ReferenceMaker.

CoreExport void PlugControllersSel ( TimeValue t )

Search for all occurrences

CoreExport void AllocVertContArray ( int count )

Search for all occurrences

CoreExport void AllocVecContArray ( int count )

Search for all occurrences

CoreExport void AllocContArrays	(	int	vertCount,
		int	vecCount
	)

Search for all occurrences

CoreExport void ReplaceVertContArray ( Tab< Control * > & nc )

Search for all occurrences

CoreExport void ReplaceVecContArray ( Tab< Control * > & nc )

Search for all occurrences

CoreExport void ReplaceContArrays	(	Tab< Control * > &	vertnc,
		Tab< Control * > &	vecnc
	)

Search for all occurrences

CoreExport BOOL PlugVertControl	(	TimeValue	t,
		int	i
	)

Search for all occurrences

CoreExport BOOL PlugVecControl	(	TimeValue	t,
		int	i
	)

Search for all occurrences

CoreExport void SetVertAnim	(	TimeValue	t,
		int	point,
		Point3	pt
	)

Search for all occurrences

CoreExport void SetVecAnim	(	TimeValue	t,
		int	point,
		Point3	pt
	)

Search for all occurrences

CoreExport void SetVertCont	(	int	i,
		Control *	c
	)

Search for all occurrences

CoreExport void SetVecCont	(	int	i,
		Control *	c
	)

Search for all occurrences

CoreExport IOResult Save ( ISave * isave ) [virtual]

Search for all occurrences

Called for saving data.

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

Parameters:

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

Returns:

The default implementation is return IO_OK.

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

Reimplemented from ReferenceMaker.

CoreExport IOResult Load ( ILoad * iload ) [virtual]

Search for all occurrences

Called for loading data.

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

Parameters:

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

Returns:

The default implementation is return IO_OK.

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

Reimplemented from ReferenceMaker.

virtual CoreExport void UpdatePatchMesh ( TimeValue t ) [virtual]

Search for all occurrences

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

This should be implemented by classes derived from PatchObject whose patches change over time.

Parameters:: TimeValue t

The time to update the patch mesh.

Default Implementation:: {}

CoreExport void PrepareMesh ( TimeValue t )

Search for all occurrences

Remarks:: This method checks to see if the mesh cache is up to date, and if not, it generates it.

Parameters:: TimeValue t

This parameter is available in release 2.0 and later only.

The mesh cache should be generated to reflect this time.

CoreExport Mesh& GetUnrelaxedMesh ( TimeValue t )

Search for all occurrences

CoreExport BOOL ShowLattice ( ) [inline]

Search for all occurrences

Remarks:: Returns TRUE if the patch lattice is displayed; otherwise FALSE.

{ return patch.GetDispFlag(DISP_LATTICE) ? TRUE : FALSE; }

CoreExport BOOL ShowVerts ( ) [inline]

Search for all occurrences

Remarks:: Returns TRUE if the patch vertices are shown; otherwise FALSE.

{ return patch.GetDispFlag(DISP_VERTS) ? TRUE : FALSE; }

CoreExport void SetShowLattice ( BOOL sw ) [inline]

Search for all occurrences

Remarks:: Sets the state of the lattice display switch.

Parameters:: BOOL sw

TRUE to turn on the lattice display; FALSE to turn it off.

{ if(sw) patch.SetDispFlag(DISP_LATTICE); else patch.ClearDispFlag(DISP_LATTICE); }

CoreExport void SetShowVerts ( BOOL sw ) [inline]

Search for all occurrences

Remarks:: Sets the state of the vertex display switch

Parameters:: BOOL sw

TRUE to turn on the vertex display; FALSE to turn it off.

{ if(sw) patch.SetDispFlag(DISP_VERTS); else patch.ClearDispFlag(DISP_VERTS); }

CoreExport void SetMeshSteps ( int steps )

Search for all occurrences

Remarks:: Sets the number of mesh steps (viewport).

Parameters:: int steps

The number of steps to set.

CoreExport int GetMeshSteps ( )

Search for all occurrences

Remarks:: Returns the number of mesh steps (viewport).

CoreExport void SetMeshStepsRender ( int steps )

Search for all occurrences

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

Sets the Surface Render Steps setting.

Parameters:: int steps

The value to set.

CoreExport int GetMeshStepsRender ( )

Search for all occurrences

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

Returns the Surface Render Steps setting.

CoreExport BOOL Relaxing ( )

Search for all occurrences

CoreExport void SetRelax ( BOOL v )

Search for all occurrences

CoreExport void SetRelaxViewports ( BOOL v )

Search for all occurrences

CoreExport void SetRelaxValue ( float v )

Search for all occurrences

CoreExport void SetRelaxIter ( int v )

Search for all occurrences

CoreExport void SetRelaxBoundary ( BOOL v )

Search for all occurrences

CoreExport void SetRelaxSaddle ( BOOL v )

Search for all occurrences

BOOL GetRelax ( ) [inline]

Search for all occurrences

{ return patch.GetRelax(); }

BOOL GetRelaxViewports ( ) [inline]

Search for all occurrences

{ return patch.GetRelaxViewports(); }

float GetRelaxValue ( ) [inline]

Search for all occurrences

{ return patch.GetRelaxValue(); }

int GetRelaxIter ( ) [inline]

Search for all occurrences

{ return patch.GetRelaxIter(); }

BOOL GetRelaxBoundary ( ) [inline]

Search for all occurrences

{ return patch.GetRelaxBoundary(); }

BOOL GetRelaxSaddle ( ) [inline]

Search for all occurrences

{ return patch.GetRelaxSaddle(); }

CoreExport void SetShowInterior ( BOOL si )

Search for all occurrences

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

Sets the 'Show Interior Edges' value.

Parameters:: BOOL si

TRUE for on; FALSE for off.

CoreExport BOOL GetShowInterior ( )

Search for all occurrences

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

Returns the 'Show Interior Edge' setting; TRUE if on; FALSE if off.

CoreExport void SetUsePatchNormals ( BOOL usePatchNorm )

Search for all occurrences

CoreExport BOOL GetUsePatchNormals ( )

Search for all occurrences

CoreExport void SetAdaptive ( BOOL sw )

Search for all occurrences

Remarks:: Sets the state of the adaptive switch.

Parameters:: BOOL sw

TRUE to turn on; FALSE to turn off.

CoreExport BOOL GetAdaptive ( )

Search for all occurrences

Remarks:: Returns the state of the adaptive switch. TRUE is on; FALSE is off.

CoreExport void SetViewTess ( TessApprox tess )

Search for all occurrences

Remarks:: Sets the tesselation approximation object used for viewport rendering.

Parameters:: TessApprox tess

The tesselation approximation object to be used for viewport rendering.

CoreExport TessApprox GetViewTess ( )

Search for all occurrences

Remarks:: Returns the tesselation approximation object used for rendering in the viewports.

CoreExport void SetProdTess ( TessApprox tess )

Search for all occurrences

Remarks:: Sets the tesselation approximation object used for production rendering.

Parameters:: TessApprox tess

The tesselation approximation object to be used for production rendering.

CoreExport TessApprox GetProdTess ( )

Search for all occurrences

Remarks:: Returns the tesselation approximation object used for production rendering.

CoreExport void SetDispTess ( TessApprox tess )

Search for all occurrences

Remarks:: Sets the tesselation approximation object used for display in the viewports.

Parameters:: TessApprox tess

The tesselation approximation object to be used for the viewports.

CoreExport TessApprox GetDispTess ( )

Search for all occurrences

Remarks:: Returns the tesselation approximation object used for display in the viewports.

CoreExport BOOL GetViewTessNormals ( )

Search for all occurrences

Remarks:: Returns TRUE if normals are used from the viewport tesselator; otherwise FALSE.

CoreExport void SetViewTessNormals ( BOOL use )

Search for all occurrences

Remarks:: Sets if normals are used from the viewport tesselator.

Parameters:: BOOL use

TRUE to use normals; FALSE to not use them.

CoreExport BOOL GetProdTessNormals ( )

Search for all occurrences

Remarks:: Returns TRUE if normals are used from the production renderer tesselator; otherwise FALSE.

CoreExport void SetProdTessNormals ( BOOL use )

Search for all occurrences

Remarks:: Sets if normals are used from the production renderer tesselator.

Parameters:: BOOL use

TRUE to use normals; FALSE to not use them.

CoreExport BOOL GetViewTessWeld ( )

Search for all occurrences

Remarks:: Returns TRUE if the viewport mesh is welded after tesselation; otherwise FALSE.

CoreExport void SetViewTessWeld ( BOOL weld )

Search for all occurrences

Remarks:: Sets if the viewport mesh is welded after tesselation; otherwise FALSE.

Parameters:: BOOL weld

TRUE to weld; FALSE to not weld.

CoreExport BOOL GetProdTessWeld ( )

Search for all occurrences

Remarks:: Returns TRUE if the production renderer mesh is welded after tesselation; otherwise FALSE.

CoreExport void SetProdTessWeld ( BOOL weld )

Search for all occurrences

Remarks:: Sets if the production renderer mesh is welded after tesselation; otherwise FALSE.

Parameters:: BOOL weld

TRUE to weld; FALSE to not weld.

CoreExport void InvalidateMesh ( )

Search for all occurrences

Remarks:: Invalidates the mesh cache.

CoreExport void InvalidateRelaxedMesh ( )

Search for all occurrences

virtual CoreExport void BeginEditParams	(	IObjParam *	ip,
		ULONG	flags,
		Animatable *	prev
	)		`[virtual]`

Search for all occurrences

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

Parameters:

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

Reimplemented from Animatable.

virtual CoreExport void EndEditParams	(	IObjParam *	ip,
		ULONG	flags,
		Animatable *	next
	)		`[virtual]`

Search for all occurrences

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

Parameters:

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

Reimplemented from Animatable.

CoreExport int GetSubobjectLevel ( )

Search for all occurrences

CoreExport int GetSubobjectType ( )

Search for all occurrences

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

This method goes hand-in-hand with GetSubobjectLevel(), except that this method returns the type of geometry that is actually being acted upon.

Returns:: The sub-object type, either PO_PATCH or PO_ELEMENT.

CoreExport void SetSubobjectLevel ( int level )

Search for all occurrences

CoreExport void ActivateSubobjSel	(	int	level,
		XFormModes &	modes
	)		`[virtual]`

Search for all occurrences

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

CoreExport int SubObjectIndex ( HitRecord * hitRec ) [virtual]

Search for all occurrences

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.

CoreExport void GetSubObjectTMs	(	SubObjAxisCallback *	cb,
		TimeValue	t,
		INode *	node,
		ModContext *	mc
	)		`[virtual]`

Search for all occurrences

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.

CoreExport void ShowEndResultChanged ( BOOL showEndResult ) [virtual]

Search for all occurrences

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

This method is called by the system then the status of the Show End Result function changes (ie. the Show End Results button has been toggled on or off). Note that setting the state of the Show End Result is done through the Interface::SetShowEndResult() method.

Parameters:: BOOL showEndResult

This flag specifies the Show End Result status, which is TRUE if on; FALSE if off.

Reimplemented from BaseObject.

CoreExport void GetSubObjectCenters	(	SubObjAxisCallback *	cb,
		TimeValue	t,
		INode *	node,
		ModContext *	mc
	)		`[virtual]`

Search for all occurrences

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.

int NeedUseSubselButton ( ) [inline]

Search for all occurrences

{ return 0; }

CoreExport void SelectSubComponent	(	HitRecord *	hitRec,
		BOOL	selected,
		BOOL	all,
		BOOL	invert
	)		`[virtual]`

Search for all occurrences

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.

CoreExport void ClearSelection ( int selLevel ) [virtual]

Search for all occurrences

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.

CoreExport void SelectAll ( int selLevel ) [virtual]

Search for all occurrences

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.

CoreExport void InvertSelection ( int selLevel ) [virtual]

Search for all occurrences

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.

CoreExport void PatchSelChanged ( )

Search for all occurrences

CoreExport void InvalidateSurfaceUI ( )

Search for all occurrences

CoreExport void InvalidateOpsUI ( )

Search for all occurrences

CoreExport void ChangeRememberedPatch ( int type )

Search for all occurrences

CoreExport void ChangeSelPatches ( int type )

Search for all occurrences

CoreExport int RememberPatchThere	(	HWND	hWnd,
		IPoint2	m
	)

Search for all occurrences

CoreExport void SetRememberedPatchType ( int type )

Search for all occurrences

CoreExport void ChangeRememberedVert ( int type )

Search for all occurrences

CoreExport void ChangeSelVerts ( int type )

Search for all occurrences

CoreExport int RememberVertThere	(	HWND	hWnd,
		IPoint2	m
	)

Search for all occurrences

CoreExport void SetRememberedVertType ( int type )

Search for all occurrences

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

Search for all occurrences

CoreExport void XFormHandles	(	POXFormProc *	xproc,
		TimeValue	t,
		Matrix3 &	partm,
		Matrix3 &	tmAxis,
		int	handleIndex
	)

Search for all occurrences

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

Search for all occurrences

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.

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

Search for all occurrences

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.

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

Search for all occurrences

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.

CoreExport void TransformStart ( TimeValue t ) [virtual]

Search for all occurrences

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.

CoreExport void TransformFinish ( TimeValue t ) [virtual]

Search for all occurrences

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.

CoreExport void TransformCancel ( TimeValue t ) [virtual]

Search for all occurrences

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.

CoreExport ObjectState Eval ( TimeValue t ) [virtual]

Search for all occurrences

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.

BOOL SupportsNamedSubSels ( ) [inline, virtual]

Search for all occurrences

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

Methods in the the interface passed to objects allow them to add items to the sub-object selection set drop down. The following methods are called when the user picks items from the list.

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

Reimplemented from BaseObject.

{return TRUE;}

CoreExport void ActivateSubSelSet ( MSTR & setName ) [virtual]

Search for all occurrences

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.

CoreExport void NewSetFromCurSel ( MSTR & setName ) [virtual]

Search for all occurrences

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.

CoreExport void RemoveSubSelSet ( MSTR & setName ) [virtual]

Search for all occurrences

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.

CoreExport void SetupNamedSelDropDown ( ) [virtual]

Search for all occurrences

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.

CoreExport int NumNamedSelSets ( ) [virtual]

Search for all occurrences

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

Returns:: the number of named selection sets.

Reimplemented from BaseObject.

CoreExport MSTR GetNamedSelSetName ( int i ) [virtual]

Search for all occurrences

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.

CoreExport void SetNamedSelSetName	(	int	i,
		MSTR &	newName
	)		`[virtual]`

Search for all occurrences

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.

CoreExport void NewSetByOperator	(	MSTR &	newName,
		Tab< int > &	sets,
		int	op
	)		`[virtual]`

Search for all occurrences

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.

CoreExport BOOL GetUniqueSetName ( MSTR & name )

Search for all occurrences

CoreExport int SelectNamedSet ( )

Search for all occurrences

CoreExport void NSCopy ( )

Search for all occurrences

CoreExport void NSPaste ( )

Search for all occurrences

CoreExport GenericNamedSelSetList& GetSelSet ( )

Search for all occurrences

CoreExport void RefreshSelType ( )

Search for all occurrences

CoreExport void SetNumSelLabel ( )

Search for all occurrences

CoreExport void SetSelDlgEnables ( )

Search for all occurrences

CoreExport void SetOpsDlgEnables ( )

Search for all occurrences

CoreExport void SetSurfDlgEnables ( )

Search for all occurrences

CoreExport void SetSoftSelDlgEnables ( HWND hSoftSel = NULL )

Search for all occurrences

CoreExport int GetAttachMat ( ) [virtual]

Search for all occurrences

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.

CoreExport void SetAttachMat ( int value ) [virtual]

Search for all occurrences

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.

CoreExport BOOL GetCondenseMat ( ) [virtual]

Search for all occurrences

Remarks:: Returns the condense material and IDs settings.

Implements AttachMatDlgUser.

CoreExport void SetCondenseMat ( BOOL sw ) [virtual]

Search for all occurrences

Remarks:: Sets the condense material and IDs setting.

Parameters:: BOOL sw

TRUE for on; FALSE for off.

Implements AttachMatDlgUser.

CoreExport void DoAttach	(	INode *	node,
		PatchMesh *	attPatch,
		bool &	canUndo
	)

Search for all occurrences

CoreExport void SetTessUI	(	HWND	hDlg,
		TessApprox *	tess
	)

Search for all occurrences

CoreExport void DoDeleteSelected ( BOOL interactive = TRUE )

Search for all occurrences

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

This method will delete the selected patches, exactly like the DeleteMesh modifier does.

Parameters:: BOOL interactive

This parameter is available in release 4.0 and later only.

If this parameter is set to TRUE it will cause the method to display the appropriate prompts, create an undo object, and notifies the dependents.

CoreExport void DoBreak ( BOOL interactive = TRUE )

Search for all occurrences

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

In vertex mode, this method examines selected vertices, and if any of the vertices that are part of the selection set are used by more than one patch, those vertices (and any attached vectors) are duplicated into separate geometry for each patch using it.

In edge mode, this method examines the selected edges and any vectors on the selected edges that are used by more than one patch are duplicated into separate geometry for each patch using them. Any vertices used by more than one selected edge are duplicated as well for patches on opposite sides of the edge.

Note: If the vertices and vectors involved have controllers attached, they are removed by this operation.

Parameters:: BOOL interactive

If this parameter is set to TRUE it will cause the method to display the appropriate prompts, create an undo object, and notifies the dependents.

CoreExport void ResolveTopoChanges ( )

Search for all occurrences

CoreExport void DeletePatchParts	(	BitArray &	delVerts,
		BitArray &	delPatches
	)

Search for all occurrences

CoreExport void CreateContArrays ( )

Search for all occurrences

CoreExport void SynchContArrays ( )

Search for all occurrences

CoreExport int GetSelMatIndex ( )

Search for all occurrences

CoreExport void SetSelMatIndex ( int index )

Search for all occurrences

CoreExport void SelectByMat	(	int	index,
		BOOL	clear
	)

Search for all occurrences

CoreExport DWORD GetSelSmoothBits ( DWORD & invalid )

Search for all occurrences

CoreExport DWORD GetUsedSmoothBits ( )

Search for all occurrences

CoreExport void SelectBySmoothGroup	(	DWORD	bits,
		BOOL	clear
	)

Search for all occurrences

CoreExport void SetSelSmoothBits	(	DWORD	bits,
		DWORD	which
	)

Search for all occurrences

CoreExport void SetPropagate ( BOOL sw )

Search for all occurrences

CoreExport BOOL GetPropagate ( )

Search for all occurrences

CoreExport void DoPatchAdd ( int type )

Search for all occurrences

CoreExport void DoSubdivide ( int level )

Search for all occurrences

CoreExport void DoPatchDetach	(	int	copy,
		int	reorient
	)

Search for all occurrences

CoreExport void DoVertWeld ( )

Search for all occurrences

CoreExport void DoVertWeld	(	int	fromVert,
		int	toVert
	)

Search for all occurrences

CoreExport void DoEdgeWeld ( )

Search for all occurrences

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

This method will perform the edge weld function on the patch object. Note that this does not take into account any threshold but welds edges only if they use the same two vertices as endpoints. When two or more edges are welded, the locations of the edge vectors are averaged to create the new edge.

CoreExport void StartCopyTangentMode ( )

Search for all occurrences

CoreExport void StartPasteTangentMode ( )

Search for all occurrences

CoreExport void StartPasteTangent ( )

Search for all occurrences

CoreExport void EndPasteTangent ( )

Search for all occurrences

CoreExport BOOL CopyTangent ( int vec )

Search for all occurrences

CoreExport BOOL PasteTangent ( int vec )

Search for all occurrences

CoreExport void DoHide ( int type )

Search for all occurrences

CoreExport void DoUnHide ( )

Search for all occurrences

CoreExport void DoPatchHide ( )

Search for all occurrences

CoreExport void DoVertHide ( )

Search for all occurrences

CoreExport void DoEdgeHide ( )

Search for all occurrences

CoreExport void DoAddHook	(	int	vert1,
		int	seg1
	)

Search for all occurrences

CoreExport void DoRemoveHook ( )

Search for all occurrences

CoreExport void DoExtrude ( TimeValue t )

Search for all occurrences

Remarks:: When called with the Animate state active and on a nonzero TimeValue, this method will prepare the controllers for the geometry that is being created. The program can then fill in the animated vertex values later.

Parameters:: TimeValue t

This parameter is available in release 4.0 and later only.

The time at which to prepare and execute the extrude operation.

CoreExport void BeginExtrude ( TimeValue t )

Search for all occurrences

CoreExport void EndExtrude	(	TimeValue	t,
		BOOL	accept = `TRUE`
	)

Search for all occurrences

CoreExport void Extrude	(	TimeValue	t,
		float	amount,
		BOOL	useLocalNorm
	)

Search for all occurrences

CoreExport void DoFlipNormals ( int patchIndex = -1 )

Search for all occurrences

Remarks:: This method flips the normals of a specified patch or all selected patches. This method will save undo information and displays a prompt if patchIndex < 0 while there are no patches selected.

Parameters:: int patchIndex

The index of the patch for which to flip the normal. If this parameter is < 0, the normals of all selected patches will be flipped (if there are any selected).

Any vertices set to PVERT_COPLANAR that lie on the boundary between flipped and unflipped patches will have their type set to PVERT_CORNER. This is because attempting to compute normals of neighboring patches with opposite normals in order to get a proper plane often results in invalid normals being generated. Making the vertex a corner type prevents the problem. Any vertices not on the boundary between flipped and unflipped patches are left as is.

CoreExport void DoUnifyNormals ( )

Search for all occurrences

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

This method examines the selected patch set and attempts to make them all face the same direction. Preferred direction is arbitrary; the first selected patch encountered in each contiguous group determines the direction all patches in that group will attain.

Any vertices set to PVERT_COPLANAR that lie on the boundary between flipped and unflipped patches will have their type set to PVERT_CORNER. This is because attempting to compute normals of neighboring patches with opposite normals in order to get a proper plane often results in invalid normals being generated. Making the vertex a corner type prevents the problem. Any vertices not on the boundary between flipped and unflipped patches are left as is.

CoreExport void DoBevel ( TimeValue t )

Search for all occurrences

Remarks:: When called with the Animate state active and on a nonzero TimeValue, this method will prepare the controllers for the geometry that is being created. The program can then fill in the animated vertex values later.

Parameters:: TimeValue t

This parameter is available in release 4.0 and later only.

The time at which to prepare and execute the bevel operation.

CoreExport void BeginBevel ( TimeValue t )

Search for all occurrences

CoreExport void EndBevel	(	TimeValue	t,
		BOOL	accept = `TRUE`
	)

Search for all occurrences

CoreExport void Bevel	(	TimeValue	t,
		float	amount,
		BOOL	smoothStart,
		BOOL	smoothEnd
	)

Search for all occurrences

CoreExport void DoPatchSmooth ( int type )

Search for all occurrences

CoreExport void CreateVertex	(	Point3	pt,
		int &	newIndex
	)

Search for all occurrences

CoreExport void CreatePatch	(	int	vertIndx1,
		int	vertIndx2,
		int	vertIndx3
	)

Search for all occurrences

CoreExport void CreatePatch	(	int	vertIndx1,
		int	vertIndx2,
		int	vertIndx3,
		int	vertIndx4
	)

Search for all occurrences

CoreExport void StartCommandMode ( patchCommandMode mode ) [virtual]

Search for all occurrences

Remarks:: Begins the specified interactive command mode.

Parameters:: patchCommandMode mode

PcmAttach

PcmExtrude

PcmBevel

PcmCreate

PcmWeldTarget

PcmFlipNormal

PcmBind

Implements IPatchOps.

CoreExport void ButtonOp ( patchButtonOp opcode ) [virtual]

Search for all occurrences

Remarks:: Performs the same operation as a button press inside the Editable Patch UI.

Parameters:: patchButtonOp opcode

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

PopBind

PopUnbind

PopHide

PopUnhideAll

PopWeld

PopDelete

PopSubdivide

PopAddTri

PopAddQuad

PopDetach

Implements IPatchOps.

CoreExport void GetUIParam	(	patchUIParam	uiCode,
		int &	ret
	)		`[virtual]`

Search for all occurrences

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

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

Parameters:: patchUIParam uiCode

This enum is currently empty.

int &ret

The returned value.

Default Implementation:: { }

Reimplemented from IPatchOps.

CoreExport void SetUIParam	(	patchUIParam	uiCode,
		int	val
	)		`[virtual]`

Search for all occurrences

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

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

Parameters:: patchUIParam uiCode

This enum is currently empty.

int val

The value to set.

Default Implementation:: { }

Reimplemented from IPatchOps.

CoreExport void GetUIParam	(	patchUIParam	uiCode,
		float &	ret
	)		`[virtual]`

Search for all occurrences

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

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

Parameters:: patchUIParam uiCode

This enum is currently empty.

float &ret

The returned value.

Default Implementation:: { }

Reimplemented from IPatchOps.

CoreExport void SetUIParam	(	patchUIParam	uiCode,
		float	val
	)		`[virtual]`

Search for all occurrences

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

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

Parameters:: patchUIParam uiCode

This enum is currently empty.

float val

The value to set.

Default Implementation:: { }

Reimplemented from IPatchOps.

bool Editing ( ) [inline]

Search for all occurrences

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

CoreExport DWORD GetSelLevel ( ) [virtual]

Search for all occurrences

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

PO_VERTEX

PO_EDGE

PO_PATCH

PO_OBJECT

Implements IPatchSelect.

CoreExport void SetSelLevel ( DWORD level ) [virtual]

Search for all occurrences

Remarks:: Sets the current level of selection of the modifier.

Parameters:: DWORD level

The level to set. One of the following values:

PO_VERTEX

PO_EDGE

PO_PATCH

PO_OBJECT

Implements IPatchSelect.

CoreExport void LocalDataChanged ( ) [virtual]

Search for all occurrences

Remarks:: This method must be called when the selection level of the modifier is changed. Developers can use the methods of this class 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 IPatchSelect.

CoreExport BitArray GetVecSel ( ) [virtual]

Search for all occurrences

Implements IPatchSelectData.

CoreExport BitArray GetVertSel ( ) [virtual]

Search for all occurrences

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

CoreExport BitArray GetEdgeSel ( ) [virtual]

Search for all occurrences

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

Implements IPatchSelectData.

CoreExport BitArray GetPatchSel ( ) [virtual]

Search for all occurrences

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

Implements IPatchSelectData.

CoreExport void SetVecSel	(	BitArray &	set,
		IPatchSelect *	imod,
		TimeValue	t
	)		`[virtual]`

Search for all occurrences

Implements IPatchSelectData.

CoreExport void SetVertSel	(	BitArray &	set,
		IPatchSelect *	imod,
		TimeValue	t
	)		`[virtual]`

Search for all occurrences

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.

IPatchSelect *imod

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

TimeValue t

The current time at which the call is made.

Implements IPatchSelectData.

CoreExport void SetEdgeSel	(	BitArray &	set,
		IPatchSelect *	imod,
		TimeValue	t
	)		`[virtual]`

Search for all occurrences

Remarks:: Sets the edge selection of the modifier.

Parameters:: BitArray &set

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

IPatchSelect *imod

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

TimeValue t

The current time at which the call is made.

Implements IPatchSelectData.

CoreExport void SetPatchSel	(	BitArray &	set,
		IPatchSelect *	imod,
		TimeValue	t
	)		`[virtual]`

Search for all occurrences

Remarks:: Sets the patch selection of the modifier.

Parameters:: BitArray &set

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

IPatchSelect *imod

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

TimeValue t

The current time at which the call is made.

Implements IPatchSelectData.

CoreExport GenericNamedSelSetList& GetNamedVecSelList ( ) [virtual]

Search for all occurrences

Implements IPatchSelectData.

CoreExport GenericNamedSelSetList& GetNamedVertSelList ( ) [virtual]

Search for all occurrences

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

Implements IPatchSelectData.

CoreExport GenericNamedSelSetList& GetNamedEdgeSelList ( ) [virtual]

Search for all occurrences

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

Implements IPatchSelectData.

CoreExport GenericNamedSelSetList& GetNamedPatchSelList ( ) [virtual]

Search for all occurrences

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

Implements IPatchSelectData.

CoreExport Color GetVertColor	(	int	mp = `0`,
		bool *	differs = `NULL`
	)

Search for all occurrences

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

This method returns the common color for all selected vertices. If no vertices are selected then white (1,1,1) will be returned, however, if multiple vertices with different colors are selected, then black (0,0,0) will be returned.

Parameters:: int mp=0

The map channel.

bool *differs=NULL

This parameter is returned to indicate if there were any differences.

CoreExport void SetVertColor	(	Color	clr,
		int	mp = `0`
	)

Search for all occurrences

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

This method will set all selected vertices to the specified color.

Parameters:: Color clr

The color you wish to apply to all the selected vertices.

int mp=0

The map channel.

CoreExport void SelectVertByColor	(	VertColor	clr,
		int	deltaR,
		int	deltaG,
		int	deltaB,
		BOOL	add,
		BOOL	sub,
		int	mp = `0`
	)

Search for all occurrences

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

This method will select all vertices which fall into a specified color range.

Parameters:: VertColor clr

The starting color of the vertices you wish to select by color.

int deltaR

The difference range for the red color component.

int deltaG

The difference range for the green color component.

int deltaB

The difference range for the blue color component.

BOOL add

This flag adds vertices to the selection that fall into the color range.

BOOL sub

This flag subtracts vertices from the selection that fall into the color range.

int mp=0

The map channel.

CoreExport Color GetPatchColor	(	int	mp = `0`,
		bool *	differs = `NULL`
	)

Search for all occurrences

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

This method returns the common color for all selected patches. If no patches are selected then white (1,1,1) will be returned, however, if different vertex colors are present in the selected patches, then black (0,0,0) will be returned.

Parameters:: int mp=0

The map channel.

bool *differs=NULL

This parameter is returned to indicate if there were any differences.

CoreExport void SetPatchColor	(	Color	clr,
		int	mp = `0`
	)

Search for all occurrences

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

This method will set all selected patches to the specified color.

Parameters:: Color clr

The color you wish to apply to all the selected patches.

int mp=0

The map channel.

CoreExport MtlID GetNextAvailMtlID ( ModContext * mc ) [virtual]

Search for all occurrences

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.

CoreExport BOOL HasFaceSelection ( ModContext * mc ) [virtual]

Search for all occurrences

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.

CoreExport void SetSelFaceMtlID	(	ModContext *	mc,
		MtlID	id,
		BOOL	bResetUnsel = `FALSE`
	)		`[virtual]`

Search for all occurrences

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.

CoreExport int GetSelFaceUniqueMtlID ( ModContext * mc ) [virtual]

Search for all occurrences

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.

CoreExport int GetSelFaceAnyMtlID ( ModContext * mc ) [virtual]

Search for all occurrences

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.

CoreExport int GetMaxMtlID ( ModContext * mc ) [virtual]

Search for all occurrences

Remarks:: This method returns the highest MtlID on the object.

Implements ISubMtlAPI.

CoreExport void ChangeMappingTypeLinear ( BOOL linear )

Search for all occurrences

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

This method will change the mapping type of the selected patches to linear or curved.

Parameters:: BOOL linear

If TRUE the mapping type will be changed to linear. FALSE will change the mapping type to curved.

CoreExport void ShrinkSelection ( int type )

Search for all occurrences

CoreExport void GrowSelection ( int type )

Search for all occurrences

CoreExport void SelectEdgeRing ( )

Search for all occurrences

CoreExport void SelectEdgeLoop ( )

Search for all occurrences

CoreExport void SelectOpenEdges ( )

Search for all occurrences

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

This method examines the patch mesh and selects any edges used by only one single patch.

CoreExport void DoCreateShape ( )

Search for all occurrences

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

This method will create a bezier spline shape from the selected edges of the patch mesh. Each edge will become a separate spline in the output shape. The user will be prompted to enter a name for the new editable spline object that will be created.

CoreExport int UseEdgeDists ( )

Search for all occurrences

CoreExport void SetUseEdgeDists ( int useSoftSelections )

Search for all occurrences

CoreExport int UseSoftSelections ( )

Search for all occurrences

CoreExport void SetUseSoftSelections ( int useSoftSelections )

Search for all occurrences

CoreExport void InvalidateVertexWeights ( )

Search for all occurrences

CoreExport void ToggleShadedFaces ( )

Search for all occurrences