AIRasterizeSuite Struct Reference
[API Suite List]

This suite provides functions that allow you to convert any art set (see AIArtSetSuite) into a single image, represented by a standard raster art object (an art object of type kRasterArt). More...

#include <AIRasterize.h>

List of all members.

Public Attributes
AIAPI AIErr(*	ComputeArtBounds )(AIArtSet artSet, AIRealRect *artBounds, AIBoolean honorCropBox)
	Retrieves the bounds for an entire art set.
AIAPI AIErr(*	Rasterize )(AIArtSet artSet, AIRasterizeSettings *settings, AIRealRect *artBounds, short paintOrder, AIArtHandle prepArt, AIArtHandle *raster, AIRasterizeProgressProc progressProc)
	Creates a raster art object from an art set.
AIAPI AIErr(*	CreateMask )(AIArtSet artSet, short paintOrder, AIArtHandle rasterArt, AIArtHandle *maskGroup)
	Creates a clipping mask from the result of rasterization of an art set.
AIAPI AIErr(*	RasterizeWithPadding )(AIArtSet artSet, AIRasterizeSettings *settings, AIRealRect *artBounds, short paintOrder, AIArtHandle prepArt, AIArtHandle *raster, AIRasterizeProgressProc progressProc, AIReal padding)
	Creates a raster art object from an art set, adding padding in both the horizontal and vertical dimensions.
AIAPI AIErr(*	RasterizeDocument )(AIRasterizeSettings *settings, short paintOrder, AIArtHandle prepArt, AIArtHandle *raster, AIRasterizeProgressProc progressProc, ai::int32 options)
	Creates a raster art object from all of the art in the current document.
AIAPI AIErr(*	ImageResample )(AIArtHandle rasterArt, const AIResamplingType flag, const AIReal resolution, const short paintOrder, AIArtHandle prepArt, AIArtHandle *newRasterArt)
	Creates a new raster object by downsampling an existing raster object.
AIAPI AIErr(*	CheckSpotColorPreservation )(AIArtSet artSet, AIBoolean *canPreserveSpotColor)
	Reports whether rasterization can preserve spot colors for an art set.
AIAPI void(*	SnapRasterRectToPixelGrid )(AIRealRect &rect, AIReal ppi)

---

Detailed Description

This suite provides functions that allow you to convert any art set (see AIArtSetSuite) into a single image, represented by a standard raster art object (an art object of type kRasterArt).

You can specify the bounds of rasterization, the destination color space, the image resolution, and whether the image will be anti-aliased.

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIRasterizeSuite and kAIRasterizeSuiteVersion.

---

Member Data Documentation

AIAPI AIErr(* AIRasterizeSuite::CheckSpotColorPreservation)(AIArtSet artSet, AIBoolean *canPreserveSpotColor)

Reports whether rasterization can preserve spot colors for an art set.

Parameters:

	artSet	The art set object.
	canPreserveSpotColor	[out] A buffer in which to return true if spot colors can be preserved.

AIAPI AIErr(* AIRasterizeSuite::ComputeArtBounds)(AIArtSet artSet, AIRealRect *artBounds, AIBoolean honorCropBox)

Retrieves the bounds for an entire art set.

Parameters:

	artSet	The art set object.
	artBounds	[out] A buffer in which to return the bounding rectangle.
	honorCropBox	When true, and if cropping has been set, artBounds returns the crop box for the art. If false, or if no crop box has been set, artBounds returns the entire bounding box.

AIAPI AIErr(* AIRasterizeSuite::CreateMask)(AIArtSet artSet, short paintOrder, AIArtHandle rasterArt, AIArtHandle *maskGroup)

Creates a clipping mask from the result of rasterization of an art set.

The function creates a clip group, places it in a new mask group, and returns the mask group. The clip group contains a union of all art objects in the art set, and an additional raster art object. This is the same as setting "Create Clipping Mask" when using the Object > Rasterize menu command.

