AIGradient.h File Reference

#include "AITypes.h"
#include "AIArt.h"
#include "AIColor.h"
#include "AIPathStyle.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AIGradientProcs
	Callback functions for `AIGradientSuite::IterateGradient()`. More...
struct	AIGradientSuite
	This suite provides the basic definition of the gradient, a graduated blend between two or more colors. More...
Defines
#define	kAIGradientSuite "AI Gradient Suite"
	Gradient suite name.
#define	kAIGradientSuiteVersion9 AIAPI_VERSION(9)
	Gradient suite version.
#define	kAIGradientSuiteVersion kAIGradientSuiteVersion9
	Gradient suite version.
#define	kAIGradientVersion kAIGradientSuiteVersion
	Gradient suite version.
#define	kAIArtGradientChangedNotifier "AI Art Gradient Changed Notifier"
	Sent when a gradient (blend) has changed.
#define	kMaxSpotChannelsExceededErr 'xSPT'
#define	CallAIGradientSetGrayProc(userRoutine, g) (*(userRoutine))((g))
	A convenience macro for the `AIGradientProcs::setGray` iteration callback.
#define	NewAIGradientSetGrayProc(userRoutine) (AIGradientSetGrayUPP)(userRoutine)
	A convenience macro for the `AIGradientProcs::setGray` iteration callback.
#define	CallAIGradientSetCMYKProc(userRoutine, c, m, y, k) (*(userRoutine))((c), (m), (y), (k))
	A convenience macro for the `AIGradientProcs::setCMYK` iteration callback.
#define	NewAIGradientSetCMYKProc(userRoutine) (AIGradientSetCMYKUPP)(userRoutine)
	A convenience macro for the `AIGradientProcs::setCMYK` iteration callback.
#define	CallAIGradientSetColorProc(userRoutine, c) (*(userRoutine))((c))
	A convenience macro for the `AIGradientProcs::setColor` iteration callback.
#define	NewAIGradientSetColorProc(userRoutine) (AIGradientSetColorUPP)(userRoutine)
	A convenience macro for the `AIGradientProcs::setColor` iteration callback.
#define	CallAIGradientBeginFillProc(userRoutine) (*(userRoutine))()
	A convenience macro for the `AIGradientProcs::beginFill` iteration callback.
#define	NewAIGradientBeginFillProc(userRoutine) (AIGradientBeginFillUPP)(userRoutine)
	A convenience macro for the `AIGradientProcs::beginFill` iteration callback.
#define	CallAIGradientEndFillProc(userRoutine) (*(userRoutine))()
	A convenience macro for the `AIGradientProcs::endFill` iteration callback.
#define	NewAIGradientEndFillProc(userRoutine) (AIGradientEndFillUPP)(userRoutine)
	A convenience macro for the `AIGradientProcs::endFill` iteration callback.
#define	CallAIGradientMoveToProc(userRoutine, x, y) (*(userRoutine))((x), (y))
	A convenience macro for the `AIGradientProcs::moveTo` iteration callback.
#define	NewAIGradientMoveToProc(userRoutine) (AIGradientMoveToUPP)(userRoutine)
	A convenience macro for the `AIGradientProcs::moveTo` iteration callback.
#define	CallAIGradientLineToProc(userRoutine, x, y) (*(userRoutine))((x), (y))
	A convenience macro for the `AIGradientProcs::lineTo` iteration callback.
#define	NewAIGradientLineToProc(userRoutine) (AIGradientLineToUPP)(userRoutine)
	A convenience macro for the `AIGradientProcs::lineTo` iteration callback.
#define	CallAIGradientCurveToProc(userRoutine, x1, y1, x2, y2, x3, y3) (*(userRoutine))((x1), (y1), (x2), (y2), (x3), (y3))
	A convenience macro for the `AIGradientProcs::curveTo` iteration callback.
#define	NewAIGradientCurveToProc(userRoutine) (AIGradientCurveToUPP)(userRoutine)
	A convenience macro for the `AIGradientProcs::curveTo` iteration callback.
Typedefs
typedef void(*	AIGradientSetGrayProcPtr )(AIReal g)
	Prototype for `setGray` callback; see `AIGradientSuite::IterateGradient()`.
typedef AIGradientSetGrayProcPtr	AIGradientSetGrayUPP
	Value type for the `AIGradientProcs::setGray` iteration callback.
typedef void(*	AIGradientSetCMYKProcPtr )(AIReal c, AIReal m, AIReal y, AIReal k)
	Prototype for `AIGradientProcs::setCMYK` callback; see `AIGradientSuite::IterateGradient()`.
