AIPathfinderSuite Struct Reference
[API Suite List]

This suite provides functions that perform operations on paths (art objects of type kPathArt), which apply various effects to selected path art. More...

#include <AIPathfinder.h>

List of all members.

Public Attributes
AIAPI AIErr(*	DoUniteEffect )(AIPathfinderData data, AIFilterMessage message)
	Applies a Unite effect to selected art.
AIAPI AIErr(*	DoIntersectEffect )(AIPathfinderData data, AIFilterMessage message)
	Applies an Intersect effect to selected art.
AIAPI AIErr(*	DoExcludeEffect )(AIPathfinderData data, AIFilterMessage message)
	Applies an Exclude effect to selected art.
AIAPI AIErr(*	DoBackMinusFrontEffect )(AIPathfinderData data, AIFilterMessage message)
	Applies a Back-minus-front effect to selected art.
AIAPI AIErr(*	DoFrontMinusBackEffect )(AIPathfinderData data, AIFilterMessage message)
	Applies a Front-minus-back effect to selected art.
AIAPI AIErr(*	DoDivideEffect )(AIPathfinderData data, AIFilterMessage message)
	Applies a Divide effect to selected art.
AIAPI AIErr(*	DoOutlineEffect )(AIPathfinderData data, AIFilterMessage message)
	Applies a Outline effect to selected art.
AIAPI AIErr(*	DoTrimEffect )(AIPathfinderData data, AIFilterMessage message)
	Applies a Trim effect to selected art.
AIAPI AIErr(*	DoMergeEffect )(AIPathfinderData data, AIFilterMessage message)
	Applies a Merge effect to selected art.
AIAPI AIErr(*	DoCropEffect )(AIPathfinderData data, AIFilterMessage message)
	Applies a Crop effect to selected art.
AIAPI AIErr(*	DoHardEffect )(AIPathfinderData data, AIFilterMessage message)
	Applies a Hard effect to selected art.
AIAPI AIErr(*	DoSoftEffect )(AIPathfinderData data, AIFilterMessage message)
	Applies a Soft effect to selected art.
AIAPI AIErr(*	DoTrapEffect )(AIPathfinderData data, AIFilterMessage message)
	Applies a Trap effect to selected art.
AIAPI AIErr(*	GetHardEffectParameters )(AIPathfinderData data, AIFilterMessage message)
	Retrieves the parameters for the Hard effect pathfinder operation.
AIAPI AIErr(*	GetSoftEffectParameters )(AIPathfinderData data, AIFilterMessage message)
	Retrieves the parameters for the Soft effect pathfinder operation.
AIAPI AIErr(*	GetTrapEffectParameters )(AIPathfinderData data, AIFilterMessage message)
	Retrieves the parameters for the Trap effect pathfinder operation.
AIAPI AIErr(*	GetGlobalOptions )(AIPathfinderData data, AIFilterMessage message)
	Retrieves the global options for Pathfinder and Effect operations.
AIAPI AIShapeMode(*	GetShapeMode )(AIArtHandle art)
	Retrieves the compound shape mode for an art plug-in group object.
AIAPI AIErr(*	SetShapeMode )(AIArtHandle art, AIShapeMode mode)
	Sets the compound shape mode for an art plug-in group object.
AIAPI AIErr(*	NewCompoundShape )(ai::int16 paintOrder, AIArtHandle prep, AIArtHandle *newArt)
	Creates a new, empty, compound shape at a specified position in the paint order of the current document's art tree.
AIAPI AIErr(*	IsCompoundShape )(AIArtHandle art, AIBoolean *isCompoundShape)
	Reports whether an art object is a compound shape.
AIAPI AIErr(*	FlattenArt )(AIArtHandle *inOutArt)
	Expands a shape into a single path or compound path, by applying the Unite effect to each component art object.

Detailed Description

This suite provides functions that perform operations on paths (art objects of type kPathArt), which apply various effects to selected path art.

The operations correspond to those available in the Pathfinder palette and Effect menu.

Additional functions allow manipulation of compound shapes, plug-in groups to which you can apply effects. See AIPluginGroupSuite. In a compound shape group, the bottom object in the group is drawn, then modified by the next object above it according to the interaction mode (AIShapeMode). Each succeeding object can be added to, subtracted from, intersected with, or excluded from the drawing.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIPathfinderSuite and kAIPathfinderVersion.

Member Data Documentation

AIAPI AIErr(* AIPathfinderSuite::DoBackMinusFrontEffect)(AIPathfinderData *data, AIFilterMessage *message)

Applies a Back-minus-front effect to selected art.

Parameters:

	data	The structure containing the selected art and operation parameters.
	message	Not used. Pass an object in which all fields are `NULL`.

AIAPI AIErr(* AIPathfinderSuite::DoCropEffect)(AIPathfinderData *data, AIFilterMessage *message)

Applies a Crop effect to selected art.

Parameters:

	data	The structure containing the selected art and operation parameters.
	message	Not used. Pass an object in which all fields are `NULL`.

AIAPI AIErr(* AIPathfinderSuite::DoDivideEffect)(AIPathfinderData *data, AIFilterMessage *message)

Applies a Divide effect to selected art.

Parameters:

	data	The structure containing the selected art and operation parameters.
	message	Not used. Pass an object in which all fields are `NULL`.

AIAPI AIErr(* AIPathfinderSuite::DoExcludeEffect)(AIPathfinderData *data, AIFilterMessage *message)

Applies an Exclude effect to selected art.

Parameters:

	data	The structure containing the selected art and operation parameters.
	message	Not used. Pass an object in which all fields are `NULL`.

AIAPI AIErr(* AIPathfinderSuite::DoFrontMinusBackEffect)(AIPathfinderData *data, AIFilterMessage *message)

