3ds Max C++ API Reference
SimpleShape Class Referenceabstract

#include <simpshp.h>

+ Inheritance diagram for SimpleShape:

Public Member Functions

CoreExport void UpdateShape (TimeValue t)
 
CoreExport SimpleShape ()
 
CoreExport ~SimpleShape ()
 
void ShapeInvalid ()
 
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 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 int Display (TimeValue t, INode *inode, ViewExp *vpt, int flags)
 This method displays the shape's generated mesh if necessary. More...
 
virtual CoreExport void BeginEditParams (IObjParam *ip, ULONG flags, Animatable *prev)
 This method allows the ShapeObject to create its new "Rendering" rollup. More...
 
virtual CoreExport void EndEditParams (IObjParam *ip, ULONG flags, Animatable *next)
 Similarly to BeginEditParams, this method allows the ShapeObject to remove its "Rendering" rollup. More...
 
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...
 
CoreExport 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...
 
CoreExport ObjectState Eval (TimeValue time)
 This method is called to evaluate the object and return the result as an ObjectState. More...
 
CoreExport Interval ObjectValidity (TimeValue t)
 This method returns the validity interval of the object as a whole at the specified time. 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 BuildMesh (TimeValue t, Mesh &mesh)
 
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 *vxt, Box3 &box)
 This is the object space bounding box, the box in the object's local coordinates. More...
 
CoreExport void GetDeformBBox (TimeValue t, Box3 &box, Matrix3 *tm, BOOL useSel)
 This method computes the bounding box in the objects local coordinates or the optional space defined by tm. More...
 
CoreExport int NumberOfVertices (TimeValue t, int curve)
 This method is used by the Summary Info and Object Properties dialogs to inform the user how many vertices or CVs are in the object. More...
 
CoreExport int NumberOfCurves (TimeValue t) override
 Returns the number of polygons in the shape at the given time. More...
 
CoreExport BOOL CurveClosed (TimeValue t, int curve)
 This method is called to determine if the specified curve of the shape is closed at the time passed. More...
 
CoreExport ShapeHierarchyOrganizeCurves (TimeValue t, ShapeHierarchy *hier=NULL)
 This method is called to prepare the shape for lofting, extrusion, etc. More...
 
CoreExport void MakePolyShape (TimeValue t, PolyShape &shape, int steps=PSHAPE_BUILTIN_STEPS, BOOL optimize=FALSE)
 Create a PolyShape representation with optional fixed steps. More...
 
CoreExport int MakeCap (TimeValue t, MeshCapInfo &capInfo, int capType)
 This method generates a mesh capping info for the shape. More...
 
CoreExport int MakeCap (TimeValue t, PatchCapInfo &capInfo)
 This method creates a patch cap info out of the shape. More...
 
int NumRefs ()
 The ShapeObject makes 1 reference; this is where it tells the system. More...
 
CoreExport RefTargetHandle GetReference (int i)
 This method allows the ShapeObject to return a pointer to its parameter block. More...
 
CoreExport RefResult NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate)
 This method will notify the Shape Object of changes in values in its parameter block. More...
 
CoreExport void ReadyGeneralParameters ()
 
CoreExport void SimpleShapeClone (SimpleShape *sshpSource)
 
int NumSubs ()
 
CoreExport AnimatableSubAnim (int i)
 This method returns the ShapeObject's animatable pointer. More...
 
CoreExport MSTR SubAnimName (int i, bool localized=true) override
 This method returns the name of the animatable's name. More...
 
CoreExport void DeleteThis ()
 Deletes an instance of this class. More...
 
CoreExport void FreeCaches ()
 
CoreExport IOResult Save (ISave *isave)
 Implemented by the System. More...
 
CoreExport IOResult Load (ILoad *iload)
 Implemented by the System. More...
 
CoreExport void SetGenUVs (BOOL sw)
 
CoreExport void SetRenderable (BOOL sw)
 
LRESULT CALLBACK TrackViewWinProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
 This function is obsolete. More...
 
void GetClassName (MSTR &s, bool localized=true) const override
 Retrieves the name of the plugin class. More...
 
void InitNodeName (MSTR &s)
 This is the default name of the node when it is created. More...
 
virtual Class_ID ClassID ()=0
 Retrieves a constant that uniquely identifies the plugin class. More...
 
virtual void BuildShape (TimeValue t, PolyShape &ashape)=0
 
virtual RefTargetHandle Clone (RemapDir &remap)=0
 This method is used by 3ds Max to clone an object. More...
 
virtual CreateMouseCallBackGetCreateMouseCallBack ()=0
 This method allows the system to retrieve a callback object used in creating an object in the 3D viewports. More...
 
virtual BOOL ValidForDisplay (TimeValue t)=0
 
virtual void InvalidateUI ()
 
virtual ParamDimensionGetParameterDim (int pbIndex)
 
virtual MSTR GetParameterName (int pbIndex) MAX_SEALED
 
virtual MSTR GetParameterName (int pbIndex, bool localized)
 
virtual Point3 InterpCurve3D (TimeValue t, int curve, float param, int ptype=PARAM_SIMPLE)=0
 
virtual Point3 TangentCurve3D (TimeValue t, int curve, float param, int ptype=PARAM_SIMPLE)=0
 
virtual float LengthOfCurve (TimeValue t, int curve)=0
 
virtual int NumberOfPieces (TimeValue t, int curve)
 
virtual Point3 InterpPiece3D (TimeValue t, int curve, int piece, float param, int ptype=PARAM_SIMPLE)
 
virtual Point3 TangentPiece3D (TimeValue t, int curve, int piece, float param, int ptype=PARAM_SIMPLE)
 
virtual CoreExport MtlID GetMatID (TimeValue t, int curve, int piece)
 
- Public Member Functions inherited from ShapeObject
CoreExport ShapeObject ()
 
CoreExport ~ShapeObject ()
 
virtual CoreExport BaseInterfaceGetInterface (Interface_ID iid)
 Inherited from Animatable. More...
 
virtual CoreExport voidGetInterface (ULONG id)
 Inherited from Animatable. More...
 
virtual CoreExport unsigned long GetObjectDisplayRequirement () const
 
virtual CoreExport bool PrepareDisplay (const MaxSDK::Graphics::UpdateDisplayContext &prepareDisplayContext)
 
virtual BOOL IsShapeObject ()
 Returns the number of shapes contained inside this object. More...
 
virtual int IntersectRay (TimeValue t, Ray &ray, float &at, Point3 &norm)
 Computes the intersection point of the ray passed and the shape. More...
 
SClass_ID SuperClassID ()
 Retrieves a constant representing the type of the plugin. More...
 
virtual CoreExport int IsRenderable ()
 Indicates whether the object may be rendered. More...
 
virtual CoreExport void CopyBaseData (ShapeObject &from)
 In order to simplify things for subclasses of ShapeObject, this method is now available. More...
 
