AIGeometry.h File Reference

#include "AIArt.h"
#include "AIPathStyle.h"
#include "AIRaster.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AIGeometryOrganizationProcs
	Passed as a pointer to a list of organization types with associated begin/end procedures. More...
struct	AIGeometryConstructionProcs
	Callbacks that get information about how paths are constructed. More...
struct	AIGeometryPaintingProcs
	Callbacks that get information about how objects are painted. More...
struct	AIGeometryStateProcs
	Callbacks that get information about painting options. More...
struct	AIGeometrySuite
	This suite provides an iteration mechanism for collecting information about the art objects in the various kinds of artwork trees. More...
Defines
#define	kAIGeometrySuite "AI Geometry Suite"
#define	kAIGeometryVersion6 AIAPI_VERSION(6)
#define	kAIGeometrySuiteVersion kAIGeometryVersion6
#define	kCancelledErr kCanceledErr
#define	kFormatErr 'FRM!'
Typedefs
typedef void *	AIGeometryUserData
	Developer-defined data for geometry callbacks.
typedef ai::int16(*	AIGeometryBeginProc )(AIGeometryUserData userData, AIArtHandle object)
	Callback prototype for `AIGeometryOrganizationProcs`.
typedef ai::int16(*	AIGeometryEndProc )(AIGeometryUserData userData, AIArtHandle object)
	Callback prototype for `AIGeometryOrganizationProcs`.
typedef ai::int16(*	AIGeometryMoveToProc )(AIGeometryUserData userData, AIRealPoint *p)
	Callback prototype for `AIGeometryConstructionProcs`.
typedef ai::int16(*	AIGeometryLineToProc )(AIGeometryUserData userData, AIRealPoint *p)
	Callback prototype for `AIGeometryConstructionProcs`.
typedef ai::int16(*	AIGeometryCurveToProc )(AIGeometryUserData userData, AIRealPoint p1, AIRealPoint p2, AIRealPoint *p3)
	Callback prototype for `AIGeometryConstructionProcs`.
typedef ai::int16(*	AIGeometryClosePathProc )(AIGeometryUserData userData)
	Callback prototype for `AIGeometryConstructionProcs`.
typedef ai::int16(*	AIGeometryFillProc )(AIGeometryUserData userData)
	Callback prototype for `AIGeometryPaintingProcs`.
typedef ai::int16(*	AIGeometryStrokeProc )(AIGeometryUserData userData)
	Callback prototype for `AIGeometryPaintingProcs`.
typedef ai::int16(*	AIGeometryClipProc )(AIGeometryUserData userData)
	Callback prototype for `AIGeometryPaintingProcs`.
typedef ai::int16(*	AIGeometryImageProc )(AIGeometryUserData userData, AIArtHandle raster)
	Callback prototype for `AIGeometryPaintingProcs`.
typedef ai::int16(*	AIGeometryImageMaskProc )(AIGeometryUserData userData, AIArtHandle raster)
	Callback prototype for `AIGeometryPaintingProcs`.
typedef ai::int16(*	AIGeometrySetGrayProc )(AIGeometryUserData userData, AIReal gray)
	Callback prototype for `AIGeometryStateProcs`.
typedef ai::int16(*	AIGeometrySetCMYKColorProc )(AIGeometryUserData userData, AIReal cyan, AIReal magenta, AIReal yellow, AIReal black)
	Callback prototype for `AIGeometryStateProcs`.
typedef ai::int16(*	AIGeometrySetRGBColorProc )(AIGeometryUserData userData, AIReal red, AIReal green, AIReal blue)
	Callback prototype for `AIGeometryStateProcs`.
typedef ai::int16(*	AIGeometrySetAlphaProc )(AIGeometryUserData userData, AIReal alpha)
	Callback prototype for `AIGeometryStateProcs`.
typedef ai::int16(*	AIGeometrySetCustomColorProc )(AIGeometryUserData userData, AICustomColorHandle customColor, AIReal tint)
	Callback prototype for `AIGeometryStateProcs`.
typedef ai::int16(*	AIGeometrySetGradientColorProc )(AIGeometryUserData userData, AIGradientHandle gradient, AIRealPoint gradientOrigin, AIReal gradientAngle, AIReal gradientLength, AIReal hiliteAngle, AIReal hiliteLength, AIRealMatrix matrix)
	Callback prototype for `AIGeometryStateProcs`.
typedef ai::int16(*	AIGeometrySetPatternColorProc )(AIGeometryUserData userData, AIPatternHandle pattern, AIReal shiftDistance, AIReal shiftAngle, AIRealPoint scale, AIReal rotateAngle, AIBoolean reflect, AIReal reflectAngle, AIReal shearAngle, AIReal shearAxis, AIRealMatrix matrix)
	Callback prototype for `AIGeometryStateProcs`.
