AIPerspectiveGridSuite Struct Reference
[API Suite List]

This suite allows you to query and set parameters of the currently defined perspective grid in a document. More...

#include <AIPerspectiveGrid.h>

List of all members.

Public Attributes
AIAPI AIBoolean(*	IsGridVisible )()
	Reports whether the perspective grid is visible in the current document.
AIAPI AIErr(*	ShowGrid )(AIBoolean flag)
	Shows or hides the currently defined perspective grid in the current document.
AIAPI AIBoolean(*	IsGridDefined )()
	Reports whether a perspective grid is defined in the current document.
AIAPI AIBoolean(*	IsGridLocked )()
	Reports whether the currently defined perspective grid in the current document is locked.
AIAPI AIErr(*	LockGrid )(AIBoolean flag)
	Locks or unlocks the currently defined perspective grid in the current document.
AIAPI AIBoolean(*	IsGridStationPointLocked )()
	Reports whether the station point of the currently defined perspective grid in the current document is locked.
AIAPI AIErr(*	LockGridStationPoint )(AIBoolean flag)
	Locks or unlocks the station point of the currently defined perspective grid in the current document.
AIAPI AIBoolean(*	IsGridRulerVisible )()
	Reports whether rulers are visible in the currently defined perspective grid in the current document.
AIAPI AIErr(*	ShowGridRuler )(AIBoolean flag)
	Shows or hides the rulers in the currently defined perspective grid in the current document.
AIAPI AIBoolean(*	IsSnapToGridEnabled )()
	Reports whether snap-to-grid is enabled in the currently defined perspective grid in the current document.
AIAPI AIErr(*	SnapToGrid )(AIBoolean flag)
	Enables or disables snap-to-grid in the currently defined perspective grid in the current document.
AIAPI AIErr(*	GetGridSnapTolerance )(AIReal &snapTolerance)
	Retrieves the snapping tolerance value of the currently defined perspective grid in the current document.
AIAPI AIErr(*	SetDefaultPreset )()
	Sets the default perspective-grid preset (the two-point grid) as the active preset in the current document.
AIAPI AIErr(*	ArtworkPointToPGPoint )(AIRealPoint &pt, GridPlaneType plane)
	Converts global ruler coordinates into perspective grid coordinates.
AIAPI AIErr(*	PGPointToArtworkPoint )(AIRealPoint &pt, GridPlaneType plane)
	Converts perspective grid coordinates into global ruler coordinates.
AIAPI AIErr(*	GetPGRulerUnit )(AIUnits &unit)
	Retrieves the ruler unit of currently defined perspective grid in the current document.
AIAPI AIErr(*	SwitchActivePlane )()
	Switches between multiple planes of the currently defined perspective grid in the current document.
AIAPI AIErr(*	SetActivePlane )(GridPlaneType gridPlane)
	Sets the active plane of the currently defined perspective grid in the current document.
AIAPI AIErr(*	GetActivePlane )(GridPlaneType &out_gridPlaneType)
	Retrieves the active plane of the currently defined perspective grid in the current document.
AIAPI AIErr(*	GetActiveGridType )(PerspectiveGridType &out_gridType)
	Retrieves the type of the currently defined perspective grid in the current document.
AIAPI AIErr(*	SwitchActivePlaneFromKB )()
	Switches between multiple planes of the currently defined perspective grid in the current document, using keyboard shortcut keys.

---

Detailed Description

This suite allows you to query and set parameters of the currently defined perspective grid in a document.

It can also be used to convert points between artwork and perspective-grid coordinate systems.
This example checks that a grid is currently defined, makes it visible, and translates the origin point on the left grid plane into artboard coordinates.

        Fn()
        {
                AIBoolean defined = sAIPerspectiveGrid->IsGridDefined();
                AIErr status = sAIPerspectiveGrid->ShowGrid(true);
                AIRealPoint pt = {0, 0};
                status = sAIPerspectiveGrid->PGPointToArtworkPoint(pt, kGridLeftPlane);
                //The point is now in artwork coordinates.
        }

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIPerspectiveGridSuite and kAIPerspectiveGridVersion.

---

Member Data Documentation

AIAPI AIErr(* AIPerspectiveGridSuite::ArtworkPointToPGPoint)(AIRealPoint &pt, GridPlaneType plane)

Converts global ruler coordinates into perspective grid coordinates.

Parameters:

	pt	[in/out] A buffer in which to pass the original point and return the converted point.
	plane	[in] The perspective-grid plane containing the point.

AIAPI AIErr(* AIPerspectiveGridSuite::GetActiveGridType)(PerspectiveGridType &out_gridType)

Retrieves the type of the currently defined perspective grid in the current document.

Parameters:

out_gridType

