AIRealMathSuite Struct Reference
[API Suite List]

This suite provides functions for working with the AIReal values that Illustrator uses for coordinates. More...

#include <AIRealMath.h>

Public Attributes
AIAPI AIReal(*	AIRealAdd )(AIReal a, AIReal b)
	Adds two real numbers.
AIAPI AIReal(*	AIRealMul )(AIReal a, AIReal b)
	Multiplies two real numbers.
AIAPI AIReal(*	AIRealDiv )(AIReal a, AIReal b)
	Divides two real numbers (a/b).
AIAPI AIReal(*	ShortRatio )(ai::int16 a, ai::int16 b)
	Divides two integers (a/b).
AIAPI AIReal(*	AIRealRatio )(AIReal a, AIReal b)
	Divides two real numbers (a/b).
AIAPI AIReal(*	AIRealMulAdd )(AIReal a, AIReal b, AIReal c, AIReal d)
	Multiplies two sets of numbers and then adds them together: (a * b) + (c * d).
AIAPI AIReal(*	AIRealMultiple )(AIReal a, AIReal multiple, AIBoolean ceiling)
	Rounds a real number to a given multiple.
AIAPI AIReal(*	AIRealSin )(AIReal a)
	Computes the sine of a real number in radians.
AIAPI AIReal(*	AIRealCos )(AIReal a)
	Computes the cosine of a real number in radians.
AIAPI AIReal(*	AIRealATan )(AIReal a, AIReal b)
	Computes the arctangent of an angle in radians, where a and b are two real numbers such that a/b is the tangent of the angle.
AIAPI AIReal(*	DegreeToRadian )(AIReal degree)
	Converts an angle expressed in degrees to radians.
AIAPI AIReal(*	RadianToDegree )(AIReal radian)
	Converts an angle expressed in radians to degrees.
AIAPI AIReal(*	AIRealSqrt )(AIReal a)
	Computes the square root of a real number.
AIAPI AIReal(*	AIRealLength )(AIReal a, AIReal b)
	Computes the length of a vector starting at (0,0) and ending at (a,b).
AIAPI AIReal(*	AIRealInterpolate )(AIReal a, AIReal b, AIReal t)
	Computes a value between two real numbers by interpolating from `b` at `t=0` to `a` at `t=1`.
AIAPI void(*	AIRealPointAdd )(const AIRealPoint a, const AIRealPoint b, AIRealPoint *result)
	Adds two points by adding the two X values and the two Y values.
AIAPI void(*	AIRealPointSubtract )(const AIRealPoint a, const AIRealPoint b, AIRealPoint *result)
	Subtracts point a from point b by subtracting the corresponding component values.
AIAPI AIBoolean(*	AIRealPointEqual )(const AIRealPoint a, const AIRealPoint b)
	Tests for exact equality of two points.
AIAPI AIBoolean(*	AIRealPointClose )(const AIRealPoint a, const AIRealPoint b, AIReal tolerance)
	Tests whether two points are within a specified square proximity of each other.
AIAPI AIReal(*	AIRealPointAngle )(const AIRealPoint a, const AIRealPoint b)
	Computes the angle made by the vector `ab` with the X-axis.
AIAPI AIReal(*	AIRealPointLength )(const AIRealPoint a, const AIRealPoint b)
	Computes the length of the vector `ab`.
AIAPI void(*	AIRealPointLengthAngle )(AIReal length, AIReal angle, AIRealPoint *result)
	Computes the location of a point a given distance and angle from the page origin.
AIAPI void(*	AIRealPointInterpolate )(const AIRealPoint a, const AIRealPoint b, AIReal t, AIRealPoint *result)
	Computes the location of a point between two points by interpolating new coordinate values between the corresponding coordinates of the points.
AIAPI void(*	AIRealRectSet )(AIRealRect *a, AIReal left, AIReal top, AIReal right, AIReal bottom)
	Sets the coordinate values in a rectangle.
AIAPI AIBoolean(*	AIRealRectEqual )(const AIRealRect a, const AIRealRect b)
	Tests whether two rectangles equal (have the same coordinate values).
AIAPI AIBoolean(*	AIRealRectEmpty )(const AIRealRect *a)
	Tests whether a rectangle is empty (invalid).
AIAPI void(*	AIRealRectInset )(AIRealRect *a, AIReal h, AIReal v)
	Moves the edges of a rectangle in or out by a uniform amount.