typedef ai::int16(*	AIGeometryImageCallback )(AIGeometryUserData userData, AIArtHandle raster, AISlice artSlice, AITile workTile, AISlice *workSlice)
	Callback prototype for `AIGeometryStateProcs`.
typedef ai::int16(*	AIGeometrySetLineWidthProc )(AIGeometryUserData userData, AIReal lineWidth)
	Callback prototype for `AIGeometryStateProcs`.
typedef ai::int16(*	AIGeometrySetLineCapProc )(AIGeometryUserData userData, AILineCap lineCap)
	Callback prototype for `AIGeometryStateProcs`.
typedef ai::int16(*	AIGeometrySetLineJoinProc )(AIGeometryUserData userData, AILineJoin lineJoin)
	Callback prototype for `AIGeometryStateProcs`.
typedef ai::int16(*	AIGeometrySetMiterLimitProc )(AIGeometryUserData userData, AIReal miterLimit)
	Callback prototype for `AIGeometryStateProcs`.
typedef ai::int16(*	AIGeometrySetDashProc )(AIGeometryUserData userData, AIReal offset, ai::int16 length, AIReal array[])
	Callback prototype for `AIGeometryStateProcs`.
Enumerations
enum	AIGeometryOrganizationType { kAIGeometryOrganizeNull = 0, kAIGeometryOrganizePath, kAIGeometryOrganizeGroup, kAIGeometryOrganizeCompound, kAIGeometryOrganizePlaced, kAIGeometryOrganizeRaster, kAIGeometryOrganizeText, kAIGeometryOrganizeTextPath, kAIGeometryOrganizeTextLine, kAIGeometryOrganizeClipGroup, kAIGeometryOrganizeMask, kAIGeometryOrganizeMesh, kAIGeometryOrganizeSymbol, kAIGeometryOrganizeForeignObject, kAIGeometryOrganizeLegacyText, kAIGeometryOrganizeChart, kAIGeometryOrganizePluginArt, kAIGeometryOrganizeGraph, kAIGeometryOrganizeRepeat, kAIGeometryOrganizeDummy = 0xFFFFFFFF }
	Types of art objects that can be enumerated to `AIGeometryOrganizationProcs`. More...

Detailed Description

Define Documentation

#define kAIGeometrySuite "AI Geometry Suite"

#define kAIGeometrySuiteVersion kAIGeometryVersion6

#define kAIGeometryVersion6 AIAPI_VERSION(6)

Typedef Documentation

typedef ai::int16(* AIGeometryBeginProc)(AIGeometryUserData userData, AIArtHandle object)

Callback prototype for AIGeometryOrganizationProcs.

Called before enumeration begins for an object of an associated AIGeometryOrganizationType. See AIGeometrySuite

Parameters:

	userData	Developer-defined data.
	object	The art object to be enumerated.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

typedef ai::int16(* AIGeometryClipProc)(AIGeometryUserData userData)

Callback prototype for AIGeometryPaintingProcs.

Called to describe the clipping of an element of the art tree being iterated. See AIGeometrySuite

Parameters:

userData

Developer-defined data.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

typedef ai::int16(* AIGeometryClosePathProc)(AIGeometryUserData userData)

Callback prototype for AIGeometryConstructionProcs.

Called to describe each path or outline within an element of the art tree being iterated. See AIGeometrySuite

Parameters:

userData

Developer-defined data.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

typedef ai::int16(* AIGeometryCurveToProc)(AIGeometryUserData userData, AIRealPoint *p1, AIRealPoint *p2, AIRealPoint *p3)

Callback prototype for AIGeometryConstructionProcs.

Called to describe each path or outline within an element of the art tree being iterated. See AIGeometrySuite

Parameters:

	userData	Developer-defined data.
	p1	The first curve point.
	p2	The second curve point.
	p3	The third curve point.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

typedef ai::int16(* AIGeometryEndProc)(AIGeometryUserData userData, AIArtHandle object)

Callback prototype for AIGeometryOrganizationProcs.

Called after enumeration ends or is halted by a 1 result for an object of an associated AIGeometryOrganizationType. See AIGeometrySuite

Parameters:

	userData	Developer-defined data.
	object	The art object that was enumerated.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

typedef ai::int16(* AIGeometryFillProc)(AIGeometryUserData userData)

Callback prototype for AIGeometryPaintingProcs.

Called to describe the fill of an element of the art tree being iterated. See AIGeometrySuite

Parameters:

userData

Developer-defined data.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

typedef ai::int16(* AIGeometryImageCallback)(AIGeometryUserData userData, AIArtHandle raster, AISlice *artSlice, AITile *workTile, AISlice *workSlice)

