AIMaskFlattenerSuite Struct Reference
[API Suite List]

This suite provides functions that allow you to flatten transparent artwork into an equivalent collection of opaque artwork. More...

#include <AIMaskFlattener.h>

List of all members.

Public Attributes
AIAPI AIErr(*	FlattenArt )(AIArtSet artSet, AIFlatteningOptions *options, ai::int16 paintOrder, AIArtHandle prep)
	Flattens transparent artwork into an equivalent collection of opaque artwork.
AIAPI AIErr(*	CreateTemporaryFlatteningLayer )(AILayerHandle *layer)
	Creates a new, temporary layer at the top of the current document to serve as a destination for flattened art.
AIAPI AIErr(*	FlattenDocumentToLayer )(AILayerHandle layer)
	Flattens all transparent artwork in the current document into an equivalent collection of opaque artwork in a layer, using flattening options obtained from the document's dictionary as set from the Document Setup dialog.
AIAPI AIErr(*	RemoveTemporaryFlatteningLayer )()
	Removes the temporary layer created with CreateTemporaryFlatteningLayer() from the current document, along with any flattened art on the layer.
AIAPI AIErr(*	IsTemporaryFlatteningLayer )(AILayerHandle layer, AIBoolean *flattening)
	Reports whether a layer is a temporary layer intended as a destination for flattened artwork.
AIAPI AIErr(*	ReportError )(AIErr error)
	Displays a common flattening error message based on the error received back from a flattening operation.
AIAPI AIErr(*	CollectDocumentFlatteningInfo )(AIFlatteningInfoReceiver receiver, void *receiverdata)
	Sends information about objects created when the document was flattened to a developer-supplied callback.
AIAPI AIErr(*	FlattenAIDocumentToLayer )(AILayerHandle layer, ASBoolean isEPS)
	Flattens all transparent artwork in the current document into an equivalent collection of opaque artwork in a layer, using flattening options obtained from the document's dictionary as set from the AI or EPS Save Options dialog.

---

Detailed Description

This suite provides functions that allow you to flatten transparent artwork into an equivalent collection of opaque artwork.

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIMaskFlattenerSuite and kAIMaskFlattenerVersion.

---

Member Data Documentation

AIAPI AIErr(* AIMaskFlattenerSuite::CollectDocumentFlatteningInfo)(AIFlatteningInfoReceiver receiver, void *receiverdata)

Sends information about objects created when the document was flattened to a developer-supplied callback.

The information is sent as a sequence of AIFlatteningInfoSnippet values, Each snippet contains information about one object.

Currently, information is supplied about linked EPS and placed art in the flattened output art. A linked EPS is also a placed object, so the callback receives both types of snippets for each linked EPS, in no guaranteed order.

Parameters:

	receiver	The developer-supplied callback function.
	receiverdata	Developer-defined data to pass through to the callback.

AIAPI AIErr(* AIMaskFlattenerSuite::CreateTemporaryFlatteningLayer)(AILayerHandle *layer)

Creates a new, temporary layer at the top of the current document to serve as a destination for flattened art.

When it is no longer , needed, use RemoveTemporaryFlatteningLayer() to delete it.

Parameters:

layer

[out] A buffer in which to return the layer object.

AIAPI AIErr(* AIMaskFlattenerSuite::FlattenAIDocumentToLayer)(AILayerHandle layer, ASBoolean isEPS)

Flattens all transparent artwork in the current document into an equivalent collection of opaque artwork in a layer, using flattening options obtained from the document's dictionary as set from the AI or EPS Save Options dialog.

Parameters:

	layer	The layer. Can be a temporary layer created with CreateTemporaryFlatteningLayer().
	isEPS	True if the document is to be saved to EPS, false if it is to be saved to AI format.

AIAPI AIErr(* AIMaskFlattenerSuite::FlattenArt)(AIArtSet artSet, AIFlatteningOptions *options, ai::int16 paintOrder, AIArtHandle prep)

Flattens transparent artwork into an equivalent collection of opaque artwork.

Parameters:

	artSet	The artwork to flatten.
	options	The flags and values that control how the flattening operation is performed.
	paintOrder	The paint order position of the output art, relative to the prep object, an AITypes::AIPaintOrder value.
	prep	The prepositional art object.

AIAPI AIErr(* AIMaskFlattenerSuite::FlattenDocumentToLayer)(AILayerHandle layer)

Flattens all transparent artwork in the current document into an equivalent collection of opaque artwork in a layer, using flattening options obtained from the document's dictionary as set from the Document Setup dialog.

Parameters:

layer

The layer. Can be a temporary layer created with CreateTemporaryFlatteningLayer().

AIAPI AIErr(* AIMaskFlattenerSuite::IsTemporaryFlatteningLayer)(AILayerHandle layer, AIBoolean *flattening)

Reports whether a layer is a temporary layer intended as a destination for flattened artwork.

Parameters:

	layer	The layer.
	flattening	[out] A buffer in which to return true if the layer is a temporary flattening layer.

AIAPI AIErr(* AIMaskFlattenerSuite::RemoveTemporaryFlatteningLayer)()

Removes the temporary layer created with CreateTemporaryFlatteningLayer() from the current document, along with any flattened art on the layer.

AIAPI AIErr(* AIMaskFlattenerSuite::ReportError)(AIErr error)

Displays a common flattening error message based on the error received back from a flattening operation.

Provides a uniform way to inform the user of the results of flattening.

Parameters:

error

An error code returned from a flattening operation.

---

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

• AIMaskFlattener.h