CoreExport float GetThickness (TimeValue t, Interval &ivalid)
 Implemented by the System. More...
 
CoreExport int GetSides (TimeValue t, Interval &ivalid)
 This method returns the number of sides for the cross-section of the rendering mesh version of the shape for the specified time. More...
 
CoreExport float GetAngle (TimeValue t, Interval &ivalid)
 This method returns the angle that the cross-section of the rendering mesh will be rotated to, for the specified time. More...
 
CoreExport float GetViewportThickness ()
 This method returns the thickness of the viewport version of the rendering mesh. More...
 
CoreExport int GetViewportSides ()
 This method returns the number of sides for the cross-section for the viewport version of the rendering mesh. More...
 
CoreExport float GetViewportAngle ()
 This method returns the angle that the cross-section of the viewport version of the rendering mesh will be rotated to. More...
 
CoreExport BOOL GetRenderable ()
 Implemented by the System. More...
 
CoreExport BOOL GetGenUVs ()
 Implemented by the System. More...
 
CoreExport BOOL GetDispRenderMesh ()
 This method returns TRUE if the "Display Render Mesh" switch is on. More...
 
CoreExport BOOL GetUseViewport ()
 This method returns TRUE if the "Use Viewport Settings" switch is on. More...
 
CoreExport BOOL GetViewportOrRenderer ()
 This method returns the value of the Viewport/Render switch and either returns GENMESH_VIEWPORT or GENMESH_RENDER. More...
 
CoreExport void SetThickness (TimeValue t, float thick)
 Implemented by the System. More...
 
CoreExport void SetSides (TimeValue t, int s)
 This method allows you to set the number of sides for the rendering mesh version of the shape for the specified time. More...
 
CoreExport void SetAngle (TimeValue t, float a)
 This method allows you to set the cross-section rotation angle for the rendering mesh version of the shape, in degrees, for the specified time. More...
 
CoreExport void SetViewportThickness (float thick)
 
CoreExport void SetViewportSides (int s)
 This method allows you to set the number of sides for the viewport version of the rendering mesh. More...
 
CoreExport void SetViewportAngle (float a)
 This method allows you to set the angle that the cross-section of the viewport version of the rendering mesh will be rotated to, in degrees. More...
 
CoreExport void SetRenderable (BOOL sw)
 Implemented by the System. More...
 
CoreExport void SetGenUVs (BOOL sw)
 Implemented by the System. More...
 
CoreExport void SetDispRenderMesh (BOOL sw)
 This method allows you to turn the "Display Render Mesh" switch on or off. More...
 
CoreExport void SetUseViewport (BOOL sw)
 This method allows you to turn the "Use Viewport Settings" switch on or off. More...
 
CoreExport void SetViewportOrRenderer (BOOL sw)
 This method allows you to set the value of the Viewport/Render switch. More...
 
virtual CoreExport MeshGetRenderMesh (TimeValue t, INode *inode, View &view, BOOL &needDelete)
 This method should be implemented by all renderable GeomObjects. More...
 
virtual CoreExport void GetRenderMeshInfo (TimeValue t, INode *inode, View &view, int &nverts, int &nfaces)
 Returns information on the rendering mesh. More...
 
virtual CoreExport void GenerateMesh (TimeValue t, int option, Mesh *mesh)
 This method will generate a mesh based on either the viewport or rendering parameters for the specified time. More...
 
virtual BOOL CanMakeBezier ()
 This method is called to determine if the shape can be converted to a bezier representation. More...
 
virtual void MakeBezier (TimeValue t, BezierShape &shape)
 Creates the bezier representation of the shape. More...
 
virtual BOOL AttachShape (TimeValue t, INode *thisNode, INode *attachNode, BOOL weldEnds=FALSE, float weldThreshold=0.0f)
 This method is called to attach the shape of attachNode to thisNode at the specified time. 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 void SetGenUVW (BOOL sw)
 This method is called to change the state of its Generate UVW boolean. More...
 
virtual void SetGenUVW (int mapChannel, BOOL sw)
 This method is called to change the state of its Generate UVW boolean for the specified mapping channel. More...
 
virtual CoreExport bool SpecifySaveReferences (ReferenceSaveManager &referenceSaveManager)
 Implemented by the System. More...
 
virtual CoreExport Class_ID PreferredCollapseType ()
 Implemented by the System. More...
 
virtual CoreExport BOOL GetExtendedProperties (TimeValue t, MSTR &prop1Label, MSTR &prop1Data, MSTR &prop2Label, MSTR &prop2Data)
 Implemented by the System. More...
 
virtual CoreExport void RescaleWorldUnits (float f)
 Implemented by the System. More...
 
CoreExport ParamDimensionGetParameterDim (int pbIndex)
 This method returns the parameter dimension of the parameter whose index is passed. More...
 
CoreExport MSTR GetParameterName (int pbIndex, bool localized=true)
 This method returns the name of the parameter whose index is passed. More...
 
virtual CoreExport int RemapRefOnLoad (int iref)
 This method remaps references at load time so that files saved from previous versions of 3ds Max get their references adjusted properly to allow for the new ShapeObject reference. More...
 
CoreExport Interval GetShapeObjValidity (TimeValue t)
 This method gets the validity interval for the ShapeObject's internal parameters only. More...
 
virtual CoreExport int HitTest (TimeValue t, INode *inode, int type, int crossing, int flags, IPoint2 *p, ViewExp *vpt, ModContext *mc)
 This method is used in modifier gizmo hit testing. More...
 
virtual CoreExport Box3 GetBoundingBox (TimeValue t, Matrix3 *tm=NULL)
 This method returns a bounding box for the shape, if it's active, if the "Display Render Mesh" switch is on. More...
 
virtual CoreExport void InvalidateGeomCache ()
 This method is very important - It causes the ShapeObject to flush its cached rendering mesh. More...
 
int SetProperty (ULONG id, void *data)
 Associates data passed in to given id. More...
 
voidGetProperty (ULONG id)
 Retrieves data associated with id. More...
 
CoreExport BOOL GetUsePhysicalScaleUVs ()
 Queries whether if real world texture size is used or not. More...
 
CoreExport void SetUsePhysicalScaleUVs (BOOL flag)
 Sets whether real world texture size is used or not. More...
 
CoreExport BOOL GetTwistCorrect ()
 Queries the twist correction switch. More...
 
CoreExport void SetTwistCorrect (BOOL flag)
 Sets the twist correction switch. More...
 
CoreExport BOOL GetCap ()
 Queries the main capping switch. More...
 
CoreExport void SetCap (BOOL flag)
 Sets the main capping switch. More...
 
CoreExport BOOL GetQuadCap ()
 Queries the quad capping switch. More...
 
CoreExport void SetQuadCap (BOOL flag)
 Sets the quad capping switch. More...
 
