Struct GorgonBox

A structure with a width, height and depth.

Implements

IGorgonEquatableByRef<GorgonBox>

IEquatable<GorgonBox>

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Namespace: Gorgon.Graphics

Assembly: Gorgon.Core.dll

Syntax

public struct GorgonBox : IGorgonEquatableByRef<GorgonBox>, IEquatable<GorgonBox>

Remarks

This value type merely represents the dimensions of a box, it does not draw a box.

Fields

| Edit this page View Source

Depth

Depth of the box.

Declaration

public int Depth

Field Value

Type	Description
int

| Edit this page View Source

Empty

An empty box.

Declaration

public static readonly GorgonBox Empty

Field Value

Type	Description
GorgonBox

| Edit this page View Source

Height

Height of the box.

Declaration

public int Height

Field Value

Type	Description
int

| Edit this page View Source

Width

Width of the box.

Declaration

public int Width

Field Value

Type	Description
int

| Edit this page View Source

X

Horizontal position.

Declaration

public int X

Field Value

Type	Description
int

| Edit this page View Source

Y

Vertical position

Declaration

public int Y

Field Value

Type	Description
int

| Edit this page View Source

Z

Depth position.

Declaration

public int Z

Field Value

Type	Description
int

Properties

| Edit this page View Source

Back

Property to return the back value of the box.

Declaration

public readonly int Back { get; }

Property Value

Type	Description
int

| Edit this page View Source

Bottom

Property to return the bottom value of the box.

Declaration

public readonly int Bottom { get; }

Property Value

Type	Description
int

| Edit this page View Source

Front

Property to set or return the front value for the box.

Declaration

public int Front { readonly get; set; }

Property Value

Type	Description
int

| Edit this page View Source

IsEmpty

Property to determine if the box is empty.

Declaration

public readonly bool IsEmpty { get; }

Property Value

Type	Description
bool

| Edit this page View Source

Left

Property to set or return the left value for the box.

Declaration

public int Left { readonly get; set; }

Property Value

Type	Description
int

| Edit this page View Source

Right

Property to return the right value of the box.

Declaration

public readonly int Right { get; }

Property Value

Type	Description
int

| Edit this page View Source

Top

Property to set or return the top value for the box.

Declaration

public int Top { readonly get; set; }

Property Value

Type	Description
int

Methods

| Edit this page View Source

Equals(GorgonBox)

Indicates whether the current object is equal to another object of the same type.

Declaration

public readonly bool Equals(GorgonBox other)

Parameters

Type	Name	Description
GorgonBox	other	An object to compare with this object.

Returns

Type	Description
bool	true if the current object is equal to the other parameter; otherwise, false.

| Edit this page View Source

Equals(in GorgonBox)

Indicates whether the current object is equal to another object of the same type.

Declaration

public readonly bool Equals(in GorgonBox other)

Parameters

Type	Name	Description
GorgonBox	other	An object to compare with this object.

Returns

Type	Description
bool	true if the current object is equal to the other parameter; otherwise, false.

| Edit this page View Source

Equals(in GorgonBox, in GorgonBox)

Function to return whether two instances are equal or not.

Declaration

public static bool Equals(in GorgonBox left, in GorgonBox right)

Parameters

Type	Name	Description
GorgonBox	left	The left instance to compare.
GorgonBox	right	The right instance to compare.

Returns

Type	Description
bool	true if equal, false if not.

| Edit this page View Source

Equals(object)

Determines whether the specified object is equal to this instance.

Declaration

public override readonly bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with this instance.

Returns

Type	Description
bool	true if the specified object is equal to this instance; otherwise, false.

Overrides

ValueType.Equals(object)

| Edit this page View Source

FromTLFRBB(int, int, int, int, int, int)

Function to return a box from top, left, front, right, bottom and back coordinates.

Declaration

public static GorgonBox FromTLFRBB(int top, int left, int front, int right, int bottom, int back)

Parameters

Type	Name	Description
int	top	Top coordinate.
int	left	Left coordinate
int	front	Front coordinate.
int	right	Right coordinate.
int	bottom	Bottom coordinate.
int	back	Back coordinate.

Returns

Type	Description
GorgonBox	A new box with the specified coordinates.

| Edit this page View Source

GetHashCode()

Returns a hash code for this instance.

Declaration

public override readonly int GetHashCode()

Returns

Type	Description
int	A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Overrides

ValueType.GetHashCode()

| Edit this page View Source

Intersect(GorgonBox)

Funciton to determine the intersection between this and another box.

Declaration

public readonly GorgonBox Intersect(GorgonBox box)

Parameters

Type	Name	Description
GorgonBox	box	Box to intersect.

Returns

Type	Description
GorgonBox	The intersection between this box and the other box.

| Edit this page View Source

Intersect(GorgonBox, GorgonBox)

Function to determine the intersection between 2 boxes.

Declaration

public static GorgonBox Intersect(GorgonBox box1, GorgonBox box2)

Parameters

Type	Name	Description
GorgonBox	box1	First box to intersect.
GorgonBox	box2	Second box to intersect.

Returns

Type	Description
GorgonBox	The intersected box.

| Edit this page View Source

Intersect(in GorgonBox, in GorgonBox, out GorgonBox)

Function to determine the intersection between 2 boxes.

Declaration

public static void Intersect(in GorgonBox box1, in GorgonBox box2, out GorgonBox result)

Parameters

Type	Name	Description
GorgonBox	box1	First box to intersect.
GorgonBox	box2	Second box to intersect.
GorgonBox	result	The resulting intersected box.

| Edit this page View Source

ToString()

Returns a string that represents this instance.

Declaration

public override readonly string ToString()

Returns

Type	Description
string	A string that represents this instance.

Overrides

ValueType.ToString()

Operators

| Edit this page View Source

operator ==(GorgonBox, GorgonBox)

Operator to determine if 2 instances are equal.

Declaration

public static bool operator ==(GorgonBox left, GorgonBox right)

Parameters

Type	Name	Description
GorgonBox	left	The left instance to compare.
GorgonBox	right	The right instance to compare.

Returns

Type	Description
bool	true if equal, false if not.

| Edit this page View Source

operator !=(GorgonBox, GorgonBox)

Operator to determine if 2 instances are not equal.

Declaration

public static bool operator !=(GorgonBox left, GorgonBox right)

Parameters

Type	Name	Description
GorgonBox	left	The left instance to compare.
GorgonBox	right	The right instance to compare.

Returns

Type	Description
bool	true if not equal, false if equal.

Implements

IGorgonEquatableByRef<T>

IEquatable<T>

Extension Methods

GorgonNullExtensions.AsNullable<T>(object)

GorgonNullExtensions.IfNull<T>(object, T)

GorgonNullExtensions.IsNull(object)