AIGradientStyle Struct Reference

The gradient style record defines a gradient instance (also called a blend). More...

#include <AIColor.h>

List of all members.

Public Member Functions
void	Init ()
Public Attributes
AIGradientHandle	gradient
	An opaque reference to the gradient.
AIRealPoint	gradientOrigin
AIReal	gradientAngle
AIReal	gradientLength
AIRealMatrix	matrix
	The accumulated transformations of the gradient.
AIReal	hiliteAngle
AIReal	hiliteLength

---

Detailed Description

The gradient style record defines a gradient instance (also called a blend).

It includes a reference to a gradient definition, and the origin point and transformation matrix for the blend.

A gradient has a name, and a gradient ramp, which describes where the color changes of the gradient occur. A gradient can be linear or radial. See the AIGradientSuite. Radial blends have an additional attribute called a blend hilight, which is the starting point for the gradient ramp as it expands outward.

---

Member Function Documentation

void AIGradientStyle::Init

(

)

[inline]

References _t_AIRealPoint::h, _t_AIRealMatrix::Init(), kAIRealZero, NULL, and _t_AIRealPoint::v.

---

Member Data Documentation

AIGradientHandle AIGradientStyle::gradient

An opaque reference to the gradient.

Access using functions in the AIGradientSuite. It contains a name, type (linear or radial), and a ramp defined by a set of stops.

Referenced by ai::Paint::operator==().

AIReal AIGradientStyle::gradientAngle

• For a linear gradient, the angle of the gradient in degrees from the X axis. The ramp extends from the origin at this angle. Positive values are counterclockwise.
• Not used for radial gradients, but the value is preserved in case the gradient is changed back to linear.

Referenced by ai::Paint::operator==().

AIReal AIGradientStyle::gradientLength

• For a linear gradient, the distance in points over which the gradient ramp is applied. The ramp is scaled so that 100% of its value is this length.
• For a radial gradient, the radius of the containing circle.

Referenced by ai::Paint::operator==().

AIRealPoint AIGradientStyle::gradientOrigin

• For a linear gradient, the origin of the gradient in page coordinates, which is 0 on the gradient ramp.
• For a radial gradient, the center of the containing circle.

Referenced by ai::Paint::operator==().

AIReal AIGradientStyle::hiliteAngle

• For a radial gradient, the angle to the blend highlight point.
• Not used for linear gradients.

Referenced by ai::Paint::operator==().

AIReal AIGradientStyle::hiliteLength

• For a radial gradient, the distance of the hilight from the origin expressed as a fraction of the radius, a value between 0 and 1.
• Not used for linear gradients.

Referenced by ai::Paint::operator==().

AIRealMatrix AIGradientStyle::matrix

The accumulated transformations of the gradient.

It is not necessarily the same as the transformation matrix of the object containing the gradient. When a gradient is first applied to an object, the value is set to the identity matrix. When the user transforms the object, the user transformation matrix is concatenated to the gradient instances matrix.

Referenced by ai::Paint::operator==().

---

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

• AIColor.h