AIAPI void(*	AIRealRectOffset )(AIRealRect *a, AIReal h, AIReal v)
	Moves a rectangle by adding given values to the sides.
AIAPI void(*	AIRealRectUnion )(const AIRealRect a, const AIRealRect b, AIRealRect *result)
	Creates a new rectangle that is the union of two rectangles.
AIAPI void(*	AIRealPointUnion )(const AIRealPoint a, const AIRealRect b, AIRealRect *result)
	Creates a new rectangle by enlarging a given rectangle to enclose a given point.
AIAPI AIBoolean(*	AIRealRectOverlap )(const AIRealRect a, const AIRealRect b)
	Tests whether two rectangles overlap (have any points in common).
AIAPI AIBoolean(*	AIRealRectIntersect )(const AIRealRect a, const AIRealRect b, AIRealRect *result)
	Creates a new rectangle that is the intersection of two rectangles.
AIAPI AIBoolean(*	AIRealRectInAIRealRect )(const AIRealRect a, const AIRealRect b)
	Tests whether one rectangle is inside (entirely contained in) another rectangle.
AIAPI AIBoolean(*	AIRealPointInAIRealRect )(const AIRealPoint a, const AIRealRect b)
	Tests whether a point is inside a rectangle.
AIAPI void(*	AIRealRectAlign )(const AIRealRect a, AIRealRect result)
	Rounds rectangle coordinates to integer values such that the result rectangle contains the original.
AIAPI void(*	AIRealMatrixSet )(AIRealMatrix *m, AIReal a, AIReal b, AIReal c, AIReal d, AIReal tx, AIReal ty)
	Sets the scale, rotation, and translation values of a transformation matrix.
AIAPI void(*	AIRealMatrixSetIdentity )(AIRealMatrix *m)
	Sets a transformation matrix to the identity matrix.
AIAPI AIBoolean(*	AIRealMatrixEqual )(const AIRealMatrix m, const AIRealMatrix n)
	Tests two matrices for exact equality.
AIAPI AIBoolean(*	AIRealMatrixIdentity )(const AIRealMatrix *m)
	Tests whether a transformation matrix is the identity matrix.
AIAPI AIBoolean(*	AIRealMatrixSingular )(const AIRealMatrix *m)
	Tests whether a matrix is singular (cannot be inverted).
AIAPI void(*	AIRealMatrixSetTranslate )(AIRealMatrix *m, AIReal tx, AIReal ty)
	Initializes a transformation matrix to a single translation.
AIAPI void(*	AIRealMatrixSetScale )(AIRealMatrix *m, AIReal h, AIReal v)
	Initializes scale values for a transformation matrix.
AIAPI void(*	AIRealMatrixSetRotate )(AIRealMatrix *m, AIReal angle)
	Initializes a transformation matrix to a single rotation.
AIAPI void(*	AIRealMatrixConcatTranslate )(AIRealMatrix *m, AIReal tx, AIReal ty)
	Concatenates translation values to the existing translation in a transformation matrix.
AIAPI void(*	AIRealMatrixConcatScale )(AIRealMatrix *m, AIReal h, AIReal v)
	Concatenates scale values to the existing scale in a transformation matrix.
AIAPI void(*	AIRealMatrixConcatRotate )(AIRealMatrix *m, AIReal angle)
	Concatenates a rotation value to the existing rotation in a transformation matrix.
AIAPI void(*	AIRealMatrixConcat )(const AIRealMatrix m, const AIRealMatrix n, AIRealMatrix *result)
	Creates a new transformation matrix by concatenating one matrix to another.
AIAPI ai::int16(*	AIRealMatrixInvert )(AIRealMatrix *m)
	Inverts a transformation matrix.
AIAPI void(*	AIRealMatrixXformPoint )(const AIRealMatrix m, const AIRealPoint a, AIRealPoint *result)
	Transforms a point using a transformation matrix.
AIAPI AIFixed(*	AIRealToAIFixed )(AIReal r)
	Converts an `AIReal` value to an `AIFixed` value.
AIAPI AIReal(*	AIFixedToAIReal )(AIFixed f)
	Converts an `AIFixed` value to an `AIReal` value.
AIAPI void(*	AIRealPointToAIFixedPoint )(const AIRealPoint r, AIFixedPoint f)
	Converts an `AIRealPoint` value to an `AIFixedPoint` value.