CoreExport int GetCapSegments (TimeValue t, Interval &ivalid)
 Get/Set the cap segments count. More...
 
CoreExport void SetCapSegments (TimeValue t, int count)
 Sets the cap segments value for the specified time. More...
 
CoreExport float GetSphereCap (TimeValue t, Interval &ivalid)
 Get/Set the sphere capping value used in quad capping. More...
 
CoreExport void SetSphereCap (TimeValue t, float value)
 Sets the sphere capping value (0-1). More...
 
- Public Member Functions inherited from GeomObject
virtual int IsInstanceDependent ()
 If an object creates different meshes depending on the particular instance (view-dependent) it should return nonzero; otherwise 0. 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...
 
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 ObjectFindBaseObject ()
 It is called to return a pointer to the base object (an object that is not a derived object). More...
 
virtual BOOL IsParamSurface ()
 There are several methods used to access a parametric position on the surface of the object. More...
 
virtual int NumSurfaces (TimeValue t)
 Returns the number of parametric surfaces within the object. More...
 
virtual Point3 GetSurfacePoint (TimeValue t, float u, float v, Interval &iv)
 This method needs to be implemented if Object::IsParamSurface() returns TRUE. More...
 
virtual Point3 GetSurfacePoint (TimeValue t, int surface, float u, float v, Interval &iv)
 This method is used to retrieve a point on the specified surface of the object based on two parameters of the surface, u and v. More...
 
virtual void SurfaceClosed (TimeValue t, int surface, BOOL &uClosed, BOOL &vClosed)
 This method allows the object to return flags that indicate whether the parametric surface is closed in the U and V dimensions. More...
 
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 ()
 
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 void TopologyChanged ()
 Implemented by the System. More...
 
virtual int IsDeformable ()
 Indicates whether this object is deformable. More...
 
virtual int NumPoints ()
 The points of a deformable object are accessed through a virtual array interface. More...
 
virtual Point3 GetPoint (int i)
 The points of a deformable object are accessed through a virtual array interface. More...
 
virtual void SetPoint (int i, const Point3 &p)
 The points of a deformable object are accessed through a virtual array interface. More...
 
virtual BOOL IsPointSelected (int i)
 Returns TRUE if the 'i-th' point is selected; otherwise FALSE. More...
 
virtual float PointSelection (int i)
 Returns a floating point weighted point selection if the object supports it. More...
 
virtual BOOL HasWeights ()
 Returns TRUE if the object has weights for its points that can be set; otherwise FALSE. More...
 
virtual double GetWeight (int i)
 Returns the weight of the specified point of the object. More...
 
virtual void SetWeight (int i, const double w)
 Sets the weight of the specified point. More...
 
virtual BOOL PolygonCount (TimeValue t, int &numFaces, int &numVerts)
 Retreives the number of faces and vertices of the polyginal mesh representation of this object. More...
 
virtual void PointsWereChanged ()
 Informs the object that its points have been deformed, so it can invalidate its cache. More...
 
virtual CoreExport void Deform (Deformer *defProc, int useSel=0)
 This is the method used to deform the object with a deformer. More...
 
virtual int IsMappable ()
 This method lets you know if the ApplyUVWMap() method is available for this object. More...
 
virtual int NumMapChannels ()
 Returns the maximum number of channels supported by this type of object. More...
 
virtual int NumMapsUsed ()
 Returns the number of maps currently used by this object. More...
 
virtual void ApplyUVWMap (int type, float utile, float vtile, float wtile, int uflip, int vflip, int wflip, int cap, const Matrix3 &tm, int channel=1)
 This method may be called to map the object with UVW mapping coordinates. More...
 
virtual CoreExport void GetCollapseTypes (Tab< Class_ID > &clist, Tab< MSTR * > &nlist)
 When the user clicks on the Edit Stack button in the modify branch a list of 'Convert To:' types is presented. More...
 
virtual 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 DWORD GetSubselState ()
 For objects that have sub selection levels, this method returns the current selection level of the object. More...
 
virtual void SetSubSelState (DWORD s)
 Implemented by the System. More...
 
CoreExport void ReadyChannelsForMod (ChannelMask channels)
 Implemented by the System. More...
 
virtual CoreExport Interval ChannelValidity (TimeValue t, int nchan)
 Retrieve the current validity interval for the nchan channel of the object. More...
 
virtual CoreExport void SetChannelValidity (int nchan, Interval v)
 Sets the validity interval of the specified channel. More...
 
virtual CoreExport void InvalidateChannels (ChannelMask channels)
 This method invalidates the intervals for the given channel mask. More...
 
virtual ObjectMakeShallowCopy (ChannelMask channels)
 This method must make a copy of its "shell" and then shallow copy (see below) only the specified channels. More...
 
virtual CoreExport void ShallowCopy (Object *fromOb, ChannelMask channels)
 This method copies the specified channels from the fromOb to this and copies the validity intervals. More...
 
virtual CoreExport void FreeChannels (ChannelMask channels)
 This method deletes the memory associated with the specified channels and set the intervals associated with the channels to invalid (empty). More...
 
virtual CoreExport void NewAndCopyChannels (ChannelMask channels)
 This method replaces the locked channels with newly allocated copies. More...
 
virtual CoreExport void MaybeEnlargeViewportRect (GraphicsWindow *gw, Rect &rect)
 This method allows the object to enlarge its viewport rectangle, if it wants to. More...
 
CoreExport bool IsBaseClassOwnedChannel (int nchan)
 Implemented by the System. More...
 
CoreExport void UpdateValidity (int nchan, Interval v)
 When a modifier is applied to an object, it needs to include its own validity interval in the interval of the object. More...
 
Interval GetNoEvalInterval ()
 
void SetNoEvalInterval (Interval iv)
 
virtual CoreExport void ReduceCaches (TimeValue t)
 This method give the object the chance to reduce its caches. More...
 
virtual int IsConstObject ()
 This is called to determine if this is a construction object or not. More...
 
virtual int NumPipeBranches (bool selected=true)
 This method returns the number of pipeline branches combined by the object. More...
 
virtual 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...
 
- 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 const MCHARGetObjectName (bool localized) const
 
virtual CoreExport BOOL OKToChangeTopology (MSTR &modName)
 Implemented by the System. More...
 
virtual BOOL ChangeTopology ()
 This method asks the question of an object or modifier "Do you change topology"? An object or modifier returns TRUE if it is capable of changing topology when its parameters are being edited; otherwise FALSE. More...
 
virtual void ForceNotify (Interval &i)
 Notifies dependents of a change. More...
 
virtual 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 void Move (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Point3 &val, BOOL localOrigin=FALSE)
 When this method is called the plug-in should respond by moving its selected sub-object components. More...
 
virtual void Rotate (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Quat &val, BOOL localOrigin=FALSE)
 When this method is called the plug-in should respond by rotating its selected sub-object components. More...
 