Callback prototype for AIGeometryStateProcs.

Called when an outline within the art tree being iterated is filled with an image. See AIGeometrySuite

Parameters:

	userData	Developer-defined data.
	alpha	The alpha channel value.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

typedef ai::int16(* AIGeometryImageMaskProc)(AIGeometryUserData userData, AIArtHandle raster)

Callback prototype for AIGeometryPaintingProcs.

Called when an outline within the art tree being iterated is filled with an image. See AIGeometrySuite

Parameters:

	userData	Developer-defined data.
	raster	The image mask object.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

typedef ai::int16(* AIGeometryImageProc)(AIGeometryUserData userData, AIArtHandle raster)

Callback prototype for AIGeometryPaintingProcs.

Called when an outline within the art tree being iterated is filled with an image. See AIGeometrySuite

Parameters:

	userData	Developer-defined data.
	raster	The image object.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

typedef ai::int16(* AIGeometryLineToProc)(AIGeometryUserData userData, AIRealPoint *p)

Callback prototype for AIGeometryConstructionProcs.

Called to describe each path or outline within an element of the art tree being iterated. See AIGeometrySuite

Parameters:

	userData	Developer-defined data.
	p	The destination location of the line draw.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

typedef ai::int16(* AIGeometryMoveToProc)(AIGeometryUserData userData, AIRealPoint *p)

Callback prototype for AIGeometryConstructionProcs.

Called to describe paths and outlines within a shape. See AIGeometrySuite

Parameters:

	userData	Developer-defined data.
	p	The destination location of the move.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

typedef ai::int16(* AIGeometrySetAlphaProc)(AIGeometryUserData userData, AIReal alpha)

Callback prototype for AIGeometryStateProcs.

Called for the fill and stroke of each element within the art tree being iterated. See AIGeometrySuite

Parameters:

	userData	Developer-defined data.
	alpha	The alpha channel value.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

typedef ai::int16(* AIGeometrySetCMYKColorProc)(AIGeometryUserData userData, AIReal cyan, AIReal magenta, AIReal yellow, AIReal black)

Callback prototype for AIGeometryStateProcs.

Called for the fill and stroke of each element within the art tree being iterated. See AIGeometrySuite

Parameters:

	userData	Developer-defined data.
	cyan	The CMYK cyan value.
	magenta	The CMYK magenta value.
	yellow	The CMYK yellow value.
	black	The CMYK black value.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

typedef ai::int16(* AIGeometrySetCustomColorProc)(AIGeometryUserData userData, AICustomColorHandle customColor, AIReal tint)

Callback prototype for AIGeometryStateProcs.

Called for the fill and stroke of each element within the art tree being iterated. See AIGeometrySuite

Parameters:

	userData	Developer-defined data.
	customColor	The custom color.
	tint	The amount of the color, a percentage in the range [0..1].

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

typedef ai::int16(* AIGeometrySetDashProc)(AIGeometryUserData userData, AIReal offset, ai::int16 length, AIReal array[])

Callback prototype for AIGeometryStateProcs.

Called for the stroke of each element within the art tree being iterated. See AIGeometrySuite

Parameters:

	userData	Developer-defined data.
	offset	The dash offset value.
	length	The number of dash values.
	array	The array of dash values.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

typedef ai::int16(* AIGeometrySetGradientColorProc)(AIGeometryUserData userData, AIGradientHandle gradient, AIRealPoint *gradientOrigin, AIReal gradientAngle, AIReal gradientLength, AIReal hiliteAngle, AIReal hiliteLength, AIRealMatrix *matrix)

Callback prototype for AIGeometryStateProcs.

Called for the fill and stroke of each element within the art tree being iterated. See AIGeometrySuite

Parameters:

	userData	Developer-defined data.
	gradient	The gradient object.
	gradientOrigin	The origin point.
	gradientAngle	The angle.
	gradientLength	The length.
	hiliteAngle	The highlight angle.
	hiliteLength	The highlight length.
	matrix	The transformation matrix.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

See also:: AIGradientStyle

typedef ai::int16(* AIGeometrySetGrayProc)(AIGeometryUserData userData, AIReal gray)

Callback prototype for AIGeometryStateProcs.

Called for the fill and stroke of each element within the art tree being iterated. See AIGeometrySuite

Parameters:

	userData	Developer-defined data.
	gray	The grayscale value.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

typedef ai::int16(* AIGeometrySetLineCapProc)(AIGeometryUserData userData, AILineCap lineCap)

Callback prototype for AIGeometryStateProcs.

Called for the stroke of each element within the art tree being iterated. See AIGeometrySuite

Parameters:

	userData	Developer-defined data.
	lineCap	The line cap value.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