AIAPI void(*	AIFixedPointToAIRealPoint )(const AIFixedPoint f, AIRealPoint r)
	Converts an `AIFixedPoint` value to an `AIRealPoint` value.
AIAPI void(*	AIRealRectToAIFixedRect )(const AIRealRect r, AIFixedRect f)
	Converts an `AIRealRect` value to an `AIFixedRect` value.
AIAPI void(*	AIFixedRectToAIRealRect )(const AIFixedRect f, AIRealRect r)
	Converts an `AIFixedRect` value to an `AIRealRect` value.
AIAPI void(*	AIRealMatrixToAIFixedMatrix )(const AIRealMatrix r, AIFixedMatrix f)
	Converts an `AIRealMatrix` value to an `AIFixedMatrix` value.
AIAPI void(*	AIFixedMatrixToAIRealMatrix )(const AIFixedMatrix f, AIRealMatrix r)
	Converts an `AIFixedMatrix` value to an `AIRealMatrix` value.
AIAPI void(*	AIFloatMatrixToAIRealMatrix )(const AIFloatMatrix f, AIRealMatrix r)
AIAPI void(*	AIFloatPointToAIRealPoint )(const AIFloatPoint f, AIRealPoint r)
AIAPI AIBoolean(*	IsAIRealUnknown )(AIReal r)
	Tests whether an `AIReal` value is `kAIRealUnknown`, the special value Illustrator uses to represent unknown quantities.
AIAPI AIBoolean(*	AIRealIsNAN )(AIReal r)
	Tests whether an `AIReal` value is `kAIRealUnknown` ("not a number").
AIAPI AIBoolean(*	AlmostEqual )(const AIReal a, const AIReal b, const AIReal percent)
	Tests whether two real numbers are within a percentage of one another.
AIAPI AIBoolean(*	EqualWithinTol )(const AIReal a, const AIReal b, const AIReal tolerance)
	Tests whether two real numbers are within a tolerance of one another.
AIAPI void(*	AIRealMatrixGetTranslate )(const AIRealMatrix m, AIReal tx, AIReal *ty)
	Retrieves the translation values from a transformation matrix.
AIAPI void(*	AIRealMatrixGetScale )(const AIRealMatrix m, AIReal h, AIReal *v)
	Retrieves the scaling values from a transformation matrix.
AIAPI void(*	AIRealMatrixGetRotate )(const AIRealMatrix m, AIReal angle)
	Retrieves the angle of rotation from a transformation matrix.
AIAPI void(*	AIDoubleRectUnion )(const AIDoubleRect a, const AIDoubleRect b, AIDoubleRect *result)
	Creates a new `AIDoubleRect` rectangle that is the union of two `AIDoubleRect` rectangles.
AIAPI AIReal(*	RestrictAngleToRange )(AIReal angle, AIReal startAngle)
	Restricts an angle to a given range.

Detailed Description

This suite provides functions for working with the AIReal values that Illustrator uses for coordinates.

(An AIReal is a C float type.) You can work with AIReal values directly, with those contained in position structures for points and rectangles, and with those contained in transformation matrices.

The functions in this suite do not return AIErr values. For the most part, they return nothing, or return the result of the operation.

Note:: Adobe Illustrator 8.0 changed all coordinate measurements from AIFixed to AIReal data types. This change affected many suites; in particular, the AIFixedMathSuite was superseded by this suite. For backward compatibility, this suite provides functions that convert between AIReal and AIFixed numbers.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIRealMathSuite and kAIRealMathVersion.

Member Data Documentation

AIAPI void(* AIRealMathSuite::AIDoubleRectUnion)(const AIDoubleRect *a, const AIDoubleRect *b, AIDoubleRect *result)

Creates a new AIDoubleRect rectangle that is the union of two AIDoubleRect rectangles.

Parameters:

	a	The first rectangle.
	b	The second rectangle.
	result	[out] A buffer in which to return the result.

AIAPI void(* AIRealMathSuite::AIFixedMatrixToAIRealMatrix)(const AIFixedMatrix *f, AIRealMatrix *r)

Converts an AIFixedMatrix value to an AIRealMatrix value.

Parameters:

	f	The fixed matrix.
	r	[out] A buffer in which to return the real matrix.