typedef AIGradientSetCMYKProcPtr	AIGradientSetCMYKUPP
	Value type for the `AIGradientProcs::setCMYK` iteration callback.
typedef void(*	AIGradientSetColorProcPtr )(AIColor *c)
	Prototype for `AIGradientProcs::setColor` callback; see `AIGradientSuite::IterateGradient()`.
typedef AIGradientSetColorProcPtr	AIGradientSetColorUPP
	Value type for the `AIGradientProcs::setColor` iteration callback.
typedef void(*	AIGradientBeginFillProcPtr )(void)
	Prototype for `AIGradientProcs::beginFill` callback; see `AIGradientSuite::IterateGradient()`.
typedef AIGradientBeginFillProcPtr	AIGradientBeginFillUPP
	Value type for the `AIGradientProcs::beginFill` iteration callback.
typedef void(*	AIGradientEndFillProcPtr )(void)
	Prototype for `AIGradientProcs::endFill` callback; see `AIGradientSuite::IterateGradient()`.
typedef AIGradientEndFillProcPtr	AIGradientEndFillUPP
	Pointer to `AIGradientEndFillProcPtr` for `endFill` iteration callback.
typedef void(*	AIGradientMoveToProcPtr )(AIReal x, AIReal y)
	Prototype for `AIGradientProcs::moveTo` callback; see `AIGradientSuite::IterateGradient()`.
typedef AIGradientMoveToProcPtr	AIGradientMoveToUPP
	Value type for the `AIGradientProcs::moveTo` iteration callback.
typedef void(*	AIGradientLineToProcPtr )(AIReal x, AIReal y)
	Prototype for the `AIGradientProcs::lineTo` callback; see `AIGradientSuite::IterateGradient()`.
typedef AIGradientLineToProcPtr	AIGradientLineToUPP
	Value type for the `AIGradientProcs::lineTo` iteration callback.
typedef void(*	AIGradientCurveToProcPtr )(AIReal x1, AIReal y1, AIReal x2, AIReal y2, AIReal x3, AIReal y3)
	Prototype for the `AIGradientProcs::curveTo` callback; see `AIGradientSuite::IterateGradient()`.
typedef AIGradientCurveToProcPtr	AIGradientCurveToUPP
	Value type for the `AIGradientProcs::curveTo` iteration callback.

Detailed Description

Define Documentation

#define CallAIGradientBeginFillProc ( userRoutine ) (*(userRoutine))()

A convenience macro for the AIGradientProcs::beginFill iteration callback.

#define CallAIGradientCurveToProc	(	userRoutine,
		x1,
		y1,
		x2,
		y2,
		x3,
		y3	)	(*(userRoutine))((x1), (y1), (x2), (y2), (x3), (y3))

A convenience macro for the AIGradientProcs::curveTo iteration callback.

#define CallAIGradientEndFillProc ( userRoutine ) (*(userRoutine))()

A convenience macro for the AIGradientProcs::endFill iteration callback.

#define CallAIGradientLineToProc	(	userRoutine,
		x,
		y	)	(*(userRoutine))((x), (y))

A convenience macro for the AIGradientProcs::lineTo iteration callback.

#define CallAIGradientMoveToProc	(	userRoutine,
		x,
		y	)	(*(userRoutine))((x), (y))

A convenience macro for the AIGradientProcs::moveTo iteration callback.

#define CallAIGradientSetCMYKProc	(	userRoutine,
		c,
		m,
		y,
		k	)	(*(userRoutine))((c), (m), (y), (k))

A convenience macro for the AIGradientProcs::setCMYK iteration callback.

#define CallAIGradientSetColorProc	(	userRoutine,
		c		)	(*(userRoutine))((c))

A convenience macro for the AIGradientProcs::setColor iteration callback.

#define CallAIGradientSetGrayProc	(	userRoutine,
		g		)	(*(userRoutine))((g))

A convenience macro for the AIGradientProcs::setGray iteration callback.

#define kAIGradientSuite "AI Gradient Suite"

Gradient suite name.

#define kAIGradientSuiteVersion kAIGradientSuiteVersion9

Gradient suite version.

#define kAIGradientSuiteVersion9 AIAPI_VERSION(9)

Gradient suite version.

#define kAIGradientVersion kAIGradientSuiteVersion

Gradient suite version.

#define kMaxSpotChannelsExceededErr 'xSPT'

#define NewAIGradientBeginFillProc ( userRoutine ) (AIGradientBeginFillUPP)(userRoutine)