typedef ai::int16(* AIGeometrySetLineJoinProc)(AIGeometryUserData userData, AILineJoin lineJoin)

Callback prototype for AIGeometryStateProcs.

Called for the stroke of each element within the art tree being iterated. See AIGeometrySuite

Parameters:

	userData	Developer-defined data.
	lineJoin	The line join value.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

typedef ai::int16(* AIGeometrySetLineWidthProc)(AIGeometryUserData userData, AIReal lineWidth)

Callback prototype for AIGeometryStateProcs.

Called for the stroke of each element within the art tree being iterated. See AIGeometrySuite

Parameters:

	userData	Developer-defined data.
	lineWidth	The line width value.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

typedef ai::int16(* AIGeometrySetMiterLimitProc)(AIGeometryUserData userData, AIReal miterLimit)

Callback prototype for AIGeometryStateProcs.

Called for the stroke of each element within the art tree being iterated. See AIGeometrySuite

Parameters:

	userData	Developer-defined data.
	miterLimit	The miter limit value.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

typedef ai::int16(* AIGeometrySetPatternColorProc)(AIGeometryUserData userData, AIPatternHandle pattern, AIReal shiftDistance, AIReal shiftAngle, AIRealPoint *scale, AIReal rotateAngle, AIBoolean reflect, AIReal reflectAngle, AIReal shearAngle, AIReal shearAxis, AIRealMatrix *matrix)

Callback prototype for AIGeometryStateProcs.

Called for the fill and stroke of each element within the art tree being iterated. See AIGeometrySuite

Parameters:

	userData	Developer-defined data.
	pattern	The pattern object.
	shiftDistance	Pattern style value.
	shiftAngle	Pattern style value.
	scale	Pattern style value.
	rotateAngle	Pattern style value.
	reflect	Pattern style value.
	reflectAngle	Pattern style value.
	shearAngle	Pattern style value.
	shearAxis	Pattern style value.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

See also:: AIPatternStyle

typedef ai::int16(* AIGeometrySetRGBColorProc)(AIGeometryUserData userData, AIReal red, AIReal green, AIReal blue)

Callback prototype for AIGeometryStateProcs.

Called for the fill and stroke of each element within the art tree being iterated. See AIGeometrySuite

Parameters:

	userData	Developer-defined data.
	red	The RGB red value.
	green	The RGB green value.
	blue	The RGB blue value.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

typedef ai::int16(* AIGeometryStrokeProc)(AIGeometryUserData userData)

Callback prototype for AIGeometryPaintingProcs.

Called to describe the strokes of an element of the art tree being iterated. See AIGeometrySuite

Parameters:

userData

Developer-defined data.

Returns:: 0 for enumeration to continue, 1 to halt enumeration.

typedef void* AIGeometryUserData

Developer-defined data for geometry callbacks.

See AIGeometrySuite

Enumeration Type Documentation

enum AIGeometryOrganizationType

Types of art objects that can be enumerated to AIGeometryOrganizationProcs.

These correspond to AIArtType values for objects. See AIGeometrySuite

Enumerator:

kAIGeometryOrganizeNull	Marks the end of an object enumeration.
kAIGeometryOrganizePath	A path object.
kAIGeometryOrganizeGroup	A group object.
kAIGeometryOrganizeCompound	A compound object.
kAIGeometryOrganizePlaced	A placed object.
kAIGeometryOrganizeRaster	A raster object.
kAIGeometryOrganizeText	A text frame object. (As of AI11 the text organization callbacks are called for each text frame.)
kAIGeometryOrganizeTextPath	A text path object. (As of AI11 this is called if the text frame has a confining path--that is, it is area text or text on a path).
kAIGeometryOrganizeTextLine	A text line object. (Obsolete, not invoked by AI11 or later.)
kAIGeometryOrganizeClipGroup	A clipping group object.
kAIGeometryOrganizeMask	A mask object.
kAIGeometryOrganizeMesh	A mesh object.
kAIGeometryOrganizeSymbol	A symbol object.
kAIGeometryOrganizeForeignObject	A foreign object. Note: AI11 and later.
kAIGeometryOrganizeLegacyText	A legacy text object. Note: AI11 and later.
kAIGeometryOrganizeChart	A chart object.
kAIGeometryOrganizePluginArt	A Plugin Art Object. Note: AI19.2 and later
kAIGeometryOrganizeGraph	A Graph Object.
kAIGeometryOrganizeRepeat	A repeat object.
kAIGeometryOrganizeDummy	Internal.

AIGeometry.h File Reference

Classes

Defines

Typedefs

Enumerations

Detailed Description

Define Documentation

Typedef Documentation

Enumeration Type Documentation