AIShapeConstructionSuite Struct Reference
[API Suite List]

This suite provides utilities for creating paths whose shapes describe a particular geometric figure. More...

#include <AIShapeConstruction.h>

Public Attributes
AIAPI AIErr(*	NewPointPointRect )(AIRealPoint fromPoint, AIRealPoint toPoint, AIBoolean isCentered, AIBoolean isReversed, AIBoolean isConstrained, AIBoolean honorConstrainAngle, AIArtHandle art, AIRealPoint size)
	Creates a path for a rectangle.
AIAPI AIErr(*	NewPointSizeRect )(AIRealPoint fromPoint, AIRealPoint size, AIBoolean isCentered, AIBoolean isReversed, AIBoolean honorConstrainAngle, AIArtHandle *art)
	Creates a path for a rectangle of a given size.
AIAPI AIErr(*	NewPointPointOval )(AIRealPoint fromPoint, AIRealPoint toPoint, AIBoolean isCentered, AIBoolean isReversed, AIBoolean isConstrained, AIBoolean isCircumscribed, AIBoolean honorConstrainAngle, AIArtHandle art, AIRealPoint size)
	Creates a path for an oval from two focus points.
AIAPI AIErr(*	NewPointSizeOval )(AIRealPoint fromPoint, AIRealPoint size, AIBoolean isCentered, AIBoolean isReversed, AIBoolean honorConstrainAngle, AIArtHandle *art)
	Creates a path for an oval of a given size.
AIAPI AIErr(*	NewPointPointRoundedRect )(AIRealPoint fromPoint, AIRealPoint toPoint, AIRealPoint radius, AIBoolean isCentered, AIBoolean isReversed, AIBoolean isConstrained, AIBoolean honorConstrainAngle, AIArtHandle art, AIRealPoint size)
	Creates a path for a rounded rectangle.
AIAPI AIErr(*	NewPointSizeRoundedRect )(AIRealPoint fromPoint, AIRealPoint size, AIRealPoint radius, AIBoolean isCentered, AIBoolean isReversed, AIBoolean honorConstrainAngle, AIArtHandle *art)
	Creates a path for a rounded rectangle of a given size.
AIAPI AIErr(*	NewRect )(AIReal top, AIReal left, AIReal bottom, AIReal right, AIBoolean reversed, AIArtHandle *newArt)
	Creates a path for a rectangle from page coordinates for the sides.
AIAPI AIErr(*	NewCenteredRect )(AIReal centerX, AIReal centerY, AIReal height, AIReal width, AIBoolean reversed, AIArtHandle *newArt)
	Creates a path for a rectangle of a given size, centered around a point.
AIAPI AIErr(*	NewRoundedRect )(AIReal top, AIReal left, AIReal bottom, AIReal right, AIReal horizRadius, AIReal vertRadius, AIBoolean reversed, AIArtHandle *newArt)
	Creates a path for a rounded rectangle from page coordinates for the sides.
AIAPI AIErr(*	NewCenteredRoundedRect )(AIReal centerX, AIReal centerY, AIReal height, AIReal width, AIReal horizRadius, AIReal vertRadius, AIBoolean reversed, AIArtHandle *newArt)
	Creates a path for a rounded rectangle of a given size, centered around a point.
AIAPI AIErr(*	NewInscribedOval )(AIReal top, AIReal left, AIReal bottom, AIReal right, AIBoolean reversed, AIArtHandle *newArt)
	Creates a path for an oval inscribed within a rectangle, from page coordinates for the sides.
AIAPI AIErr(*	NewCircumscribedOval )(AIReal top, AIReal left, AIReal bottom, AIReal right, AIBoolean reversed, AIArtHandle *newArt)
	Creates a path for an oval circumscribed around a rectangle, from page coordinates for the sides.
AIAPI AIErr(*	NewInscribedCenteredOval )(AIReal centerX, AIReal centerY, AIReal height, AIReal width, AIBoolean reversed, AIArtHandle *newArt)
	Creates a path for an oval inscribed within a rectangle of a given size, centered around a point.