virtual void Scale (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Point3 &val, BOOL localOrigin=FALSE)
 When this method is called the plug-in should respond by scaling its selected sub-object components. More...
 
virtual void TransformStart (TimeValue t)
 This method is called before the first Move(), Rotate() or Scale() call and before a hold is in effect. More...
 
virtual void TransformHoldingStart (TimeValue t)
 This method is called before the first Move(), Rotate() or Scale() call and after a hold is in effect. More...
 
virtual void TransformHoldingFinish (TimeValue t)
 This method is called after the user has completed the Move(), Rotate() or Scale() operation and before the undo object has been accepted. More...
 
virtual void TransformFinish (TimeValue t)
 This method is called after the user has completed the Move(), Rotate() or Scale() operation and the undo object has been accepted. More...
 
virtual void TransformCancel (TimeValue t)
 This method is called when the transform operation is canceled by a right-click and the undo has been canceled. More...
 
virtual int Display (TimeValue t, INode *inode, ViewExp *vpt, int flags, ModContext *mc)
 When this method is called the plug-in should respond by performing a quick render of the modifier gizmo in viewport using the current TM. More...
 
virtual void GetWorldBoundBox (TimeValue t, INode *inode, ViewExp *vpt, Box3 &box, ModContext *mc)
 This method computes the world space bounding box of the modifier gizmo (or any object that when in sub-object mode has a gizmo). More...
 
virtual void CloneSelSubComponents (TimeValue t)
 This method is called to make a copy of the selected sub-object components of the item. More...
 
virtual void AcceptCloneSelSubComponents (TimeValue t)
 This method is called when the user mouses up after shift-cloning a sub-object selection. More...
 
virtual void SelectSubComponent (HitRecord *hitRec, BOOL selected, BOOL all, BOOL invert=FALSE)
 This method is called to change the selection state of the component identified by hitRec. More...
 
virtual void ClearSelection (int selLevel)
 This method is called to clear the selection for the given sub-object level. More...
 
virtual void SelectAll (int selLevel)
 This method is called to select every element of the given sub-object level. More...
 
virtual void InvertSelection (int selLevel)
 This method is called to invert the specified sub-object level. More...
 
virtual int SubObjectIndex (HitRecord *hitRec)
 Returns the index of the sub-object element identified by the HitRecord hitRec. More...
 
virtual void ActivateSubobjSel (int level, XFormModes &modes)
 When the user changes the selection of the sub-object drop down, this method is called to notify the plug-in. More...
 
virtual BOOL SupportsNamedSubSels ()
 An object that supports sub-object selection can choose to support named sub object selection sets. More...
 
virtual void ActivateSubSelSet (MSTR &setName)
 When the user chooses a name from the drop down list this method is called. More...
 
virtual void NewSetFromCurSel (MSTR &setName)
 If the user types a new name into the named selection set drop down then this method is called. More...
 
virtual void RemoveSubSelSet (MSTR &setName)
 If the user selects a set from the drop down and then chooses Remove Named Selections from the Edit menu this method is called. More...
 
virtual void SetupNamedSelDropDown ()
 To support the Edit Named Selections dialog, plug-ins must implement this method. More...
 
virtual int NumNamedSelSets ()
 To support the Edit Named Selections dialog, plug-ins must implement this method. More...
 
virtual MSTR GetNamedSelSetName (int i)
 To support the Edit Named Selections dialog, plug-ins must implement this method. More...
 
virtual void SetNamedSelSetName (int i, MSTR &newName)
 To support the Edit Named Selections dialog, plug-ins must implement this method. More...
 
virtual void NewSetByOperator (MSTR &newName, Tab< int > &sets, int op)
 To support the Edit Named Selections dialog, plug-ins must implement this method. More...
 
virtual void GetSubObjectCenters (SubObjAxisCallback *cb, TimeValue t, INode *node, ModContext *mc)
 When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis. More...
 
virtual void GetSubObjectTMs (SubObjAxisCallback *cb, TimeValue t, INode *node, ModContext *mc)
 When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis. More...
 
virtual void NotifyPreCollapse (INode *node, IDerivedObject *derObj, int index)
 This method is called before a modifier or object is collapsed. More...
 
virtual void NotifyPostCollapse (INode *node, Object *obj, IDerivedObject *derObj, int index)
 This method is called after a modifier or object is collapsed. More...
 
virtual int NumSubObjTypes ()
 Objects and modifiers that support subobjects have to overwrite this method - as well as GetSubObjType() - and return a class derived from ISubObjType in GetSubObjType(). More...
 
virtual ISubObjTypeGetSubObjType (int i)
 Returns a pointer to the sub-object type for the sub-object whose index is passed. More...
 
virtual CoreExport int GetSubObjectLevel ()
 This method returns an integer which indicates the current sub-object level of the modifier or base object. More...
 
virtual void ShowEndResultChanged (BOOL showEndResult)
 This method notifies the BaseObject that the end result display has been switched (the "Show End Result" button has been toggled). More...
 
- Public Member Functions inherited from ReferenceTarget
virtual BOOL IsRefTarget ()
 Checks if this is a ReferenceTarget. More...
 
CoreExport RefResult TestForLoop (const Interval &refInterval, RefMakerHandle hmaker)
 Tests for a cyclical reference. More...
 
CoreExport BOOL HasDependents ()
 Checks if a ReferenceTarget has references. More...
 
CoreExport BOOL HasRealDependents ()
 Checks if this has Real (Strong) Dependents. More...
 
void BeginDependencyTest ()
 Starts Dependency Test. More...
 
BOOL EndDependencyTest ()
 Ends Dependency Test. More...
 
virtual void RefAdded (RefMakerHandle rm)
 Called after a reference is made to a target. More...
 
virtual void RefAddedUndoRedo (RefMakerHandle rm)
 Called after a reference is made to a target because of undo or redo. More...
 
virtual void RefDeleted ()
 Called after a references to this is deleted. More...
 
virtual void RefDeletedUndoRedo ()
 Called after a references to this is deleted because of undo or redo. More...
 
CoreExport RefResult DeleteAllRefsToMe ()
 Deletes all references to this ReferenceTarget. More...
 
CoreExport RefResult TransferReferences (RefTargetHandle oldTarget, BOOL delOld=FALSE)
 Transfers all the references from oldTarget to this. More...
 
CoreExport int DoEnumDependents (DependentEnumProc *dep)
 Begins an enumeration that searches back in the dependency network. More...
 
virtual CoreExport 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...
 
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 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)
 
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 int SubNumToRefNum (int subNum)
 
virtual BOOL CanCopyAnim ()
 
CoreExport int HasSubElements (int type=0)
 
virtual int GetSubFCurveExtents (int subNum, ParamDimensionBase *dim, float &min, float &max, DWORD flags)
 The values max and min should be initialized before calling this function. More...
 