AIAPI void(* AIRealMathSuite::AIFixedPointToAIRealPoint)(const AIFixedPoint *f, AIRealPoint *r)

Converts an AIFixedPoint value to an AIRealPoint value.

Parameters:

	f	The fixed point.
	r	[out] A buffer in which to return the real point.

AIAPI void(* AIRealMathSuite::AIFixedRectToAIRealRect)(const AIFixedRect *f, AIRealRect *r)

Converts an AIFixedRect value to an AIRealRect value.

Parameters:

	f	The fixed rectangle.
	r	[out] A buffer in which to return the real rectangle.

AIAPI AIReal(* AIRealMathSuite::AIFixedToAIReal)(AIFixed f)

Converts an AIFixed value to an AIReal value.

Parameters:

f

The fixed value.

Returns:: The real value.

AIAPI void(* AIRealMathSuite::AIFloatMatrixToAIRealMatrix)(const AIFloatMatrix *f, AIRealMatrix *r)

AIAPI void(* AIRealMathSuite::AIFloatPointToAIRealPoint)(const AIFloatPoint *f, AIRealPoint *r)

AIAPI AIReal(* AIRealMathSuite::AIRealAdd)(AIReal a, AIReal b)

Adds two real numbers.

Parameters:

	a	The first number.
	b	The second number.

Returns:: The result. In case of overflow or underflow, returns the system-defined maximum or minimum constant.

AIAPI AIReal(* AIRealMathSuite::AIRealATan)(AIReal a, AIReal b)

Computes the arctangent of an angle in radians, where a and b are two real numbers such that a/b is the tangent of the angle.

Parameters:

	a	The first number.
	b	The second number.

Returns:: The result.

AIAPI AIReal(* AIRealMathSuite::AIRealCos)(AIReal a)

Computes the cosine of a real number in radians.

Parameters:

a

The number.

Returns:: The result.

AIAPI AIReal(* AIRealMathSuite::AIRealDiv)(AIReal a, AIReal b)

Divides two real numbers (a/b).

Parameters:

	a	The first number.
	b	The second number.

Returns:: The result. In case of overflow, underflow, or divide by 0, returns the system-defined maximum or minimum constant.

AIAPI AIReal(* AIRealMathSuite::AIRealInterpolate)(AIReal a, AIReal b, AIReal t)

Computes a value between two real numbers by interpolating from b at t=0 to a at t=1.

For example, if t=0.5, the function returns the average of a and b. If a = 0, b = 1, and t = 0.25, the function returns 0.75.

Parameters:

	a	The first number.
	b	The second number.
	t	A percentage of (b-a), expressed as a number between 0 and 1.

Returns:: The result.

AIAPI AIBoolean(* AIRealMathSuite::AIRealIsNAN)(AIReal r)

Tests whether an AIReal value is kAIRealUnknown ("not a number").

This constant is used for mathematically undefined values such as 0/0.

Parameters:

r

The real number.

Returns:: True if the value is equal to kAIRealUnknown.

AIAPI AIReal(* AIRealMathSuite::AIRealLength)(AIReal a, AIReal b)

Computes the length of a vector starting at (0,0) and ending at (a,b).

This is the same as AIRealSqrt(a*a + b*b).

Parameters:

	a	The X coordinate of the endpoint.
	b	The Y coordinate of the endpoint.

Returns:: The result.

AIAPI void(* AIRealMathSuite::AIRealMatrixConcat)(const AIRealMatrix *m, const AIRealMatrix *n, AIRealMatrix *result)

Creates a new transformation matrix by concatenating one matrix to another.

Parameters:

	m	The first matrix object.
	n	The second matrix object.
	result	[out] A buffer in which to return the result.

AIAPI void(* AIRealMathSuite::AIRealMatrixConcatRotate)(AIRealMatrix *m, AIReal angle)

Concatenates a rotation value to the existing rotation in a transformation matrix.

The matrix must be initialized first.

Parameters:

	m	The matrix object.
	angle	New angle value in radians.

AIAPI void(* AIRealMathSuite::AIRealMatrixConcatScale)(AIRealMatrix *m, AIReal h, AIReal v)

Concatenates scale values to the existing scale in a transformation matrix.

The matrix must be initialized first.

Parameters:

	m	The matrix object.
	h	New horizontal scale value.
	v	New vertical scale value.

