AIVectorizeSuite Struct Reference
[API Suite List]

This suite gives you access to the object model for the tracing art type, a plug-in group containing:. More...

#include <AIVectorize.h>

Public Attributes
AIAPI AIErr(*	CreateTracing )(ai::int16 paintOrder, AIArtHandle prep, AIArtHandle art, AIArtHandle *tracing)
	Creates a tracing group whose source art is the specified raster or foreign object art.
AIAPI AIBoolean(*	IsTracing )(AIArtHandle tracing)
	Reports whether an art object is a tracing group.
AIAPI AIErr(*	GetSourceImage )(AIArtHandle tracing, AIArtHandle *raster)
	Retrieves the source art of a tracing group.
AIAPI AIErr(*	CopyTracingArt )(AIArtHandle tracing, ai::int16 paintOrder, AIArtHandle prep, AIArtHandle *art, AIBool8 copyAsViewed)
	Copies the tracing result art of a tracing group into the current document.
AIAPI AIErr(*	AcquireTracingOptions )(AIArtHandle tracing, AIDictionaryRef *options)
	Retrieves the tracing options dictionary of a tracing group.
AIAPI AIErr(*	AcquireTracingStatistics )(AIArtHandle tracing, AIDictionaryRef *options)
	Retrieves the tracing statistics dictionary of a tracing group.
AIAPI AIErr(*	EmbedSwatches )(AIArtHandle tracing)
	Embeds swatches in the tracing result.
AIAPI AIErr(*	Update )(AIArtHandle tracing)
	Creates the tracing result from the source art of a tracing group.
AIAPI AIErr(*	GetNativeResolution )(AIArtHandle art, AIReal *dpi)
	Retrieves the native resolution (if any) of an art object.
AIAPI AIErr(*	GetEffectiveResolution )(AIArtHandle art, AIReal *dpi)
	Retrieves the effective resolution of a tracing object.
AIAPI AIErr(*	SetSourceArtChanged )(AIArtHandle tracing, AIBoolean changed)
	Marks or unmarks a tracing art object as changed.

Detailed Description

This suite gives you access to the object model for the tracing art type, a plug-in group containing:.

A source image.
A posterized/preprocessed version of the source image, called the tracing result or result group.
The options used for tracing.
The internal tracing state kept by the vectorization engine.
The view options that determine which elements of the group to display during update.

A tracing preset is a named collection of state information that can be used to recreate a commonly used tracing configuration. It includes parameters specific to the various tracing tasks such as color tracing, black and white tracing, high resolution tracing, low resolution tracing, and so on.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIVectorizeSuite and kAIVectorizeVersion.

Member Data Documentation

AIAPI AIErr(* AIVectorizeSuite::AcquireTracingOptions)(AIArtHandle tracing, AIDictionaryRef *options)

Retrieves the tracing options dictionary of a tracing group.

Parameters:

	tracing	The tracing group object.
	options	[out] A buffer in which to return the options dictionary. This is a counted object (see `AICountedObject.h`). Use the `Ref` class to access it. See `IAIRef.h`.

See also:: kTracingOptionsKey

AIAPI AIErr(* AIVectorizeSuite::AcquireTracingStatistics)(AIArtHandle tracing, AIDictionaryRef *options)

Retrieves the tracing statistics dictionary of a tracing group.

This is a read-only dictionary.

Parameters:

	tracing	The tracing group object.
	options	[out] A buffer in which to return the statistics dictionary. This is a counted object (see `AICountedObject.h`). Use the `Ref` class to access it. See `IAIRef.h`.

See also:: kTracingStatisticsKey

AIAPI AIErr(* AIVectorizeSuite::CopyTracingArt)(AIArtHandle tracing, ai::int16 paintOrder, AIArtHandle prep, AIArtHandle *art, AIBool8 copyAsViewed)

Copies the tracing result art of a tracing group into the current document.

Parameters:

	tracing	The tracing group object.
	paintOrder	The paint order, relative to the `prep` object. See `AITypes::AIPaintOrder`.
	prep	The prepositional art object for the paint order.
	art	[out] A buffer in which to return the copied result group.
	copyAsViewed	True to copy the tracing result as viewed; that is, maintaining the visual appearance of viewing modes currently in effect. False to copy as if in the Show-No-Image/Show-Tracing-Result mode.

AIAPI AIErr(* AIVectorizeSuite::CreateTracing)(ai::int16 paintOrder, AIArtHandle prep, AIArtHandle art, AIArtHandle *tracing)

Creates a tracing group whose source art is the specified raster or foreign object art.

Use Update() to create the result group.

Parameters:

	paintOrder	The paint order, relative to the `prep` object. See `AITypes::AIPaintOrder`.
	prep	The prepositional art object for the paint order.
	art	A raster art object or a foreign object.
	tracing	[out] A buffer in which to return the tracing plug-in group

AIAPI AIErr(* AIVectorizeSuite::EmbedSwatches)(AIArtHandle tracing)

Embeds swatches in the tracing result.

Call after changing the kTracingPaletteKey option value.

Parameters:

tracing

The tracing group object.

AIAPI AIErr(* AIVectorizeSuite::GetEffectiveResolution)(AIArtHandle art, AIReal *dpi)

Retrieves the effective resolution of a tracing object.

Parameters:

art

The tracing art object.

dpi

[out] A buffer in which to return:

The resampling DPI if resampling is turned on
The effective resolution in DPI if strictly uniform scaling has been applied to the source art.
The average of x/y DPI if non-uniform scaling has been applied.

AIAPI AIErr(* AIVectorizeSuite::GetNativeResolution)(AIArtHandle art, AIReal *dpi)

Retrieves the native resolution (if any) of an art object.

Parameters:

	art	The art object, typically a tracing group, raster, or foreign object.
	dpi	[out] A buffer in which to return the native resolution in DPI, if strictly uniform scaling has been applied to the source art. or 0 if no native resolution is available.