Applies a Front-minus-back effect to selected art.

Parameters:

	data	The structure containing the selected art and operation parameters.
	message	Not used. Pass an object in which all fields are `NULL`.

AIAPI AIErr(* AIPathfinderSuite::DoHardEffect)(AIPathfinderData *data, AIFilterMessage *message)

Applies a Hard effect to selected art.

Parameters:

	data	The structure containing the selected art and operation parameters.
	message	Not used. Pass an object in which all fields are `NULL`.

AIAPI AIErr(* AIPathfinderSuite::DoIntersectEffect)(AIPathfinderData *data, AIFilterMessage *message)

Applies an Intersect effect to selected art.

Parameters:

	data	The structure containing the selected art and operation parameters.
	message	Not used. Pass an object in which all fields are `NULL`.

AIAPI AIErr(* AIPathfinderSuite::DoMergeEffect)(AIPathfinderData *data, AIFilterMessage *message)

Applies a Merge effect to selected art.

Parameters:

	data	The structure containing the selected art and operation parameters.
	message	Not used. Pass an object in which all fields are `NULL`.

AIAPI AIErr(* AIPathfinderSuite::DoOutlineEffect)(AIPathfinderData *data, AIFilterMessage *message)

Applies a Outline effect to selected art.

Parameters:

	data	The structure containing the selected art and operation parameters.
	message	Not used. Pass an object in which all fields are `NULL`.

AIAPI AIErr(* AIPathfinderSuite::DoSoftEffect)(AIPathfinderData *data, AIFilterMessage *message)

Applies a Soft effect to selected art.

Parameters:

	data	The structure containing the selected art and operation parameters.
	message	Not used. Pass an object in which all fields are `NULL`.

AIAPI AIErr(* AIPathfinderSuite::DoTrapEffect)(AIPathfinderData *data, AIFilterMessage *message)

Applies a Trap effect to selected art.

Parameters:

	data	The structure containing the selected art and operation parameters.
	message	Not used. Pass an object in which all fields are `NULL`.

AIAPI AIErr(* AIPathfinderSuite::DoTrimEffect)(AIPathfinderData *data, AIFilterMessage *message)

Applies a Trim effect to selected art.

Parameters:

	data	The structure containing the selected art and operation parameters.
	message	Not used. Pass an object in which all fields are `NULL`.

AIAPI AIErr(* AIPathfinderSuite::DoUniteEffect)(AIPathfinderData *data, AIFilterMessage *message)

Applies a Unite effect to selected art.

Parameters:

	data	The structure containing the selected art and operation parameters.
	message	Not used. Pass an object in which all fields are `NULL`.

AIAPI AIErr(* AIPathfinderSuite::FlattenArt)(AIArtHandle *inOutArt)

Expands a shape into a single path or compound path, by applying the Unite effect to each component art object.

Parameters:

inOutArt

[in, out] A buffer containing the shape art object, in which to return the path object.

AIAPI AIErr(* AIPathfinderSuite::GetGlobalOptions)(AIPathfinderData *data, AIFilterMessage *message)

Retrieves the global options for Pathfinder and Effect operations.

Parameters:

	data	[out] A structure in which to return the relevant parameters.
	message	Not used. Pass an object in which all fields are `NULL`.

AIAPI AIErr(* AIPathfinderSuite::GetHardEffectParameters)(AIPathfinderData *data, AIFilterMessage *message)

Retrieves the parameters for the Hard effect pathfinder operation.

Parameters:

	data	[out] A structure in which to return the relevant parameters.
	message	Not used. Pass an object in which all fields are `NULL`.

AIAPI AIShapeMode(* AIPathfinderSuite::GetShapeMode)(AIArtHandle art)

Retrieves the compound shape mode for an art plug-in group object.

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

Parameters:

art

The art object, a plug-in group.

Returns:: The shape mode value.

AIAPI AIErr(* AIPathfinderSuite::GetSoftEffectParameters)(AIPathfinderData *data, AIFilterMessage *message)

Retrieves the parameters for the Soft effect pathfinder operation.

Parameters:

	data	[out] A structure in which to return the relevant parameters.
	message	Not used. Pass an object in which all fields are `NULL`.

AIAPI AIErr(* AIPathfinderSuite::GetTrapEffectParameters)(AIPathfinderData *data, AIFilterMessage *message)

Retrieves the parameters for the Trap effect pathfinder operation.

Parameters:

	data	[out] A structure in which to return the relevant parameters.
	message	Not used. Pass an object in which all fields are `NULL`.

AIAPI AIErr(* AIPathfinderSuite::IsCompoundShape)(AIArtHandle art, AIBoolean *isCompoundShape)

Reports whether an art object is a compound shape.

Parameters:

	art	The art object.
	isCompoundShape	A buffer in which to return true if the art is a compound shape.

AIAPI AIErr(* AIPathfinderSuite::NewCompoundShape)(ai::int16 paintOrder, AIArtHandle prep, AIArtHandle *newArt)

Creates a new, empty, compound shape at a specified position in the paint order of the current document's art tree.

Use the AIPluginGroupSuite to add objects to the group.

Parameters:

	paintOrder	The paint order, relative to the `prep` object. See `AITypes::AIPaintOrder`.
	prep	The prepositional art object for the paint order.
	newArt	[out] A buffer in which to return the new art object of type `kPluginArt`.

AIAPI AIErr(* AIPathfinderSuite::SetShapeMode)(AIArtHandle art, AIShapeMode mode)

Sets the compound shape mode for an art plug-in group object.

This controls what effects are applied as successive objects are drawn.

Parameters:

	art	The art object of type `kPluginArt`.
	The	new shape mode value.

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

AIPathfinder.h

AIPathfinderSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIPathfinderSuite Struct Reference
[API Suite List]