AIAPI void(* AIRealMathSuite::AIRealMatrixConcatTranslate)(AIRealMatrix *m, AIReal tx, AIReal ty)

Concatenates translation values to the existing translation in a transformation matrix.

The matrix must be initialized first.

Parameters:

	m	The matrix object.
	tx	New horizontal translation value in document points.
	ty	New vertical translation value in document points.

AIAPI AIBoolean(* AIRealMathSuite::AIRealMatrixEqual)(const AIRealMatrix *m, const AIRealMatrix *n)

Tests two matrices for exact equality.

Parameters:

	m	The first matrix.
	n	The second matrix.

Returns:: True if the matrices are equal.

AIAPI void(* AIRealMathSuite::AIRealMatrixGetRotate)(const AIRealMatrix *m, AIReal *angle)

Retrieves the angle of rotation from a transformation matrix.

Parameters:

	m	The matrix.
	angle	[out] A buffer in which to return the angle in radians.

AIAPI void(* AIRealMathSuite::AIRealMatrixGetScale)(const AIRealMatrix *m, AIReal *h, AIReal *v)

Retrieves the scaling values from a transformation matrix.

Parameters:

	m	The matrix.
	h	[out] A buffer in which to return the horizontal scaling value.
	v	[out] A buffer in which to return the vertical scaling value.

AIAPI void(* AIRealMathSuite::AIRealMatrixGetTranslate)(const AIRealMatrix *m, AIReal *tx, AIReal *ty)

Retrieves the translation values from a transformation matrix.

Parameters:

	m	The matrix.
	tx	[out] A buffer in which to return the horizontal translation value.
	ty	[out] A buffer in which to return the vertical translation value.

AIAPI AIBoolean(* AIRealMathSuite::AIRealMatrixIdentity)(const AIRealMatrix *m)

Tests whether a transformation matrix is the identity matrix.

Parameters:

m

The matrix object.

Returns:: True if the matrix is the identity matrix.

AIAPI ai::int16(* AIRealMathSuite::AIRealMatrixInvert)(AIRealMatrix *m)

Inverts a transformation matrix.

Parameters:

m

The matrix object.

Returns:: 3 if the matrix could not be inverted or kNoErr on success.

AIAPI void(* AIRealMathSuite::AIRealMatrixSet)(AIRealMatrix *m, AIReal a, AIReal b, AIReal c, AIReal d, AIReal tx, AIReal ty)

Sets the scale, rotation, and translation values of a transformation matrix.

Parameters:

	m	The matrix object.
	a	New a value.
	b	New b value.
	c	New c value.
	d	New d value.
	tx	New horizontal translation value.
	ty	New vertical translation value.

AIAPI void(* AIRealMathSuite::AIRealMatrixSetIdentity)(AIRealMatrix *m)

Sets a transformation matrix to the identity matrix.

Parameters:

m

The matrix object.

AIAPI void(* AIRealMathSuite::AIRealMatrixSetRotate)(AIRealMatrix *m, AIReal angle)

Initializes a transformation matrix to a single rotation.

Parameters:

	m	The matrix object.
	angle	New angle value in radians.

AIAPI void(* AIRealMathSuite::AIRealMatrixSetScale)(AIRealMatrix *m, AIReal h, AIReal v)

Initializes scale values for a transformation matrix.

Parameters:

	m	The matrix object.
	h	New horizontal scale value, a percentage where 1 is 100%.
	v	New vertical scale value, a percentage where 1 is 100%.

AIAPI void(* AIRealMathSuite::AIRealMatrixSetTranslate)(AIRealMatrix *m, AIReal tx, AIReal ty)

Initializes a transformation matrix to a single translation.

Parameters:

	m	The matrix object.
	tx	New horizontal translation value in document points.
	ty	New vertical translation value in document points.

AIAPI AIBoolean(* AIRealMathSuite::AIRealMatrixSingular)(const AIRealMatrix *m)

Tests whether a matrix is singular (cannot be inverted).

Parameters:

m

The matrix object.

Returns:: True if the matrix is singular.

AIAPI void(* AIRealMathSuite::AIRealMatrixToAIFixedMatrix)(const AIRealMatrix *r, AIFixedMatrix *f)

Converts an AIRealMatrix value to an AIFixedMatrix value.

Parameters:

	r	The real matrix.
	f	[out] A buffer in which to return the fixed matrix.

