Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
SiliconStudio.Paradox.UI.Thickness Struct Reference

Describes the thickness of a frame around a cuboid. Six float values describe the Left, Top, Right, Bottom, Front, and Back sides of the cuboid, respectively. More...

Public Member Functions

 Thickness (float left, float top, float right, float bottom)
 Initializes a new instance of the Thickness structure that has specific lengths applied to each side of the rectangle. More...
 
 Thickness (float left, float top, float back, float right, float bottom, float front)
 Initializes a new instance of the Thickness structure that has specific lengths applied to each side of the cuboid. More...
 

Static Public Member Functions

static Thickness UniformRectangle (float thickness)
 Initializes a new instance of the Thickness structure that has the specified uniform length on the Left, Right, Top, Bottom side and 0 for the Front and Back side. More...
 
static Thickness UniformCuboid (float thickness)
 Initializes a new instance of the Thickness structure that has the specified uniform length on the Left, Right, Top, Bottom, Front, and Back side. More...
 
static Thickness operator- (Thickness value)
 Reverses the direction of a given Thickness. More...
 
static Thickness operator+ (Thickness value1, Thickness value2)
 Addition two Thickness together. More...
 
static Thickness operator/ (Thickness value1, float value2)
 Divide a Thickness by a float. More...
 

Public Attributes

float Bottom
 The bottom side of the bounding rectangle. More...
 
float Left
 The left side of the bounding rectangle. More...
 
float Right
 The right side of the bounding rectangle. More...
 
float Top
 The upper side of the bounding rectangle. More...
 
float Front
 The front side of the bounding rectangle. More...
 
float Back
 The Back side of the bounding rectangle. More...
 

Properties

float this[int index] [get]
 Gets the component at the specified index. More...
 

Detailed Description

Describes the thickness of a frame around a cuboid. Six float values describe the Left, Top, Right, Bottom, Front, and Back sides of the cuboid, respectively.

Definition at line 12 of file Thickness.cs.

Constructor & Destructor Documentation

SiliconStudio.Paradox.UI.Thickness.Thickness ( float  left,
float  top,
float  right,
float  bottom 
)

Initializes a new instance of the Thickness structure that has specific lengths applied to each side of the rectangle.

Parameters
bottomThe thickness for the lower side of the rectangle.
leftThe thickness for the left side of the rectangle.
rightThe thickness for the right side of the rectangle
topThe thickness for the upper side of the rectangle.

Definition at line 41 of file Thickness.cs.

References SiliconStudio.Paradox.UI.Bottom, and SiliconStudio.Paradox.UI.Top.

SiliconStudio.Paradox.UI.Thickness.Thickness ( float  left,
float  top,
float  back,
float  right,
float  bottom,
float  front 
)

Initializes a new instance of the Thickness structure that has specific lengths applied to each side of the cuboid.

Parameters
bottomThe thickness for the lower side of the rectangle.
leftThe thickness for the left side of the rectangle.
rightThe thickness for the right side of the rectangle
topThe thickness for the upper side of the rectangle.
frontThe thickness for the front side of the rectangle.
backThe thickness for the Back side of the rectangle.

Definition at line 92 of file Thickness.cs.

References SiliconStudio.Paradox.UI.Bottom, and SiliconStudio.Paradox.UI.Top.

Member Function Documentation

static Thickness SiliconStudio.Paradox.UI.Thickness.operator+ ( Thickness  value1,
Thickness  value2 
)
static

Addition two Thickness together.

Parameters
value1The first thickness to add.
value2The second thickness to add.
Returns
A Thickness with the opposite direction.

Definition at line 67 of file Thickness.cs.

References SiliconStudio.Paradox.UI.Thickness.Back, SiliconStudio.Paradox.UI.Thickness.Bottom, SiliconStudio.Paradox.UI.Thickness.Front, SiliconStudio.Paradox.UI.Thickness.Left, SiliconStudio.Paradox.UI.Thickness.Right, and SiliconStudio.Paradox.UI.Thickness.Top.

static Thickness SiliconStudio.Paradox.UI.Thickness.operator- ( Thickness  value)
static
static Thickness SiliconStudio.Paradox.UI.Thickness.operator/ ( Thickness  value1,
float  value2 
)
static

Divide a Thickness by a float.

Parameters
value1The first thickness to add.
value2The float value to divide by.
Returns
The divided thickness

Definition at line 78 of file Thickness.cs.

References SiliconStudio.Paradox.UI.Thickness.Back, SiliconStudio.Paradox.UI.Thickness.Bottom, SiliconStudio.Paradox.UI.Thickness.Front, SiliconStudio.Paradox.UI.Thickness.Left, SiliconStudio.Paradox.UI.Thickness.Right, and SiliconStudio.Paradox.UI.Thickness.Top.

static Thickness SiliconStudio.Paradox.UI.Thickness.UniformCuboid ( float  thickness)
static

Initializes a new instance of the Thickness structure that has the specified uniform length on the Left, Right, Top, Bottom, Front, and Back side.

Parameters
thicknessThe uniform length applied to all six sides of the bounding cuboid.
Returns
The created thickness class

Definition at line 29 of file Thickness.cs.

static Thickness SiliconStudio.Paradox.UI.Thickness.UniformRectangle ( float  thickness)
static

Initializes a new instance of the Thickness structure that has the specified uniform length on the Left, Right, Top, Bottom side and 0 for the Front and Back side.

Parameters
thicknessThe uniform length applied to all four sides of the bounding rectangle.
Returns
The created thickness class

Definition at line 19 of file Thickness.cs.

Member Data Documentation

float SiliconStudio.Paradox.UI.Thickness.Back
float SiliconStudio.Paradox.UI.Thickness.Bottom
float SiliconStudio.Paradox.UI.Thickness.Front
float SiliconStudio.Paradox.UI.Thickness.Left
float SiliconStudio.Paradox.UI.Thickness.Right
float SiliconStudio.Paradox.UI.Thickness.Top

Property Documentation

float SiliconStudio.Paradox.UI.Thickness.this[int index]
get

Gets the component at the specified index.

Parameters
indexThe index of the component to access. Use 0 for the Left component, 1 for the Top component, 2 for the Front component, 3 for the Right component, 4 for the Bottom component, 5 for the Back component.
Returns
The value of the component at the specified index.
Exceptions
System.ArgumentOutOfRangeExceptionThrown when the index is out of the range [0, 5].

Definition at line 140 of file Thickness.cs.


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