This reference page is linked to from the following overview topics: Object Plug-ins, Porting Object Plug-ins to Nitrous, General Best Practices, Plug-in Base Classes, Calling CopyBaseData(), Creating Primitive NURBS Objects, Mental Ray Classes, Translation of Object Plug-ins.

Detailed Description

ShapeObjects are open or closed hierarchical shapes made up of one or more pieces.

This base class defines a set of methods that plug-in shapes must implement. Note: Many plug-in shapes may be derived from Class SimpleSpline rather than this class and have fewer methods to implement. See that class for more details. Any classes subclassing off of ShapeObject should be sure to call the ShapeObject constructor in their constructor, in order to properly initialize the fields contained in the ShapeObject. This is the thickness field, which specifies the thickness of the mesh generated from the shape at rendering time. For example:

LinearShape::LinearShape() : ShapeObject()
{
    ...
}

Also, the ShapeObject contains Load and Save methods, which handle 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 the ShapeObject Load and Save methods before storing their information. For example:

IOResult LinearShape::Save(ISave *isave)
{
    IOResult res = ShapeObject::Save(isave);
    if(res != IO_OK)
        return res;
    ...
}

IOResult LinearShape::Load(ILoad *iload)
{
    IOResult res = ShapeObject::Load(iload);
    if(res != IO_OK)
        return res;
    ...
}

The number of ShapeObject references/subanims are defined as SHAPE_OBJ_NUM_REFS and SHAPE_OBJ_NUM_SUBS in /include/object.h and are set to the number of references and subanims in the ShapeObject class, you can use them to make your code more bullet-proof should the number of references change in the future. See maxsdk/include/splshape.h for an example of how they can be used.

See also:: Class GeomObject, Class PolyShape

#include <object.h>

Inheritance diagram for ShapeObject:

[legend]

List of all members.

Public Member Functions
CoreExport	ShapeObject ()
CoreExport	~ShapeObject ()
virtual CoreExport BaseInterface *	GetInterface (Interface_ID iid)
	Inherited from Animatable.
virtual CoreExport void *	GetInterface (ULONG id)
	Inherited from Animatable.
virtual CoreExport bool	RequiresSupportForLegacyDisplayMode () const
virtual CoreExport bool	UpdateDisplay (unsigned long renderItemCategories, const MaxSDK::Graphics::MaterialRequiredStreams &materialRequiredStreams, TimeValue t)
virtual BOOL	IsShapeObject ()
virtual int	IntersectRay (TimeValue t, Ray &ray, float &at, Point3 &norm)
	Computes the intersection point of the ray passed and the shape.
virtual void	InitNodeName (MSTR &s)
	This is the default name of the node when it is created.
SClass_ID	SuperClassID ()
	Retrieves a constant representing the type of the plugin.
virtual CoreExport int	IsRenderable ()
	Indicates whether the object may be rendered.
virtual CoreExport void	CopyBaseData (ShapeObject &from)
	In order to simplify things for subclasses of ShapeObject, this method is now available.
CoreExport float	GetThickness (TimeValue t, Interval &ivalid)
	Implemented by the System.
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.
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.
CoreExport float	GetViewportThickness ()
	This method returns the thickness of the viewport version of the rendering mesh.
CoreExport int	GetViewportSides ()
	This method returns the number of sides for the cross-section for the viewport version of the rendering mesh.
CoreExport float	GetViewportAngle ()
	This method returns the angle that the cross-section of the viewport version of the rendering mesh will be rotated to.
CoreExport BOOL	GetRenderable ()
	Implemented by the System.
CoreExport BOOL	GetGenUVs ()
	Implemented by the System.
CoreExport BOOL	GetDispRenderMesh ()
	This method returns TRUE if the "Display Render Mesh" switch is on.
CoreExport BOOL	GetUseViewport ()
	This method returns TRUE if the "Use Viewport Settings" switch is on.
CoreExport BOOL	GetViewportOrRenderer ()
	This method returns the value of the Viewport/Render switch and either returns GENMESH_VIEWPORT or GENMESH_RENDER.
CoreExport void	SetThickness (TimeValue t, float thick)
	Implemented by the System.
CoreExport void	SetSides (TimeValue t, int s)
	This method allows you to set the number of sides for the rendering mesh version of the shape for the specified time.
CoreExport void	SetAngle (TimeValue t, float a)
	This method allows you to set the cross-section rotation angle for the rendering mesh version of the shape, in degrees, for the specified time.
CoreExport void	SetViewportThickness (float thick)
CoreExport void	SetViewportSides (int s)
	This method allows you to set the number of sides for the viewport version of the rendering mesh.
CoreExport void	SetViewportAngle (float a)
	This method allows you to set the angle that the cross-section of the viewport version of the rendering mesh will be rotated to, in degrees.
