This reference page is linked to from the following overview topics: Shape and Spline Principal Classes.

Detailed Description

See also:: Class ShapeObject, Class IParamBlock, Class PolyShape, Class Interval, Working with 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.

#include <simpshp.h>

Inheritance diagram for SimpleShape:

[legend]

List of all members.

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.
CoreExport void	Snap (TimeValue t, INode inode, SnapInfo snap, IPoint2 p, ViewExp vpt)
	Checks the point passed for a snap and updates the SnapInfo structure.
CoreExport int	Display (TimeValue t, INode inode, ViewExp vpt, int flags)
	This method displays the shape's generated mesh if necessary.
virtual CoreExport void	BeginEditParams (IObjParam ip, ULONG flags, Animatable prev)
	This method allows the ShapeObject to create its new "Rendering" rollup.
virtual CoreExport void	EndEditParams (IObjParam ip, ULONG flags, Animatable next)
	Similarly to BeginEditParams, this method allows the ShapeObject to remove its "Rendering" rollup.
IParamArray *	GetParamBlock ()
	An object or modifier should implement this method if it wishes to make its parameter block available for other plug-ins to access it.
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.
CoreExport ObjectState	Eval (TimeValue time)
	This method is called to evaluate the object and return the result as an ObjectState.
CoreExport Interval	ObjectValidity (TimeValue t)
	This method returns the validity interval of the object as a whole at the specified time.
CoreExport int	CanConvertToType (Class_ID obtype)
	Indicates whether the object can be converted to the specified type.
CoreExport Object *	ConvertToType (TimeValue t, Class_ID obtype)
	This method converts this object to the type specified and returns a pointer it.
CoreExport void	BuildMesh (TimeValue t, Mesh &mesh)
CoreExport ObjectHandle	CreateTriObjRep (TimeValue t)
CoreExport void	GetWorldBoundBox (TimeValue t, INode inode, ViewExp vpt, Box3 &box)
	This method returns the world space bounding box for Objects (see below for the Sub-object gizmo or Modifiers gizmo version).
CoreExport void	GetLocalBoundBox (TimeValue t, INode inode, ViewExp vxt, Box3 &box)
	This is the object space bounding box, the box in the object's local coordinates.
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.
CoreExport int	NumberOfVertices (TimeValue t, int curve)
	This method is used by the Summary Info and Object Properties dialogs to inform the user how many vertices or CVs are in the object.
CoreExport int	NumberOfCurves ()
	Returns the number of polygons in the shape.
CoreExport BOOL	CurveClosed (TimeValue t, int curve)
	This method is called to determine if the specified curve of the shape is closed at the time passed.
CoreExport ShapeHierarchy &	OrganizeCurves (TimeValue t, ShapeHierarchy *hier=NULL)
	This method is called to prepare the shape for lofting, extrusion, etc.
CoreExport void	MakePolyShape (TimeValue t, PolyShape &shape, int steps=PSHAPE_BUILTIN_STEPS, BOOL optimize=FALSE)
	Create a PolyShape representation with optional fixed steps.
CoreExport int	MakeCap (TimeValue t, MeshCapInfo &capInfo, int capType)
	This method generates a mesh capping info for the shape.
CoreExport int	MakeCap (TimeValue t, PatchCapInfo &capInfo)
	This method creates a patch cap info out of the shape.
int	NumRefs ()
	The ShapeObject makes 1 reference; this is where it tells the system.
CoreExport RefTargetHandle	GetReference (int i)
	This method allows the ShapeObject to return a pointer to its parameter block.
CoreExport RefResult	NotifyRefChanged (Interval changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message)
	This method will notify the Shape Object of changes in values in its parameter block.
CoreExport void	ReadyGeneralParameters ()
CoreExport void	SimpleShapeClone (SimpleShape *sshpSource)
int	NumSubs ()
CoreExport Animatable *	SubAnim (int i)
	This method returns the ShapeObject's animatable pointer.
