AIPerspectiveTransformSuite Struct Reference
[API Suite List]

This suite allows you to project or reverse-project points and art objects using the currently defined perspective grid in the current document. More...

#include <AIPerspectiveTransform.h>

List of all members.

Public Attributes
AIAPI AIBoolean(*	PutInPerspective )(AIArtHandle art, GridPlaneType activePlane, AIReal *planeOffset)
	Projects an art object into perspective, using the currently defined perspective grid in the current document.
AIAPI AIBoolean(*	GetOriginalArt )(AIArtHandle art)
	Reverse-projects art from perspective.
AIAPI AIBoolean(*	GetOriginalPoint )(AIRealPoint &point, GridPlaneType activePlane, AIReal *planeOffset)
	Reverse-projects a point from perspective.
AIAPI AIBoolean(*	GetPerspectivePoint )(AIRealPoint &point, GridPlaneType activePlane, AIReal *planeOffset)
	Projects a point into perspective.
AIAPI AIBoolean(*	ApplyTransformInPerspective )(AIArtHandle art, AIRealMatrix transform)
	Transforms art into perspective on the current perspective grid of the current document, using the supplied transformation matrix.
AIAPI AIBoolean(*	IsArtInPerspective )(AIArtHandle art)
	Reports whether art is currently in perspective.
AIAPI AIErr(*	ReleaseArtFromPerspective )(AIArtHandle art)
	Releases art from the perspective grid, preserving the appearance.
AIAPI AIErr(*	AttachArtToPerspective )(AIArtHandle art)
	Attaches art to the perspective grid, preserving the appearance.
AIAPI AIBoolean(*	CanAttachToPerspective )(AIArtHandle art)
	Reports whether art can be attached to the perspective grid.
AIAPI AIBoolean(*	CanReleaseFromPerspective )(AIArtHandle art)
	Reports whether art can be released from the perspective grid.
AIAPI AIBoolean(*	IsPerspectivePluginObject )(AIArtHandle art)
	Reports whether art is a perspective plug-in group object, created for putting text and symbols in perspective.
AIAPI AIErr(*	GetTypeOfPerspectiveObject )(AIArtHandle art, ai::int16 &type)
	Retrieves the type of art contained in a given perspective plug-in object.
AIAPI AIBoolean(*	IsPerspectiveObjectEditingOriginal )(AIArtHandle art)
	Reports whether user is currently editing the original art (text or symbol) of a given perspective plug-in object.
AIAPI AIErr(*	PlaceArtInPerspective )(AIArtHandle art, AIRealPoint startPoint, AIRealPoint endPoint, GridPlaneType plane)
	Places art in a given perspective plane at a given position.
AIAPI AIReal(*	GetObjectPlaneOffset )(AIArtHandle art)
	Retrieves the offset of art on the perspective plane on which it is placed.
AIAPI AIErr(*	GetObjectPlane )(AIArtHandle art, GridPlaneType *objectPlane)
	Retrieves the perspective plane for art that is currently in perspective.
AIAPI AIErr(*	ConstrainPtsInPlane )(AIRealPoint &startPt, AIRealPoint &endPt, GridPlaneType &gridPlane, AIReal *offset)
	This method places two points into perspective with one another on a given plane.
AIAPI AIErr(*	IsSelectionInMultipleOffset )(AIBoolean *isMultiOffsetSelection)
	Reports whether selected objects are at different offsets on the perspective grid plane.
AIAPI AIErr(*	GetOriginalArtBounds )(AIArtHandle art, ai::int32 flags, AIRealRect &bounds)
	Retrieves the perspective bounds from a perspective art object.

---

Detailed Description

This suite allows you to project or reverse-project points and art objects using the currently defined perspective grid in the current document.

---

Member Data Documentation

AIAPI AIBoolean(* AIPerspectiveTransformSuite::ApplyTransformInPerspective)(AIArtHandle art, AIRealMatrix transform)

Transforms art into perspective on the current perspective grid of the current document, using the supplied transformation matrix.