AIAPI AIErr(*	NewCircumscribedCenteredOval )(AIReal centerX, AIReal centerY, AIReal height, AIReal width, AIBoolean reversed, AIArtHandle *newArt)
	Creates a path for an oval circumscribed around a rectangle of a given size, centered around a point.
AIAPI AIErr(*	NewRegularPolygon )(ai::uint16 numSides, AIReal centerX, AIReal centerY, AIReal radius, AIBoolean reversed, AIArtHandle *newArt)
	Creates a path for a regular polygon of a given radius, centered around a point.
AIAPI AIErr(*	NewRegularPolygonPoint )(ai::uint16 numsides, AIRealPoint center, AIRealPoint vertex, AIBoolean reversed, AIArtHandle *newArt)
	Creates a path for a regular polygon with a given vertex point, centered around a point.
AIAPI AIErr(*	NewStar )(ai::uint16 numPoints, AIReal centerX, AIReal centerY, AIReal radius1, AIReal radius2, AIBoolean reversed, AIArtHandle *newArt)
	Creates a path for an n-pointed star with a given radius, centered around a point.
AIAPI AIErr(*	NewStarPoint )(ai::uint16 numPoints, AIRealPoint center, AIRealPoint vertex, AIReal radiusRatio, AIBoolean reversed, AIArtHandle *newArt)
	Creates a path for an n-pointed star with a given vertex point and radius ratio, centered around a point.
AIAPI AIErr(*	NewSpiral )(AIRealPoint firstArcCenter, AIRealPoint start, AIReal decayPercent, ai::int16 numQuarterTurns, AIBoolean clockwiseFromOutside, AIArtHandle *newArt)
	Creates a path for spiral around a point.
AIAPI AIErr(*	NewEllipticalPie )(AIRealPoint center, AIReal width, AIReal height, AIReal rotationAngle, AIReal startAngle, AIReal endAngle, AIBoolean isReversed, AIArtHandle *newArt)
	Creates a path for elliptical pie around a point.
AIAPI AIErr(*	NewLinePoint )(const AIRealPoint &startPoint, const AIRealPoint &endPoint, AIArtHandle *newArt)
	Creates a path for a line.
AIAPI AIErr(*	NewLine )(const AIRealPoint &center, const AIReal length, const AIReal rotationAngle, AIArtHandle *newArt)
	Creates a path for a line.

Detailed Description

This suite provides utilities for creating paths whose shapes describe a particular geometric figure.

All of the utilities take parameters that describe the geometric figure and return a new art object. The art object is created in the art tree at the current insertion point as returned by AIArtSuite::GetInsertionPoint().

Note:: The shape suite is supplied by a plug-in, which the user can remove. Clients of the shape suite should fail gracefully if it is not available.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIShapeConstructionSuite and kAIShapeConstructionVersion.

Member Data Documentation

AIAPI AIErr(* AIShapeConstructionSuite::NewCenteredRect)(AIReal centerX, AIReal centerY, AIReal height, AIReal width, AIBoolean reversed, AIArtHandle *newArt)

Creates a path for a rectangle of a given size, centered around a point.

Parameters:

	centerX	The X coordinate of the center.
	centerY	The Y coordinate of the center.
	height	The height in document points.
	width	The width in document points.
	reversed	True to reverse the figure.
	newArt	[out] A buffer in which to return the new path object.

AIAPI AIErr(* AIShapeConstructionSuite::NewCenteredRoundedRect)(AIReal centerX, AIReal centerY, AIReal height, AIReal width, AIReal horizRadius, AIReal vertRadius, AIBoolean reversed, AIArtHandle *newArt)

Creates a path for a rounded rectangle of a given size, centered around a point.

Parameters:

	centerX	The X coordinate of the center.
	centerY	The Y coordinate of the center.
	height	The height in document points.
	width	The width in document points.
	horizRadius	The horizontal radius of the rounded corners, in document points.
	vertRadius	The vertical radius of the rounded corners, in document points.
	reversed	True to reverse the figure.
	newArt	[out] A buffer in which to return the new path object.

