3ds Max C++ API Reference
PatchObject Class Reference

#include <patchobj.h>

+ Inheritance diagram for PatchObject:

Public Member Functions

void CopyValidity (PatchObject *fromOb, ChannelMask channels)
 
RefResult NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate)
 Receives and responds to messages. More...
 
CoreExport PatchObject ()
 
CoreExport PatchObject (PatchObject &from)
 
CoreExport void PatchObjectInit ()
 
CoreExport ~PatchObject ()
 
virtual CoreExport unsigned long GetObjectDisplayRequirement () const
 
virtual CoreExport bool PrepareDisplay (const MaxSDK::Graphics::UpdateDisplayContext &prepareDisplayContext)
 
virtual CoreExport bool UpdatePerNodeItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer)
 
CoreExport PatchObjectoperator= (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. More...
 
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. More...
 
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). More...
 
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. More...
 
CoreExport CreateMouseCallBackGetCreateMouseCallBack ()
 This method allows the system to retrieve a callback object used in creating an object in the 3D viewports. More...
 
CoreExport RefTargetHandle Clone (RemapDir &remap)
 This method is used by 3ds Max to clone an object. More...
 
CoreExport int GetSubObjectLevel () override
 This method returns an integer which indicates the current sub-object level of the modifier or base object. More...
 
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(). More...
 
CoreExport ISubObjTypeGetSubObjType (int i)
 Returns a pointer to the sub-object type for the sub-object whose index is passed. More...
 
CoreExport Interval ObjectValidity (TimeValue t)
 This method returns the validity interval of the object as a whole at the specified time. More...
 
CoreExport BOOL GetExtendedProperties (TimeValue t, MSTR &prop1Label, MSTR &prop1Data, MSTR &prop2Label, MSTR &prop2Data)
 This method allows an object to return extended Properties fields. More...
 
CoreExport BOOL PolygonCount (TimeValue t, int &numFaces, int &numVerts)
 Retreives the number of faces and vertices of the polyginal mesh representation of this object. More...
 
CoreExport Interval ChannelValidity (TimeValue t, int nchan)
 Retrieve the current validity interval for the nchan channel of the object. More...
 
CoreExport void SetChannelValidity (int i, Interval v)
 Sets the validity interval of the specified channel. More...
 
CoreExport void InvalidateChannels (ChannelMask channels)
 This method invalidates the intervals for the given channel mask. More...
 
CoreExport void TopologyChanged ()
 Implemented by the System. More...
 
CoreExport Interval ConvertValidity (TimeValue t)
 
virtual int IsDeformable ()
 Indicates whether this object is deformable. More...
 
CoreExport int NumPoints ()
 The points of a deformable object are accessed through a virtual array interface. More...
 
CoreExport Point3 GetPoint (int i)
 The points of a deformable object are accessed through a virtual array interface. More...
 
CoreExport void SetPoint (int i, const Point3 &p)
 The points of a deformable object are accessed through a virtual array interface. More...
 
CoreExport BOOL IsPointSelected (int i)
 Returns TRUE if the 'i-th' point is selected; otherwise FALSE. More...
 
CoreExport void PointsWereChanged ()
 Informs the object that its points have been deformed, so it can invalidate its cache. More...
 
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. More...
 
CoreExport void Deform (Deformer *defProc, int useSel)
 This is the method used to deform the object with a deformer. More...
 
virtual BOOL IsParamSurface ()
 There are several methods used to access a parametric position on the surface of the object. More...
 
CoreExport Point3 GetSurfacePoint (TimeValue t, float u, float v, Interval &iv)
 This method needs to be implemented if Object::IsParamSurface() returns TRUE. More...
 
virtual int IsMappable ()
 This method lets you know if the ApplyUVWMap() method is available for this object. More...
 
virtual int NumMapChannels ()
 Returns the maximum number of channels supported by this type of object. More...
 
virtual int NumMapsUsed ()
 Returns the number of maps currently used by this object. More...
 
virtual void ApplyUVWMap (int type, float utile, float vtile, float wtile, int uflip, int vflip, int wflip, int cap, const Matrix3 &tm, int channel=1)
 This method may be called to map the object with UVW mapping coordinates. More...
 
CoreExport int CanConvertToType (Class_ID obtype)
 Indicates whether the object can be converted to the specified type. More...
 
CoreExport ObjectConvertToType (TimeValue t, Class_ID obtype)
 This method converts this object to the type specified and returns a pointer it. More...
 
CoreExport void GetCollapseTypes (Tab< Class_ID > &clist, Tab< MSTR * > &nlist)
 When the user clicks on the Edit Stack button in the modify branch a list of 'Convert To:' types is presented. More...
 
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). More...
 
CoreExport ObjectMakeShallowCopy (ChannelMask channels)
 This method must make a copy of its "shell" and then shallow copy (see below) only the specified channels. More...
 
CoreExport void ShallowCopy (Object *fromOb, ChannelMask channels)
 This method copies the specified channels from the fromOb to this and copies the validity intervals. More...
 
CoreExport void NewAndCopyChannels (ChannelMask channels)
 This method replaces the locked channels with newly allocated copies. More...
 
CoreExport DWORD GetSubselState ()
 For objects that have sub selection levels, this method returns the current selection level of the object. More...
 
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. More...
 
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). More...
 
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. More...
 
CoreExport int IsInstanceDependent ()
 If an object creates different meshes depending on the particular instance (view-dependent) it should return nonzero; otherwise 0. More...
 
CoreExport MeshGetRenderMesh (TimeValue t, INode *inode, View &view, BOOL &needDelete)
 This method should be implemented by all renderable GeomObjects. More...
 
CoreExport PatchMeshGetPatchMesh (TimeValue t)
 
CoreExport MeshGetMesh (TimeValue t)
 
virtual CoreExport void DeleteThis ()
 Deletes an instance of this class. More...
 
virtual void FreeCaches ()
 
virtual Class_ID ClassID ()
 Retrieves a constant that uniquely identifies the plugin class. More...
 
CoreExport BOOL IsSubClassOf (Class_ID classID)
 returns true if the animatable has sub-classed off the given class More...
 
virtual CoreExport void GetClassName (MSTR &s, bool localized=true) const override
 Retrieves the name of the plugin class. More...
 
CoreExport voidGetInterface (ULONG id)
 Inherited from Animatable. More...
 
virtual CoreExport const MCHARGetObjectName (bool localized=true) const override
 
int NumSubs ()
 
CoreExport AnimatableSubAnim (int i)
 
CoreExport MSTR SubAnimName (int i, bool localized=true) override
 
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. More...
 
int NumRefs ()
 Returns the total number of references this ReferenceMaker can hold. More...
 
CoreExport RefTargetHandle GetReference (int i)
 Returns the 'i-th' reference. More...
 
CoreExport int RemapRefOnLoad (int iref)
 Used to load old files with references. More...
 
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. More...
 
CoreExport IOResult Load (ILoad *iload)
 Called for loading data. More...
 
virtual CoreExport void UpdatePatchMesh (TimeValue t)
 
CoreExport void PrepareMesh (TimeValue t)
 
CoreExport MeshGetUnrelaxedMesh (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 *objParam, ULONG flags, Animatable *prev)
 