virtual ParamDimensionGetParamDimension (int i)
 
virtual BOOL SelectSubAnim (int subNum)
 
virtual BOOL BypassTreeView ()
 
virtual BOOL BypassTrackBar ()
 
virtual BOOL BypassPropertyLevel ()
 
virtual BOOL InvisibleProperty ()
 
virtual int NumKeys ()
 
virtual TimeValue GetKeyTime (int index)
 
virtual int GetKeyIndex (TimeValue t)
 
virtual BOOL GetNextKeyTime (TimeValue t, DWORD flags, TimeValue &nt)
 
virtual void CopyKeysFromTime (TimeValue src, TimeValue dst, DWORD flags)
 
virtual void DeleteKeyAtTime (TimeValue t)
 
virtual BOOL IsKeyAtTime (TimeValue t, DWORD flags)
 
virtual int GetKeyTimes (Tab< TimeValue > &times, Interval range, DWORD flags)
 
virtual int GetKeySelState (BitArray &sel, Interval range, DWORD flags)
 
CoreExport void OpenTreeEntry (int type, DWORD tv)
 
CoreExport void CloseTreeEntry (int type, DWORD tv)
 
CoreExport int IsTreeEntryOpen (int type, DWORD tv)
 
CoreExport BOOL GetSelInTrackView (DWORD tv)
 
CoreExport void SetSelInTrackView (DWORD tv, BOOL sel)
 
CoreExport BOOL InTrackViewSelSet (int which)
 
CoreExport void SetTrackViewSelSet (int which, BOOL inOut)
 
virtual BOOL AssignController (Animatable *control, int subAnim)
 
virtual BOOL CanAssignController (int subAnim)
 Return true if we can reassign the subanim specified. More...
 
virtual BOOL CanMakeUnique ()
 
CoreExport int EnumAnimTree (AnimEnum *animEnum, Animatable *client, int subNum)
 
virtual int RenderBegin (TimeValue t, ULONG flags=0)
 
virtual int RenderEnd (TimeValue t)
 
virtual CoreExport Interval GetTimeRange (DWORD flags)
 
virtual void EditTimeRange (Interval range, DWORD flags)
 
virtual void DeleteTime (Interval iv, DWORD flags)
 
virtual void ReverseTime (Interval iv, DWORD flags)
 
virtual void ScaleTime (Interval iv, float s)
 
virtual void InsertTime (TimeValue ins, TimeValue amount)
 
virtual BOOL SupportTimeOperations ()
 
virtual CoreExport void MapKeys (TimeMap *map, DWORD flags)
 
virtual void DeleteKeys (DWORD flags)
 
virtual void DeleteKeyByIndex (int index)
 
virtual void SelectKeys (TrackHitTab &sel, DWORD flags)
 
virtual void SelectSubKeys (int subNum, TrackHitTab &sel, DWORD flags)
 
virtual void SelectSubCurve (int subNum, BOOL sel)
 
virtual void SelectKeyByIndex (int i, BOOL sel)
 
virtual BOOL IsKeySelected (int i)
 
virtual void FlagKey (TrackHitRecord hit)
 
virtual int GetFlagKeyIndex ()
 
virtual int NumSelKeys ()
 
virtual void CloneSelectedKeys (BOOL offset=FALSE)
 
virtual void AddNewKey (TimeValue t, DWORD flags)
 
virtual void MoveKeys (ParamDimensionBase *dim, float delta, DWORD flags)
 
virtual void ScaleKeyValues (ParamDimensionBase *dim, float origin, float scale, DWORD flags)
 
virtual void SelectCurve (BOOL sel)
 
virtual BOOL IsCurveSelected ()
 Returns TRUE if the function curve is selected; otherwise returns FALSE. More...
 
virtual BOOL IsSubCurveSelected (int subNum)
 Returns the selected state of the sub-curve whose index is passed. More...
 
virtual int GetSelKeyCoords (TimeValue &t, float &val, DWORD flags)
 
virtual void SetSelKeyCoords (TimeValue t, float val, DWORD flags)
 
virtual int SetSelKeyCoordsExpr (ParamDimension *dim, const MCHAR *timeExpr, const MCHAR *valExpr, DWORD flags)
 
virtual void AdjustTangents (TrackHitRecord hit, ParamDimensionBase *dim, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, int dx, int dy, DWORD flags)
 
virtual void AdjustTangents (TrackHitRecord hit, ParamDimensionBase *dim, float angle, float length, DWORD flags)
 
virtual CoreExport BOOL IsAnimated ()
 
virtual BOOL CanCopyTrack (Interval iv, DWORD flags)
 
virtual BOOL CanPasteTrack (TrackClipObject *cobj, Interval iv, DWORD flags)
 
virtual 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 BOOL IsSubClassOf (Class_ID classID)
 returns true if the animatable has sub-classed off the given class More...
 
virtual CoreExport void MouseCycleCompleted (TimeValue t)
 
virtual CoreExport void MouseCycleStarted (TimeValue t)
 
virtual int NumParamBlocks ()
 
virtual 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

IParamBlockpblock
 
PolyShape shape
 
Interval ivalid
 
BOOL suspendSnap
 

Static Public Attributes

static IObjParamip
 
static HWND hGenParams
 
static BOOL dlgRenderable
 
static float dlgThickness
 
static int dlgSides
 
static float dlgAngle
 
static BOOL dlgGenUVs
 
static ISpinnerControlthickSpin
 
static SimpleShapeeditOb
 
- Static Public Attributes inherited from Animatable
static const AnimHandle kInvalidAnimHandle = 0
 

Protected Member Functions

virtual CoreExport void SetReference (int i, RefTargetHandle rtarg)
 This method sets the ShapeObject's parameter block pointer. More...
 
CoreExport bool IsRequiresLegacyDisplayMode () const
 
virtual CoreExport bool UpdatePerNodeItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer)
 
- 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 ()
 

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 ShapeObject, Class IParamBlock, Class PolyShape, Class Interval, Shapes and Splines.

Description:
This class defines a simple shape object to make procedural shape primitives easier to create. For example, the 3ds Max Helix plug-in is derived from this class. There are a set of mandatory and optional methods to implement.

Revised for 3ds Max 2.0 SimpleShape-based objects have a new 'General' rollup, which contains renderable shape options: Renderable checkbox, Thickness spinner, and a Mapping coords checkbox. These are supported automatically. To support the new features of the renderable splines, the derived class of SimpleShape needs to work with a few new methods – see SimpleShapeClone() and ReadyGeneralParameters() below for details.
Data Members:
IParamBlock *pblock;

The parameter block for managing the shape's parameters.

static IObjParam *ip;

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

This is the interface pointer stored by the class.

static HWND hGenParams;

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

The window handle to the 'General' rollup.

static BOOL dlgRenderable;

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

