This reference page is linked to from the following overview topics: Shape and Spline Principal Classes, Capping a Shape with a Mesh, Capping a Shape with a Patch.

Detailed Description

A multi-polygon shape class.

This class is used in the caching of bezier shapes. This is used for doing a one time interpolation of a bezier shape into a form that is the same shape but doesn't require any further interpolation. In this way the system can do the complex calculations once, store the shape into this PolyShape representation, and not have to go through the cubic spline calculations to figure out where the points are in the future. This class maintains an array of PolyLines. As an example, this is used in the Extrude modifier. First, it generates a PolyShape from the bezier shape it is extruding. Next, this PolyShape is used to generate the mesh.

See also:: Class ShapeObject, Class PolyLine, Class ShapeVSel, Class ShapeSSel, Class ShapePSel, Class ShapeHierarchy.

#include <polyshp.h>

Inheritance diagram for PolyShape:

[legend]

List of all members.

Public Member Functions
CoreExport	PolyShape ()
	Constructor.
CoreExport	PolyShape (PolyShape &from)
	Constructor.
CoreExport	~PolyShape ()
	Destructor.
CoreExport void	Init ()
CoreExport void	NewShape ()
	This deletes all the lines from the PolyShape and clears the shape out.
CoreExport BOOL	SetNumLines (int count, BOOL keep=TRUE)
	Sets the number of polygons used by the poly shape.
CoreExport PolyLine *	NewLine ()
	Creates a new PolyLine and appends it to the end of the list of lines maintained by this PolyShape.
CoreExport void	Append (PolyLine &l)
	Appends the specified PolyLine to the end of the lines list.
CoreExport void	Insert (int where, PolyLine &l)
	Inserts the specified PolyLine at the input location.
CoreExport void	Delete (int where)
	Deletes the specified PolyLine from the lines list.
CoreExport PolyShape &	operator= (PolyShape &from)
	Assignment operator.
CoreExport PolyShape &	operator= (BezierShape &from)
	Assignment operator.
CoreExport void	BuildBoundingBox (void)
	Builds a bounding box surrounding every line in the lines list.
CoreExport void	InvalidateGeomCache (BOOL unused)
	Invalidates the cache of each line in the PolyShape.
CoreExport void	InvalidateCapCache ()
	Invalidates the morph, and grid cap caches.
CoreExport Box3	GetBoundingBox (Matrix3 *tm=NULL)
	Returns the bounding box of the PolyLines in this PolyShape.
CoreExport void	GetDeformBBox (TimeValue t, Box3 &box, Matrix3 *tm, BOOL useSel)
	Computes the bounding box of this PolyShape.
CoreExport void	Render (GraphicsWindow gw, Material ma, RECT *rp, int compFlags, int numMat)
CoreExport BOOL	Select (GraphicsWindow gw, Material ma, HitRegion *hr, int abortOnHit=FALSE)
CoreExport void	Snap (GraphicsWindow gw, SnapInfo snap, IPoint2 *p, Matrix3 &tm)
CoreExport void	Snap (GraphicsWindow gw, SnapInfo snap, IPoint2 *p, Matrix3 &tm, DWORD flags)
CoreExport void	Transform (Matrix3 &tm)
	Transforms the vertices of each PolyLine in this PolyShape by the specified matrix.
CoreExport int	MakeCap (TimeValue t, MeshCapInfo &capInfo, int capType)
	This method may be called to fill in the MeshCapInfo passed with the appropriate capping information.
CoreExport int	MakeCap (TimeValue t, PatchCapInfo &capInfo)
	This method may be called to fill in the PatchCapInfo passed with the appropriate capping information.
CoreExport int	Make3DSCap (MeshCapInfo &capInfo, DWORD options=0)
CoreExport int	MakeGridCap (MeshCapInfo &capInfo)
CoreExport void	Dump (MCHAR *title=NULL)
	This may be called to display information about the PolyShape to the debug window via DebugPrint().
CoreExport void	UpdateCachedHierarchy ()
CoreExport ShapeHierarchy &	OrganizeCurves (TimeValue t, ShapeHierarchy *hier=NULL)
	This methods looks at the shape organization, and puts together a shape hierarchy.
CoreExport void	UpdateSels ()
	This is a very important call to make.
CoreExport void	Reverse (int poly, BOOL keepZero=FALSE)
	Reverses the PolyLine whose index is passed.
CoreExport void	Reverse (BitArray &reverse, BOOL keepZero=FALSE)
	Reverses the splines of this shape if the corresponding bit in reverse is set.
CoreExport MtlID	GetMatID (int poly, int piece)
	Returns the material ID for the specified segment of the specified poly.
CoreExport BitArray	VertexTempSel (int poly)
	Constructs a vertex selection list based on the current selection level of the specified poly.