[out] A buffer in which to return the type constant.

AIAPI AIErr(* AIPerspectiveGridSuite::GetActivePlane)(GridPlaneType &out_gridPlaneType)

Retrieves the active plane of the currently defined perspective grid in the current document.

Parameters:

out_gridPlaneType

[out] A buffer in which to return the active plane constant.

AIAPI AIErr(* AIPerspectiveGridSuite::GetGridSnapTolerance)(AIReal &snapTolerance)

Retrieves the snapping tolerance value of the currently defined perspective grid in the current document.

Parameters:

snapTolerance

[out] A buffer in which to return the snapping tolerance value.

AIAPI AIErr(* AIPerspectiveGridSuite::GetPGRulerUnit)(AIUnits &unit)

Retrieves the ruler unit of currently defined perspective grid in the current document.

Parameters:

unit

[out] A buffer in which to return the unit.

AIAPI AIBoolean(* AIPerspectiveGridSuite::IsGridDefined)()

Reports whether a perspective grid is defined in the current document.

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

Returns:

True if a perspective grid is defined.

AIAPI AIBoolean(* AIPerspectiveGridSuite::IsGridLocked)()

Reports whether the currently defined perspective grid in the current document is locked.

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

Returns:

True if the perspective grid is locked.

AIAPI AIBoolean(* AIPerspectiveGridSuite::IsGridRulerVisible)()

Reports whether rulers are visible in the currently defined perspective grid in the current document.

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

Returns:

True if rulers are visible.

AIAPI AIBoolean(* AIPerspectiveGridSuite::IsGridStationPointLocked)()

Reports whether the station point of the currently defined perspective grid in the current document is locked.

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

Returns:

True if station point is locked.

AIAPI AIBoolean(* AIPerspectiveGridSuite::IsGridVisible)()

Reports whether the perspective grid is visible in the current document.

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

Returns:

True if the perspective grid is visible.

AIAPI AIBoolean(* AIPerspectiveGridSuite::IsSnapToGridEnabled)()

Reports whether snap-to-grid is enabled in the currently defined perspective grid in the current document.

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

Returns:

True if snap-to-grid is enabled.

AIAPI AIErr(* AIPerspectiveGridSuite::LockGrid)(AIBoolean flag)

Locks or unlocks the currently defined perspective grid in the current document.

Parameters:

flag

[in] True to lock the perspective grid, false to unlock it.

AIAPI AIErr(* AIPerspectiveGridSuite::LockGridStationPoint)(AIBoolean flag)

Locks or unlocks the station point of the currently defined perspective grid in the current document.

Parameters:

flag

[in] True to lock the station point, false to unlock it.

AIAPI AIErr(* AIPerspectiveGridSuite::PGPointToArtworkPoint)(AIRealPoint &pt, GridPlaneType plane)

Converts perspective grid coordinates into global ruler coordinates.

Parameters:

	pt	[in/out] A buffer in which to pass the original point and return the converted point.
	plane	[in] The perspective-grid plane containing the point.

AIAPI AIErr(* AIPerspectiveGridSuite::SetActivePlane)(GridPlaneType gridPlane)

Sets the active plane of the currently defined perspective grid in the current document.

Parameters:

gridPlane

The plane to make active.

AIAPI AIErr(* AIPerspectiveGridSuite::SetDefaultPreset)()

Sets the default perspective-grid preset (the two-point grid) as the active preset in the current document.

AIAPI AIErr(* AIPerspectiveGridSuite::ShowGrid)(AIBoolean flag)

Shows or hides the currently defined perspective grid in the current document.

Parameters:

flag

[in] True to make the perspective grid visible, false to hide it.

AIAPI AIErr(* AIPerspectiveGridSuite::ShowGridRuler)(AIBoolean flag)

Shows or hides the rulers in the currently defined perspective grid in the current document.

Parameters:

flag

[in] True to show rulers, false to hide them.

AIAPI AIErr(* AIPerspectiveGridSuite::SnapToGrid)(AIBoolean flag)

Enables or disables snap-to-grid in the currently defined perspective grid in the current document.

Parameters:

flag

[in] True to enable, false to disable snap-to-grid.

AIAPI AIErr(* AIPerspectiveGridSuite::SwitchActivePlane)()

Switches between multiple planes of the currently defined perspective grid in the current document.

AIAPI AIErr(* AIPerspectiveGridSuite::SwitchActivePlaneFromKB)()

Switches between multiple planes of the currently defined perspective grid in the current document, using keyboard shortcut keys.

Call from a drag loop to allow the user to switch planes using shortcut keys during the drag operation. This is handled automatically by perspective-aware tools; that is those that set the option kToolWantsAlternateSelectionTool.

---

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

• AIPerspectiveGrid.h