Point

Scaleform::Render::Point

Declaration

template <class T>
class Point;

Description

The Point class defines a point in a two-dimensional plane, specified by an x coordinate and y coordinate. The coordinates are public and accessed directly; they can be set either directly or by calling the SetPoint function.

Although the GFx graphics library supplies a complete set of classes for geometric and rendering purposes, the Point provides vertex style operations such as addition, subtraction, division and multiplication; where each component is modified separately.

Data Members

Data Member	Description
x	The x variable specifies the X (horizontal) coordinate of the point.
y	The y variable specifies the Y (vertical) coordinate of the point.

Enumerations

Enumeration	Description
BoundsType	An enumeration used by SetPoint and Point constructors to initialize the point with the minimum (Min) or maximum (Max) point values.

Methods

Method	Description
Absolute	Converts the x and y coordinate values of the current point to their positive (absolute value) equivalent.
Angle	Calculates the angle, in radians, between the current Point and a passed point.
BitwiseEqual	Bitwise comparison.
Clamp	Compares the x and y coordinate values of the current point to alternate values and replaces it with the alternate value if the coordinate is either less than or greater than the alternate value.
ClampMax	Compares the x and y coordinates of the current point to an alternate value. If the coordinate value is greater than the alternate value, the alternate value replaces the original coordinate value.
ClampMin	Compares the x and y coordinates of the current point to an alternate value. If the coordinate value is less than the alternate value, the alternate value replaces the original coordinate value.
Clear	Assigns the x and y coordinate values of the current point to zero.
Dot	Returns the dot product of two points.
DistanceSquared	Calculates the distance squared between two points.
Distance	Calculates the distance between the current point and the passed point.
DistanceL1	Calculates the L1 distance Manhattan style.
DistanceLn	Calculates the L Infinite Distance.
Div	Divides the x and y coordinate values of the current point by a fixed value.
IsNull	Tells whether the point is currently at null (or zero) state.
Mul	Multiplies the current point with the passed value or point.
Offset	Offsets the position; the point is moved to a new position.
Point	Initializes a new instance of a point.
SetPoint	Initializes the x and y coordinate values of the current point.
SetLerp	Set to a + (b - a) * t
Swap	Swaps the x and y components with the coordinates of the passed Point parameter.

Operators

Operator	Description
-	Changes the sign (positive, negative) of a Point.
/=	Divides the x and y coordinate values of a point by a fixed value.
+=	Adds a set value to the x and y coordinates of the current point.
=	Assigns a fixed value to the current point.
-=	Subtracts a set value from the current point.
*=	Multiplies the x and y coordinate values of the current point with a fixed value.
!=	Determines the inequality of the two points.
==	Determines the equality of two points.
-	Subtracts a set value from a Point.
*	Multiplies a point with a fixed value.
/	Divides a point by a set value.
+	Adds a set value to a point.

File

Render_Types2D.h