AIFOConversionSuite Struct Reference
[API Suite List]

These functions allows you to convert artwork and collect information about its contents. More...

#include <AIFOConversion.h>

List of all members.

Public Attributes
AIAPI AIErr(*	ConvertToNative )(AIArtHandle art, AIFOConversionOptions *options, ai::int16 paintOrder, AIArtHandle prep)
	Creates native Illustrator art objects by drawing a source art object to a conversion port.
AIAPI AIErr(*	GetConversionPort )(AIFOConversionOptions *options, ai::int16 paintOrder, AIArtHandle prep, AIDisplayPortHandle *port)
	Retrieves the conversion port that would be used to perform a specific conversion.
AIAPI AIErr(*	ReleaseConversionPort )(AIDisplayPortHandle port)
	Releases a conversion port.
AIAPI AIErr(*	EnumerateFonts )(AIArtHandle art, AIVisitFontProc visitor, void *data)
	Enumerates the fonts used to draw an art object, passing them to a callback along with developer-defined data.
AIAPI AIErr(*	EnumerateContents )(AIArtHandle art, AIVisitContentProc visitor, void *data)
	Enumerates information about the contents of an art object needed in order to draw it, passing it to a callback along with developer-defined data.
AIAPI AIErr(*	EnumerateContentsEx )(AIArtHandle art, AIVisitContentProc visitor, AIFOContentInfoSelectorFlag flags, void *data)
	Enumerates only the requested information required to draw the contents of the art object.
AIAPI AIErr(*	OutlineLegacyText )(AIArtHandle art, ai::int16 paintOrder, AIArtHandle prep)
	Converts a legacy text object to outlines.
AIAPI AIErr(*	EnumerateEmbeddedFonts )(AIArtHandle art, AIVisitFontExtendedProc visitor, void *data)
	For internal use only.

---

Detailed Description

These functions allows you to convert artwork and collect information about its contents.

The suite was originally intended for use with foreign objects (see AIForeignObjectSuite). However, you can use the functions with any type of artwork. For example, you can use AIFOConversionSuite::ConvertToNative() to convert artwork in such a way that the resulting art does not contain self-intersecting paths.

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIFOConversionSuite and kAIFOConversionVersion.

---

Member Data Documentation

AIAPI AIErr(* AIFOConversionSuite::ConvertToNative)(AIArtHandle art, AIFOConversionOptions *options, ai::int16 paintOrder, AIArtHandle prep)

Creates native Illustrator art objects by drawing a source art object to a conversion port.

The source art can be any type; however, clipping objects (such as clip paths, clipping text, or clipping legacy text) have no marking commands, so nothing is drawn.

Parameters:

	art	The source art object. This object is not deleted.
	options	Drawing options for the operation.
	paintOrder	The position for the new artwork in the paint order, relative to the prep object. See AITypes::AIPaintOrder.
	prep	The prepositional art object.

See also:

AIArtSuite::NewArt() for paint order details.
AILegacyTextConversionSuite for converting legacy text clips to native clips.

AIAPI AIErr(* AIFOConversionSuite::EnumerateContents)(AIArtHandle art, AIVisitContentProc visitor, void *data)

Enumerates information about the contents of an art object needed in order to draw it, passing it to a callback along with developer-defined data.

Parameters:

	art	The art object.
	visitor	The callback procedure.
	data	The developer-defined data to pass to the callback.

Note:

If client is interested in only some of the types of information from AIFOContentInfoSelector (not all), then caling EnumerateContentsEx() with appropriate flags is recommended for better performance.

See also:

EnumerateContentsEx().

AIAPI AIErr(* AIFOConversionSuite::EnumerateContentsEx)(AIArtHandle art, AIVisitContentProc visitor, AIFOContentInfoSelectorFlag flags, void *data)

Enumerates only the requested information required to draw the contents of the art object.

Pass on this information to a callback along with the developer-defined data.

Parameters:

	art	The art object.
	visitor	The callback procedure.
	flags	The type of information that the callback procedure needs to receive, a logical OR of AIFOContentInfoSelectorFlag values.
	data	The developer-defined data for the callback.

AIAPI AIErr(* AIFOConversionSuite::EnumerateEmbeddedFonts)(AIArtHandle art, AIVisitFontExtendedProc visitor, void *data)

For internal use only.

Enumerates the fonts used to draw an art object, passing them to a callback along with information of whether the font is embedded in PDF or EPSdeveloper-defined data.

Parameters:

	art	The art object.
	visitor	The callback procedure.
	data	The developer-defined data to pass to the callback.

AIAPI AIErr(* AIFOConversionSuite::EnumerateFonts)(AIArtHandle art, AIVisitFontProc visitor, void *data)

Enumerates the fonts used to draw an art object, passing them to a callback along with developer-defined data.

Parameters:

	art	The art object.
	visitor	The callback procedure.
	data	The developer-defined data to pass to the callback.

AIAPI AIErr(* AIFOConversionSuite::GetConversionPort)(AIFOConversionOptions *options, ai::int16 paintOrder, AIArtHandle prep, AIDisplayPortHandle *port)

Retrieves the conversion port that would be used to perform a specific conversion.

For AGM clients only.

Parameters:

	options	Drawing options for the operation.
	paintOrder	The position for the new artwork in the paint order, relative to the prep object. See AITypes::AIPaintOrder.
	prep	The prepositional art object.
	port	[out] A buffer in which to return the port. Caller must release with ReleaseConversionPort()

AIAPI AIErr(* AIFOConversionSuite::OutlineLegacyText)(AIArtHandle art, ai::int16 paintOrder, AIArtHandle prep)

Converts a legacy text object to outlines.

Attempts to perform the conversion in a way such that the result is identical with the result in the legacy application version. This is intended for use by plug-in groups or Live Effects that need to be executed against the legacy text. It ensures that the execution results are the same as that of the legacy version.

Parameters:

	art	The art object.
	paintOrder	The position for the new artwork in the paint order, relative to the prep object. See AITypes::AIPaintOrder.
	prep	The prepositional art object.

See also:

kAIFOConversionSuppressAttributes flag on application to object-level attributes.

AIAPI AIErr(* AIFOConversionSuite::ReleaseConversionPort)(AIDisplayPortHandle port)

Releases a conversion port.

For AGM clients only.

Parameters:

port

The port returned by GetConversionPort()

---

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

• AIFOConversion.h