AIAPI AIErr(* AIShapeConstructionSuite::NewCircumscribedCenteredOval)(AIReal centerX, AIReal centerY, AIReal height, AIReal width, AIBoolean reversed, AIArtHandle *newArt)

Creates a path for an oval circumscribed around a rectangle of a given size, centered around a point.

Parameters:

	centerX	The X coordinate of the center.
	centerY	The Y coordinate of the center.
	height	The height in document points.
	width	The width in document points.
	reversed	True to reverse the figure.
	newArt	[out] A buffer in which to return the new path object.

AIAPI AIErr(* AIShapeConstructionSuite::NewCircumscribedOval)(AIReal top, AIReal left, AIReal bottom, AIReal right, AIBoolean reversed, AIArtHandle *newArt)

Creates a path for an oval circumscribed around a rectangle, from page coordinates for the sides.

Parameters:

	top	The X coordinate of the top.
	left	The Y coordinate of the left edge.
	bottom	The X coordinate of the bottom.
	right	The Y coordinate of the right edge.
	reversed	True to reverse the figure.
	newArt	[out] A buffer in which to return the new path object.

AIAPI AIErr(* AIShapeConstructionSuite::NewEllipticalPie)(AIRealPoint center, AIReal width, AIReal height, AIReal rotationAngle, AIReal startAngle, AIReal endAngle, AIBoolean isReversed, AIArtHandle *newArt)

Creates a path for elliptical pie around a point.

Parameters:

	center	The center point for the ellipse of which this pie is a part of.
	width	The width of the ellipse of which this pie is a part of.
	height	The height of the ellipse of which this pie is a part of.
	rotationAngle	The rotation angle of the ellipse of which this pie is a part of.
	startAngle	absolute start angle of the pie.
	endAngle	absolute end angle of the pie.
	isReversed	True to reverse the figure.
	newArt	[out] A buffer in which to return the new path object.

AIAPI AIErr(* AIShapeConstructionSuite::NewInscribedCenteredOval)(AIReal centerX, AIReal centerY, AIReal height, AIReal width, AIBoolean reversed, AIArtHandle *newArt)

Creates a path for an oval inscribed within a rectangle of a given size, centered around a point.

Parameters:

	centerX	The X coordinate of the center.
	centerY	The Y coordinate of the center.
	height	The height in document points.
	width	The width in document points.
	reversed	True to reverse the figure.
	newArt	[out] A buffer in which to return the new path object.

AIAPI AIErr(* AIShapeConstructionSuite::NewInscribedOval)(AIReal top, AIReal left, AIReal bottom, AIReal right, AIBoolean reversed, AIArtHandle *newArt)

Creates a path for an oval inscribed within a rectangle, from page coordinates for the sides.

Parameters:

	top	The X coordinate of the top.
	left	The Y coordinate of the left edge.
	bottom	The X coordinate of the bottom.
	right	The Y coordinate of the right edge.
	reversed	True to reverse the figure.
	newArt	[out] A buffer in which to return the new path object.

AIAPI AIErr(* AIShapeConstructionSuite::NewLine)(const AIRealPoint &center, const AIReal length, const AIReal rotationAngle, AIArtHandle *newArt)

Creates a path for a line.

Parameters:

	center	The coordinate of the center of line (Mid point of line).
	length	of line in document points.
	rotationAngle	absolute rotation angle of the line.
	art	[out] A buffer in which to return the new path object.

AIAPI AIErr(* AIShapeConstructionSuite::NewLinePoint)(const AIRealPoint &startPoint, const AIRealPoint &endPoint, AIArtHandle *newArt)

Creates a path for a line.

Parameters:

	startPoint	The starting point of line.
	endPoint	The end point of line.
	art	[out] A buffer in which to return the new path object.

AIAPI AIErr(* AIShapeConstructionSuite::NewPointPointOval)(AIRealPoint fromPoint, AIRealPoint toPoint, AIBoolean isCentered, AIBoolean isReversed, AIBoolean isConstrained, AIBoolean isCircumscribed, AIBoolean honorConstrainAngle, AIArtHandle *art, AIRealPoint *size)

Creates a path for an oval from two focus points.