A convenience macro for the AIGradientProcs::beginFill iteration callback.

#define NewAIGradientCurveToProc ( userRoutine ) (AIGradientCurveToUPP)(userRoutine)

A convenience macro for the AIGradientProcs::curveTo iteration callback.

#define NewAIGradientEndFillProc ( userRoutine ) (AIGradientEndFillUPP)(userRoutine)

A convenience macro for the AIGradientProcs::endFill iteration callback.

#define NewAIGradientLineToProc ( userRoutine ) (AIGradientLineToUPP)(userRoutine)

A convenience macro for the AIGradientProcs::lineTo iteration callback.

#define NewAIGradientMoveToProc ( userRoutine ) (AIGradientMoveToUPP)(userRoutine)

A convenience macro for the AIGradientProcs::moveTo iteration callback.

#define NewAIGradientSetCMYKProc ( userRoutine ) (AIGradientSetCMYKUPP)(userRoutine)

A convenience macro for the AIGradientProcs::setCMYK iteration callback.

#define NewAIGradientSetColorProc ( userRoutine ) (AIGradientSetColorUPP)(userRoutine)

A convenience macro for the AIGradientProcs::setColor iteration callback.

#define NewAIGradientSetGrayProc ( userRoutine ) (AIGradientSetGrayUPP)(userRoutine)

A convenience macro for the AIGradientProcs::setGray iteration callback.

Typedef Documentation

typedef void(* AIGradientBeginFillProcPtr)(void)

Prototype for AIGradientProcs::beginFill callback; see AIGradientSuite::IterateGradient().

This is called before each path-creation iteration.

typedef AIGradientBeginFillProcPtr AIGradientBeginFillUPP

Value type for the AIGradientProcs::beginFill iteration callback.

typedef void(* AIGradientCurveToProcPtr)(AIReal x1, AIReal y1, AIReal x2, AIReal y2, AIReal x3, AIReal y3)

Prototype for the AIGradientProcs::curveTo callback; see AIGradientSuite::IterateGradient().

Your implementation can use this to modify position values for the set of point that defines the curve between endpoints of a segment in a generated intermediate path object.

Parameters:

	x1	The horizontal coordinate value of the first point of this curve.
	y1	The vertical coordinate value of the first point of this curve.
	x2	The horizontal coordinate value of the second point of this curve.
	y2	The vertical coordinate value of the second point of this curve.
	x3	The horizontal coordinate value of the third point of this curve.
	y3	The vertical coordinate value of the third point of this curve.

typedef AIGradientCurveToProcPtr AIGradientCurveToUPP

Value type for the AIGradientProcs::curveTo iteration callback.

typedef void(* AIGradientEndFillProcPtr)(void)

Prototype for AIGradientProcs::endFill callback; see AIGradientSuite::IterateGradient().

This is called after each path-creation iteration.

typedef AIGradientEndFillProcPtr AIGradientEndFillUPP

Pointer to AIGradientEndFillProcPtr for endFill iteration callback.

typedef void(* AIGradientLineToProcPtr)(AIReal x, AIReal y)

Prototype for the AIGradientProcs::lineTo callback; see AIGradientSuite::IterateGradient().

Your implementation can use this to modify position values for the end point in a segment of a generated intermediate path object.

Parameters:

	x	The horizontal coordinate value of the endpoint for this segment.
	y	The vertical coordinate value of the endpoint for this segment.

typedef AIGradientLineToProcPtr AIGradientLineToUPP

Value type for the AIGradientProcs::lineTo iteration callback.

typedef void(* AIGradientMoveToProcPtr)(AIReal x, AIReal y)

Prototype for AIGradientProcs::moveTo callback; see AIGradientSuite::IterateGradient().

Your implementation can use this to modify position values for the first point in a segment of a generated intermediate path object.

Parameters:

	x	The horizontal coordinate value of the start point for this segment.
	y	The vertical coordinate value of the start point for this segment.

typedef AIGradientMoveToProcPtr AIGradientMoveToUPP

Value type for the AIGradientProcs::moveTo iteration callback.

typedef void(* AIGradientSetCMYKProcPtr)(AIReal c, AIReal m, AIReal y, AIReal k)

Prototype for AIGradientProcs::setCMYK callback; see AIGradientSuite::IterateGradient().

Your implementation can use this to modify CMYK color values in a generated intermediate path object.

Parameters:

	c	The cyan color value of this segment.
	m	The magenta color value of this segment.
	y	The yellow color value of this segment.
	k	The black color value of this segment.