AIAPI void(* AIRealMathSuite::AIRealMatrixXformPoint)(const AIRealMatrix *m, const AIRealPoint *a, AIRealPoint *result)

Transforms a point using a transformation matrix.

Parameters:

	m	The matrix.
	a	The point.
	result	[out] A buffer in which to return the result.

AIAPI AIReal(* AIRealMathSuite::AIRealMul)(AIReal a, AIReal b)

Multiplies two real numbers.

Parameters:

	a	The first number.
	b	The second number.

Returns:: The result. In case of overflow or underflow, returns the system-defined maximum or minimum constant.

AIAPI AIReal(* AIRealMathSuite::AIRealMulAdd)(AIReal a, AIReal b, AIReal c, AIReal d)

Multiplies two sets of numbers and then adds them together: (a * b) + (c * d).

Parameters:

	a	The first number of the first pair.
	b	The second number of the first pair.
	c	The first number of the second pair.
	d	The second number of the second pair.

Returns:: The result. In case of overflow or underflow, returns the system-defined maximum or minimum constant.

AIAPI AIReal(* AIRealMathSuite::AIRealMultiple)(AIReal a, AIReal multiple, AIBoolean ceiling)

Rounds a real number to a given multiple.

Parameters:

	a	The number.
	multiple	The multiple; for example, 0.01 to round to the nearest hundredth, or 0.05 to round to the nearest twentieth. Must not be 0.
	ceiling	When true, round up. When false, round down. (Up and down are signed-- that is, floor -0.5 is -1 and ceiling -0.5 is 0, not the other way around.)

Note:: When working with decimals, the result is subject to general AIReal accuracy problems.

AIAPI void(* AIRealMathSuite::AIRealPointAdd)(const AIRealPoint *a, const AIRealPoint *b, AIRealPoint *result)

Adds two points by adding the two X values and the two Y values.

No overflow checking is done.

Parameters:

	a	The first point.
	b	The second point.
	result	[out] A buffer in which to return the result.

AIAPI AIReal(* AIRealMathSuite::AIRealPointAngle)(const AIRealPoint *a, const AIRealPoint *b)

Computes the angle made by the vector ab with the X-axis.

Parameters:

	a	The first point.
	b	The second point.

Returns:: The result, in radians.

AIAPI AIBoolean(* AIRealMathSuite::AIRealPointClose)(const AIRealPoint *a, const AIRealPoint *b, AIReal tolerance)

Tests whether two points are within a specified square proximity of each other.

This is true if an axis-aligned, closed rectangle of a given tolerance can be placed such that it can contain the two points.

Parameters:

	a	The first point.
	b	The second point.
	tolerance	The proximity value, the maximum allowed distance between the X and Y coordinates of the points.
	result	[out] A buffer in which to return true if the points can be contained.

AIAPI AIBoolean(* AIRealMathSuite::AIRealPointEqual)(const AIRealPoint *a, const AIRealPoint *b)

Tests for exact equality of two points.

Parameters:

	a	The first point.
	b	The second point.
	result	[out] A buffer in which to return true if the points have the same coordinate values.

AIAPI AIBoolean(* AIRealMathSuite::AIRealPointInAIRealRect)(const AIRealPoint *a, const AIRealRect *b)

Tests whether a point is inside a rectangle.

The point is considered inside if it is on one of the rectangle�s sides.

Parameters:

	a	The point.
	b	The closed rectangle.

Returns:: True if the point is contained in the closed rectangle.

AIAPI void(* AIRealMathSuite::AIRealPointInterpolate)(const AIRealPoint *a, const AIRealPoint *b, AIReal t, AIRealPoint *result)

Computes the location of a point between two points by interpolating new coordinate values between the corresponding coordinates of the points.

The result is a * t + b * (1-t)

Parameters:

	a	The first point.
	b	The second point.
	t	A percentage of (b-a), expressed as a number between 0 and 1.
	result	[out] A buffer in which to return the result.

AIAPI AIReal(* AIRealMathSuite::AIRealPointLength)(const AIRealPoint *a, const AIRealPoint *b)

Computes the length of the vector ab.

The result is always positive.

Parameters:

	a	The first point.
	b	The second point.

Returns:: The result.

AIAPI void(* AIRealMathSuite::AIRealPointLengthAngle)(AIReal length, AIReal angle, AIRealPoint *result)