The 'Renderable' flag in the 'General' rollup.

static float dlgThickness;

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

The 'Thickness' setting in the 'General' rollup.

static BOOL dlgGenUVs;

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

The 'Generate Mapping Coords' flag in the 'General' rollup.

PolyShape shape;

The shape cache.

Interval ivalid;

The validity interval for the shape cache.

BOOL suspendSnap;

A flag to suspend snapping used during the creation process.

static SimpleShape *editOb;

The shape that is currently being edited in the command panel.

static ISpinnerControl *thickSpin;

Points to the spinner control used for the thickness parameter.

Constructor & Destructor Documentation

◆ SimpleShape()

Remarks
Constructor.

◆ ~SimpleShape()

Remarks
Destructor.

Clients of SimpleShape need to implement these methods:

Member Function Documentation

◆ UpdateShape()

CoreExport void UpdateShape ( TimeValue  t)

◆ ShapeInvalid()

void ShapeInvalid ( )
inline
99 { ivalid.SetEmpty(); }
void SetEmpty()
Definition: interval.h:126
Interval ivalid
Definition: simpshp.h:84

◆ HitTest()

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

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

◆ Display()

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

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

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

{

Eval(t);

GraphicsWindow *gw = vpt->getGW();

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

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

...

}

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

Parameters
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
The return value is not currently used.

Reimplemented from ShapeObject.

◆ BeginEditParams()

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

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

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

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

{

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

...

}

Parameters
objParamThe interface pointer passed to the plug-in.
flagsThe flags passed along to the plug-in in Animatable::BeginEditParams().
prevThe pointer passed to the plug-in in Animatable::BeginEditParams().

Reimplemented from ShapeObject.

◆ EndEditParams()

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

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

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

*next )
{
// ...
}
Definition: Animatable.h:118
Definition: maxapi.h:8377
CoreExport void EndEditParams(IObjParam *objParam, ULONG flags, Animatable *next)
Similarly to BeginEditParams, this method allows the ShapeObject to remove its "Rendering" rollup.
static IObjParam * ip
Definition: simpshp.h:73
virtual CoreExport void EndEditParams(IObjParam *ip, ULONG flags, Animatable *next)
Similarly to BeginEditParams, this method allows the ShapeObject to remove its "Rendering" rollup.
Parameters
objParamThe interface pointer passed to the plug-in.
flagsThe flags passed along to the plug-in in Animatable::BeginEditParams().
nextThe pointer passed to the plug-in in Animatable::EndEditParams().

Reimplemented from ShapeObject.

◆ GetParamBlock()

IParamArray* GetParamBlock ( )
inlinevirtual

An object or modifier should implement this method if it wishes to make its parameter block available for other plug-ins to access it.

The system itself doesn't actually call this method. This method is optional.

Returns
A pointer to the item's parameter block. See Class IParamArray.

Reimplemented from BaseObject.

110 {return (IParamArray*)pblock;}
Definition: iparamb.h:211
IParamBlock * pblock
Definition: simpshp.h:71

◆ GetParamBlockIndex()

CoreExport int GetParamBlockIndex ( int  id)
virtual

If a plug-in makes its parameter block available (using GetParamBlock()) then it will need to provide #defines for indices into the parameter block.

These defines should not be directly used with the parameter block but instead converted by this function that the plug-in implements. This way if a parameter moves around in a future version of the plug-in the #define can be remapped. A return value of -1 indicates an invalid parameter id.

Parameters
idThe parameter block id. See Parameter Block IDs.
Returns
The parameter block index or -1 if it is invalid.

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.

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

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

◆ BuildMesh()

CoreExport void BuildMesh ( TimeValue  t,
Mesh mesh 
)

◆ GetWorldBoundBox()

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.

◆ GetDeformBBox()

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

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

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

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

◆ NumberOfVertices()

CoreExport int NumberOfVertices ( TimeValue  t,
int  curve 
)
virtual

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

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

Parameters
tThe time at which the number of vertices is to be computed.
curveThe curve index. See note above.

Reimplemented from ShapeObject.

◆ NumberOfCurves()

CoreExport int NumberOfCurves ( TimeValue  t)
overridevirtual

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

Parameters
tThe time to check.
Returns
the number of polygons in the shape.

Implements ShapeObject.

◆ CurveClosed()

CoreExport BOOL CurveClosed ( TimeValue  t,
int  curve 
)
virtual

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

Parameters
tThe time to check.
curveThe index of the curve to check.
Returns
TRUE if the curve is closed; otherwise FALSE.

Implements ShapeObject.

◆ OrganizeCurves()

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

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

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

Parameters
tThe time to organize the curves.
hierThis class provides information about the hierarchy. See Class ShapeHierarchy.

Implements ShapeObject.

◆ MakePolyShape()

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

Create a PolyShape representation with optional fixed steps.

Parameters
tThe time to make the PolyShape.
shapeThe PolyShape representation is stored here.
stepsThe number of steps between knots. Values >=0 indicates the use of fixed steps:

PSHAPE_BUILTIN_STEPS
Use the shape's built-in steps/adaptive settings (default).

PSHAPE_ADAPTIVE_STEPS
Force adaptive steps.
optimizeIf TRUE intermediate steps are removed from linear segments.

Implements ShapeObject.

◆ MakeCap() [1/2]

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

This method generates a mesh capping info for the shape.

Parameters
tThe time to create the cap info.
capInfoThe cap info to update.
capTypeSee Shape Capping Types.
Returns
Nonzero if the cap info was generated; otherwise zero.

Implements ShapeObject.

◆ MakeCap() [2/2]

CoreExport int MakeCap ( TimeValue  t,
PatchCapInfo capInfo 
)
virtual

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

Only implement this method if CanMakeBezier() returns TRUE.

Parameters
tThe time to create the cap info.
capInfoThe cap info to update.
Returns
Nonzero if the cap info was generated; otherwise zero.

Reimplemented from ShapeObject.

◆ NumRefs()

int NumRefs ( )
inlinevirtual

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

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

return myNumRefs + ShapeObject::NumRefs();

}

Reimplemented from ShapeObject.

132 { return 1 + ShapeObject::NumRefs(); }
virtual int NumRefs()
The ShapeObject makes 1 reference; this is where it tells the system.
Definition: object.h:5016

◆ GetReference()

CoreExport RefTargetHandle GetReference ( int  i)
virtual

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

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

>RefTargetHandle SomeShape::GetReference(int i) {
If(i == 0) return ShapeObject::GetReference(i);
}
A scene entity that is being owned and listened to by other scene entities.
Definition: ref.h:1844
ShapeObjects are open or closed hierarchical shapes made up of one or more pieces.
Definition: object.h:4538
CoreExport RefTargetHandle GetReference(int i)
This method allows the ShapeObject to return a pointer to its parameter block.
Parameters
iThe reference handle to retrieve.
Returns
The handle to the Reference Target.