(Note that this method returns a Boolean value, not an error code.)

Parameters:

	art	The art object.
	transform	The transformation matrix to be applied to the original dimensions of the art.

Returns:

True on success.

AIAPI AIErr(* AIPerspectiveTransformSuite::AttachArtToPerspective)(AIArtHandle art)

Attaches art to the perspective grid, preserving the appearance.

For a group or container, the group and all its children are recursively attached to the current active plane of the perspective grid.

Parameters:

art

The art object, or NULL to operate on current selection.

AIAPI AIBoolean(* AIPerspectiveTransformSuite::CanAttachToPerspective)(AIArtHandle art)

Reports whether art can be attached to the perspective grid.

(Note that this method returns a Boolean value, not an error code.)

Parameters:

art

The art object, or NULL to operate on current selection.

Returns:

True if the art can be attached to the perspective grid.

AIAPI AIBoolean(* AIPerspectiveTransformSuite::CanReleaseFromPerspective)(AIArtHandle art)

Reports whether art can be released from the perspective grid.

(Note that this method returns a Boolean value, not an error code.)

Parameters:

art

The art object, or NULL to operate on current selection.

Returns:

True if the art can be released from the perspective grid.

AIAPI AIErr(* AIPerspectiveTransformSuite::ConstrainPtsInPlane)(AIRealPoint &startPt, AIRealPoint &endPt, GridPlaneType &gridPlane, AIReal *offset)

This method places two points into perspective with one another on a given plane.

If needed, modifies the point values in place; for example, if the end point goes beyond the vanishing point. You can choose to return the offset used to perform the transformation, which reflects the depth of the plane.

Parameters:

	startPt	[in/out] Document coordinates of start point. Modified in place if necessary.
	endPt	[in/out] Document coordinates of end point. Modified in place if necessary.
	gridPlane	[in] The grid plane.
	offset	[optional, out] A buffer in which to return the offset used for the transformation.

AIAPI AIErr(* AIPerspectiveTransformSuite::GetObjectPlane)(AIArtHandle art, GridPlaneType *objectPlane)

Retrieves the perspective plane for art that is currently in perspective.

Parameters:

	art	The art object in perspective.
	objectPlane	[out] A buffer in which to return the plane on which the art object is placed.

AIAPI AIReal(* AIPerspectiveTransformSuite::GetObjectPlaneOffset)(AIArtHandle art)

Retrieves the offset of art on the perspective plane on which it is placed.

(Note that this method returns a numeric value, not an error code.)

Parameters:

art

The art object in perspective.

Returns:

The offset value.

AIAPI AIBoolean(* AIPerspectiveTransformSuite::GetOriginalArt)(AIArtHandle art)

Reverse-projects art from perspective.

Replaces the passed object handle with the handle to the original art object that was projected into perspective. (Note that this method returns a Boolean value, not an error code.)

Parameters:

art

[in, out] The art object, modified in place on success.

Returns:

True on success.

AIAPI AIErr(* AIPerspectiveTransformSuite::GetOriginalArtBounds)(AIArtHandle art, ai::int32 flags, AIRealRect &bounds)

Retrieves the perspective bounds from a perspective art object.

The perspective grid scale is not considered in the returned bounds.

Parameters:

	art	The perspective art object.
	flags	Bit flags that specify which bounds to return, a logical OR of AIArtBoundsOptions constants.
	bounds	[out] A buffer in which to return the perspective art bounds.

AIAPI AIBoolean(* AIPerspectiveTransformSuite::GetOriginalPoint)(AIRealPoint &point, GridPlaneType activePlane, AIReal *planeOffset)

Reverse-projects a point from perspective.

Replaces the passed point with the original point on the canvas that was projected into perspective. (Note that this method returns a Boolean value, not an error code.)

Parameters:

	point	[in, out] A buffer that supplies the original point, and that returns the modified point.
	activePlane	The plane on which the point was projected.
	planeOffset	A pointer to the plane offset, or NULL to use the current plane offset.

Returns:

True on success.