Parameters:

	fromPoint	The first focus point.
	toPoint	The second focus point.
	isCentered	True to center the figure.
	isReversed	True to reverse the figure.
	isConstrained	True to constrain the figure.
	isCircumscribed	True to circumscribe the figure.
	honorConstrainAngle	True to constrain the angle.
	art	[out] A buffer in which to return the new path object.
	size	[out] A buffer in which to return a point giving the horizontal and vertical size of the figure, in document points.

AIAPI AIErr(* AIShapeConstructionSuite::NewPointPointRect)(AIRealPoint fromPoint, AIRealPoint toPoint, AIBoolean isCentered, AIBoolean isReversed, AIBoolean isConstrained, AIBoolean honorConstrainAngle, AIArtHandle *art, AIRealPoint *size)

Creates a path for a rectangle.

Parameters:

	fromPoint	The upper left point.
	toPoint	The lower right point.
	isCentered	True to center the figure.
	isReversed	True to reverse the figure.
	isConstrained	True to constrain the figure.
	honorConstrainAngle	True to constrain the angle.
	art	[out] A buffer in which to return the new path object.
	size	[out] A buffer in which to return a point giving the horizontal and vertical size of the figure, in document points.

AIAPI AIErr(* AIShapeConstructionSuite::NewPointPointRoundedRect)(AIRealPoint fromPoint, AIRealPoint toPoint, AIRealPoint radius, AIBoolean isCentered, AIBoolean isReversed, AIBoolean isConstrained, AIBoolean honorConstrainAngle, AIArtHandle *art, AIRealPoint *size)

Creates a path for a rounded rectangle.

Parameters:

	fromPoint	The upper left point.
	toPoint	The lower right point.
	isCentered	True to center the figure.
	isReversed	True to reverse the figure.
	isConstrained	True to constrain the figure.
	honorConstrainAngle	True to constrain the angle.
	art	[out] A buffer in which to return the new path object.
	size	[out] A buffer in which to return a point giving the horizontal and vertical size of the figure, in document points.

AIAPI AIErr(* AIShapeConstructionSuite::NewPointSizeOval)(AIRealPoint fromPoint, AIRealPoint size, AIBoolean isCentered, AIBoolean isReversed, AIBoolean honorConstrainAngle, AIArtHandle *art)

Creates a path for an oval of a given size.

Parameters:

	fromPoint	The source point.
	size	A point whose components specify the horizontal and vertical size of the figure, in document points.
	isCentered	True to center the figure.
	isReversed	True to reverse the figure.
	isConstrained	True to constrain the figure.
	honorConstrainAngle	True to constrain the angle.
	art	[out] A buffer in which to return the new path object.

AIAPI AIErr(* AIShapeConstructionSuite::NewPointSizeRect)(AIRealPoint fromPoint, AIRealPoint size, AIBoolean isCentered, AIBoolean isReversed, AIBoolean honorConstrainAngle, AIArtHandle *art)

Creates a path for a rectangle of a given size.

Parameters:

	fromPoint	The upper left point.
	size	A point whose components specify the horizontal and vertical size of the figure, in document points.
	isCentered	True to center the figure.
	isReversed	True to reverse the figure.
	isConstrained	True to constrain the figure.
	honorConstrainAngle	True to constrain the angle.
	art	[out] A buffer in which to return the new path object.

AIAPI AIErr(* AIShapeConstructionSuite::NewPointSizeRoundedRect)(AIRealPoint fromPoint, AIRealPoint size, AIRealPoint radius, AIBoolean isCentered, AIBoolean isReversed, AIBoolean honorConstrainAngle, AIArtHandle *art)

Creates a path for a rounded rectangle of a given size.

Parameters:

	fromPoint	The upper left point.
	size	A point whose components specify the horizontal and vertical size of the figure, in document points.
	isCentered	True to center the figure.
	isReversed	True to reverse the figure.
	isConstrained	True to constrain the figure.
	honorConstrainAngle	True to constrain the angle.
	art	[out] A buffer in which to return the new path object.