CoreExport void	SetRenderable (BOOL sw)
	Implemented by the System.
CoreExport void	SetGenUVs (BOOL sw)
	Implemented by the System.
CoreExport void	SetDispRenderMesh (BOOL sw)
	This method allows you to turn the "Display Render Mesh" switch on or off.
CoreExport void	SetUseViewport (BOOL sw)
	This method allows you to turn the "Use Viewport Settings" switch on or off.
CoreExport void	SetViewportOrRenderer (BOOL sw)
	This method allows you to set the value of the Viewport/Render switch.
virtual CoreExport Mesh *	GetRenderMesh (TimeValue t, INode *inode, View &view, BOOL &needDelete)
	This method should be implemented by all renderable GeomObjects.
virtual CoreExport void	GetRenderMeshInfo (TimeValue t, INode *inode, View &view, int &nverts, int &nfaces)
	Returns information on the rendering mesh.
virtual CoreExport void	GenerateMesh (TimeValue t, int option, Mesh *mesh)
	This method will generate a mesh based on either the viewport or rendering parameters for the specified time.
virtual int	NumberOfVertices (TimeValue t, int curve=-1)
	This method is used by the Summary Info and Object Properties dialogs to inform the user how many vertices or CVs are in the object.
virtual int	NumberOfCurves ()=0
	Returns the number of polygons in the shape.
virtual BOOL	CurveClosed (TimeValue t, int curve)=0
	This method is called to determine if the specified curve of the shape is closed at the time passed.
virtual Point3	InterpCurve3D (TimeValue t, int curve, float param, int ptype=PARAM_SIMPLE)=0
	This method returns a point interpolated on the entire curve.
virtual Point3	TangentCurve3D (TimeValue t, int curve, float param, int ptype=PARAM_SIMPLE)=0
	This method returns a tangent vector interpolated on the entire curve.
virtual float	LengthOfCurve (TimeValue t, int curve)=0
	Returns the length of the specified curve.
virtual int	NumberOfPieces (TimeValue t, int curve)=0
	Returns the number of sub-curves in a curve.
virtual Point3	InterpPiece3D (TimeValue t, int curve, int piece, float param, int ptype=PARAM_SIMPLE)=0
	This method returns the interpolated point along the specified sub-curve (segment).
virtual Point3	TangentPiece3D (TimeValue t, int curve, int piece, float param, int ptype=PARAM_SIMPLE)=0
	Returns the tangent vector on a sub-curve at the specified 'distance' along the curve.
virtual MtlID	GetMatID (TimeValue t, int curve, int piece)
	This method provides access to the material IDs of the shape.
virtual BOOL	CanMakeBezier ()
	This method is called to determine if the shape can be converted to a bezier representation.
virtual void	MakeBezier (TimeValue t, BezierShape &shape)
	Creates the bezier representation of the shape.
virtual ShapeHierarchy &	OrganizeCurves (TimeValue t, ShapeHierarchy *hier=NULL)=0
	This method is called to prepare the shape for lofting, extrusion, etc.
virtual void	MakePolyShape (TimeValue t, PolyShape &shape, int steps=PSHAPE_BUILTIN_STEPS, BOOL optimize=FALSE)=0
	Create a PolyShape representation with optional fixed steps.
virtual int	MakeCap (TimeValue t, MeshCapInfo &capInfo, int capType)=0
	This method generates a mesh capping info for the shape.
virtual int	MakeCap (TimeValue t, PatchCapInfo &capInfo)
	This method creates a patch cap info out of the shape.
virtual BOOL	AttachShape (TimeValue t, INode thisNode, INode attachNode, BOOL weldEnds=FALSE, float weldThreshold=0.0f)
	This method is called to attach the shape of attachNode to thisNode at the specified time.
virtual BOOL	HasUVW ()
	It is called to find out if the object is has UVW coordinates.
virtual BOOL	HasUVW (int mapChannel)
	It is called to find out if the object is has UVW coordinates for the specified mapping channel.
virtual void	SetGenUVW (BOOL sw)
	This method is called to change the state of its Generate UVW boolean.
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.
virtual CoreExport IOResult	Save (ISave *isave)
	Implemented by the System.
virtual CoreExport IOResult	Load (ILoad *iload)
	Implemented by the System.
virtual CoreExport Class_ID	PreferredCollapseType ()
	Implemented by the System.
virtual CoreExport BOOL	GetExtendedProperties (TimeValue t, MSTR &prop1Label, MSTR &prop1Data, MSTR &prop2Label, MSTR &prop2Data)
	Implemented by the System.
virtual CoreExport void	RescaleWorldUnits (float f)
	Implemented by the System.