Reimplemented from ShapeObject.

◆ SetReference()

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

This method sets the ShapeObject's parameter block pointer.

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

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

}

Parameters
iThe virtual array index of the reference to store.
rtargThe reference handle to store.

Reimplemented from ShapeObject.

◆ IsRequiresLegacyDisplayMode()

CoreExport bool IsRequiresLegacyDisplayMode ( ) const
protectedvirtual

Reimplemented from ShapeObject.

◆ UpdatePerNodeItems()

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

Reimplemented from ShapeObject.

◆ NotifyRefChanged()

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

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

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

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

if(hTarget == GetReference(0))

return ShapeObject::NotifyRefChanged(

changeInt, hTarget, partID, message);

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

Parameters
changeIntThis is the interval of time over which the message is active.
hTargetThis 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.
partIDThis contains information specific to the message passed in. Some messages don't use the partID at all. See the section Reference Messages for more information about the meaning of the partID for some common messages.
messageThe msg parameter passed into this method is the specific message which needs to be handled. See Reference Messages.
propagate- If called through ReferenceMaker::NotifyDependents(), the value of 'propagate' passed to it. Used if calling NotifyDependents() from within NotifyRefChanged().
Returns
The return value from this method is of type RefResult. This is usually REF_SUCCEED indicating the message was processed. Sometimes, the return value may be REF_STOP. This return value is used to stop the message from being propagated to the dependents of the item.

Reimplemented from ShapeObject.

◆ ReadyGeneralParameters()

CoreExport void ReadyGeneralParameters ( )
Remarks
This method is available in release 2.0 and later only.

To support the new features of the renderable splines, in the derived class's constructor, call ReadyGeneralParameters(). This will set up the general parameters in the base class to the proper defaults. Failure to make this call will cause SimpleShape-based objects to be created with default general parameters rather than those of the previously-created object.

◆ SimpleShapeClone()

CoreExport void SimpleShapeClone ( SimpleShape sshpSource)
Remarks
This method is available in release 2.0 and later only.

To support the new features of the renderable splines, the derived class of SimpleShape needs to, in the Clone method, call this method. This will insure that the base class parameters are copied to the cloned object. Failure to make this call will cause cloned SimpleShape-based objects to revert to the default rendering parameters.
Parameters:
SimpleShape *sshpSource

The source shape for the clone.

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

165 { return 1 + ShapeObject::NumSubs(); }
virtual int NumSubs()
Definition: object.h:5017

◆ SubAnim()

CoreExport Animatable* SubAnim ( int  i)
virtual

This method returns the ShapeObject's animatable pointer.

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

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

}

Parameters
iThis is the index of the sub-anim to return.

Reimplemented from ShapeObject.

◆ SubAnimName()

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

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

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

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

}

Parameters
iThis is the index of the sub-anim's name to return.
localizedIf true, then the sub-anim name returned is localized.

Reimplemented from ShapeObject.

◆ DeleteThis()

CoreExport void DeleteThis ( )
virtual

Deletes an instance of this class.

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

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

See also
Required DLL Functions, Class ClassDesc.

Reimplemented from Animatable.

◆ FreeCaches()

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

◆ Save()

CoreExport IOResult Save ( ISave isave)
virtual

Implemented by the System.

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

Parameters
isaveAn interface for saving data. See Class ISave.

Reimplemented from ShapeObject.

◆ Load()

CoreExport IOResult Load ( ILoad iload)
virtual

Implemented by the System.

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

Parameters
iloadAn interface for loading data. See Class ILoad.

Reimplemented from ShapeObject.

◆ SetGenUVs()

CoreExport void SetGenUVs ( BOOL  sw)

◆ SetRenderable()

CoreExport void SetRenderable ( BOOL  sw)

◆ TrackViewWinProc()

LRESULT CALLBACK TrackViewWinProc ( HWND  hwnd,
UINT  message,
WPARAM  wParam,
LPARAM  lParam 
)
inlinevirtual

This function is obsolete.

Reimplemented from Animatable.

180  {return(0);}

◆ GetClassName()

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

Retrieves the name of the plugin class.

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

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

182 {s = GetObjectName(localized);}
virtual const MCHAR * GetObjectName() MAX_SEALED
Definition: object.h:650

◆ InitNodeName()

void InitNodeName ( MSTR s)
inlinevirtual

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

Parameters
sThe default name of the node is stored here.

Reimplemented from ShapeObject.

183 {s = GetObjectName(true);}

◆ ClassID()

virtual Class_ID ClassID ( )
pure virtual

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.

◆ BuildShape()

virtual void BuildShape ( TimeValue  t,
PolyShape ashape 
)
pure virtual
Remarks
This method is called to build the shape at the specified time and store the result into the PolyShape passed.
Parameters:
TimeValue t

The time to build the shape.

PolyShape& ashape

The built shape is stored here.

◆ Clone()

virtual RefTargetHandle Clone ( RemapDir remap)
pure 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)));
}
};
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.
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.
virtual RefTargetHandle Clone(RemapDir &remap)=0
This method is used by 3ds Max to clone an object.

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.

◆ GetCreateMouseCallBack()

virtual CreateMouseCallBack* GetCreateMouseCallBack ( )
pure 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.

◆ ValidForDisplay()

virtual BOOL ValidForDisplay ( TimeValue  t)
pure virtual
Remarks
This method indicates if the shape may be displayed at the time passed. At certain times, for certain shapes, the shape may not be in a displayable form. For example, the size of the shape may go to zero at a certain point and would be inappropriate to display.
Parameters:
TimeValue t

The time to check.
Returns
TRUE if the shape may be displayed at the specified time; otherwise FALSE.

◆ InvalidateUI()

virtual void InvalidateUI ( )
inlinevirtual
Remarks
This is called if the user interface parameters needs to be updated because the user moved to a new time. The UI controls must display values for the current time.

If the plug-in uses a parameter map for handling its UI, it may call a method of the parameter map to handle this: ipmapParam->Invalidate();

If the plug-in does not use parameter maps, it should call the SetValue() method on each of its controls that display a value, for example the spinner controls. This will cause to the control to update the value displayed. The code below shows how this may be done for a spinner control. Note that ip and pblock are assumed to be initialized interface and parameter block pointers

(IObjParam *ip, IParamBlock *pblock).

float newval;

Interval valid=FOREVER;

TimeValue t=ip->GetTime();

// Get the value from the parameter block at the current time.

pblock->GetValue( PB_ANGLE, t, newval, valid );

// Set the value. Note that the notify argument is passed as FALSE.

// This ensures no messages are sent when the value changes.

angleSpin->SetValue( newval, FALSE );
Default Implementation:
{}
235 {}

◆ GetParameterDim()