CoreExport MSTR	SubAnimName (int i)
	This method returns the name of the animatable's name.
CoreExport void	DeleteThis ()
	Deletes an instance of this class.
CoreExport void	FreeCaches ()
CoreExport IOResult	Save (ISave *isave)
	Implemented by the System.
CoreExport IOResult	Load (ILoad *iload)
	Implemented by the System.
CoreExport void	SetGenUVs (BOOL sw)
	Implemented by the System.
CoreExport void	SetRenderable (BOOL sw)
	Implemented by the System.
LRESULT CALLBACK	TrackViewWinProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
	This function is obsolete.
void	GetClassName (MSTR &s)
	Retrieves the name of the plugin class.
void	InitNodeName (MSTR &s)
	This is the default name of the node when it is created.
virtual Class_ID	ClassID ()=0
	Retrieves a constant that uniquely identifies the plugin class.
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.
virtual CreateMouseCallBack *	GetCreateMouseCallBack ()=0
	This method allows the system to retrieve a callback object used in creating an object in the 3D viewports.
virtual BOOL	ValidForDisplay (TimeValue t)=0
virtual void	InvalidateUI ()
virtual ParamDimension *	GetParameterDim (int pbIndex)
virtual MSTR	GetParameterName (int pbIndex)
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 Attributes
IParamBlock *	pblock
PolyShape	shape
Interval	ivalid
BOOL	suspendSnap
Static Public Attributes
static IObjParam *	ip
static HWND	hGenParams
static BOOL	dlgRenderable
static float	dlgThickness
static int	dlgSides
static float	dlgAngle
static BOOL	dlgGenUVs
static ISpinnerControl *	thickSpin
static SimpleShape *	editOb
Protected Member Functions
virtual CoreExport void	SetReference (int i, RefTargetHandle rtarg)
	This method sets the ShapeObject's parameter block pointer.

Constructor & Destructor Documentation

CoreExport SimpleShape ( )

Remarks:: Constructor.

CoreExport ~SimpleShape ( )

Remarks:: Destructor.

Clients of SimpleShape need to implement these methods:

Member Function Documentation

CoreExport void UpdateShape ( TimeValue t )

Search for all occurrences

void ShapeInvalid ( ) [inline]

Search for all occurrences

{ ivalid.SetEmpty(); }

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

Search for all occurrences

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

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

Parameters:

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

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

Reimplemented from BaseObject.

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

Search for all occurrences

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

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

Parameters:

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

Reimplemented from BaseObject.

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

Search for all occurrences

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

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

{

Eval(t);

GraphicsWindow *gw = vpt->getGW();

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

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

...

}

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

Parameters:

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

Returns:: The return value is not currently used.

Reimplemented from ShapeObject.

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

Search for all occurrences

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:

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

Reimplemented from ShapeObject.

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

Search for all occurrences

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

A derived class simply calls this first thing in its own EndEditParams. An example from the SplineShape code: void SplineShape::EndEditParams( IObjParam *ip, ULONG flags,Animatable next )

{

ShapeObject::EndEditParams(ip, flags, next);

...

}

Parameters:

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

Reimplemented from ShapeObject.

IParamArray* GetParamBlock ( ) [inline, virtual]

Search for all occurrences

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.

{return (IParamArray*)pblock;}

CoreExport int GetParamBlockIndex ( int id ) [virtual]

Search for all occurrences

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:

id	The parameter block id. See Parameter Block IDs.

Returns:: The parameter block index or -1 if it is invalid.

Reimplemented from BaseObject.

CoreExport ObjectState Eval ( TimeValue t ) [virtual]

Search for all occurrences

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

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

Parameters:

t	Specifies the time to evaluate the object.

Returns:: The result of evaluating the object as an ObjectState.

Sample Code:

Typically this method is implemented as follows:

    { return ObjectState(this); }

Implements Object.

CoreExport Interval ObjectValidity ( TimeValue t ) [virtual]

Search for all occurrences

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

Parameters:

t	The time to compute the validity interval.

Default Implementation:: { return FOREVER; }

Returns:: The validity interval of the object.

Reimplemented from Object.

CoreExport int CanConvertToType ( Class_ID obtype ) [virtual]

Search for all occurrences

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

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

See also:: Class ObjectConverter for additional details on converting objects between types.

Parameters:

obtype The Class_ID of the type of object to convert to. See Class Class_ID, List of Class_IDs.

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

Default Implementation:: { return 0; }

Reimplemented from Object.

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

Search for all occurrences

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

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

See also:: class ObjectConverter for additional details on converting objects between types.

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

World space modifiers that work on anything other than generic deformable: objects are responsible for transforming the points of the object they modify into world space using the ObjectState TM. To understand why this is necessary, consider how 3ds Max applies the node transformation to the object flowing down the pipeline.

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

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

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

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

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

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

This is the issue developers need to be aware of. To state this in simple: terms then: Any world space modifier that needs to put the points of the object into world space (since it doesn't implement InputType() as defObjectClassID) needs to specify PART_GEOM in its implementation of ChannelsChanged().

Parameters:

t	The time at which to convert.
obtype	The Class_ID of the type of object to convert to. See Class Class_ID, List of Class_IDs.

Returns:: A pointer to an object of type obtype.

Default Implementation:: { return NULL; }

Sample Code:

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

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

Reimplemented from Object.

CoreExport void BuildMesh	(	TimeValue	t,
		Mesh &	mesh
	)

Search for all occurrences

CoreExport ObjectHandle CreateTriObjRep ( TimeValue t )

Search for all occurrences

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

Search for all occurrences

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

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

Parameters:

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

Reimplemented from BaseObject.

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

Search for all occurrences

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

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

Parameters:

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

Reimplemented from BaseObject.

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

Search for all occurrences

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

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

Parameters:

t	The time to compute the box.
box	A reference to a box the result is stored in.
tm	This is an alternate coordinate system used to compute the box. If the tm is not NULL this matrix should be used in the computation of the result.
useSel	If TRUE, the bounding box of selected sub-elements should be computed; otherwise the entire object should be used.

Reimplemented from Object.

CoreExport int NumberOfVertices	(	TimeValue	t,
		int	curve
	)		`[virtual]`

Search for all occurrences

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

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

Parameters:

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

Reimplemented from ShapeObject.

CoreExport int NumberOfCurves ( ) [virtual]

Search for all occurrences

Returns the number of polygons in the shape.

Implements ShapeObject.

CoreExport BOOL CurveClosed	(	TimeValue	t,
		int	curve
	)		`[virtual]`

Search for all occurrences

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

Parameters:

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

Returns:: TRUE if the curve is closed; otherwise FALSE.

Implements ShapeObject.

CoreExport ShapeHierarchy& OrganizeCurves	(	TimeValue	t,
		ShapeHierarchy *	hier = `NULL`
	)		`[virtual]`

Search for all occurrences

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

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

Parameters:

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

Implements ShapeObject.

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

Search for all occurrences

Create a PolyShape representation with optional fixed steps.

Parameters:

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

Implements ShapeObject.

CoreExport int MakeCap	(	TimeValue	t,
		MeshCapInfo &	capInfo,
		int	capType
	)		`[virtual]`

Search for all occurrences

This method generates a mesh capping info for the shape.

Parameters:

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

Returns:: Nonzero if the cap info was generated; otherwise zero.

Implements ShapeObject.

CoreExport int MakeCap	(	TimeValue	t,
		PatchCapInfo &	capInfo
	)		`[virtual]`

Search for all occurrences

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

Only implement this method if CanMakeBezier() returns TRUE.

Parameters:

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

Returns:: Nonzero if the cap info was generated; otherwise zero.

Reimplemented from ShapeObject.

int NumRefs ( ) [inline, virtual]

Search for all occurrences

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.

{ return 1 + ShapeObject::NumRefs(); }

CoreExport RefTargetHandle GetReference ( int i ) [virtual]

Search for all occurrences

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

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

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

Parameters:

i	The reference handle to retrieve.

Returns:: The handle to the Reference Target.

Reimplemented from ShapeObject.

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

Search for all occurrences

This method sets the ShapeObject's parameter block pointer.

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

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

}