AIAPI AIBoolean(* AIPerspectiveTransformSuite::GetPerspectivePoint)(AIRealPoint &point, GridPlaneType activePlane, AIReal *planeOffset)

Projects a point into perspective.

Replaces the passed point, which is assumed to be in normal 2D space, with the point projected onto the given plane in the current perspective grid of the current document. (Note that this method returns a Boolean value, not an error code.)

Parameters:

	point	[in, out] A buffer that supplies the original point, and that returns the modified point.
	activePlane	The plane onto which to project the point.
	planeOffset	A pointer to the plane offset, or NULL to use the current plane offset.

Returns:

True on success.

AIAPI AIErr(* AIPerspectiveTransformSuite::GetTypeOfPerspectiveObject)(AIArtHandle art, ai::int16 &type)

Retrieves the type of art contained in a given perspective plug-in object.

Currently, only Text and Symbol art objects can be placed in a perspective plug-in object.

Parameters:

	art	The perspective plug-in object.
	type	[out] A buffer in which to return the type of perspective object, one of kTextFrameArt or kSymbolArt.

AIAPI AIBoolean(* AIPerspectiveTransformSuite::IsArtInPerspective)(AIArtHandle art)

Reports whether art is currently in perspective.

(Note that this method returns a Boolean value, not an error code.)

Parameters:

art

The art object.

Returns:

True if the art is in perspective.

AIAPI AIBoolean(* AIPerspectiveTransformSuite::IsPerspectiveObjectEditingOriginal)(AIArtHandle art)

Reports whether user is currently editing the original art (text or symbol) of a given perspective plug-in object.

(Note that this method returns a Boolean value, not an error code.)

Parameters:

art

The perspective plug-in art object.

Returns:

True if the original art is being edited.

AIAPI AIBoolean(* AIPerspectiveTransformSuite::IsPerspectivePluginObject)(AIArtHandle art)

Reports whether art is a perspective plug-in group object, created for putting text and symbols in perspective.

(Note that this method returns a Boolean value, not an error code.)

Parameters:

art

The art object.

Returns:

True if the art is a perspective plug-in group object

AIAPI AIErr(* AIPerspectiveTransformSuite::IsSelectionInMultipleOffset)(AIBoolean *isMultiOffsetSelection)

Reports whether selected objects are at different offsets on the perspective grid plane.

Parameters:

isMultiOffsetSelection

[out] A buffer in which to return true if selected objects are at different offsets.

AIAPI AIErr(* AIPerspectiveTransformSuite::PlaceArtInPerspective)(AIArtHandle art, AIRealPoint startPoint, AIRealPoint endPoint, GridPlaneType plane)

Places art in a given perspective plane at a given position.

Parameters:

	art	The art object.
	startPoint	Start point of a placement drag operation.
	endPoint	End point of a placement drag operation.
	plane	The plane in which to place the art object.

AIAPI AIBoolean(* AIPerspectiveTransformSuite::PutInPerspective)(AIArtHandle art, GridPlaneType activePlane, AIReal *planeOffset)

Projects an art object into perspective, using the currently defined perspective grid in the current document.

Breaks down the object into segments, and projects each of the points of each segment into perspective. (Note that this method returns a Boolean value, not an error code.)

Parameters:

	art	[in, out] The art object, modified in place on success.
	activePlane	The plane in which to project the art.
	planeOffset	A pointer to the plane offset, or NULL to use the current plane offset.

Returns:

True on success.

AIAPI AIErr(* AIPerspectiveTransformSuite::ReleaseArtFromPerspective)(AIArtHandle art)

Releases art from the perspective grid, preserving the appearance.

• For perspective plug-in objects (created for putting text and symbols in perspective), replaces the plug-in art with the result art, and deletes the plug-in art from the artwork tree. You will no longer be able to edit text or symbols associated with this perspective plug-in object.
• For a group or container, the group and all its children are released from the perspective grid recursively.

Parameters:

art

The art object, or NULL to operate on current selection.

---

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

• AIPerspectiveTransform.h