virtual 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.
virtual CoreExport RefTargetHandle	GetReference (int i)
	This method allows the ShapeObject to return a pointer to its parameter block.
virtual CoreExport Animatable *	SubAnim (int i)
	This method returns the ShapeObject's animatable pointer.
virtual CoreExport MSTR	SubAnimName (int i)
	This method returns the name of the animatable's name.
CoreExport ParamDimension *	GetParameterDim (int pbIndex)
	This method returns the parameter dimension of the parameter whose index is passed.
CoreExport MSTR	GetParameterName (int pbIndex)
	This method returns the name of the parameter whose index is passed.
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.
virtual int	NumRefs ()
	The ShapeObject makes 1 reference; this is where it tells the system.
virtual int	NumSubs ()
CoreExport void	BeginEditParams (IObjParam ip, ULONG flags, Animatable prev)
	This method allows the ShapeObject to create its new "Rendering" rollup.
CoreExport void	EndEditParams (IObjParam ip, ULONG flags, Animatable next)
	Similarly to BeginEditParams, this method allows the ShapeObject to remove its "Rendering" rollup.
CoreExport Interval	GetShapeObjValidity (TimeValue t)
	This method gets the validity interval for the ShapeObject's internal parameters only.
CoreExport int	Display (TimeValue t, INode inode, ViewExp vpt, int flags)
	This method displays the shape's generated mesh if necessary.
virtual CoreExport Box3	GetBoundingBox (TimeValue t, Matrix3 *tm=NULL)
	This method returns a bounding box for the shape, if it's active, if the "Display Render Mesh" switch is on.
virtual CoreExport void	InvalidateGeomCache ()
	This method is very important - It causes the ShapeObject to flush its cached rendering mesh.
int	SetProperty (ULONG id, void *data)
	Associates data passed in to given id.
void *	GetProperty (ULONG id)
	Retrieves data associated with id.
CoreExport BOOL	GetUsePhysicalScaleUVs ()
	Queries whether if real world texture size is used or not.
CoreExport void	SetUsePhysicalScaleUVs (BOOL flag)
	Sets whether real world texture size is used or not.
Protected Member Functions
virtual CoreExport void	SetReference (int i, RefTargetHandle rtarg)
	This method sets the ShapeObject's parameter block pointer.
Friends
class	SObjRenderingDlgProc
class	ShapePostLoadCallback
class	IShapeRectRenderParams

Constructor & Destructor Documentation

CoreExport ShapeObject ( )

CoreExport ~ShapeObject ( )

Member Function Documentation

virtual CoreExport BaseInterface* GetInterface ( Interface_ID id ) [virtual]

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

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

t	The time to compute the intersection.
ray	Ray to intersect.
at	The point of intersection.
norm	The surface normal at the point of intersection.

CoreExport float GetThickness	(	TimeValue	t,
		Interval &	ivalid
	)

t	The time to obtain the thickness.
ivalid	The validity interval.

t	The time at which to set the thickness.
thick	The new thickness setting for the shape.

t	The time at which to set the number of sides.
s	The number of sides you wish to set.

t	The time at which to set the angle.
a	The angle you wish to set, in degrees.

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

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

virtual CoreExport void GetRenderMeshInfo	(	TimeValue	t,
		INode *	inode,
		View &	view,
		int &	nverts,
		int &	nfaces
	)		`[virtual]`

t	The time to get the information.
inode	The node associated with the mesh.
view	Describes properties of the view associated with the render. See Class View.
nverts	The number of vertices in the render mesh.
nfaces	The number of faces in the render mesh.

virtual CoreExport void GenerateMesh	(	TimeValue	t,
		int	option,
		Mesh *	mesh
	)		`[virtual]`

t	The time at which to generate the mesh.
option	The option can be either GENMESH_VIEWPORT, GENMESH_RENDER, or GENMESH_DEFAULT. When using the default definition the mesh generator will use whatever is in the Viewport/Render switch in the parameter block.
mesh	A pointer to a Mesh object. If this is set to NULL, the mesh will be generated and cached, but not returned.

virtual int NumberOfVertices	(	TimeValue	t,
		int	curve = `-1`
	)		`[inline, virtual]`

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

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

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

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

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

ShapeObject Class Reference

Detailed Description

Public Member Functions

Protected Member Functions

Friends

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

t	The time at which to evaluate the curve.
curve	The index of the curve to evaluate.
param	The 'distance' along the curve where 0.0 is the start and 1.0 is the end. int ptype=PARAM_SIMPLE The parameter type for spline interpolation. See List of Parameter Types for Shape Interpolation.

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

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

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

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

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

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

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

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

virtual void MakeBezier	(	TimeValue	t,
		BezierShape &	shape
	)		`[inline, virtual]`