Parameters:

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

Reimplemented from ShapeObject.

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

Search for all occurrences

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

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

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

if(hTarget == GetReference(0))

return ShapeObject::NotifyRefChanged(

changeInt, hTarget, partID, message);

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

Parameters:

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

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.

CoreExport void ReadyGeneralParameters ( )

Search for all occurrences

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.

CoreExport void SimpleShapeClone ( SimpleShape * sshpSource )

Search for all occurrences

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.

int NumSubs ( ) [inline, virtual]

Search for all occurrences

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

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

Default Implementation:: { return 0; }

Reimplemented from ShapeObject.

{ return 1 + ShapeObject::NumSubs(); }

CoreExport Animatable* SubAnim ( int i ) [virtual]

Search for all occurrences

This method returns the ShapeObject's animatable pointer.

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

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

}

Parameters:

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

Reimplemented from ShapeObject.

CoreExport MSTR SubAnimName ( int i ) [virtual]

Search for all occurrences

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

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

}

Parameters:

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

Reimplemented from ShapeObject.

CoreExport void DeleteThis ( ) [virtual]

Search for all occurrences

Deletes an instance of this class.

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

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

Remarks:: See Memory Allocation.

See also:: Plugin DLL Functions, Class ClassDesc.

Reimplemented from Animatable.

CoreExport void FreeCaches ( ) [virtual]

Search for all occurrences

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

Default Implementation:: {}

Reimplemented from Animatable.

CoreExport IOResult Save ( ISave * isave ) [virtual]

Search for all occurrences

Implemented by the System.

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

Parameters:

isave An interface for saving data. See Class ISave.

Reimplemented from ShapeObject.

CoreExport IOResult Load ( ILoad * iload ) [virtual]

Search for all occurrences

Implemented by the System.

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

Parameters:

iload An interface for loading data. See Class ILoad.

Reimplemented from ShapeObject.

CoreExport void SetGenUVs ( BOOL sw )

Search for all occurrences

Implemented by the System.

Pass TRUE to set the generate UVs switch to on; FALSE to set it off.

Parameters:

sw	TRUE for on; FALSE for off.

Reimplemented from ShapeObject.

CoreExport void SetRenderable ( BOOL sw )

Search for all occurrences

Implemented by the System.

Sets the rendering flag to the specified value.

Parameters:

sw	TRUE for on; FALSE for off.

Reimplemented from ShapeObject.

LRESULT CALLBACK TrackViewWinProc	(	HWND	hwnd,
		UINT	message,
		WPARAM	wParam,
		LPARAM	lParam
	)		`[inline, virtual]`

Search for all occurrences

This function is obsolete.

Reimplemented from Animatable.

                                                {return(0);}

void GetClassName ( MSTR & s ) [inline, virtual]

Search for all occurrences

Retrieves the name of the plugin class.

This name is usually used internally for debugging purposes. For Material plug-ins this method is used to put up the material "type" name in the Material Editor.

Parameters:

s	Reference to a string filled in with the name of the plugin class

Reimplemented from ReferenceTarget.

{s = GetObjectName();}

void InitNodeName ( MSTR & s ) [inline, virtual]

Search for all occurrences

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

Parameters:

s	The default name of the node is stored here.

Reimplemented from ShapeObject.

{s = GetObjectName();}

virtual Class_ID ClassID ( ) [pure virtual]

Search for all occurrences

Retrieves a constant that uniquely identifies the plugin class.

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

Returns:: A class id that uniquely identifies a plugin class

See also:: Class ClassID, List of Class IDs.

Reimplemented from Animatable.