CoreExport void	ShallowCopy (PolyShape *ashape, ChannelMask channels)
CoreExport void	DeepCopy (PolyShape *ashape, ChannelMask channels)
CoreExport void	NewAndCopyChannels (ChannelMask channels)
CoreExport void	FreeChannels (ChannelMask channels, int zeroOthers=1)
CoreExport IOResult	Save (ISave *isave)
CoreExport IOResult	Load (ILoad *iload)
CoreExport bool	Delete (const unsigned int *indices, unsigned int n)
	Deletes multiple lines at once.
CoreExport void	Append (PolyLine *lines, unsigned int n, bool useSwap=false)
	Append multiple lines at once.
Public Attributes
int	numLines
	The number of lines in the polyshape.
PolyLine *	lines
	The array of lines.
DWORD	flags
	Currently not used.
Box3	bdgBox
	Stores the bounding box surrounding each PolyLine in the shape.
DWORD	selLevel
	The selection level.
DWORD	dispFlags
	Display Attribute Flags.
Selections
ShapeVSel	vertSel
	selected vertices
ShapeSSel	segSel
	selected segments
ShapePSel	polySel
	selected polygons
Capping Caches
MeshCapInfo	morphCap
	The morph cap information.
BOOL	morphCapCacheValid
	Determines if the morph cap is valid.
MeshCapInfo	gridCap
	The grid cap information.
BOOL	gridCapCacheValid
	Determines if the grid cap is valid.
PatchCapInfo	patchCap
	The patch cap information.
BOOL	patchCapCacheValid
	Determines if the patch cap is valid.
ShapeHierarchy	cachedHier
	Hierarchy cache.
BOOL	hierCacheValid
	Determines if the hierarchy cache is valid.

Constructor & Destructor Documentation

CoreExport PolyShape ( )

Constructor.

The number of lines is set to 0, the lines array is set to NULL, the flags and display flags are set to 0, the selection level is set to SHAPE_OBJECT, the geometry cache is invalidated, and the masterObject is set to NULL.

CoreExport PolyShape ( PolyShape & from )

Constructor.

The PolyShape is initialized from the specified PolyShape.

CoreExport ~PolyShape ( )

Destructor.

Member Function Documentation

CoreExport void Init ( )

count	The number of lines.
keep	If set to true, any old lines are copied to the new storage. They are freed otherwise. Defaults to true.

where	The index into the lines list specifying where to insert the PolyLine.
l	The PolyLine to be inserted.

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

t	The time at which to evaluate the bounding box.
box	The result is stored here.
tm	The points of each PolyLine in this PolyShape are deformed using this matrix.
useSel	If set to true, the box is computed about the selected vertices only. All points will be used for this otherwise.

CoreExport void Render	(	GraphicsWindow *	gw,
		Material *	ma,
		RECT *	rp,
		int	compFlags,
		int	numMat
	)

CoreExport BOOL Select	(	GraphicsWindow *	gw,
		Material *	ma,
		HitRegion *	hr,
		int	abortOnHit = `FALSE`
	)

CoreExport void Snap	(	GraphicsWindow *	gw,
		SnapInfo *	snap,
		IPoint2 *	p,
		Matrix3 &	tm
	)

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

tThis	should be passed as the current time. You may retrieve this using Interface::GetTime() (See Class Interface).
capInfo	This information is filled in by this method. (See Class MeshCapInfo).
capType	The cap type. See Shape Capping Types.

t	This should be passed as the current time. You may retrieve this using Interface::GetTime() (See Class Interface).
capInfo	This information is filled in by this method. (See Class PatchCapInfo).

CoreExport int Make3DSCap	(	MeshCapInfo &	capInfo,
		DWORD	options = `0`
	)

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

t	This parameter is not used.
hier	If non-NULL the result is store here (in addition to being returned). (See Class ShapeHierarchy).

CoreExport void Reverse	(	BitArray &	reverse,
		BOOL	keepZero = `FALSE`
	)

poly	The zero based index of the poly.
piece	The zero based index of the segment.

CoreExport void ShallowCopy	(	PolyShape *	ashape,
		ChannelMask	channels
	)

CoreExport void DeepCopy	(	PolyShape *	ashape,
		ChannelMask	channels
	)

CoreExport void FreeChannels	(	ChannelMask	channels,
		int	zeroOthers = `1`
	)

CoreExport bool Delete	(	const unsigned int *	indices,
		unsigned int	n
	)

CoreExport void Append	(	PolyLine *	lines,
		unsigned int	n,
		bool	useSwap = `false`
	)

PolyShape Class Reference

Detailed Description

Public Member Functions

Public Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

lines	Array of lines to append.
n	Number of entries in the lines array.
useSwap	Should PolyLine::Swap() be used instead of operator = ? Using Swap() is faster, and should be used if you are just going to discard the contents of the lines array.