Computes the location of a point a given distance and angle from the page origin.

Parameters:

	length	The distance.
	angle	The angle in radians, counter-clockwise with respect to the X axis.
	result	[out] A buffer in which to return the result.

AIAPI void(* AIRealMathSuite::AIRealPointSubtract)(const AIRealPoint *a, const AIRealPoint *b, AIRealPoint *result)

Subtracts point a from point b by subtracting the corresponding component values.

No overflow checking is done.

Parameters:

	a	The first point.
	b	The second point.
	result	[out] A buffer in which to return the result.

AIAPI void(* AIRealMathSuite::AIRealPointToAIFixedPoint)(const AIRealPoint *r, AIFixedPoint *f)

Converts an AIRealPoint value to an AIFixedPoint value.

Parameters:

	r	The real point.
	f	[out] A buffer in which to return the fixed point.

AIAPI void(* AIRealMathSuite::AIRealPointUnion)(const AIRealPoint *a, const AIRealRect *b, AIRealRect *result)

Creates a new rectangle by enlarging a given rectangle to enclose a given point.

Parameters:

	a	The point.
	b	The rectangle.
	result	[out] A buffer in which to return the result.

AIAPI AIReal(* AIRealMathSuite::AIRealRatio)(AIReal a, AIReal b)

Divides two real numbers (a/b).

This is the same as AIRealDiv().

Parameters:

	a	The first number.
	b	The second number.

Returns:: The result. In case of overflow, underflow, or divide by 0, returns the system-defined maximum or minimum constant.

AIAPI void(* AIRealMathSuite::AIRealRectAlign)(const AIRealRect *a, AIRealRect *result)

Rounds rectangle coordinates to integer values such that the result rectangle contains the original.

Does not necessarily return the smallest such rectangle; takes the floor of the coordinates and adds 1 to the top and right.

Parameters:

	a	The rectangle.
	result	[out] A buffer in which to return the result.

AIAPI AIBoolean(* AIRealMathSuite::AIRealRectEmpty)(const AIRealRect *a)

Tests whether a rectangle is empty (invalid).

A rectangle is invalid if the right edge is equal to or less than the left edge, or the top edge is equal to or less than the bottom edge.

Parameters:

a

The rectangle.

Returns:: True if the rectangle is empty.

AIAPI AIBoolean(* AIRealMathSuite::AIRealRectEqual)(const AIRealRect *a, const AIRealRect *b)

Tests whether two rectangles equal (have the same coordinate values).

Uses an inexact equality test to account for floating-point errors.

Parameters:

	a	The first rectangle.
	b	The second rectangle.

Returns:: True if the rectangles are equal.

AIAPI AIBoolean(* AIRealMathSuite::AIRealRectInAIRealRect)(const AIRealRect *a, const AIRealRect *b)

Tests whether one rectangle is inside (entirely contained in) another rectangle.

Both must be open or both closed.

Parameters:

	a	The first rectangle.
	b	The second rectangle.

Returns:: True if the set of points contained by a is also contained by b.

AIAPI void(* AIRealMathSuite::AIRealRectInset)(AIRealRect *a, AIReal h, AIReal v)

Moves the edges of a rectangle in or out by a uniform amount.

Positive values for h or v move the corresponding sides in, negative values move the sides out.

Parameters:

	a	The rectangle.
	h	The number of document points to move the edges in or out horizontally.
	v	The number of document points to move the edges in or out vertically.

AIAPI AIBoolean(* AIRealMathSuite::AIRealRectIntersect)(const AIRealRect *a, const AIRealRect *b, AIRealRect *result)

Creates a new rectangle that is the intersection of two rectangles.

Parameters:

	a	The first rectangle.
	b	The second rectangle.
	result	[out] A buffer in which to return the result.

Returns:: False if the result is an empty (invalid) rectangle, true otherwise.

AIAPI void(* AIRealMathSuite::AIRealRectOffset)(AIRealRect *a, AIReal h, AIReal v)

Moves a rectangle by adding given values to the sides.

Positive values for h or v move the corresponding rectangle up or right, negative values move it down or left.

Parameters:

	a	The rectangle.
	h	The number of document points to move the rectangle horizontally.
	v	The number of document points to move the rectangle vertically.