virtual void BuildShape	(	TimeValue	t,
		PolyShape &	ashape
	)		`[pure virtual]`

Search for all occurrences

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.

virtual RefTargetHandle Clone ( RemapDir & remap ) [pure virtual]

Search for all occurrences

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

See also:

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

            class MyDerivedPlugin
                : public MyBasePlugin
            {
                const int MY_REFERENCE = 1;

                ReferenceTarget* Clone(RemapDir& remap)
                {
                    ReferenceTarget* result = new MyDerivedPlugin();
                    BaseClone(this, result, remap);
                    return result;
                }

                void BaseClone(ReferenceTarget* from, ReferenceTarget* to, RemapDir& remap)
                {
                    if (!to || !from || from == to)
                        return;    
                    MyBasePlugin::BaseClone(from, to, remap);
                    to->ReplaceReference(MY_REFERENCE, remap->CloneRef(from->GetReference(MY_REFERENCE)));
                }
            };

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

Note:: See the remarks in method BaseClone() below.

Parameters:

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

Returns:: A pointer to the cloned item.

Reimplemented from ReferenceTarget.

virtual CreateMouseCallBack* GetCreateMouseCallBack ( ) [pure virtual]

Search for all occurrences

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

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

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

Implements BaseObject.

virtual BOOL ValidForDisplay ( TimeValue t ) [pure virtual]

Search for all occurrences

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.

virtual void InvalidateUI ( ) [inline, virtual]

Search for all occurrences

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:: {}

{}

virtual ParamDimension* GetParameterDim ( int pbIndex ) [inline, virtual]

Search for all occurrences

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

Reimplemented from ShapeObject.

{return defaultDim;}

virtual MSTR GetParameterName ( int pbIndex ) [inline, virtual]

Search for all occurrences

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.

Default Implementation:: {return MSTR(_M("Parameter"));}

Reimplemented from ShapeObject.

{return MSTR(_M("Parameter"));}

virtual Point3 InterpCurve3D	(	TimeValue	t,
		int	curve,
		float	param,
		int	ptype = `PARAM_SIMPLE`
	)		`[pure virtual]`

Search for all occurrences

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 List of Parameter Types for Shape Interpolation.

Returns:: The interpolated point on the curve.

Implements ShapeObject.

virtual Point3 TangentCurve3D	(	TimeValue	t,
		int	curve,
		float	param,
		int	ptype = `PARAM_SIMPLE`
	)		`[pure virtual]`

Search for all occurrences

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 List of Parameter Types for Shape Interpolation.

Returns:: The tangent vector.

Implements ShapeObject.

virtual float LengthOfCurve	(	TimeValue	t,
		int	curve
	)		`[pure virtual]`

Search for all occurrences

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.

virtual int NumberOfPieces	(	TimeValue	t,
		int	curve
	)		`[inline, virtual]`

Search for all occurrences

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.

{ return 1; }

virtual Point3 InterpPiece3D	(	TimeValue	t,
		int	curve,
		int	piece,
		float	param,
		int	ptype = `PARAM_SIMPLE`
	)		`[inline, virtual]`

Search for all occurrences

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 List of Parameter Types for Shape Interpolation.

Returns:: The point in world space.

Default Implementation:: { return InterpCurve3D(t, curve, param); }

Implements ShapeObject.

{ return InterpCurve3D(t, curve, param, ptype); }

virtual Point3 TangentPiece3D	(	TimeValue	t,
		int	curve,
		int	piece,
		float	param,
		int	ptype = `PARAM_SIMPLE`
	)		`[inline, virtual]`

Search for all occurrences

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 List of Parameter Types for Shape Interpolation.

Returns:: The tangent vector.

Default Implementation:: { return TangentCurve3D(t, curve, param, ptype); }

Implements ShapeObject.

{ return TangentCurve3D(t, curve, param, ptype); }

virtual CoreExport MtlID GetMatID	(	TimeValue	t,
		int	curve,
		int	piece
	)		`[virtual]`

Search for all occurrences

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.