Struct Rectangle

Describes rectangle in 2D space defines by location of its upper-left corner and the size.

Assembly: FlaxEngine.dll

File: Engine/Core/Math/Rectangle.h

Syntax

public struct Rectangle

Constructors

Rectangle()

Empty constructor.

Declaration

public Rectangle() = default

Rectangle(const Float2& location, const Float2& size)

Initializes a new instance of the Rectangle struct.

Declaration

public Rectangle(const Float2& location, const Float2& size)

Parameters

Float2 location The location of the upper left corner.

Float2 size The size.

Rectangle(float x, float y, float width, float height)

Initializes a new instance of the Rectangle struct.

Declaration

public Rectangle(float x, float y, float width, float height)

Parameters

float x The X coordinate of the upper left corner.

float y The Y coordinate of the upper left corner.

float width The width.

float height The height.

Fields

Empty

The empty rectangle.

Declaration

public static Rectangle Empty

Field Value

Rectangle

Location

Rectangle location (coordinates of the upper-left corner)

Declaration

public Float2 Location

Field Value

Float2

Size

Rectangle size

Declaration

public Float2 Size

Field Value

Float2

Methods

Contains(const Float2& location)

Declaration

public bool Contains(const Float2& location) const

Parameters

Float2 location

Returns

bool

Contains(const Rectangle& value)

Declaration

public bool Contains(const Rectangle& value) const

Parameters

Rectangle value

Returns

bool

Expand(float toExpand)

Declaration

public void Expand(float toExpand)

Parameters

float toExpand

FromPoints(const Float2& p1, const Float2& p2)

Declaration

public static Rectangle FromPoints(const Float2& p1, const Float2& p2)

Parameters

Float2 p1

Float2 p2

Returns

Rectangle

FromPoints(const Float2* points, int32 pointsCount)

Declaration

public static Rectangle FromPoints(const Float2* points, int32 pointsCount)

Parameters

Float2 points

int32 pointsCount

Returns

Rectangle

GetBottom()

Declaration

public float GetBottom() const

Returns

float

GetBottomLeft()

Declaration

public Float2 GetBottomLeft() const

Returns

Float2

GetBottomRight()

Declaration

public Float2 GetBottomRight() const

Returns

Float2

GetCenter()

Declaration

public Float2 GetCenter() const

Returns

Float2

GetHeight()

Declaration

public float GetHeight() const

Returns

float

GetLeft()

Declaration

public float GetLeft() const

Returns

float

GetLowerLeft()

Declaration

public Float2 GetLowerLeft() const

Returns

Float2

GetLowerRight()

Declaration

public Float2 GetLowerRight() const

Returns

Float2

GetRight()

Declaration

public float GetRight() const

Returns

float

GetTop()

Declaration

public float GetTop() const

Returns

float

GetTopLeft()

Declaration

public Float2 GetTopLeft() const

Returns

Float2

GetTopRight()

Declaration

public Float2 GetTopRight() const

Returns

Float2

GetUpperLeft()

Declaration

public Float2 GetUpperLeft() const

Returns

Float2

GetUpperRight()

Declaration

public Float2 GetUpperRight() const

Returns

Float2

GetWidth()

Declaration

public float GetWidth() const

Returns

float

GetX()

Declaration

public float GetX() const

Returns

float

GetY()

Declaration

public float GetY() const

Returns

float

Intersects(const Rectangle& value)

Declaration

public bool Intersects(const Rectangle& value) const

Parameters

Rectangle value

Returns

bool

MakeExpanded(float toExpand)

Declaration

public Rectangle MakeExpanded(float toExpand) const

Parameters

float toExpand

Returns

Rectangle

MakeOffsetted(const Float2& offset)

Declaration

public Rectangle MakeOffsetted(const Float2& offset) const

Parameters

Float2 offset

Returns

Rectangle

MakeScaled(float scale)

Declaration

public Rectangle MakeScaled(float scale) const

Parameters

float scale

Returns

Rectangle

NearEqual(const Rectangle& a, const Rectangle& b)

Declaration

public static bool NearEqual(const Rectangle& a, const Rectangle& b)

Parameters

Rectangle a

Rectangle b

Returns

bool

NearEqual(const Rectangle& a, const Rectangle& b, float epsilon)

Declaration

public static bool NearEqual(const Rectangle& a, const Rectangle& b, float epsilon)

Parameters

Rectangle a

Rectangle b

float epsilon

Returns

bool

Offset(const Float2& offset)

Declaration

public void Offset(const Float2& offset)

Parameters

Float2 offset

Offset(float x, float y)

Declaration

public void Offset(float x, float y)

Parameters

float x

float y

operator!=(const Rectangle& b)

Declaration

public bool operator!=(const Rectangle& b) const

Parameters

Rectangle b

Returns

bool

operator-(const Float2& v)

Declaration

public Rectangle operator-(const Float2& v) const

Parameters

Float2 v

Returns

Rectangle

operator*(float b)

Declaration

public Rectangle operator*(float b) const

Parameters

float b

Returns

Rectangle

operator*=(float b)

Declaration

public Rectangle operator*=(float b)

Parameters

float b

Returns

Rectangle

operator/(float b)

Declaration

public Rectangle operator/(float b) const

Parameters

float b

Returns

Rectangle

operator/=(float b)

Declaration

public Rectangle operator/=(float b)

Parameters

float b

Returns

Rectangle

operator+(const Float2& v)

Declaration

public Rectangle operator+(const Float2& v) const

Parameters

Float2 v

Returns

Rectangle

operator+=(const Float2& b)

Declaration

public Rectangle operator+=(const Float2& b)

Parameters

Float2 b

Returns

Rectangle

operator-=(const Float2& b)

Declaration

public Rectangle operator-=(const Float2& b)

Parameters

Float2 b

Returns

Rectangle

operator==(const Rectangle& b)

Declaration

public bool operator==(const Rectangle& b) const

Parameters

Rectangle b

Returns

bool

Scale(float scale)

Declaration

public void Scale(float scale)

Parameters

float scale

Shared(const Rectangle& a, const Rectangle& b)

Declaration

public static Rectangle Shared(const Rectangle& a, const Rectangle& b)

Parameters

Rectangle a

Rectangle b

Returns

Rectangle

ToString()

Declaration

public String ToString() const

Returns

String

Union(const Rectangle& a, const Float2& b)

Declaration

public static Rectangle Union(const Rectangle& a, const Float2& b)

Parameters

Rectangle a

Float2 b

Returns

Rectangle

Union(const Rectangle& a, const Rectangle& b)

Declaration

public static Rectangle Union(const Rectangle& a, const Rectangle& b)

Parameters

Rectangle a

Rectangle b

Returns

Rectangle