AIAPI AIBoolean(* AIRealMathSuite::AIRealRectOverlap)(const AIRealRect *a, const AIRealRect *b)

Tests whether two rectangles overlap (have any points in common).

Parameters:

	a	The first rectangle.
	b	The second rectangle.

Returns:: True if the rectangles overlap.

AIAPI void(* AIRealMathSuite::AIRealRectSet)(AIRealRect *a, AIReal left, AIReal top, AIReal right, AIReal bottom)

Sets the coordinate values in a rectangle.

(In the Illustrator art coordinate system, the origin, (0, 0), is at the bottom left corner of a page. X and Y values increase upward and to the right.)

Parameters:

	a	The rectangle object.
	left	The left side location..
	top	The top side location.
	right	The right side location.
	bottom	The bottom side location.

AIAPI void(* AIRealMathSuite::AIRealRectToAIFixedRect)(const AIRealRect *r, AIFixedRect *f)

Converts an AIRealRect value to an AIFixedRect value.

Parameters:

	r	The real rectangle.
	f	[out] A buffer in which to return the fixed rectangle.

AIAPI void(* AIRealMathSuite::AIRealRectUnion)(const AIRealRect *a, const AIRealRect *b, AIRealRect *result)

Creates a new rectangle that is the union of two rectangles.

Parameters:

	a	The first rectangle.
	b	The second rectangle.
	result	[out] A buffer in which to return the result.

AIAPI AIReal(* AIRealMathSuite::AIRealSin)(AIReal a)

Computes the sine of a real number in radians.

Parameters:

a

The number.

Returns:: The result.

AIAPI AIReal(* AIRealMathSuite::AIRealSqrt)(AIReal a)

Computes the square root of a real number.

Parameters:

a

The number.

Returns:: The result.

AIAPI AIFixed(* AIRealMathSuite::AIRealToAIFixed)(AIReal r)

Converts an AIReal value to an AIFixed value.

Parameters:

r

The real value.

Returns:: The fixed value.

AIAPI AIBoolean(* AIRealMathSuite::AlmostEqual)(const AIReal a, const AIReal b, const AIReal percent)

Tests whether two real numbers are within a percentage of one another.

Parameters:

	a	The first number.
	b	The second number.
	percent	A number between 0 and 1, where 1.0 is 100%.

Returns:: For a > b, true if abs(a) - abs(b) < abs(b) * percent.
For b > a, true if abs(a) < abs(b) * percent.

AIAPI AIReal(* AIRealMathSuite::DegreeToRadian)(AIReal degree)

Converts an angle expressed in degrees to radians.

Parameters:

degree

The number of degrees in the angle.

Returns:: The number of radians in the angle.

AIAPI AIBoolean(* AIRealMathSuite::EqualWithinTol)(const AIReal a, const AIReal b, const AIReal tolerance)

Tests whether two real numbers are within a tolerance of one another.

Parameters:

	a	The first number.
	b	The second number.
	tolerance	The tolerance.

Returns:: True if abs(a-b) <= tolerance

AIAPI AIBoolean(* AIRealMathSuite::IsAIRealUnknown)(AIReal r)

Tests whether an AIReal value is kAIRealUnknown, the special value Illustrator uses to represent unknown quantities.

This is sometimes used as a parameter to signal a special condition; for example, use of a default value.

Parameters:

r

The real number.

Returns:: True if the value is equal to kAIRealUnknown.

AIAPI AIReal(* AIRealMathSuite::RadianToDegree)(AIReal radian)

Converts an angle expressed in radians to degrees.

Parameters:

radian

The number of radians in the angle.

Returns:: The number of degrees in the angle.

AIAPI AIReal(* AIRealMathSuite::RestrictAngleToRange)(AIReal angle, AIReal startAngle)

Restricts an angle to a given range.

Parameters:

	angle	The angle to be restricted in radians.
	startAngle	The beginning of the range in radians. For startAngle=n, the range is [n, (n + 2 * pi)).

Returns:: The restricted angle.

AIAPI AIReal(* AIRealMathSuite::ShortRatio)(ai::int16 a, ai::int16 b)

Divides two integers (a/b).

Parameters:

	a	The first number.
	b	The second number.

Returns:: The result. In case of overflow or underflow, returns the system-defined maximum or minimum constant.

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

AIRealMath.h

AIRealMathSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIRealMathSuite Struct Reference
[API Suite List]