AIAPI AIErr(* AIShapeConstructionSuite::NewRect)(AIReal top, AIReal left, AIReal bottom, AIReal right, AIBoolean reversed, AIArtHandle *newArt)

Creates a path for a rectangle from page coordinates for the sides.

Parameters:

	top	The X coordinate of the top.
	left	The Y coordinate of the left edge.
	bottom	The X coordinate of the bottom.
	right	The Y coordinate of the right edge.
	reversed	True to reverse the figure.
	newArt	[out] A buffer in which to return the new path object.

AIAPI AIErr(* AIShapeConstructionSuite::NewRegularPolygon)(ai::uint16 numSides, AIReal centerX, AIReal centerY, AIReal radius, AIBoolean reversed, AIArtHandle *newArt)

Creates a path for a regular polygon of a given radius, centered around a point.

Parameters:

	numSides	The number of sides.
	centerX	The X coordinate of the center.
	centerY	The Y coordinate of the center.
	radius	The radius, in document points.
	reversed	True to reverse the figure.
	newArt	[out] A buffer in which to return the new path object.

AIAPI AIErr(* AIShapeConstructionSuite::NewRegularPolygonPoint)(ai::uint16 numsides, AIRealPoint center, AIRealPoint vertex, AIBoolean reversed, AIArtHandle *newArt)

Creates a path for a regular polygon with a given vertex point, centered around a point.

Parameters:

	numsides	The number of sides.
	center	The center point.
	vertex	The vertex point.
	reversed	True to reverse the figure.
	newArt	[out] A buffer in which to return the new path object.

AIAPI AIErr(* AIShapeConstructionSuite::NewRoundedRect)(AIReal top, AIReal left, AIReal bottom, AIReal right, AIReal horizRadius, AIReal vertRadius, AIBoolean reversed, AIArtHandle *newArt)

Creates a path for a rounded rectangle from page coordinates for the sides.

Parameters:

	top	The X coordinate of the top.
	left	The Y coordinate of the left edge.
	bottom	The X coordinate of the bottom.
	right	The Y coordinate of the right edge.
	reversed	True to reverse the figure.
	newArt	[out] A buffer in which to return the new path object.

AIAPI AIErr(* AIShapeConstructionSuite::NewSpiral)(AIRealPoint firstArcCenter, AIRealPoint start, AIReal decayPercent, ai::int16 numQuarterTurns, AIBoolean clockwiseFromOutside, AIArtHandle *newArt)

Creates a path for spiral around a point.

Parameters:

	firstArcCenter	The center point for the first arc of the spiral.
	start	The starting point.
	decayPercent	The decay ration expressed as a percentage.
	numQuarterTurns	The number of quarter turns.
	clockwiseFromOutside	True to spiral clockwise.
	newArt	[out] A buffer in which to return the new path object.

AIAPI AIErr(* AIShapeConstructionSuite::NewStar)(ai::uint16 numPoints, AIReal centerX, AIReal centerY, AIReal radius1, AIReal radius2, AIBoolean reversed, AIArtHandle *newArt)

Creates a path for an n-pointed star with a given radius, centered around a point.

Parameters:

	numPoints	The number of star points.
	centerX	The X coordinate of the center.
	centerY	The Y coordinate of the center.
	radius1	The first radius, in document points.
	radius2	The second radius, in document points.
	reversed	True to reverse the figure.
	newArt	[out] A buffer in which to return the new path object.

AIAPI AIErr(* AIShapeConstructionSuite::NewStarPoint)(ai::uint16 numPoints, AIRealPoint center, AIRealPoint vertex, AIReal radiusRatio, AIBoolean reversed, AIArtHandle *newArt)

Creates a path for an n-pointed star with a given vertex point and radius ratio, centered around a point.

Parameters:

	numPoints	The number of star points.
	center	The center point.
	vertex	The vertex point.
	radiusRation	The radius ratio.
	reversed	True to reverse the figure.
	newArt	[out] A buffer in which to return the new path object.

The documentation for this struct was generated from the following file:

AIShapeConstruction.h

AIShapeConstructionSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIShapeConstructionSuite Struct Reference
[API Suite List]