Size

Scaleform::Render::Size

Declaration

template <class T>
class Size;

Description

Size represents a simple two-dimensional size consisting of two components: Width and Height. The coordinates are public and accessed directly; they can be set either directly or by calling the SetSize function.

Data Members

Data Member	Description
Height	A value representing the height component of a two-dimensional size.
Width	A value representing the width component of a two-dimensional size.

Enumerations

Enumeration	Description
BoundsType	An enumeration used by SetSize and Size constructors to initialize the size with the minimum (Min) or maximum (Max) size values.

Methods

Method	Description
Area	Determines the area of a size.
Center	Determines the center of the current size.
Clamp	Clamps the current size to alternate values.
ClampHeight	Clamps the current Height to an alternate value.
ClampWidth	Clamps the current Width to an alternate value.
ClampedTo	Clamps the current size to alternate values.
ClampedToHeight	Clamps the current Height to an alternate value.
ClampedToWidth	Clamps the current Width to an alternate value.
Clear	Initializes Width and Height to zero.
Contract	Contracts the current size by subtracting a fixed value from each of its components.
Div	Divides the current size by a fixed value.
Expand	Expands a size by adding a fixed value to each of its components.
ExpandedTo	Expands the current size to passed values (unions them).
ExpandedToHeight	Expands (unions) the Height of the current size to a passed value.
ExpandedToWidth	Expands (unions) the Width of the current size to a passed value.
HCenter	Determines the center of Width.
IsEmpty	Determines whether the size is empty.
IsNull	Determines whether the size is NULL.
Mul	Multiplies the current size by a fixed value.
Size	Initializes a new instance of a size.
SetHeight	Sets the Height component of the current size.
SetLerp	SetLerp set to a + (b - a) * t
SetSize	Sets the components of the current size.
SetWidth	Sets the Width component of the current size.
Swap	Swaps the components of the current size with those of a passed size.
Transpose	Swaps the Width and Height components of the current size.
VCenter	Determines the center of Height.

Topics

Topic	Description
Scaleform::Render::Size::IsValid@const	Determines whether the size is valid.

Operators

Operator	Description
*=	Multiplies the components of the size by fixed value.
/=	Contracts a size by dividing each of its components by a fixed value.
!=	Determines the inequality of two sizes.
&=	Clamps a size to another size.
\|=	Determines the union of two sizes.
+=	Expands a size by adding a fixed value to each of its components.
-=	Contracts a size by subtracting a fixed value from each of its components.
=	Assigns values to each component of a current size.
==	Determines the equality of two sizes.
-	Negates the components of a size.
&	Determines the intersection of two sizes.
*	Multiplies each of its components by a fixed value.
/	Divides each size component by a fixed value.
+	Expands a size by adding fixed values to its components.
\|	Determines the union of two sizes.
Size<S>

File

Render_Types2D.h