Parameters:

	artSet	The art set object. The function disposes of the art objects contained in this set, but does not dispose off this variable.
	paintOrder	The paint order, which determines how the new mask group is placed relative to the raster art. Must be kPlaceAbove or kPlaceBelow.
	rasterArt	A raster art object to be included in the clip group. The result of a call to Rasterize() on the supplied art set.
	maskGroup	[out] A buffer in which to return the new mask object.

AIAPI AIErr(* AIRasterizeSuite::ImageResample)(AIArtHandle rasterArt, const AIResamplingType flag, const AIReal resolution, const short paintOrder, AIArtHandle prepArt, AIArtHandle *newRasterArt)

Creates a new raster object by downsampling an existing raster object.

Parameters:

	rasterArt	The raster art object.
	flag	The type of sampling to perform, trading off speed and quality.
	resolution	The resolution for the resulting image, in dots-per-inch (dpi) or equivalently displayed as pixels-per-inch (ppi) in the UI.
	paintOrder	The paint order, relative to the prep object, for the placement of the new object, an AITypes::AIPaintOrder value.
	prep	The prepositional art object for the paint order.
	newRasterArt	[out] A buffer in which to return the new raster art object.

AIAPI AIErr(* AIRasterizeSuite::Rasterize)(AIArtSet artSet, AIRasterizeSettings *settings, AIRealRect *artBounds, short paintOrder, AIArtHandle prepArt, AIArtHandle *raster, AIRasterizeProgressProc progressProc)

Creates a raster art object from an art set.

Parameters:

	artSet	The art set object.
	settings	Settings that describe the type of raster desired, resolution, amount of anti-aliasing, and other options.
	artBounds	The bounding rectangle for the art to rasterize, which can be the one returned by ComputeArtBounds().
	paintOrder	The paint order, relative to the prep object, for the placement of the new object, an AITypes::AIPaintOrder value.
	prep	The prepositional art object for the paint order.
	raster	[out] A buffer in which to return the new raster art object.
	progressProc	A callback function that presents a progress dialog during a lengthy operation.

AIAPI AIErr(* AIRasterizeSuite::RasterizeDocument)(AIRasterizeSettings *settings, short paintOrder, AIArtHandle prepArt, AIArtHandle *raster, AIRasterizeProgressProc progressProc, ai::int32 options)

Creates a raster art object from all of the art in the current document.

Parameters:

	settings	Settings that describe the type of raster desired, resolution, amount of anti-aliasing and other options.
	artBounds	The bounding rectangle for the art to rasterize, which can be the one returned by ComputeArtBounds().
	paintOrder	The paint order, relative to the prep object, for the placement of the new object, an AITypes::AIPaintOrder value.
	prep	The prepositional art object for the paint order.
	raster	[out] A buffer in which to return the new raster art object.
	progressProc	A callback function that presents a progress dialog during a lengthy operation.
	options	A set of option flags that control how the rasterization is performed. A logical OR of AIRasterizeOptions.

AIAPI AIErr(* AIRasterizeSuite::RasterizeWithPadding)(AIArtSet artSet, AIRasterizeSettings *settings, AIRealRect *artBounds, short paintOrder, AIArtHandle prepArt, AIArtHandle *raster, AIRasterizeProgressProc progressProc, AIReal padding)

Creates a raster art object from an art set, adding padding in both the horizontal and vertical dimensions.

Parameters:

	artSet	The art set object.
	settings	Settings that describe the type of raster desired, resolution, amount of anti-aliasing, and other options. If the setting specify an alpha channel, the padding pixels are fully transparent. Otherwise, they are white.
	artBounds	The bounding rectangle for the art to rasterize, which can be the one returned by ComputeArtBounds().
	paintOrder	The paint order, relative to the prep object, for the placement of the new object, an AITypes::AIPaintOrder value.
	prep	The prepositional art object for the paint order.
	raster	[out] A buffer in which to return the new raster art object.
	progressProc	A callback function that presents a progress dialog during a lengthy operation.
	padding	The amount of padding to add to the resulting raster image, a number of document points.

AIAPI void(* AIRasterizeSuite::SnapRasterRectToPixelGrid)(AIRealRect &rect, AIReal ppi)

---

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

• AIRasterize.h