virtual CoreExport void EndEditParams (IObjParam *objParam, 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. More...
 
CoreExport int SubObjectIndex (HitRecord *hitRec)
 Returns the index of the sub-object element identified by the HitRecord hitRec. More...
 
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. More...
 
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. More...
 
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. More...
 
CoreExport void ClearSelection (int selLevel)
 This method is called to clear the selection for the given sub-object level. More...
 
CoreExport void SelectAll (int selLevel)
 This method is called to select every element of the given sub-object level. More...
 
CoreExport void InvertSelection (int selLevel)
 This method is called to invert the specified sub-object level. More...
 
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. More...
 
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. More...
 
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. More...
 
CoreExport void TransformStart (TimeValue t)
 This method is called before the first Move(), Rotate() or Scale() call and before a hold is in effect. More...
 
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. More...
 
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. More...
 
CoreExport ObjectState Eval (TimeValue t)
 This method is called to evaluate the object and return the result as an ObjectState. More...
 
BOOL SupportsNamedSubSels ()
 An object that supports sub-object selection can choose to support named sub object selection sets. More...
 
CoreExport void ActivateSubSelSet (MSTR &setName)
 When the user chooses a name from the drop down list this method is called. More...
 
CoreExport void NewSetFromCurSel (MSTR &setName)
 If the user types a new name into the named selection set drop down then this method is called. More...
 
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. More...
 
CoreExport void SetupNamedSelDropDown ()
 To support the Edit Named Selections dialog, plug-ins must implement this method. More...
 
CoreExport int NumNamedSelSets ()
 To support the Edit Named Selections dialog, plug-ins must implement this method. More...
 
CoreExport MSTR GetNamedSelSetName (int i)
 To support the Edit Named Selections dialog, plug-ins must implement this method. More...
 
CoreExport void SetNamedSelSetName (int i, MSTR &newName)
 To support the Edit Named Selections dialog, plug-ins must implement this method. More...
 
CoreExport void NewSetByOperator (MSTR &newName, Tab< int > &sets, int op)
 To support the Edit Named Selections dialog, plug-ins must implement this method. More...
 
CoreExport BOOL GetUniqueSetName (MSTR &name)
 
CoreExport int SelectNamedSet ()
 
CoreExport void NSCopy ()
 
CoreExport void NSPaste ()
 
CoreExport GenericNamedSelSetListGetSelSet ()
 
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 GenericNamedSelSetListGetNamedVecSelList ()
 
CoreExport GenericNamedSelSetListGetNamedVertSelList ()
 
CoreExport GenericNamedSelSetListGetNamedEdgeSelList ()
 
CoreExport GenericNamedSelSetListGetNamedPatchSelList ()
 
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 Member Functions inherited from GeomObject
virtual void InitNodeName (MSTR &s)
 This is the default name of the node when it is created. More...
 
SClass_ID SuperClassID ()
 Retrieves a constant representing the type of the plugin. More...
 
virtual int IsRenderable ()
 Indicates whether the object may be rendered. More...
 
virtual int NumberOfRenderMeshes ()
 Objects may supply multiple render meshes ( e.g. More...
 
virtual MeshGetMultipleRenderMesh (TimeValue t, INode *inode, View &view, BOOL &needDelete, int meshNumber)
 For multiple render meshes, this method must be implemented. More...
 
virtual void GetMultipleRenderMeshTM (TimeValue t, INode *inode, View &view, int meshNumber, Matrix3 &meshTM, Interval &meshTMValid)
 For multiple render meshes, this method must be implemented. More...
 
virtual CoreExport PatchMeshGetRenderPatchMesh (TimeValue t, INode *inode, View &view, BOOL &needDelete)
 This method provides a patch mesh representation of the object for use by the renderer. More...
 
CoreExport Class_ID PreferredCollapseType ()
 This method allows objects to specify the class that is the best class to convert to when the user collapses the stack. More...
 
virtual BOOL CanDoDisplacementMapping ()
 Returns TRUE if this object can do displacement mapping; otherwise FALSE. More...
 
- Public Member Functions inherited from Object
CoreExport Object ()
 
CoreExport ~Object ()
 
virtual BOOL CheckObjectIntegrity ()
 This method is used for debugging only. More...
 
virtual BOOL HasUVW ()
 Call this method to find out if the object has UVW coordinates. More...
 
virtual BOOL HasUVW (int mapChannel)
 Call this method to find out if the object is has UVW coordinates for the specified mapping channel. More...
 
virtual ObjectFindBaseObject ()
 It is called to return a pointer to the base object (an object that is not a derived object). More...
 
virtual int NumSurfaces (TimeValue t)
 Returns the number of parametric surfaces within the object. More...
 
virtual Point3 GetSurfacePoint (TimeValue t, int surface, float u, float v, Interval &iv)
 This method is used to retrieve a point on the specified surface of the object based on two parameters of the surface, u and v. More...
 
virtual void SurfaceClosed (TimeValue t, int surface, BOOL &uClosed, BOOL &vClosed)
 This method allows the object to return flags that indicate whether the parametric surface is closed in the U and V dimensions. More...
 
CoreExport SvGraphNodeReference SvTraverseAnimGraph (IGraphObjectManager *gom, Animatable *owner, int id, DWORD flags)
 
CoreExport bool SvHandleDoubleClick (IGraphObjectManager *gom, IGraphNode *gNode)
 
CoreExport MSTR SvGetName (IGraphObjectManager *gom, IGraphNode *gNode, bool isBeingEdited)
 
CoreExport COLORREF SvHighlightColor (IGraphObjectManager *gom, IGraphNode *gNode)
 
CoreExport bool SvIsSelected (IGraphObjectManager *gom, IGraphNode *gNode)
 Returns true if the object is selected in its schematic view. More...
 
CoreExport MultiSelectCallbackSvGetMultiSelectCallback (IGraphObjectManager *gom, IGraphNode *gNode)
 
CoreExport bool SvCanSelect (IGraphObjectManager *gom, IGraphNode *gNode)
 
CoreExport void AddXTCObject (XTCObject *pObj, int priority=0, int branchID=-1)
 This method adds an extension object into the pipeline. More...
 
CoreExport int NumXTCObjects ()
 Returns the number of extension objects maintained by this Object. More...
 
CoreExport XTCObjectGetXTCObject (int index)
 Returns a pointer to the specified extension object. More...
 
CoreExport void RemoveXTCObject (int index)
 Removes the extension object as indicated by the index. More...
 
CoreExport void SetXTCObjectPriority (int index, int priority)
 Sets the priority for the extension object whose index is passed. More...
 
CoreExport int GetXTCObjectPriority (int index)
 Returns the integer priority number of the extension object whose index is passed. More...
 
CoreExport void SetXTCObjectBranchID (int index, int branchID)
 Sets the branch ID of the extension object whose index is passed. More...
 
CoreExport int GetXTCObjectBranchID (int index)
 Returns the integer branch ID of the extension object whose index is passed. More...
 
CoreExport void MergeAdditionalChannels (Object *from, int branchID)
 This method has to be called whenever the CompoundObject updates a branch (calling Eval() on it). More...
 
CoreExport void BranchDeleted (int branchID, bool reorderChannels)
 This method has to be called on the CompoundObject so it can delete the XTCObjects for the specified branch. More...
 
CoreExport void CopyAdditionalChannels (Object *from, bool deleteOld=true, bool bShallowCopy=false)
 This method copies all extension objects from the "from" object into the current object. More...
 
CoreExport void DeleteAllAdditionalChannels ()
 Implemented by the System. More...
 
virtual BOOL UseSelectionBrackets ()
 This method allows an object to choose whether or not it will display selection brackets in shaded viewports. More...
 
virtual BOOL IsManipulator ()
 
CoreExport BaseInterfaceGetInterface (Interface_ID id)
 Inherited from Animatable. More...
 
virtual void ReduceDisplayCaches ()
 Should reduce any derived display data to save memory, since the node wont be drawn until the user undhides it. More...
 
virtual bool NeedGWCacheRebuilt (GraphicsWindow *gw, Material *ma, int numMat)
 This returns whether the Graphics Cache for this object needs to be rebuilt. More...
 
virtual void BuildGWCache (GraphicsWindow *gw, Material *ma, int numMat, BOOL threaded)
 This builds the graphics window cached mesh. More...
 
virtual void StartStackEval ()
 This are called right before and after a modifier is applied to an object. More...
 
virtual void EndStackEval ()
 
virtual int UsesWireColor ()
 This method determines if the object color is used for display. More...
 
virtual int DoOwnSelectHilite ()
 If an object wants to draw itself in the 3D viewports in its selected state in some custom manner this method should return nonzero. More...
 
virtual BOOL NormalAlignVector (TimeValue t, Point3 &pt, Point3 &norm)
 Objects that don't support the IntersectRay() method (such as helper objects) can implement this method to provide a default vector for use with the normal align command in 3ds Max. More...
 
void LockObject ()
 Implemented by the System. More...
 
void UnlockObject ()
 Implemented by the System. More...
 
int IsObjectLocked ()
 Implemented by the System. More...
 
void LockChannels (ChannelMask channels)
 Implemented by the System. More...
 
void UnlockChannels (ChannelMask channels)
 Implemented by the System. More...
 
ChannelMask GetChannelLocks ()
 Implemented by the System. More...
 
void SetChannelLocks (ChannelMask channels)
 Implemented by the System. More...
 
ChannelMask GetChannelLocks (ChannelMask m)
 Implemented by the System. More...
 
virtual BOOL CanCacheObject ()
 This method determines if this object can have channels cached. More...
 
virtual void WSStateInvalidate ()
 This is called by a node when the node's world space state has become invalid. More...
 
virtual BOOL IsWorldSpaceObject ()
 Returns TRUE if the object as a world space object; otherwise FALSE. More...
 
CoreExport INodeGetWorldSpaceObjectNode ()
 Implemented by the System. More...
 
virtual BOOL IsParticleSystem ()
 Implemented by the System. More...
 
CoreExport void CopyChannelLocks (Object *obj, ChannelMask needChannels)
 Implemented by the System. More...
 
virtual float PointSelection (int i)
 Returns a floating point weighted point selection if the object supports it. More...
 
virtual BOOL HasWeights ()
 Returns TRUE if the object has weights for its points that can be set; otherwise FALSE. More...
 
virtual double GetWeight (int i)
 Returns the weight of the specified point of the object. More...
 
virtual void SetWeight (int i, const double w)
 Sets the weight of the specified point. More...
 
virtual ObjectCollapseObject ()
 This method is called on the world space cache object when the stack gets collapsed, that lets the pipeline object decide, if it wants to return a different object than itself. More...
 
virtual void SetSubSelState (DWORD s)
 Implemented by the System. More...
 
CoreExport void ReadyChannelsForMod (ChannelMask channels)
 Implemented by the System. More...
 
virtual CoreExport void MaybeEnlargeViewportRect (GraphicsWindow *gw, Rect &rect)
 This method allows the object to enlarge its viewport rectangle, if it wants to. More...
 
CoreExport bool IsBaseClassOwnedChannel (int nchan)
 Implemented by the System. More...
 
CoreExport void UpdateValidity (int nchan, Interval v)
 When a modifier is applied to an object, it needs to include its own validity interval in the interval of the object. More...
 
Interval GetNoEvalInterval ()
 
void SetNoEvalInterval (Interval iv)
 
virtual CoreExport void ReduceCaches (TimeValue t)
 This method give the object the chance to reduce its caches. More...
 
virtual int IsConstObject ()
 This is called to determine if this is a construction object or not. More...
 
virtual int NumPipeBranches (bool selected=true)
 This method returns the number of pipeline branches combined by the object. More...
 
virtual ObjectGetPipeBranch (int i, bool selected=true)
 Retrieves sub-object branches from an object that supports branching. More...
 
virtual INodeGetBranchINode (TimeValue t, INode *node, int i, bool selected=true)
 When an object has sub-object branches, it is likely that the sub-objects are transformed relative to the object. More...
 
virtual int NumberOfContainedShapes ()
 Returns the number of shapes contained inside this object. More...
 
virtual ShapeObjectGetContainedShape (TimeValue t, int index)
 This method returns the ShapeObject specified by the index passed at the time specified. More...
 
virtual void GetContainedShapeMatrix (TimeValue t, int index, Matrix3 &mat)
 Returns the matrix associated with the shape whose index is passed. More...
 
virtual BitArray ContainedShapeSelectionArray ()
 This is used by the lofter. More...
 
virtual BOOL IsShapeObject ()
 Returns the number of shapes contained inside this object. More...
 
- Public Member Functions inherited from BaseObject
virtual CoreExport bool UpdatePerViewItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::UpdateViewContext &viewContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer)
 
virtual CoreExport const MaxSDK::Graphics::RenderItemHandleArrayGetRenderItems () const
 
CoreExport BaseObject ()
 
virtual CoreExport ~BaseObject ()
 
virtual BOOL HasViewDependentBoundingBox ()
 This method return true if GetWorldBoundBox returns different boxes for different viewports. More...
 
virtual void SetExtendedDisplay (int flags)
 This method is used for storing mode-dependent display attributes. More...
 
virtual const MCHARGetObjectName () MAX_SEALED
 
virtual CoreExport BOOL OKToChangeTopology (MSTR &modName)
 Implemented by the System. More...
 
virtual BOOL ChangeTopology ()
 This method asks the question of an object or modifier "Do you change topology"? An object or modifier returns TRUE if it is capable of changing topology when its parameters are being edited; otherwise FALSE. More...
 
virtual void ForceNotify (Interval &i)
 Notifies dependents of a change. More...
 
virtual IParamArrayGetParamBlock ()
 An object or modifier should implement this method if it wishes to make its parameter block available for other plug-ins to access it. More...
 
virtual IParamBlock2GetParamBlock (int i) override
 An object or modifier should implement this method if it wishes to make its parameter block available for other plug-ins to access it. More...
 
virtual int GetParamBlockIndex (int id)
 If a plug-in makes its parameter block available (using GetParamBlock()) then it will need to provide #defines for indices into the parameter block. More...
 
virtual void TransformHoldingStart (TimeValue t)
 This method is called before the first Move(), Rotate() or Scale() call and after a hold is in effect. More...
 
virtual void TransformHoldingFinish (TimeValue t)
 This method is called after the user has completed the Move(), Rotate() or Scale() operation and before the undo object has been accepted. More...
 
virtual void CloneSelSubComponents (TimeValue t)
 This method is called to make a copy of the selected sub-object components of the item. More...
 
virtual void AcceptCloneSelSubComponents (TimeValue t)
 This method is called when the user mouses up after shift-cloning a sub-object selection. More...
 
virtual void NotifyPreCollapse (INode *node, IDerivedObject *derObj, int index)
 This method is called before a modifier or object is collapsed. More...
 
virtual void NotifyPostCollapse (INode *node, Object *obj, IDerivedObject *derObj, int index)
 This method is called after a modifier or object is collapsed. More...
 
virtual void SetGenUVW (BOOL sw)
 This method is called to change the state of its Generate UVW boolean. More...
 
virtual void SetGenUVW (int mapChannel, BOOL sw)
 This method is called to change the state of its Generate UVW boolean for the specified mapping channel. More...
 
- Public Member Functions inherited from ReferenceTarget
virtual BOOL IsRefTarget ()
 Checks if this is a ReferenceTarget. More...
 
CoreExport RefResult TestForLoop (const Interval &refInterval, RefMakerHandle hmaker)
 Tests for a cyclical reference. More...
 
CoreExport BOOL HasDependents ()
 Checks if a ReferenceTarget has references. More...
 
CoreExport BOOL HasRealDependents ()
 Checks if this has Real (Strong) Dependents. More...
 
void BeginDependencyTest ()
 Starts Dependency Test. More...
 
BOOL EndDependencyTest ()
 Ends Dependency Test. More...
 
virtual void RefAdded (RefMakerHandle rm)
 Called after a reference is made to a target. More...
 
virtual void RefAddedUndoRedo (RefMakerHandle rm)
 Called after a reference is made to a target because of undo or redo. More...
 
virtual void RefDeleted ()
 Called after a references to this is deleted. More...
 
virtual void RefDeletedUndoRedo ()
 Called after a references to this is deleted because of undo or redo. More...
 
CoreExport RefResult DeleteAllRefsToMe ()
 Deletes all references to this ReferenceTarget. More...
 
CoreExport RefResult TransferReferences (RefTargetHandle oldTarget, BOOL delOld=FALSE)
 Transfers all the references from oldTarget to this. More...
 
CoreExport int DoEnumDependents (DependentEnumProc *dep)
 Begins an enumeration that searches back in the dependency network. More...
 
virtual CoreExport void BaseClone (ReferenceTarget *from, ReferenceTarget *to, RemapDir &remap)
 This method copies base class data from an object to its clone. More...
 
virtual CoreExport RefResult NotifyDependents (const Interval &changeInt, PartID partID, RefMessage message, SClass_ID sclass=NOTIFY_ALL, BOOL propagate=TRUE, RefTargetHandle hTarg=NULL, NotifyDependentsOption notifyDependentsOption=REFNOTIFY_ALLOW_OPTIMIZATIONS)
 Notify all dependent RefMakers concerned with the message. More...
 
void FlagDependents (TimeValue t, PartID which=PART_PUT_IN_FG)
 This sends the REFMSG_FLAGDEPENDENTS message up the pipeline. More...
 
virtual void NotifyForeground (TimeValue t)
 This method is called to flag dependents into the FG. More...
 
virtual void NotifyTarget (int message, ReferenceMaker *hMaker)
 Sends messages to ReferenceTargets. More...
 
CoreExport ReferenceTarget ()
 Constructor. More...
 
virtual CoreExport RefResult AutoDelete ()
 Deletes the object when it has no more real dependents. More...
 
CoreExport RefResult MaybeAutoDelete ()
 Deletes the object when it has no more real dependents. More...
 
- Public Member Functions inherited from ReferenceMaker
CoreExport RefResult ReplaceReference (int which, RefTargetHandle newtarg, BOOL delOld=TRUE)
 Used when cloning reference makers. More...
 
CoreExport RefResult DeleteAllRefsFromMe ()
 Deletes all references from this ReferenceMaker. More...
 
CoreExport RefResult DeleteAllRefs ()
 Deletes all references both to and from this item. More...
 
CoreExport RefResult DeleteReference (int i)
 Deletes the specified reference. More...
 
virtual BOOL CanTransferReference (int i)
 Tells whether this reference can be transfered. More...
 
CoreExport ReferenceSaveManagerGetReferenceSaveManager ()
 Access the ReferenceSaveManager of this ReferenceMaker. More...
 
virtual CoreExport void EnumAuxFiles (AssetEnumCallback &assetEnum, DWORD flags)
 Enumerate auxiliary files (e.g. bitmaps) More...
 
virtual CoreExport void SaveEnum (SaveEnumProc &sep, BOOL isNodeCall=0)
 The default save enumeration. More...
 
virtual CoreExport bool SpecifySaveReferences (ReferenceSaveManager &referenceSaveManager)
 Used to specify reference slot remapping during scene file save. More...
 
CoreExport int DoEnumDependents (DependentEnumProc *dep)
 Begins an enumeration that searches back in the dependency network. More...
 
CoreExport bool EnumRefHierarchy (RefEnumProc &proc, bool includeCustAttribs=true, bool includeIndirectRefs=true, bool includeNonPersistentRefs=true, bool preventDuplicatesViaFlag=true)
 This method provides a general purpose reference enumerator. More...
 
CoreExport int FindRef (RefTargetHandle rtarg)
 Get the index of the ReferenceTarget. More...
 
virtual BOOL IsRefMaker ()
 Tells whether it is a ReferenceMaker. More...
 
virtual BOOL IsRealDependency (ReferenceTarget *rtarg)
 Returns whether this is a "real" (strong) dependency or not. More...
 
virtual BOOL ShouldPersistWeakRef (RefTargetHandle rtarg)
 Specifies whether a weak reference is to be persisted on a partial load or save. More...
 
CoreExport ReferenceMaker ()
 Constructor. More...
 
CoreExport void DeleteMe ()
 Deletes an instance of this class. More...
 
- Public Member Functions inherited from Animatable
virtual int NumChildren ()
 
virtual AnimatableChildAnim (int i)
 
virtual CoreExport MSTR NodeName ()
 
virtual void EditTrack ()
 
virtual CoreExport BOOL SubAnimSetKeyBufferPresent (int subNum)
 returns true if the sub-anim has a "Set Key" buffer present More...
 
virtual BOOL SetKeyBufferPresent ()
 returns true if there is a "Set Key" buffer present More...
 
virtual CoreExport void SubAnimCommitSetKeyBuffer (TimeValue t, int subNum)
 Commit any "Set Key" buffers on the given sub-anim. More...
 
virtual void CommitSetKeyBuffer (TimeValue t)
 Commit any "Set Key" buffers. More...
 
virtual CoreExport void SubAnimRevertSetKeyBuffer (int subNum)
 Revert any "Set Key" buffers on the given sub-anim. More...
 
virtual void RevertSetKeyBuffer ()
 Revert any "Set Key" buffers. More...
 
virtual LRESULT CALLBACK TrackViewWinProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
 This function is obsolete. More...
 
virtual bool IsParamBlockDesc2Used (ParamBlockDesc2 *desc)
 Returns true if the passed description is being used. More...
 
virtual bool GetMacroRecorderName (bool used_as_rhs_value, MSTR &objectSpecifiedName)
 This method is called to access the object specified name to use for the Maxscript macrorecorder. More...
 
CoreExport Animatable ()
 Constructor. More...
 
virtual void GetClassName (MSTR &s) MAX_SEALED
 
MSTR ClassName (bool localized=true) const
 Returns the name of the plugin class. More...
 
virtual CoreExport void ReleaseInterface (ULONG id, void *i)
 
virtual CoreExport int SetProperty (ULONG id, void *data)
 
virtual CoreExport voidGetProperty (ULONG id)
 
CoreExport void AppendProperty (AnimProperty *prop)
 A function to directly add arbitrary properties to this object developers should ensure that the properties ID does not conflict with any Max-specific IDs. More...
 
CoreExport AnimPropertyFindProperty (DWORD id)
 Find any property. More...
 
CoreExport void AddAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid, DWORD len, void *data)
 Adds application/plugin specific (custom) data to an Animatable. More...
 