virtual ParamDimension* GetParameterDim ( int  pbIndex)
inlinevirtual
Remarks
This method returns the parameter dimension of the parameter whose index is passed.
Parameters:
int pbIndex

The index of the parameter to return the dimension of.
Returns
Pointer to a ParamDimension. See Class ParamDimension.
Default Implementation:
{return defaultDim;}
245 {return defaultDim;}
CoreExport ParamDimension * defaultDim

◆ GetParameterName() [1/2]

virtual MSTR GetParameterName ( int  pbIndex)
inlinevirtual
Note
This method has been deprecated in terms of implementation as of 3ds Max 2022. Plugin developers should implement GetParameterName(int pbIndex, bool localized) instead. This method can no longer be overriden and calls to it are now forwarded to the function that replaced it with a "bool localized" value of true. This is done so that plugin developers who do not localize their plugins don't have to update all the places where they call this method. Plugin developers who do localize their plugins should analyze the places where they call this method to decide what value to pass it for the "bool localized" parameter.
See also
SimpleShape::GetParameterName(int pbIndex, bool localized)
254  {
255  return GetParameterName(pbIndex, true);
256  }
virtual MSTR GetParameterName(int pbIndex) MAX_SEALED
Definition: simpshp.h:253

◆ GetParameterName() [2/2]

virtual MSTR GetParameterName ( int  pbIndex,
bool  localized 
)
inlinevirtual
Remarks
Returns the name of the parameter whose index is passed.
Parameters:
int pbIndex

The index into the parameter block of the parameter to return the name of. bool localized

If true, then the parameter name returned should be localized in the language 3ds Max is currently using. Otherwise it should be the parameter name in English. If a plugin does not provide localized string resources, it can disregard this parameter and always return the parameter name in English.
Default Implementation:
{return MSTR(_M("Parameter"));}
267 {return MSTR(_M("Parameter"));}
#define _M(x)
Used to wrap string literals.
Definition: strbasic.h:67
WStr MSTR
Definition: strclass.h:1058

◆ InterpCurve3D()

virtual Point3 InterpCurve3D ( TimeValue  t,
int  curve,
float  param,
int  ptype = PARAM_SIMPLE 
)
pure virtual
Remarks
This method returns a point interpolated on the entire curve.
Parameters:
TimeValue t

The time to evaluate.

int curve

The index of the curve to evaluate.

float param

The 'distance' along the curve where 0 is the start and 1 is the end.

int ptype=PARAM_SIMPLE

The parameter type for spline interpolation. See Parameter types for shape interpolation.
Returns
The interpolated point on the curve.

Implements ShapeObject.

◆ TangentCurve3D()

virtual Point3 TangentCurve3D ( TimeValue  t,
int  curve,
float  param,
int  ptype = PARAM_SIMPLE 
)
pure virtual
Remarks
This method returns a tangent vector interpolated on the entire curve.
Parameters:
TimeValue t

The time at which to evaluate the curve.

int curve

The index of the curve to evaluate.

float param

The 'distance' along the curve where 0.0 is the start and 1.0 is the end.

int ptype=PARAM_SIMPLE

The parameter type for spline interpolation. See Parameter types for shape interpolation.
Returns
The tangent vector.

Implements ShapeObject.

◆ LengthOfCurve()

virtual float LengthOfCurve ( TimeValue  t,
int  curve 
)
pure virtual
Remarks
Returns the length of the specified curve.
Parameters:
TimeValue t

The time at which to compute the length.

int curve

The index of the curve.

Implements ShapeObject.

◆ NumberOfPieces()

virtual int NumberOfPieces ( TimeValue  t,
int  curve 
)
inlinevirtual
Remarks
Returns the number of sub-curves in a curve.
Parameters:
TimeValue t

The time at which to check.

int curve

The index of the curve.
Default Implementation:
{ return 1; }

Implements ShapeObject.

318 { return 1; }

◆ InterpPiece3D()

virtual Point3 InterpPiece3D ( TimeValue  t,
int  curve,
int  piece,
float  param,
int  ptype = PARAM_SIMPLE 
)
inlinevirtual
Remarks
This method returns the interpolated point along the specified sub-curve.
Parameters:
TimeValue t

The time to evaluate the sub-curve.

int curve

The curve to evaluate.

int piece

The sub-curve (segment) to evaluate.

float param

The position along the sub-curve to return where 0.0 is the start and 1.0 is the end.

int ptype=PARAM_SIMPLE

The parameter type for spline interpolation. See Parameter types for shape interpolation.
Returns
The point in world space.
Default Implementation:
{ return InterpCurve3D(t, curve, param); }

Implements ShapeObject.

337 { return InterpCurve3D(t, curve, param, ptype); }
virtual Point3 InterpCurve3D(TimeValue t, int curve, float param, int ptype=PARAM_SIMPLE)=0

◆ TangentPiece3D()

virtual Point3 TangentPiece3D ( TimeValue  t,
int  curve,
int  piece,
float  param,
int  ptype = PARAM_SIMPLE 
)
inlinevirtual
Remarks
Returns the tangent vector on a sub-curve at the specified 'distance' along the curve.
Parameters:
TimeValue t

The time to evaluate the sub-curve.

int curve

The curve to evaluate.

int piece

The sub-curve (segment) to evaluate.

float param

The position along the sub-curve to return where 0.0 is the start and 1.0 is the end.

int ptype=PARAM_SIMPLE

The parameter type for spline interpolation. See Parameter types for shape interpolation.
Returns
The tangent vector.
Default Implementation:
{ return TangentCurve3D(t, curve, param, ptype); }

Implements ShapeObject.

356 { return TangentCurve3D(t, curve, param, ptype); }
virtual Point3 TangentCurve3D(TimeValue t, int curve, float param, int ptype=PARAM_SIMPLE)=0

◆ GetMatID()

virtual CoreExport MtlID GetMatID ( TimeValue  t,
int  curve,
int  piece 
)
virtual
Remarks
This method is available in release 3.0 and later only.

Returns the material ID of the specified segment of the specified curve or the shape.
Parameters:
TimeValue t

The time at which to return the material ID

int curve

The zero based index of the curve.

int piece

The zero based index of the segment of the curve.

Reimplemented from ShapeObject.

Member Data Documentation

◆ pblock

IParamBlock* pblock

◆ ip

IObjParam* ip
static

◆ hGenParams

HWND hGenParams
static

◆ dlgRenderable

BOOL dlgRenderable
static

◆ dlgThickness

float dlgThickness
static

◆ dlgSides

int dlgSides
static

◆ dlgAngle

float dlgAngle
static

◆ dlgGenUVs

BOOL dlgGenUVs
static

◆ thickSpin

ISpinnerControl* thickSpin
static

◆ shape

PolyShape shape

◆ ivalid

Interval ivalid

◆ suspendSnap

BOOL suspendSnap

◆ editOb

SimpleShape* editOb
static