CoreExport AppDataChunkGetAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
 Retrieves the application/plugin specific (custom) data stored with an Animatable. More...
 
CoreExport BOOL RemoveAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
 Deletes the application/plugin specific (custom) data stored with an Animatable. More...
 
CoreExport void ClearAllAppData ()
 Deletes all application/plugin specific (custom) data stored with an Animatable. More...
 
virtual MSTR SubAnimName (int i) MAX_SEALED
 
virtual BOOL CanDeleteSubAnim (int i)
 
virtual void DeleteSubAnim (int i)
 
virtual DWORD GetSubAnimCurveColor (int subNum)
 
virtual BOOL CanCopyAnim ()
 
CoreExport int HasSubElements (int type=0)
 
virtual int GetSubFCurveExtents (int subNum, ParamDimensionBase *dim, float &min, float &max, DWORD flags)
 The values max and min should be initialized before calling this function. More...
 
virtual ParamDimensionGetParamDimension (int i)
 
virtual BOOL BypassTreeView ()
 
virtual BOOL BypassTrackBar ()
 
virtual BOOL BypassPropertyLevel ()
 
virtual BOOL InvisibleProperty ()
 
virtual int NumKeys ()
 
virtual TimeValue GetKeyTime (int index)
 
virtual int GetKeyIndex (TimeValue t)
 
virtual BOOL GetNextKeyTime (TimeValue t, DWORD flags, TimeValue &nt)
 
virtual void CopyKeysFromTime (TimeValue src, TimeValue dst, DWORD flags)
 
virtual void DeleteKeyAtTime (TimeValue t)
 
virtual BOOL IsKeyAtTime (TimeValue t, DWORD flags)
 
virtual int GetKeyTimes (Tab< TimeValue > &times, Interval range, DWORD flags)
 
virtual int GetKeySelState (BitArray &sel, Interval range, DWORD flags)
 
CoreExport void OpenTreeEntry (int type, DWORD tv)
 
CoreExport void CloseTreeEntry (int type, DWORD tv)
 
CoreExport int IsTreeEntryOpen (int type, DWORD tv)
 
CoreExport BOOL GetSelInTrackView (DWORD tv)
 
CoreExport void SetSelInTrackView (DWORD tv, BOOL sel)
 
CoreExport BOOL InTrackViewSelSet (int which)
 
CoreExport void SetTrackViewSelSet (int which, BOOL inOut)
 
virtual BOOL CanAssignController (int subAnim)
 Return true if we can reassign the subanim specified. More...
 
virtual BOOL CanMakeUnique ()
 
CoreExport int EnumAnimTree (AnimEnum *animEnum, Animatable *client, int subNum)
 
virtual int RenderBegin (TimeValue t, ULONG flags=0)
 
virtual int RenderEnd (TimeValue t)
 
virtual CoreExport Interval GetTimeRange (DWORD flags)
 
virtual void EditTimeRange (Interval range, DWORD flags)
 
virtual void DeleteTime (Interval iv, DWORD flags)
 
virtual void ReverseTime (Interval iv, DWORD flags)
 
virtual void ScaleTime (Interval iv, float s)
 
virtual void InsertTime (TimeValue ins, TimeValue amount)
 
virtual BOOL SupportTimeOperations ()
 
virtual CoreExport void MapKeys (TimeMap *map, DWORD flags)
 
virtual void DeleteKeys (DWORD flags)
 
virtual void DeleteKeyByIndex (int index)
 
virtual void SelectKeys (TrackHitTab &sel, DWORD flags)
 
virtual void SelectSubKeys (int subNum, TrackHitTab &sel, DWORD flags)
 
virtual void SelectSubCurve (int subNum, BOOL sel)
 
virtual void SelectKeyByIndex (int i, BOOL sel)
 
virtual BOOL IsKeySelected (int i)
 
virtual void FlagKey (TrackHitRecord hit)
 
virtual int GetFlagKeyIndex ()
 
virtual int NumSelKeys ()
 
virtual void CloneSelectedKeys (BOOL offset=FALSE)
 
virtual void AddNewKey (TimeValue t, DWORD flags)
 
virtual void MoveKeys (ParamDimensionBase *dim, float delta, DWORD flags)
 
virtual void ScaleKeyValues (ParamDimensionBase *dim, float origin, float scale, DWORD flags)
 
virtual void SelectCurve (BOOL sel)
 
virtual BOOL IsCurveSelected ()
 Returns TRUE if the function curve is selected; otherwise returns FALSE. More...
 
virtual BOOL IsSubCurveSelected (int subNum)
 Returns the selected state of the sub-curve whose index is passed. More...
 
virtual int GetSelKeyCoords (TimeValue &t, float &val, DWORD flags)
 
virtual void SetSelKeyCoords (TimeValue t, float val, DWORD flags)
 
virtual int SetSelKeyCoordsExpr (ParamDimension *dim, const MCHAR *timeExpr, const MCHAR *valExpr, DWORD flags)
 
virtual void AdjustTangents (TrackHitRecord hit, ParamDimensionBase *dim, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, int dx, int dy, DWORD flags)
 
virtual void AdjustTangents (TrackHitRecord hit, ParamDimensionBase *dim, float angle, float length, DWORD flags)
 
virtual CoreExport BOOL IsAnimated ()
 
virtual BOOL CanCopyTrack (Interval iv, DWORD flags)
 
virtual BOOL CanPasteTrack (TrackClipObject *cobj, Interval iv, DWORD flags)
 
virtual TrackClipObjectCopyTrack (Interval iv, DWORD flags)
 
virtual void PasteTrack (TrackClipObject *cobj, Interval iv, DWORD flags)
 
virtual BOOL CanCopySubTrack (int subNum, Interval iv, DWORD flags)
 
virtual BOOL CanPasteSubTrack (int subNum, TrackClipObject *cobj, Interval iv, DWORD flags)
 
virtual TrackClipObjectCopySubTrack (int subNum, Interval iv, DWORD flags)
 
virtual void PasteSubTrack (int subNum, TrackClipObject *cobj, Interval iv, DWORD flags)
 
virtual int GetTrackVSpace (int lineHeight)
 
virtual int HitTestTrack (TrackHitTab &hits, Rect &rcHit, Rect &rcTrack, float zoom, int scroll, DWORD flags)
 
virtual int PaintTrack (ParamDimensionBase *dim, HDC hdc, Rect &rcTrack, Rect &rcPaint, float zoom, int scroll, DWORD flags)
 
virtual int PaintSubTrack (int subNum, ParamDimensionBase *dim, HDC hdc, Rect &rcTrack, Rect &rcPaint, float zoom, int scroll, DWORD flags)
 
virtual int PaintFCurves (ParamDimensionBase *dim, HDC hdc, Rect &rcGraph, Rect &rcPaint, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
 
virtual int HitTestFCurves (ParamDimensionBase *dim, TrackHitTab &hits, Rect &rcHit, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
 
virtual int PaintSubFCurves (int subNum, ParamDimensionBase *dim, HDC hdc, Rect &rcGraph, Rect &rcPaint, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
 
virtual int HitTestSubFCurves (int subNum, ParamDimensionBase *dim, TrackHitTab &hits, Rect &rcHit, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
 
virtual void EditTrackParams (TimeValue t, ParamDimensionBase *dim, const MCHAR *pname, HWND hParent, IObjParam *ip, DWORD flags)
 
virtual int TrackParamsType ()
 
virtual int GetFCurveExtents (ParamDimensionBase *dim, float &min, float &max, DWORD flags)
 This method is called to calculate the largest and smallest values of the anim. More...
 
CoreExport void AddNoteTrack (NoteTrack *note)
 
CoreExport void DeleteNoteTrack (NoteTrack *note, BOOL delNote=TRUE)
 
CoreExport BOOL HasNoteTracks ()
 
CoreExport int NumNoteTracks ()
 
CoreExport NoteTrackGetNoteTrack (int i)
 
virtual void FreeAllBitmaps ()
 
virtual void GetSystemNodes (INodeTab &nodes, SysNodeContext Context)
 
virtual CoreExport void MouseCycleCompleted (TimeValue t)
 
virtual CoreExport void MouseCycleStarted (TimeValue t)
 
virtual int NumParamBlocks ()
 
virtual IParamBlock2GetParamBlockByID (short id)
 
CoreExport bool SvSaveData (ISave *isave, USHORT id)
 
CoreExport bool SvLoadData (ILoad *iLoad)
 
CoreExport DWORD SvGetRefIndex ()
 
CoreExport void SvSetRefIndex (DWORD i)
 
CoreExport bool SvDeleteRefIndex ()
 
CoreExport SvGraphNodeReference SvStdTraverseAnimGraph (IGraphObjectManager *gom, Animatable *owner, int id, DWORD flags)
 
virtual CoreExport bool SvCanInitiateLink (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport bool SvCanConcludeLink (IGraphObjectManager *gom, IGraphNode *gNode, IGraphNode *gNodeChild)
 
virtual CoreExport bool SvCanSetName (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport bool SvSetName (IGraphObjectManager *gom, IGraphNode *gNode, const MSTR &name)
 
virtual CoreExport bool SvCanRemoveThis (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport bool SvRemoveThis (IGraphObjectManager *gom, IGraphNode *gNode)
 Called when the user deletes this object in the schematic view... More...
 
virtual CoreExport bool SvIsHighlighted (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport COLORREF SvGetSwatchColor (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport bool SvIsInactive (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport bool SvLinkChild (IGraphObjectManager *gom, IGraphNode *gNodeThis, IGraphNode *gNodeChild)
 
virtual CoreExport bool SvEditProperties (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport MSTR SvGetTip (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport MSTR SvGetRefTip (IGraphObjectManager *gom, IGraphNode *gNode, IGraphNode *gNodeMaker)
 
virtual CoreExport bool SvCanDetach (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport bool SvDetach (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport MSTR SvGetRelTip (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
 Returns a string to be displayed in the tip window in the schematic view for a relationship from "gNodeMaker" to "gNodeTarget"... More...
 
virtual CoreExport bool SvCanDetachRel (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
 Returns true if this object can respond to the SvDetachRel(...) method... More...
 
virtual CoreExport bool SvDetachRel (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
 Detach this relationship. More...
 
virtual CoreExport bool SvHandleRelDoubleClick (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
 Called when this relationship is double-clicked in the schematic view... More...
 
CoreExport ICustAttribContainerGetCustAttribContainer ()
 This method returns a pointer to the custom attributes container interface class. More...
 
CoreExport void AllocCustAttribContainer ()
 This method allocates space for a custom attributes container. More...
 
CoreExport void DeleteCustAttribContainer ()
 This method deletes space used by a custom attributes container. More...
 
void SetAFlag (DWORD mask)
 
void ClearAFlag (DWORD mask)
 Clears one or more bits in the Animatable flags. More...
 
bool TestAFlag (DWORD mask) const
 Tests one or more bits in the Animatable flags. More...
 
void SetAFlagEx (DWORD mask)
 Sets one or more bits in the Animatable extended flags. More...
 
void ClearAFlagEx (DWORD mask)
 Clears one or more bits in the Animatable extended flags. More...
 
bool TestAFlagEx (DWORD mask) const
 Tests one or more bits in the Animatable extended flags. More...
 
CoreExport bool TestFlagBit (int index)
 Tests the specified flag bit. More...
 
CoreExport void SetFlagBit (int index, bool newValue=true)
 Sets the specified flag bit. More...
 
CoreExport void ClearFlagBit (int index)
 Clears the specified flag bit. More...
 
- Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor. More...
 
template<class InterfaceType >
InterfaceType * GetTypedInterface ()
 

Public Attributes

int loadRefVersion
 
Interval geomValid
 
Interval topoValid
 
Interval texmapValid
 
Interval selectValid
 
ChannelMask validBits
 
PatchMesh patch
 
int patchSelSubType
 
PointControllerContainerpointCtrlContainer
 
Tab< Control * > vertCont
 
Tab< Control * > vecCont
 
PatchMeshrememberedPatch
 
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
 
SingleRefMakerPatchNodenoderef
 
SingleRefMakerPatchMtlmtlref
 

Static Public Attributes

static HWND hSelectPanel
 
static HWND hOpsPanel
 
static HWND hSurfPanel
 
static HWND hSoftSelPanel
 
static BOOL rsSel
 
static BOOL rsOps
 
static BOOL rsSurf
 
static MoveModBoxCModemoveMode
 
static RotateModBoxCModerotMode
 
static UScaleModBoxCModeuscaleMode
 
static NUScaleModBoxCModenuscaleMode
 
static SquashModBoxCModesquashMode
 
static SelectModBoxCModeselectMode
 
static EP_BindCModebindMode
 
static EP_ExtrudeCModeextrudeMode
 
static EP_NormalFlipCModenormalFlipMode
 
static EP_BevelCModebevelMode
 
static EP_CreateVertCModecreateVertMode
 
static EP_CreatePatchCModecreatePatchMode
 
static EP_VertWeldCModevertWeldMode
 
static EP_CopyTangentCModecopyTangentMode
 
static EP_PasteTangentCModepasteTangentMode
 
static BOOL settingViewportTess
 
static BOOL settingDisp
 
static ISpinnerControluSpin
 
static ISpinnerControlvSpin
 
static ISpinnerControledgeSpin
 
static ISpinnerControlangSpin
 
static ISpinnerControldistSpin
 
static ISpinnerControlmergeSpin
 
static ISpinnerControlmatSpin
 
static ISpinnerControlmatSpinSel
 
static ISpinnerControlweldSpin
 
static ISpinnerControltargetWeldSpin
 
static ISpinnerControlstepsSpin
 
static ISpinnerControlstepsRenderSpin
 
static ISpinnerControlrelaxSpin
 
static ISpinnerControlrelaxIterSpin
 
static POPickPatchAttach pickCB
 
static BOOL patchUIValid
 
static BOOL opsUIValid
 
static int attachMat
 
static BOOL condenseMat
 
static int pickBoxSize
 
static int weldBoxSize
 
static IObjParamip
 
static PatchObjecteditObj
 
static MAX_DEPRECATED PointControllerContainermasterCont
 
- Static Public Attributes inherited from Animatable
static const AnimHandle kInvalidAnimHandle = 0
 

Protected Member Functions

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

Friends

class PatchObjectRestore
 
class POXFormProc
 
class POPickPatchAttach
 

Additional Inherited Members

- Static Public Member Functions inherited from Animatable
static CoreExport BOOL IsDeleted (Animatable *anim)
 Debug method to determine whether an object has been deleted. More...
 
static CoreExport AnimHandle GetHandleByAnim (Animatable *anim)
 Get the unique handle for an Animatable object. More...
 
static CoreExport AnimatableGetAnimByHandle (AnimHandle handle)
 Get an Animatable object from its unique handle. More...
 
static CoreExport AnimHandle GetNextHandle ()
 Get the unique handle for the next Animatable object to be created. More...
 
static CoreExport void EnumerateAllAnimatables (EnumAnimList &enumProcObject)
 Enumerator to enumerate across all animatables. More...
 
static CoreExport bool RegisterAppDataLoadCallback (const Class_ID &cid, SClass_ID sid, APPDATALOADPROC proc)
 Registers a callback proc that is called when an AppDataChunk is read from a scene file. More...
 
static CoreExport bool UnRegisterAppDataLoadCallback (const Class_ID &cid, SClass_ID sid, APPDATALOADPROC proc)
 Unregisters a callback proc that is called when an AppDataChunk is read from a scene file. More...
 
static CoreExport bool RegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
 Registers a callback proc that is called when an AppDataChunk is read from a scene file. More...
 
static CoreExport bool UnRegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
 Unregisters a callback proc that is called when an AppDataChunk is read from a scene file. More...
 
static CoreExport int RequestFlagBit ()
 Requests an unique flag bit index. More...
 
static CoreExport void ReleaseFlagBit (int index)
 Releases the flag bit index. More...
 
static CoreExport void ClearFlagBitInAllAnimatables (int index)
 Clears the specified flag bit in all Animatables. More...
 
- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e)
 Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new (size_t size, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new (size_t size, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport voidoperator new[] (size_t size, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
 
static UtilExport void operator delete (void *ptr)
 Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete (void *ptr, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
 
static UtilExport void operator delete[] (void *ptr, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
 
static UtilExport voidoperator new (size_t size, void *placement_ptr)
 Placement new operator. More...
 
static UtilExport void operator delete (void *ptr, void *placement_ptr)
 Placement delete operator. More...
 
static UtilExport voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary. More...
 
static UtilExport voidaligned_realloc (void *ptr, size_t size, size_t alignment)
 Reallocates memory on a specified alignment boundary. More...
 
static UtilExport void aligned_free (void *ptr)
 Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...
 
- Protected Attributes inherited from BaseObject
MaxSDK::Graphics::RenderItemHandleArray mRenderItemHandles
 
- Protected Attributes inherited from Animatable
DWORD aflag
 
AnimPropertyList aprops
 

Detailed Description

See also
Class GeomObject, Class IPatchOps, Class IPatchSelect, Class IPatchSelectData, Class ISubMtlAPI, Class AttachMatDlgUser, Class PatchMesh, Class Patch, Class Mesh, Class TessApprox, Patches and Faces.

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.

Constructor & Destructor Documentation

◆ PatchObject() [1/2]

Remarks
Constructor.

◆ PatchObject() [2/2]

◆ ~PatchObject()

Remarks
Destructor.

Member Function Documentation

◆ CopyValidity()

void CopyValidity ( PatchObject fromOb,
ChannelMask  channels 
)

◆ NotifyRefChanged()

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

Receives and responds to messages.

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

  • For developer that need to update a dialog box with data about an object you reference note the following related to this method: This method may be called many times. For instance, say you have a dialog box that displays data about an object you reference. This method will get called many time during the drag operations on that object. If you updated the display every time you'd wind up with a lot of 'flicker' in the dialog box. Rather than updating the dialog box each time, you should just invalidate the window in response to the NotifyRefChanged() call. Then, as the user drags the mouse your window will still receive paint messages. If the scene is complex the user may have to pause (but not let up on the mouse) to allow the paint message to go through since they have a low priority. This is the way many windows in 3ds Max work.
Parameters
changeInt- This is the interval of time over which the message is active. Currently, all plug-ins will receive FOREVER for this interval, with the exception of REFMSG_FLAGDEPENDENTS notifications. In that case, changeInt.Start() is the timepoint to perform the dependency test.
hTarget- This is the handle of the reference target the message was sent by. The reference maker uses this handle to know specifically which reference target sent the message.
partID- This contains information specific to the message passed in. Some messages don't use the partID at all. See the section List of Reference Messages for more information about the meaning of the partID for some common messages.
message- The message parameters passed into this method is the specific message which needs to be handled.
propagate- If called through ReferenceMaker::NotifyDependents(), the value of 'propagate' passed to it. Used if calling NotifyDependents() from within NotifyRefChanged().
Returns
The return value from this method is of type RefResult. This is usually REF_SUCCEED indicating the message was processed. Sometimes, the return value may be REF_STOP. This return value is used to stop the message from being propagated to the dependents of the item.

Implements ReferenceMaker.

◆ PatchObjectInit()

CoreExport void PatchObjectInit ( )

◆ GetObjectDisplayRequirement()

virtual CoreExport unsigned long GetObjectDisplayRequirement ( ) const
virtual

Reimplemented from BaseObject.

◆ PrepareDisplay()

virtual CoreExport bool PrepareDisplay ( const MaxSDK::Graphics::UpdateDisplayContext prepareDisplayContext)
virtual

Reimplemented from BaseObject.

◆ UpdatePerNodeItems()

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

Reimplemented from BaseObject.

◆ operator=()

CoreExport PatchObject& operator= ( PatchObject from)

◆ SetFlag()

void SetFlag ( DWORD  fl,
BOOL  val = TRUE 
)
inline
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.
627 { if (val) epFlags |= fl; else epFlags &= ~fl; }
DWORD epFlags
Definition: patchobj.h:580

◆ ClearFlag()

void ClearFlag ( DWORD  fl)
inline
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.
635 { epFlags &= (~fl); }

◆ GetFlag()

bool GetFlag ( DWORD  fl)
inline
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.
644 { return (epFlags&fl) ? TRUE : FALSE; }

◆ HitTest() [1/2]

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

This method is called to determine if the specified screen point intersects the item.

The method returns nonzero if the item was hit; otherwise 0.

Parameters
tThe time to perform the hit test.
inodeA pointer to the node to test.
typeThe type of hit testing to perform. See Scene and Node Hit Test Types. for details.
crossingThe state of the crossing setting. If TRUE crossing selection is on.
flagsThe hit test flags. See Scene and Node Hit Testing Flags for details.
pThe screen point to test.
vptAn 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.

◆ HitTest() [2/2]

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

This method is used in modifier gizmo hit testing.

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

Parameters
tThe time to perform the hit test.
inodeA pointer to the node to test.
typeThe type of hit testing to perform. See Scene and Node Hit Test Types. for details.
crossingThe state of the crossing setting. If TRUE crossing selection is on.
flagsThe hit test flags. See Scene and Node Hit Testing Flags for details.
pThe screen point to test.
vptAn interface pointer that may be used to call methods associated with the viewports.
mcA pointer to the modifiers ModContext.
Returns
Nonzero if the item was hit; otherwise 0.

Reimplemented from BaseObject.

◆ Display() [1/2]

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

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
tThe time to display the object.
inodeThe node to display.
vptAn interface pointer that may be used to call methods associated with the viewports.
flagsSee Display Flags.
Returns
Default return value is -1, means this object doesn't have display function. 0 means it didn't draw anything in current frame. Otherwise return positive values..

Reimplemented from BaseObject.

◆ Snap()

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

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

Note
Developers wanting to find snap points on an Editable Mesh object should see the method XmeshSnap::Snap() in /MAXSDK/SAMPLES/SNAPS/XMESH/XMESH.CPP.
Parameters
tThe time to check.
inodeThe node to check.
snapThe snap info structure to update.
pThe screen point to check.
vptAn interface pointer that may be used to call methods associated with the viewports.

Reimplemented from BaseObject.

◆ GetCreateMouseCallBack()

CoreExport CreateMouseCallBack* GetCreateMouseCallBack ( )
virtual

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

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

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

Implements BaseObject.

◆ Clone()

CoreExport RefTargetHandle Clone ( RemapDir remap)
virtual

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

See also
CloneRefHierarchy(), class RemapDir This method is called by 3ds Max to have the plugin clone itself. The plug-in's implementation of this method should copy both the data structure and all the data residing in the data structure of this reference target. The plugin should clone all its references as well. Also, the plug-in's implementation of this method must call BaseClone(). In order for classes derived from this class to clone cleanly, the Clone method should just create the new instance, and then call an implementation of BaseClone that clones the references and copies any other necessary data. For example:
class MyDerivedPlugin
: public MyBasePlugin
{
const int MY_REFERENCE = 1;
{
ReferenceTarget* result = new MyDerivedPlugin();
BaseClone(this, result, remap);
return result;
}
{
if (!to || !from || from == to)
return;
MyBasePlugin::BaseClone(from, to, remap);
to->ReplaceReference(MY_REFERENCE, remap->CloneRef(from->GetReference(MY_REFERENCE)));
}
};
CoreExport RefTargetHandle Clone(RemapDir &remap)
This method is used by 3ds Max to clone an object.
virtual CoreExport RefTargetHandle GetReference(int i)
Returns the 'i-th' reference.
CoreExport RefResult ReplaceReference(int which, RefTargetHandle newtarg, BOOL delOld=TRUE)
Used when cloning reference makers.
A scene entity that is being owned and listened to by other scene entities.
Definition: ref.h:1844
virtual CoreExport void BaseClone(ReferenceTarget *from, ReferenceTarget *to, RemapDir &remap)
This method copies base class data from an object to its clone.
For remapping references during a Clone.
Definition: ref.h:830
virtual RefTargetHandle CloneRef(RefTargetHandle oldTarg)
Creates a clone of a reference target only if it hasn't been cloned already.

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.

◆ GetSubObjectLevel()

CoreExport int GetSubObjectLevel ( )
inlineoverridevirtual

This method returns an integer which indicates the current sub-object level of the modifier or base object.

Returns
A value of 0 indicates object level. A value of 1 through NumSubObjTypes() are the sub-object levels in the same order as they are returned by GetSubObjType(int i) (with an offset of 1 of course).

Reimplemented from BaseObject.

655 { return GetSubobjectLevel(); }
CoreExport int GetSubobjectLevel()

◆ Display() [2/2]

CoreExport int Display ( TimeValue  t,
INode inode,
ViewExp vpt,
int  flags,
ModContext mc 
)
virtual
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 Display Flags for more information.

ModContext* mc

A pointer to the modifiers ModContext.

Reimplemented from BaseObject.

◆ GetWorldBoundBox() [1/2]

CoreExport void GetWorldBoundBox ( TimeValue  t,
INode inode,
ViewExp vp,
Box3 box,
ModContext mc 
)
virtual
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.

◆ NumSubObjTypes()

CoreExport int NumSubObjTypes ( )
virtual

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

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

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

Reimplemented from BaseObject.

◆ GetSubObjType()

CoreExport ISubObjType* GetSubObjType ( int  i)
virtual

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

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

Parameters
iThe 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.

◆ ObjectValidity()

CoreExport Interval ObjectValidity ( TimeValue  t)
virtual

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

Parameters
tThe time to compute the validity interval.
Returns
The validity interval of the object, including that queried from the base class.

Reimplemented from Object.

◆ GetExtendedProperties()

CoreExport BOOL GetExtendedProperties ( TimeValue  t,
MSTR prop1Label,
MSTR prop1Data,
MSTR prop2Label,
MSTR prop2Data 
)
virtual

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
tThe time at which the strings are requested.
prop1LabelThe string for the property 1 label.
prop1DataThe formatted data string to appear as property 1.
prop2LabelThe string for the property 2 label.
prop2DataThe 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.

◆ PolygonCount()

CoreExport BOOL PolygonCount ( TimeValue  t,
int numFaces,
int numVerts 
)
virtual

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
tThe time at which to compute the number of faces and vertices.
numFacesThe number of faces is returned here.
numVertsThe number of vertices is returned here.
Returns
TRUE if the method is fully implemented; otherwise FALSE.

Reimplemented from Object.

◆ ChannelValidity()

CoreExport Interval ChannelValidity ( TimeValue  t,
int  nchan 
)
virtual

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

Note
Most procedural objects won't implement this method since they don't have individual channels. Developers wanting to get the validity interval for a procedural object should use Object::ObjectValidity() instead.
Parameters
tThe time to retrieve the validity interval of the channel.
nchanSpecifies the channel to return the validity interval of. See
Object Channels.
Returns
The validity interval of the specified channel.

Reimplemented from Object.

◆ SetChannelValidity()

CoreExport void SetChannelValidity ( int  nchan,
Interval  v 
)
virtual

Sets the validity interval of the specified channel.

Parameters
nchanSpecifies the channel. See Object Channels.
vThe validity interval for the channel.

Reimplemented from Object.

◆ InvalidateChannels()

CoreExport void InvalidateChannels ( ChannelMask  channels)
virtual

This method invalidates the intervals for the given channel mask.

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

Parameters
channelsSpecifies the channels to invalidate.

Reimplemented from Object.

◆ TopologyChanged()

CoreExport void TopologyChanged ( )
virtual

Implemented by the System.

This method locks the object as a whole. The object defaults to not modifiable.

Reimplemented from Object.

◆ ConvertValidity()

CoreExport Interval ConvertValidity ( TimeValue  t)

◆ IsDeformable()

virtual int IsDeformable ( )
inlinevirtual

Indicates whether this object is deformable.

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

Note
The Deformable object methods only need to be implemented if the object returns TRUE from this method.
Returns
Return nonzero if the object is deformable and implements the generic deformable object methods; otherwise 0.

Reimplemented from Object.

713 { return 1; }

◆ NumPoints()

CoreExport int NumPoints ( )
virtual

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

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

Returns
The number of points in the object.

Reimplemented from Object.

◆ GetPoint()

CoreExport Point3 GetPoint ( int  i)
virtual

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

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

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

Reimplemented from Object.

◆ SetPoint()

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

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

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

Parameters
iThe index of the point to store.
pThe point to store.

Reimplemented from Object.

◆ IsPointSelected()

CoreExport BOOL IsPointSelected ( int  i)
virtual

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

Parameters
iThe zero based index of the point to check.

Reimplemented from Object.

◆ PointsWereChanged()

CoreExport void PointsWereChanged ( )
virtual

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

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

Reimplemented from Object.

◆ GetDeformBBox()

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

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

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

Parameters
tThe time to compute the box.
boxA reference to a box the result is stored in.
tmThis 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.
useSelIf TRUE, the bounding box of selected sub-elements should be computed; otherwise the entire object should be used.

Reimplemented from Object.

◆ Deform()

CoreExport void Deform ( Deformer defProc,
int  useSel 
)
virtual

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

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

Parameters
defProcA pointer to an instance of the Deformer class. This is the callback object that actually performs the deformation.
useSelA 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)));
}
The callback object used by modifiers to deform "Deformable" objects.
Definition: object.h:1224
virtual CoreExport Point3 Map(int i, Point3 p) const
This is the method that is called to deform or alter a single point.
virtual CoreExport void Deform(Deformer *defProc, int useSel=0)
This is the method used to deform the object with a deformer.
CoreExport void SetPoint(int i, const Point3 &p)
The points of a deformable object are accessed through a virtual array interface.
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 PointsWereChanged()
Informs the object that its points have been deformed, so it can invalidate its cache.
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)));
}
}
Definition: bitarray.h:60
Definition: point3.h:56
CoreExport void Deform(Deformer *defProc, int useSel)
This is the method used to deform the object with a deformer.

Reimplemented from Object.

◆ IsParamSurface()

virtual BOOL IsParamSurface ( )
inlinevirtual

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.

723 {return TRUE;}

◆ GetSurfacePoint()

CoreExport Point3 GetSurfacePoint ( TimeValue  t,
float  u,
float  v,
Interval iv 
)
virtual

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
tThe time to retrieve the point.
uThe parameter along the horizontal axis of the surface.
vThe parameter along the vertical axis of the surface.
ivThis interval is updated based on the interval of the surface parameter.

Reimplemented from Object.

◆ IsMappable()

virtual int IsMappable ( )
inlinevirtual

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.

727 { return 1; }

◆ NumMapChannels()

virtual int NumMapChannels ( )
inlinevirtual

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.

728 { return patch.NumMapChannels (); }
int NumMapChannels()
Definition: patch.h:2268
PatchMesh patch
Definition: patchobj.h:558

◆ NumMapsUsed()

virtual int NumMapsUsed ( )
inlinevirtual

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.

729 { return patch.getNumMaps(); }
int getNumMaps()
Definition: patch.h:2242

◆ ApplyUVWMap()

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 
)
inlinevirtual

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
typeThe mapping type. One of the following values: MAP_PLANAR
MAP_CYLINDRICAL
MAP_SPHERICAL
MAP_BALL
MAP_BOX
utileNumber of tiles in the U direction.
vtileNumber of tiles in the V direction.
wtileNumber of tiles in the W direction.
uflipIf nonzero the U values are mirrored.
vflipIf nonzero the V values are mirrored.
wflipIf nonzero the W values are mirrored.
capThis is used with MAP_CYLINDRICAL. If nonzero, then any face normal that is pointing more vertically than horizontally will be mapped using planar coordinates.
tmThis defines the mapping space. As each point is mapped, it is multiplied by this matrix, and then it is mapped.
channelThis indicates which channel the mapping is applied to. See Mapping Channels .

Reimplemented from Object.

731  {
732  patch.ApplyUVWMap(type,utile,vtile,wtile,uflip,vflip,wflip,cap,tm,channel); }
CoreExport void ApplyUVWMap(int type, float utile, float vtile, float wtile, int uflip, int vflip, int wflip, int cap, const Matrix3 &tm, int channel=1)

◆ CanConvertToType()

CoreExport int CanConvertToType ( Class_ID  obtype)
virtual

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

If the object returns nonzero to indicate it can be converted to the specified type, it must handle converting to and returning an object of that type from ConvertToType().

See also
Class ObjectConverter for additional details on converting objects between types.
Parameters
obtypeThe Class_ID of the type of object to convert to. See Class Class_ID, Class IDs defined in plugapi.h.
Returns
Nonzero if the object can be converted to the specified type; otherwise 0.
Default Implementation:
{ return 0; }

Reimplemented from Object.

◆ ConvertToType()

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

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

Note that if ConvertToType() returns a new object it should be a completely different object with no ties (pointers or references) to the original.

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);
}
#define NULL
Definition: autoptr.h:18
Definition: matrix3.h:98
#define GEOM_CHAN_NUM
The geometry channel number.
Definition: channels.h:112
#define FOREVER
Definition: interval.h:168
As the code above shows, the Bomb checks if the ObjectState TM is non-NULL. If it is, the points of the object are still not in world space and thus must be transformed. It does this by looping through the points of the TriObject and multiplying each point by the ObjectState TM. When it is done, it sets the ObjectState TM to NULL to indicate the points are now in world space. This ensure that any later WSMs will not transform the points with this matrix again.
For the Bomb world space modifier this is not a problem since it specifies
in its implementation of ChannelsChanged() that it will operate on the geometry channel (GEOM_CHANNEL). Certain world space modifiers may not normally specify GEOM_CHANNEL in their implementation of ChannelsChanged(). Consider the camera mapping world space modifier. Its function is to apply mapping coordinates to the object it is applied to. Thus it would normally only specify TEXMAP_CHANNEL for ChannelsChanged(). However, since it operates directly on TriObjects, just like the Bomb, the system cannot transform the points into world space, and therefore the camera mapping modifier must do so in its implementation of ModifyObject(). But since it is actually altering the points of the object by putting them into world space it is altering the geometry channel. Therefore, it should really specify GEOM_CHANNEL | TEXMAP_CHANNEL in its implementation of ChannelsChanged(). If it didn't do this, but went ahead and modified the points of the object anyway, it would be transforming not copies of the points, but the original points stored back in an earlier cache or even the base object.
This is the issue developers need to be aware of. To state this in simple
terms then: Any world space modifier that needs to put the points of the object into world space (since it doesn't implement InputType() as defObjectClassID) needs to specify GEOM_CHANNEL in its implementation of ChannelsChanged().
Parameters
tThe time at which to convert.
obtypeThe Class_ID of the type of object to convert to. See Class Class_ID, Class IDs defined in plugapi.h.
Returns
A pointer to an object of type obtype.
Default Implementation:
{ return NULL; }
Sample Code:
The following code shows how a TriObject can be retrieved from a node. Note on the code that if you call ConvertToType() on an object and it returns a pointer other than itself, you are responsible for deleting that object.
// Retrieve the TriObject from the node
int deleteIt;
TriObject *triObject = GetTriObjectFromNode(ip->GetSelNode(0),deleteIt);
// Use the TriObject if available
if (!triObject) return;
// ...
// Delete it when done...
if (deleteIt) triObject->DeleteMe();
// Return a pointer to a TriObject given an INode or return NULL
// if the node cannot be converted to a TriObject
TriObject *Utility::GetTriObjectFromNode(INode *node, int &deleteIt)
{
deleteIt = FALSE;
Object *obj = node->EvalWorldState(0).obj;
// 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;
}
}
Definition: maxtypes.h:154
Definition: inode.h:55
virtual const ObjectState & EvalWorldState(TimeValue time, BOOL evalHidden=TRUE)=0
virtual INode * GetSelNode(int i)=0
The object class is the base class for all objects.
Definition: object.h:1428
virtual CoreExport int CanConvertToType(Class_ID obtype)
Indicates whether the object can be converted to the specified type.
virtual CoreExport Object * ConvertToType(TimeValue t, Class_ID obtype)
This method converts this object to the type specified and returns a pointer it.
Object * obj
Pointer to the object in the pipeline.
Definition: object.h:295
static IObjParam * ip
Definition: patchobj.h:555
CoreExport void DeleteMe()
Deletes an instance of this class.
Definition: triobj.h:62
#define TRIOBJ_CLASS_ID
TriObject class ID.
Definition: plugapi.h:546

Reimplemented from Object.

◆ GetCollapseTypes()

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

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

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

Parameters
clistThe table of allowable Class_IDs.
nlistThe 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);
MSTR *name = new MSTR(GetString(IDS_SM_NURBS_SURFACE));
clist.Append(1,&id);
nlist.Append(1,&name);
}
virtual CoreExport void GetCollapseTypes(Tab< Class_ID > &clist, Tab< MSTR * > &nlist)
When the user clicks on the Edit Stack button in the modify branch a list of 'Convert To:' types is p...
int Append(int num, T *el, int allocExtra=0)
Appends items at the end of the Tab.
Definition: tab.h:281
Definition: strclass.h:738
WStr MSTR
Definition: strclass.h:1058
#define EDITABLE_SURF_CLASS_ID
Definition: surf_api.h:30

Reimplemented from Object.

◆ FreeChannels()

CoreExport void FreeChannels ( ChannelMask  channels)
virtual

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

Parameters
channelsSpecifies the channels to free.

Reimplemented from Object.

◆ MakeShallowCopy()

CoreExport Object* MakeShallowCopy ( ChannelMask  channels)
virtual

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

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

Parameters
channelsThe channels to copy.
Returns
A pointer to the shallow copy of the object.

Reimplemented from Object.

◆ ShallowCopy()

CoreExport void ShallowCopy ( Object fromOb,
ChannelMask  channels 
)
virtual

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

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

Parameters
fromObObject to copy the channels from.
channelsChannels to copy.

Reimplemented from Object.

◆ NewAndCopyChannels()

CoreExport void NewAndCopyChannels ( ChannelMask  channels)
virtual

This method replaces the locked channels with newly allocated copies.

It will only be called if the channel is locked.

Parameters
channelsThe channels to be allocate and copy.

Reimplemented from Object.

◆ GetSubselState()

CoreExport DWORD GetSubselState ( )
virtual

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

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

Returns
The current selection level of the object.

Reimplemented from Object.

◆ IntersectRay()

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

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

Parameters
tThe time to compute the intersection.
rRay to intersect. See Class Ray.
atThe point of intersection.
normSurface 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.

◆ GetWorldBoundBox() [2/2]

CoreExport void GetWorldBoundBox ( TimeValue  t,
INode inode,
ViewExp vp,
Box3 box 
)
virtual

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

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

Parameters
tThe time to compute the bounding box.
inodeThe node to calculate the bounding box for.
vpAn interface pointer that can be used to call methods associated with the viewports.
boxContains the returned bounding box.

Reimplemented from BaseObject.

◆ GetLocalBoundBox()

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

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

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

Parameters
tThe time to retrieve the bounding box.
inodeThe node to calculate the bounding box for.
vpAn interface pointer that may be used to call methods associated with the viewports.
boxContains the returned bounding box.

Reimplemented from BaseObject.

◆ IsInstanceDependent()

CoreExport int IsInstanceDependent ( )
virtual

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

Reimplemented from GeomObject.

◆ GetRenderMesh()

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

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
tThe time to get the mesh.
inodeThe node in the scene.
viewIf the renderer calls this method it will pass the view information here. See Class View.
needDeleteSet to TRUE if the renderer should delete the mesh, FALSE otherwise.
Returns
A pointer to the mesh object.

Reimplemented from GeomObject.

◆ GetPatchMesh()

CoreExport PatchMesh& GetPatchMesh ( TimeValue  t)

◆ GetMesh()

CoreExport Mesh& GetMesh ( TimeValue  t)

◆ DeleteThis()

virtual CoreExport void DeleteThis ( )
virtual

Deletes an instance of this class.

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

Note
See the method ClassDesc::Create() for details on how Max allocates plugin objects.
See ReferenceMaker::DeleteMe() and ReferenceTarget::MaybeAutoDelete() for information on how plugin instances are deleted by the system.
Remarks
See Memory Management.

See also
Required DLL Functions, Class ClassDesc.

Reimplemented from Animatable.

◆ FreeCaches()

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

Reimplemented from Animatable.

CoreExport void InvalidateGeomCache()

◆ ClassID()

virtual Class_ID ClassID ( )
inlinevirtual

Retrieves a constant that uniquely identifies the plugin class.

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

Returns
A class id that uniquely identifies a plugin class
See also
Class ClassID, class ID definitions in plugapi.h.

Reimplemented from Animatable.

758 { return Class_ID(PATCHOBJ_CLASS_ID,0); }
#define PATCHOBJ_CLASS_ID
Patch object.
Definition: plugapi.h:549

◆ IsSubClassOf()

CoreExport BOOL IsSubClassOf ( Class_ID  classID)
virtual

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

◆ GetClassName()

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

Retrieves the name of the plugin class.

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

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

Reimplemented from ReferenceTarget.

◆ GetInterface()

CoreExport void* GetInterface ( ULONG  id)
virtual

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.

◆ GetObjectName()

virtual CoreExport const MCHAR* GetObjectName ( bool  localized = true) const
overridevirtual
Returns
the name that will appear in the modifier stack.
Parameters
localizedIf true, then the object name returned should be localized in the language 3ds Max is currently using. Otherwise it should be the object name in English. If a plugin does not provide localized string resources, it can disregard this parameter and always return the object name in English.

Reimplemented from BaseObject.

◆ NumSubs()

int NumSubs ( )
inlinevirtual
Remarks
The system uses a virtual array mechanism to access the sub-anims of a plug-in. This method returns the total number of sub-anims maintained by the plug-in. If a plug-in is using a parameter block to manage its parameters it should just return 1 for all the parameters directed by the parameter block.
Returns
The number of sub-anims used by the plug-in.
Default Implementation:
{ return 0; }

Reimplemented from Animatable.

769 { return 1; } // Just tell it about the Point Controller Container

◆ SubAnim()

CoreExport Animatable* SubAnim ( int  i)
virtual
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
iThis is the index of the sub-anim to return.
Default Implementation:
{ return NULL };

Reimplemented from Animatable.

◆ SubAnimName()

CoreExport MSTR SubAnimName ( int  i,
bool  localized = true 
)
overridevirtual
Remarks
This method returns the name of the 'i-th' sub-anim to appear in track view. The system has no idea what name to assign to the sub-anim (it only knows it by the virtual array index), so this method is called to retrieve the name to display. Developer need to make sure the 'i-th' SubAnim() is non-NULL or this method will fail.
Parameters
iThe index of the parameter name to return
localizedIf true, then the sub-anim name returned should be localized in the language 3ds Max is currently using. Otherwise it should be the sub-anim name in English. If a plugin does not provide localized string resources, it can disregard this parameter and always return the sub-anim name in English.
Returns
The name of the 'i-th' parameter.

Reimplemented from Animatable.

◆ AssignController()

CoreExport BOOL AssignController ( Animatable control,
int  subAnim 
)
virtual
Remarks
This method is called to assign the controller to the sub-anim whose index is passed.
Parameters
controlThe controller to assign.
subAnimThe index of the sub-anim to assign the controller to.
Default Implementation:
{ return FALSE; }
Returns
Returns TRUE if the controller was assigned; otherwise FALSE.

Reimplemented from Animatable.

◆ SubNumToRefNum()

int SubNumToRefNum ( int  subNum)
inlinevirtual
Remarks
This method is used for copying and pasting in the track view. It converts an anim index to a reference index or returns -1 if there is no correspondence. If a client does not wish an anim to be copied or pasted then it can return -1 even if there is a corresponding reference num.
Parameters
subNumThe 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.

773 {return subNum;}

◆ SelectSubAnim()

CoreExport BOOL SelectSubAnim ( int  subNum)
virtual
Remarks
This method is available in release 2.0 and later only.

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

◆ HasControllers()

CoreExport BOOL HasControllers ( BOOL  assertCheck = TRUE)

◆ RescaleWorldUnits()

CoreExport void RescaleWorldUnits ( float  f)
virtual

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

return;
void SetAFlag(DWORD mask)
Definition: Animatable.h:299
bool TestAFlag(DWORD mask) const
Tests one or more bits in the Animatable flags.
Definition: Animatable.h:312
#define A_WORK1
Definition: AnimatableFlags.h:221

before doing this on a reference hierarchy.

Parameters
f- The scale factor.

Reimplemented from ReferenceMaker.

◆ NumRefs()

int NumRefs ( )
inlinevirtual

Returns the total number of references this ReferenceMaker can hold.

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

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

Reimplemented from ReferenceMaker.

779 {return vertCont.Count() + vecCont.Count() + 1;} // vert conts + vec conts + Point Controller Container
Tab< Control * > vertCont
Definition: patchobj.h:564
Tab< Control * > vecCont
Definition: patchobj.h:565
int Count() const
Retrieves the number of items in the Tab.
Definition: tab.h:219

◆ GetReference()

CoreExport RefTargetHandle GetReference ( int  i)
virtual

Returns the 'i-th' reference.

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

Parameters
i- The index of the reference to retrieve. Valid values are from 0 to NumRefs()-1.
Returns
The reference handle of the 'i-th' reference. Note that different calls to this method with the same 'i' value can result in different reference handles being retrieved, as the plugin changes the scene objects it references as its 'i-th' reference.

Reimplemented from ReferenceMaker.

◆ SetReference()

virtual CoreExport void SetReference ( int  i,
RefTargetHandle  rtarg 
)
protectedvirtual

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

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

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

Reimplemented from ReferenceMaker.

◆ RemapRefOnLoad()

CoreExport int RemapRefOnLoad ( int  iref)
virtual

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.

◆ PlugControllersSel()

CoreExport void PlugControllersSel ( TimeValue  t)

◆ AllocVertContArray()

CoreExport void AllocVertContArray ( int  count)

◆ AllocVecContArray()

CoreExport void AllocVecContArray ( int  count)

◆ AllocContArrays()

CoreExport void AllocContArrays ( int  vertCount,
int  vecCount 
)

◆ ReplaceVertContArray()

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

◆ ReplaceVecContArray()

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

◆ ReplaceContArrays()

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

◆ PlugVertControl()

CoreExport BOOL PlugVertControl ( TimeValue  t,
int  i 
)

◆ PlugVecControl()

CoreExport BOOL PlugVecControl ( TimeValue  t,
int  i 
)

◆ SetVertAnim()

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

◆ SetVecAnim()

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

◆ SetVertCont()

CoreExport void SetVertCont ( int  i,
Control c 
)

◆ SetVecCont()

CoreExport void SetVecCont ( int  i,
Control c 
)

◆ Save()

CoreExport IOResult Save ( ISave isave)
virtual

Called for saving data.

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

Parameters
isave- This pointer may be used to call methods to write data to disk. See the section on Loading and Saving Plug-in Data for an overview of the load/save process.
Returns
The default implementation is return IO_OK.
  • IO_OK means the result was acceptable, with no errors.
  • IO_ERROR This should be returned if an error occurred.

Reimplemented from ReferenceMaker.

◆ Load()

CoreExport IOResult Load ( ILoad iload)
virtual

Called for loading data.

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

Parameters
iload- This interface pointer may be used to call methods to read data from disk.
Returns
The default implementation is return IO_OK.
  • IO_OK means the result was acceptable, with no errors.
  • IO_ERROR This should be returned if an error occurred.

Reimplemented from ReferenceMaker.

◆ UpdatePatchMesh()

virtual CoreExport void UpdatePatchMesh ( TimeValue  t)
virtual
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:
{}

◆ PrepareMesh()

CoreExport void PrepareMesh ( TimeValue  t)
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.

◆ GetUnrelaxedMesh()

CoreExport Mesh& GetUnrelaxedMesh ( TimeValue  t)

◆ ShowLattice()

CoreExport BOOL ShowLattice ( )
inline
Remarks
Returns TRUE if the patch lattice is displayed; otherwise FALSE.
824 { return patch.GetDispFlag(DISP_LATTICE) ? TRUE : FALSE; }
DWORD GetDispFlag(DWORD f)
Definition: patch.h:1977
#define DISP_LATTICE
Display the patch lattice.
Definition: GraphicsConstants.h:28

◆ ShowVerts()

CoreExport BOOL ShowVerts ( )
inline
Remarks
Returns TRUE if the patch vertices are shown; otherwise FALSE.
827 { return patch.GetDispFlag(DISP_VERTS) ? TRUE : FALSE; }
#define DISP_VERTS
This is used by the Edit Patch modifier to indicate whether the vertices are displayed or not.
Definition: GraphicsConstants.h:31

◆ SetShowLattice()

CoreExport void SetShowLattice ( BOOL  sw)
inline
Remarks
Sets the state of the lattice display switch.
Parameters:
BOOL sw

TRUE to turn on the lattice display; FALSE to turn it off.
void SetDispFlag(DWORD f)
Definition: patch.h:1974
void ClearDispFlag(DWORD f)
Definition: patch.h:1980

◆ SetShowVerts()

CoreExport void SetShowVerts ( BOOL  sw)
inline
Remarks
Sets the state of the vertex display switch
Parameters:
BOOL sw

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

◆ SetMeshSteps()

CoreExport void SetMeshSteps ( int  steps)
Remarks
Sets the number of mesh steps (viewport).
Parameters:
int steps

The number of steps to set.

◆ GetMeshSteps()

CoreExport int GetMeshSteps ( )
Remarks
Returns the number of mesh steps (viewport).

◆ SetMeshStepsRender()

CoreExport void SetMeshStepsRender ( int  steps)
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.

◆ GetMeshStepsRender()

CoreExport int GetMeshStepsRender ( )
Remarks
This method is available in release 3.0 and later only.

Returns the Surface Render Steps setting.

◆ Relaxing()

CoreExport BOOL Relaxing ( )

◆ SetRelax()

CoreExport void SetRelax ( BOOL  v)

◆ SetRelaxViewports()

CoreExport void SetRelaxViewports ( BOOL  v)

◆ SetRelaxValue()

CoreExport void SetRelaxValue ( float  v)

◆ SetRelaxIter()

CoreExport void SetRelaxIter ( int  v)

◆ SetRelaxBoundary()

CoreExport void SetRelaxBoundary ( BOOL  v)

◆ SetRelaxSaddle()

CoreExport void SetRelaxSaddle ( BOOL  v)

◆ GetRelax()

BOOL GetRelax ( )
inline
864 { return patch.GetRelax(); }
CoreExport BOOL GetRelax()

◆ GetRelaxViewports()

BOOL GetRelaxViewports ( )
inline
865 { return patch.GetRelaxViewports(); }
CoreExport BOOL GetRelaxViewports()

◆ GetRelaxValue()

float GetRelaxValue ( )
inline
866 { return patch.GetRelaxValue(); }
CoreExport float GetRelaxValue()

◆ GetRelaxIter()

int GetRelaxIter ( )
inline
867 { return patch.GetRelaxIter(); }
CoreExport int GetRelaxIter()

◆ GetRelaxBoundary()

BOOL GetRelaxBoundary ( )
inline
868 { return patch.GetRelaxBoundary(); }
CoreExport BOOL GetRelaxBoundary()

◆ GetRelaxSaddle()

BOOL GetRelaxSaddle ( )
inline
869 { return patch.GetRelaxSaddle(); }
CoreExport BOOL GetRelaxSaddle()

◆ SetShowInterior()

CoreExport void SetShowInterior ( BOOL  si)
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.

◆ GetShowInterior()

CoreExport BOOL GetShowInterior ( )
Remarks
This method is available in release 3.0 and later only.

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

◆ SetUsePatchNormals()

CoreExport void SetUsePatchNormals ( BOOL  usePatchNorm)

◆ GetUsePatchNormals()

CoreExport BOOL GetUsePatchNormals ( )

◆ SetAdaptive()

CoreExport void SetAdaptive ( BOOL  sw)
Remarks
Sets the state of the adaptive switch.
Parameters:
BOOL sw

TRUE to turn on; FALSE to turn off.

◆ GetAdaptive()

CoreExport BOOL GetAdaptive ( )
Remarks
Returns the state of the adaptive switch. TRUE is on; FALSE is off.

◆ SetViewTess()

CoreExport void SetViewTess ( TessApprox  tess)
Remarks
Sets the tesselation approximation object used for viewport rendering.
Parameters:
TessApprox tess

The tesselation approximation object to be used for viewport rendering.

◆ GetViewTess()

CoreExport TessApprox GetViewTess ( )
Remarks
Returns the tesselation approximation object used for rendering in the viewports.

◆ SetProdTess()

CoreExport void SetProdTess ( TessApprox  tess)
Remarks
Sets the tesselation approximation object used for production rendering.
Parameters:
TessApprox tess

The tesselation approximation object to be used for production rendering.

◆ GetProdTess()

CoreExport TessApprox GetProdTess ( )
Remarks
Returns the tesselation approximation object used for production rendering.

◆ SetDispTess()

CoreExport void SetDispTess ( TessApprox  tess)
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.

◆ GetDispTess()

CoreExport TessApprox GetDispTess ( )
Remarks
Returns the tesselation approximation object used for display in the viewports.

◆ GetViewTessNormals()

CoreExport BOOL GetViewTessNormals ( )
Remarks
Returns TRUE if normals are used from the viewport tesselator; otherwise FALSE.

◆ SetViewTessNormals()

CoreExport void SetViewTessNormals ( BOOL  use)
Remarks
Sets if normals are used from the viewport tesselator.
Parameters:
BOOL use

TRUE to use normals; FALSE to not use them.

◆ GetProdTessNormals()

CoreExport BOOL GetProdTessNormals ( )
Remarks
Returns TRUE if normals are used from the production renderer tesselator; otherwise FALSE.

◆ SetProdTessNormals()

CoreExport void SetProdTessNormals ( BOOL  use)
Remarks
Sets if normals are used from the production renderer tesselator.
Parameters:
BOOL use

TRUE to use normals; FALSE to not use them.

◆ GetViewTessWeld()

CoreExport BOOL GetViewTessWeld ( )
Remarks
Returns TRUE if the viewport mesh is welded after tesselation; otherwise FALSE.

◆ SetViewTessWeld()

CoreExport void SetViewTessWeld ( BOOL  weld)
Remarks
Sets if the viewport mesh is welded after tesselation; otherwise FALSE.
Parameters:
BOOL weld

TRUE to weld; FALSE to not weld.

◆ GetProdTessWeld()

CoreExport BOOL GetProdTessWeld ( )
Remarks
Returns TRUE if the production renderer mesh is welded after tesselation; otherwise FALSE.

◆ SetProdTessWeld()

CoreExport void SetProdTessWeld ( BOOL  weld)
Remarks
Sets if the production renderer mesh is welded after tesselation; otherwise FALSE.
Parameters:
BOOL weld

TRUE to weld; FALSE to not weld.

◆ InvalidateMesh()

CoreExport void InvalidateMesh ( )
Remarks
Invalidates the mesh cache.

◆ InvalidateRelaxedMesh()

CoreExport void InvalidateRelaxedMesh ( )

◆ BeginEditParams()

virtual CoreExport void BeginEditParams ( IObjParam ip,
ULONG  flags,
Animatable prev 
)
virtual
Remarks
This method is called by the system when the user may edit the item's (object, modifier, controller, etc.) parameters.
Parameters
ipInterface 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.
flagsDescribe 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.

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

◆ EndEditParams()

virtual CoreExport void EndEditParams ( IObjParam ip,
ULONG  flags,
Animatable next 
)
virtual
Remarks
This method is called when the user is finished editing an objects parameters. The system passes a flag into the EndEditParams() method to indicate if the rollup page should be removed. If this flag is TRUE, the plug-in must un-register the rollup page, and delete it from the panel.
Parameters
ipAn interface pointer. The developer may use the interface pointer to call methods such as DeleteRollupPage().

flagsThe following flag may be set:

END_EDIT_REMOVEUI
If TRUE, the item's user interface should be removed.

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

◆ GetSubobjectLevel()

CoreExport int GetSubobjectLevel ( )

◆ GetSubobjectType()

CoreExport int GetSubobjectType ( )
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.

◆ SetSubobjectLevel()

CoreExport void SetSubobjectLevel ( int  level)

◆ ActivateSubobjSel()

CoreExport void ActivateSubobjSel ( int  level,
XFormModes modes 
)
virtual

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

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

Parameters
levelThe 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.
modesThe command modes to support
Sample Code:
{
switch ( level ) {
case 1: // Modifier box
break;
case 2: // Modifier Center
break;
}
}
static NUScaleModBoxCMode * nuscaleMode
Definition: patchobj.h:495
static RotateModBoxCMode * rotMode
Definition: patchobj.h:493
static SquashModBoxCMode * squashMode
Definition: patchobj.h:496
static MoveModBoxCMode * moveMode
Definition: patchobj.h:492
static UScaleModBoxCMode * uscaleMode
Definition: patchobj.h:494
virtual CoreExport RefResult NotifyDependents(const Interval &changeInt, PartID partID, RefMessage message, SClass_ID sclass=NOTIFY_ALL, BOOL propagate=TRUE, RefTargetHandle hTarg=NULL, NotifyDependentsOption notifyDependentsOption=REFNOTIFY_ALLOW_OPTIMIZATIONS)
Notify all dependent RefMakers concerned with the message.
CoreExport void ActivateSubobjSel(int level, XFormModes &modes) override
When the user changes the selection of the sub-object drop down, this method is called to notify the ...
This class contains a set of six command mode pointers that make up the XForm modes.
Definition: cmdmode.h:133
#define REFMSG_CHANGE
Sent to dependents of a ReferenceTarget that has changed in some way.
Definition: ref.h:251
const PartID PART_DISPLAY
See DISP_ATTRIB_CHANNEL.
Definition: ref.h:72
See also
Class XFormModes.

Reimplemented from BaseObject.

◆ SubObjectIndex()

CoreExport int SubObjectIndex ( HitRecord hitRec)
virtual

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

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

Reimplemented from BaseObject.

◆ GetSubObjectTMs()

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

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

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

Parameters
cbThe callback object whose methods may be called.
tThe time to enumerate the TMs.
nodeA pointer to the node.
mcA pointer to the ModContext.

Reimplemented from BaseObject.

◆ ShowEndResultChanged()

CoreExport void ShowEndResultChanged ( BOOL  showEndResult)
virtual
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.

◆ GetSubObjectCenters()

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

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

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

Parameters
cbThe callback object whose methods may be called. See Class SubObjAxisCallback.
tThe time to enumerate the centers.
nodeA pointer to the node.
mcA pointer to the ModContext.

Reimplemented from BaseObject.

◆ SelectSubComponent()

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

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

Parameters
hitRecIdentifies the component whose selected state should be set. See Class HitRecord .
selectedTRUE if the item should be selected; FALSE if the item should be de-selected.
allTRUE 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).
invertThis is set to TRUE when all is also set to TRUE and the user is holding down the Shift key while region selecting in select mode. This indicates the items hit in the region should have their selection state inverted

Reimplemented from BaseObject.

◆ ClearSelection()

CoreExport void ClearSelection ( int  selLevel)
virtual

This method is called to clear the selection for the given sub-object level.

All sub-object elements of this type should be deselected. This will be called when the user chooses Select None from the 3ds Max Edit menu.

Parameters
selLevelSpecifies the selection level to clear.

Reimplemented from BaseObject.

◆ SelectAll()

CoreExport void SelectAll ( int  selLevel)
virtual

This method is called to select every element of the given sub-object level.

This will be called when the user chooses Select All from the 3ds Max Edit menu.

Parameters
selLevelSpecifies the selection level to select.

Reimplemented from BaseObject.

◆ InvertSelection()

CoreExport void InvertSelection ( int  selLevel)
virtual

This method is called to invert the specified sub-object level.

If the element is selected it should be deselected. If it's deselected it should be selected. This will be called when the user chooses Select Invert from the 3ds Max Edit menu.

Parameters
selLevelSpecifies the selection level to invert.

Reimplemented from BaseObject.

◆ PatchSelChanged()

CoreExport void PatchSelChanged ( )

◆ InvalidateSurfaceUI()

CoreExport void InvalidateSurfaceUI ( )

◆ InvalidateOpsUI()

CoreExport void InvalidateOpsUI ( )

◆ ChangeRememberedPatch()

CoreExport void ChangeRememberedPatch ( int  type)

◆ ChangeSelPatches()

CoreExport void ChangeSelPatches ( int  type)

◆ RememberPatchThere()

CoreExport int RememberPatchThere ( HWND  hWnd,
IPoint2  m 
)

◆ SetRememberedPatchType()

CoreExport void SetRememberedPatchType ( int  type)

◆ ChangeRememberedVert()

CoreExport void ChangeRememberedVert ( int  type)

◆ ChangeSelVerts()

CoreExport void ChangeSelVerts ( int  type)

◆ RememberVertThere()

CoreExport int RememberVertThere ( HWND  hWnd,
IPoint2  m 
)

◆ SetRememberedVertType()

CoreExport void SetRememberedVertType ( int  type)

◆ XFormVerts()

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

◆ XFormHandles()

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

◆ Move()

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

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

Parameters
tThe time of the transformation.
partmThe '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.
tmAxisThe matrix that represents the axis system. This is the space in which the transformation is taking place.
valThis value is a vector with X, Y, and Z representing the movement along each axis.
localOriginWhen TRUE the transformation is occurring about the sub-object's local origin.

Reimplemented from BaseObject.

◆ Rotate()

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

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

Parameters
tThe time of the transformation.
partmThe '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.
tmAxisThe matrix that represents the axis system. This is the space in which the transformation is taking place.
valThe amount to rotate the selected components.
localOriginWhen TRUE the transformation is occurring about the sub-object's local origin. Note: This information may be passed onto a transform controller (if there is one) so they may avoid generating 0 valued position keys for rotation and scales. For example if the user is rotating an item about anything other than its local origin then it will have to translate in addition to rotating to achieve the result. If a user creates an object, turns on the animate button, and rotates the object about the world origin, and then plays back the animation, the object does not do what the was done interactively. The object ends up in the same position, but it does so by both moving and rotating. Therefore both a position and a rotation key are created. If the user performs a rotation about the local origin however there is no need to create a position key since the object didn't move (it only rotated). So a transform controller can use this information to avoid generating 0 valued position keys for rotation and scales.

Reimplemented from BaseObject.

◆ Scale()

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

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

Parameters
tThe time of the transformation.
partmThe '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.
tmAxisThe matrix that represents the axis system. This is the space in which the transformation is taking place.
valThis value is a vector with X, Y, and Z representing the scale along X, Y, and Z respectively.
localOriginWhen TRUE the transformation is occurring about the sub-object's local origin. See the note above in the Rotate method. The following methods may be used to receive notification about the starting and ending phases of transforming the item when in sub-object selection.

Reimplemented from BaseObject.

◆ TransformStart()

CoreExport void TransformStart ( TimeValue  t)
virtual

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

Parameters
tThe current time when this method is called.

Reimplemented from BaseObject.

◆ TransformFinish()

CoreExport void TransformFinish ( TimeValue  t)
virtual

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

Parameters
tThe current time when this method is called.

Reimplemented from BaseObject.

◆ TransformCancel()

CoreExport void TransformCancel ( TimeValue  t)
virtual

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

Parameters
tThe current time when this method is called.

Reimplemented from BaseObject.

◆ Eval()

CoreExport ObjectState Eval ( TimeValue  t)
virtual

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

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

Parameters
tSpecifies 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); }
The ObjectState is the structure that flows up the geometry pipeline.
Definition: object.h:284

Implements Object.

◆ SupportsNamedSubSels()

BOOL SupportsNamedSubSels ( )
inlinevirtual

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

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

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

Reimplemented from BaseObject.

1032 {return TRUE;}

◆ ActivateSubSelSet()

CoreExport void ActivateSubSelSet ( MSTR setName)
virtual

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

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

Parameters
setNameThe name of the set to select.

Reimplemented from BaseObject.

◆ NewSetFromCurSel()

CoreExport void NewSetFromCurSel ( MSTR setName)
virtual

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

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

Parameters
setNameThe name for the selection set.

Reimplemented from BaseObject.

◆ RemoveSubSelSet()

CoreExport void RemoveSubSelSet ( MSTR setName)
virtual

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

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

Parameters
setNameThe selection set to remove.

Reimplemented from BaseObject.

◆ SetupNamedSelDropDown()

CoreExport void SetupNamedSelDropDown ( )
virtual

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

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

Reimplemented from BaseObject.

◆ NumNamedSelSets()

CoreExport int NumNamedSelSets ( )
virtual

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

Returns
the number of named selection sets.

Reimplemented from BaseObject.

◆ GetNamedSelSetName()

CoreExport MSTR GetNamedSelSetName ( int  i)
virtual

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

Parameters
iThe index of the selection set whose name is returned.
Returns
the name of the 'i-th' named selection set.

Reimplemented from BaseObject.

◆ SetNamedSelSetName()

CoreExport void SetNamedSelSetName ( int  i,
MSTR newName 
)
virtual

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

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

Parameters
iThe index of the selection set whose name is to be set.
newNameThe new name for the selection set the plug-in should store.

Reimplemented from BaseObject.

◆ NewSetByOperator()

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

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

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

Parameters
newNameThe new name for the selection set is passed here.
setsA table of the selection sets to operate on. There are sets.Count() sets in the table.
opOne of the following values defined in Arguments for BaseObject::NewSetByOperator()

Reimplemented from BaseObject.

◆ GetUniqueSetName()

CoreExport BOOL GetUniqueSetName ( MSTR name)

◆ SelectNamedSet()

CoreExport int SelectNamedSet ( )

◆ NSCopy()

CoreExport void NSCopy ( )

◆ NSPaste()

CoreExport void NSPaste ( )

◆ GetSelSet()

◆ RefreshSelType()

CoreExport void RefreshSelType ( )

◆ SetNumSelLabel()

CoreExport void SetNumSelLabel ( )

◆ SetSelDlgEnables()

CoreExport void SetSelDlgEnables ( )

◆ SetOpsDlgEnables()

CoreExport void SetOpsDlgEnables ( )

◆ SetSurfDlgEnables()

CoreExport void SetSurfDlgEnables ( )

◆ SetSoftSelDlgEnables()

CoreExport void SetSoftSelDlgEnables ( HWND  hSoftSel = NULL)

◆ GetAttachMat()

CoreExport int GetAttachMat ( )
virtual
Remarks
Returns the attach material setting. One of the following values:

ATTACHMAT_IDTOMAT

Match material IDs to material.

ATTACHMAT_MATTOID

Match Material to Material IDs.

ATTACHMAT_NEITHER

Do not modify Material IDs or Material.

Implements AttachMatDlgUser.

◆ SetAttachMat()

CoreExport void SetAttachMat ( int  value)
virtual
Remarks
Sets the attach material value.
Parameters:
int value

One of the following values:

ATTACHMAT_IDTOMAT

Match material IDs to material.

ATTACHMAT_MATTOID

Match Material to Material IDs.

ATTACHMAT_NEITHER

Do not modify Material IDs or Material.

Implements AttachMatDlgUser.

◆ GetCondenseMat()

CoreExport BOOL GetCondenseMat ( )
virtual
Remarks
Returns the condense material and IDs settings.

Implements AttachMatDlgUser.

◆ SetCondenseMat()

CoreExport void SetCondenseMat ( BOOL  sw)
virtual
Remarks
Sets the condense material and IDs setting.
Parameters:
BOOL sw

TRUE for on; FALSE for off.

Implements AttachMatDlgUser.

◆ DoAttach()

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

◆ SetTessUI()

CoreExport void SetTessUI ( HWND  hDlg,
TessApprox tess 
)

◆ DoDeleteSelected()

CoreExport void DoDeleteSelected ( BOOL  interactive = TRUE)
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.

◆ DoBreak()

CoreExport void DoBreak ( BOOL  interactive = TRUE)
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.

◆ ResolveTopoChanges()

CoreExport void ResolveTopoChanges ( )

◆ DeletePatchParts()

CoreExport void DeletePatchParts ( BitArray delVerts,
BitArray delPatches 
)

◆ CreateContArrays()

CoreExport void CreateContArrays ( )

◆ SynchContArrays()

CoreExport void SynchContArrays ( )

◆ GetSelMatIndex()

CoreExport int GetSelMatIndex ( )

◆ SetSelMatIndex()

CoreExport void SetSelMatIndex ( int  index)

◆ SelectByMat()

CoreExport void SelectByMat ( int  index,
BOOL  clear 
)

◆ GetSelSmoothBits()

CoreExport DWORD GetSelSmoothBits ( DWORD &  invalid)

◆ GetUsedSmoothBits()

CoreExport DWORD GetUsedSmoothBits ( )

◆ SelectBySmoothGroup()

CoreExport void SelectBySmoothGroup ( DWORD  bits,
BOOL  clear 
)

◆ SetSelSmoothBits()

CoreExport void SetSelSmoothBits ( DWORD  bits,
DWORD  which 
)

◆ SetPropagate()

CoreExport void SetPropagate ( BOOL  sw)

◆ GetPropagate()

CoreExport BOOL GetPropagate ( )

◆ DoPatchAdd()

CoreExport void DoPatchAdd ( int  type)

◆ DoSubdivide()

CoreExport void DoSubdivide ( int  level)

◆ DoPatchDetach()

CoreExport void DoPatchDetach ( int  copy,
int  reorient 
)

◆ DoVertWeld() [1/2]

CoreExport void DoVertWeld ( )

◆ DoVertWeld() [2/2]

CoreExport void DoVertWeld ( int  fromVert,
int  toVert 
)

◆ DoEdgeWeld()

CoreExport void DoEdgeWeld ( )
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.

◆ StartCopyTangentMode()

CoreExport void StartCopyTangentMode ( )

◆ StartPasteTangentMode()

CoreExport void StartPasteTangentMode ( )

◆ StartPasteTangent()

CoreExport void StartPasteTangent ( )

◆ EndPasteTangent()

CoreExport void EndPasteTangent ( )

◆ CopyTangent()

CoreExport BOOL CopyTangent ( int  vec)

◆ PasteTangent()

CoreExport BOOL PasteTangent ( int  vec)

◆ DoHide()

CoreExport void DoHide ( int  type)

◆ DoUnHide()

CoreExport void DoUnHide ( )

◆ DoPatchHide()

CoreExport void DoPatchHide ( )

◆ DoVertHide()

CoreExport void DoVertHide ( )

◆ DoEdgeHide()

CoreExport void DoEdgeHide ( )

◆ DoAddHook()

CoreExport void DoAddHook ( int  vert1,
int  seg1 
)

◆ DoRemoveHook()

CoreExport void DoRemoveHook ( )

◆ DoExtrude()

CoreExport void DoExtrude ( TimeValue  t)
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.

◆ BeginExtrude()

CoreExport void BeginExtrude ( TimeValue  t)

◆ EndExtrude()

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

◆ Extrude()

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

◆ DoFlipNormals()

CoreExport void DoFlipNormals ( int  patchIndex = -1)
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.

◆ DoUnifyNormals()

CoreExport void DoUnifyNormals ( )
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.

◆ DoBevel()

CoreExport void DoBevel ( TimeValue  t)
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.

◆ BeginBevel()

CoreExport void BeginBevel ( TimeValue  t)

◆ EndBevel()

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

◆ Bevel()

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

◆ DoPatchSmooth()

CoreExport void DoPatchSmooth ( int  type)

◆ CreateVertex()

CoreExport void CreateVertex ( Point3  pt,
int newIndex 
)

◆ CreatePatch() [1/2]

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

◆ CreatePatch() [2/2]

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

◆ StartCommandMode()

CoreExport void StartCommandMode ( patchCommandMode  mode)
virtual
Remarks
Begins the specified interactive command mode.
Parameters:
patchCommandMode mode

PcmAttach

PcmExtrude

PcmBevel

PcmCreate

PcmWeldTarget

PcmFlipNormal

PcmBind

Implements IPatchOps.

◆ ButtonOp()

CoreExport void ButtonOp ( patchButtonOp  opcode)
virtual
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.

◆ GetUIParam() [1/2]

CoreExport void GetUIParam ( patchUIParam  uiCode,
int ret 
)
virtual
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.

◆ SetUIParam() [1/2]

CoreExport void SetUIParam ( patchUIParam  uiCode,
int  val 
)
virtual
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.

◆ GetUIParam() [2/2]

CoreExport void GetUIParam ( patchUIParam  uiCode,
float &  ret 
)
virtual
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.

◆ SetUIParam() [2/2]

CoreExport void SetUIParam ( patchUIParam  uiCode,
float  val 
)
virtual
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.

◆ Editing()

bool Editing ( )
inline
Remarks
This method is available in release 4.0 and later only.

This method will return TRUE if the SplineShape object or Edit Spline modifier is active in the command panel.
Default Implementation:
{ return (ip && (editObj==this)) ? TRUE : FALSE; }
1269 { return (ip && (editObj==this)) ? TRUE : FALSE; }
static PatchObject * editObj
Definition: patchobj.h:556

◆ GetSelLevel()

CoreExport DWORD GetSelLevel ( )
virtual
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.

◆ SetSelLevel()

CoreExport void SetSelLevel ( DWORD  level)
virtual
Remarks
Sets the current level of selection of the modifier.
Parameters:
DWORD level

The level to set. One of the following values:

PO_VERTEX

PO_EDGE

PO_PATCH

PO_OBJECT

Implements IPatchSelect.

◆ LocalDataChanged()

CoreExport void LocalDataChanged ( )
virtual
Remarks
This method must be called when the selection level of the modifier is changed. Developers can use the methods of 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.

◆ GetVecSel()

CoreExport BitArray GetVecSel ( )
virtual

Implements IPatchSelectData.

◆ GetVertSel()

CoreExport BitArray GetVertSel ( )
virtual
Remarks
Returns a BitArray that reflects the current vertex selection. There is one bit for each vertex. Bits that are 1 indicate the vertex is selected.

Implements IPatchSelectData.

◆ GetEdgeSel()

CoreExport BitArray GetEdgeSel ( )
virtual
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.

◆ GetPatchSel()

CoreExport BitArray GetPatchSel ( )
virtual
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.

◆ SetVecSel()

CoreExport void SetVecSel ( BitArray set,
IPatchSelect imod,
TimeValue  t 
)
virtual

Implements IPatchSelectData.

◆ SetVertSel()

CoreExport void SetVertSel ( BitArray set,
IPatchSelect imod,
TimeValue  t 
)
virtual
Remarks
Sets the vertex selection of the modifier.
Parameters:
BitArray &set

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

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.

◆ SetEdgeSel()

CoreExport void SetEdgeSel ( BitArray set,
IPatchSelect imod,
TimeValue  t 
)
virtual
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.

◆ SetPatchSel()

CoreExport void SetPatchSel ( BitArray set,
IPatchSelect imod,
TimeValue  t 
)
virtual
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.

◆ GetNamedVecSelList()

CoreExport GenericNamedSelSetList& GetNamedVecSelList ( )
virtual

Implements IPatchSelectData.

◆ GetNamedVertSelList()

CoreExport GenericNamedSelSetList& GetNamedVertSelList ( )
virtual
Remarks
Returns a reference to a class used for manipulating the lists of vertex level named selection sets associated with this modifier.

Implements IPatchSelectData.

◆ GetNamedEdgeSelList()

CoreExport GenericNamedSelSetList& GetNamedEdgeSelList ( )
virtual
Remarks
Returns a reference to a class used for manipulating the lists of edge level named selection sets associated with this modifier.

Implements IPatchSelectData.

◆ GetNamedPatchSelList()

CoreExport GenericNamedSelSetList& GetNamedPatchSelList ( )
virtual
Remarks
Returns a reference to a class used for manipulating the lists of patch level named selection sets associated with this modifier.

Implements IPatchSelectData.

◆ GetVertColor()

CoreExport Color GetVertColor ( int  mp = 0,
bool *  differs = NULL 
)
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.

◆ SetVertColor()

CoreExport void SetVertColor ( Color  clr,
int  mp = 0 
)
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.

◆ SelectVertByColor()

CoreExport void SelectVertByColor ( VertColor  clr,
int  deltaR,
int  deltaG,
int  deltaB,
BOOL  add,
BOOL  sub,
int  mp = 0 
)
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.

◆ GetPatchColor()

CoreExport Color GetPatchColor ( int  mp = 0,
bool *  differs = NULL 
)
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.

◆ SetPatchColor()

CoreExport void SetPatchColor ( Color  clr,
int  mp = 0 
)
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.

◆ GetNextAvailMtlID()

CoreExport MtlID GetNextAvailMtlID ( ModContext mc)
virtual
Remarks
This method returns a material ID that is currently not used by the object. If the current face selection share one single MtlDI that is not used by any other faces, you should use it.

Implements ISubMtlAPI.

◆ HasFaceSelection()

CoreExport BOOL HasFaceSelection ( ModContext mc)
virtual
Remarks
This method indicates if you are active in the modifier panel and have an active face selection. Return TRUE if so, otherwise FALSE.

Implements ISubMtlAPI.

◆ SetSelFaceMtlID()

CoreExport void SetSelFaceMtlID ( ModContext mc,
MtlID  id,
BOOL  bResetUnsel = FALSE 
)
virtual
Remarks
This method sets the selected faces to the specified material ID..
Parameters:
MtlID id

The material id to set for the selected faces.

BOOL bResetUnsel = FALSE

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

Implements ISubMtlAPI.

◆ GetSelFaceUniqueMtlID()

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

Implements ISubMtlAPI.

◆ GetSelFaceAnyMtlID()

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

Implements ISubMtlAPI.

◆ GetMaxMtlID()

CoreExport int GetMaxMtlID ( ModContext mc)
virtual
Remarks
This method returns the highest MtlID on the object.

Implements ISubMtlAPI.

◆ ChangeMappingTypeLinear()

CoreExport void ChangeMappingTypeLinear ( BOOL  linear)
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.

◆ ShrinkSelection()

CoreExport void ShrinkSelection ( int  type)

◆ GrowSelection()

CoreExport void GrowSelection ( int  type)

◆ SelectEdgeRing()

CoreExport void SelectEdgeRing ( )

◆ SelectEdgeLoop()

CoreExport void SelectEdgeLoop ( )

◆ SelectOpenEdges()

CoreExport void SelectOpenEdges ( )
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.

◆ DoCreateShape()

CoreExport void DoCreateShape ( )
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.

◆ UseEdgeDists()

CoreExport int UseEdgeDists ( )

◆ SetUseEdgeDists()

CoreExport void SetUseEdgeDists ( int  useSoftSelections)

◆ UseSoftSelections()

CoreExport int UseSoftSelections ( )

◆ SetUseSoftSelections()

CoreExport void SetUseSoftSelections ( int  useSoftSelections)

◆ InvalidateVertexWeights()

CoreExport void InvalidateVertexWeights ( )

◆ ToggleShadedFaces()

CoreExport void ToggleShadedFaces ( )

◆ UpdateVertexDists()

CoreExport void UpdateVertexDists ( )

◆ UpdateEdgeDists()

CoreExport void UpdateEdgeDists ( )

◆ UpdateVertexWeights()

CoreExport void UpdateVertexWeights ( )

◆ VertexNormal()

CoreExport Point3 VertexNormal ( int  vIndex)

Friends And Related Function Documentation

◆ PatchObjectRestore

friend class PatchObjectRestore
friend

◆ POXFormProc

friend class POXFormProc
friend

◆ POPickPatchAttach

friend class POPickPatchAttach
friend

Member Data Documentation

◆ hSelectPanel

HWND hSelectPanel
static

◆ hOpsPanel

HWND hOpsPanel
static

◆ hSurfPanel

HWND hSurfPanel
static

◆ hSoftSelPanel

HWND hSoftSelPanel
static

◆ rsSel

BOOL rsSel
static

◆ rsOps

BOOL rsOps
static

◆ rsSurf

BOOL rsSurf
static

◆ moveMode

MoveModBoxCMode* moveMode
static

◆ rotMode

RotateModBoxCMode* rotMode
static

◆ uscaleMode

UScaleModBoxCMode* uscaleMode
static

◆ nuscaleMode

NUScaleModBoxCMode* nuscaleMode
static

◆ squashMode

SquashModBoxCMode* squashMode
static

◆ selectMode

SelectModBoxCMode* selectMode
static

◆ bindMode

EP_BindCMode* bindMode
static

◆ extrudeMode

EP_ExtrudeCMode* extrudeMode
static

◆ normalFlipMode

EP_NormalFlipCMode* normalFlipMode
static

◆ bevelMode

EP_BevelCMode* bevelMode
static

◆ createVertMode

EP_CreateVertCMode* createVertMode
static

◆ createPatchMode

EP_CreatePatchCMode* createPatchMode
static

◆ vertWeldMode

EP_VertWeldCMode* vertWeldMode
static

◆ copyTangentMode

EP_CopyTangentCMode* copyTangentMode
static

◆ pasteTangentMode

EP_PasteTangentCMode* pasteTangentMode
static

◆ settingViewportTess

BOOL settingViewportTess
static

◆ settingDisp

BOOL settingDisp
static

◆ uSpin

ISpinnerControl* uSpin
static

◆ vSpin

ISpinnerControl* vSpin
static

◆ edgeSpin

ISpinnerControl* edgeSpin
static

◆ angSpin

ISpinnerControl* angSpin
static

◆ distSpin

ISpinnerControl* distSpin
static

◆ mergeSpin

ISpinnerControl* mergeSpin
static

◆ matSpin

ISpinnerControl* matSpin
static

◆ matSpinSel

ISpinnerControl* matSpinSel
static

◆ weldSpin

ISpinnerControl* weldSpin
static

◆ targetWeldSpin

ISpinnerControl* targetWeldSpin
static

◆ stepsSpin

ISpinnerControl* stepsSpin
static

◆ stepsRenderSpin

ISpinnerControl* stepsRenderSpin
static

◆ relaxSpin

ISpinnerControl* relaxSpin
static

◆ relaxIterSpin

ISpinnerControl* relaxIterSpin
static

◆ pickCB

POPickPatchAttach pickCB
static

◆ patchUIValid

BOOL patchUIValid
static

◆ opsUIValid

BOOL opsUIValid
static

◆ attachMat

int attachMat
static

◆ condenseMat

BOOL condenseMat
static

◆ pickBoxSize

int pickBoxSize
static

◆ weldBoxSize

int weldBoxSize
static

◆ loadRefVersion

int loadRefVersion

◆ geomValid

Interval geomValid

◆ topoValid

Interval topoValid

◆ texmapValid

Interval texmapValid

◆ selectValid

Interval selectValid

◆ validBits

ChannelMask validBits

◆ ip

IObjParam* ip
static

◆ editObj

PatchObject* editObj
static

◆ patch

PatchMesh patch

◆ patchSelSubType

int patchSelSubType

◆ masterCont

MAX_DEPRECATED PointControllerContainer* masterCont
static
Deprecated:
This has been deprecated as of 3ds Max 2022, please use pointCtrlContainer instead [insensitive language]

◆ pointCtrlContainer

PointControllerContainer* pointCtrlContainer

◆ vertCont

Tab<Control*> vertCont

◆ vecCont

Tab<Control*> vecCont

◆ rememberedPatch

PatchMesh* rememberedPatch

◆ rememberedIndex

int rememberedIndex

◆ rememberedData

int rememberedData

◆ doingHandles

BOOL doingHandles

◆ showMesh

BOOL showMesh

◆ propagate

BOOL propagate

◆ inExtrude

BOOL inExtrude

◆ inBevel

BOOL inBevel

◆ inPatchCreate

BOOL inPatchCreate

◆ epFlags

DWORD epFlags

◆ copyTanLength

BOOL copyTanLength

◆ tangentCopied

BOOL tangentCopied

◆ copiedTangent

Point3 copiedTangent

◆ hselSet

◆ vselSet

◆ eselSet

◆ pselSet

◆ noderef

◆ mtlref