Falco Engine 3.9.0.1 (beta)
FalcoEngine.Bounds Struct Reference

Public Member Functions

 Bounds (Vector3 center, Vector3 size)
 
override int GetHashCode ()
 
override bool Equals (object other)
 
bool Equals (Bounds other)
 
void SetMinMax (Vector3 min, Vector3 max)
 
void Encapsulate (Vector3 point)
 
void Encapsulate (Bounds bounds)
 
void Expand (float amount)
 
void Expand (Vector3 amount)
 
bool Intersects (Bounds bounds)
 
override string ToString ()
 
string ToString (string format)
 

Static Public Member Functions

static bool operator== (Bounds lhs, Bounds rhs)
 
static bool operator!= (Bounds lhs, Bounds rhs)
 

Properties

Vector3 center [getset]
 
Vector3 size [getset]
 
Vector3 extents [getset]
 
Vector3 min [getset]
 
Vector3 max [getset]
 

Detailed Description

Definition at line 8 of file Bounds.cs.

Constructor & Destructor Documentation

◆ Bounds()

FalcoEngine.Bounds.Bounds ( Vector3  center,
Vector3  size 
)

Creates a new Bounds.

Parameters
centerThe location of the origin of the Bounds.
sizeThe dimensions of the Bounds.

Definition at line 94 of file Bounds.cs.

Member Function Documentation

◆ Encapsulate() [1/2]

void FalcoEngine.Bounds.Encapsulate ( Bounds  bounds)

Grow the bounds to encapsulate the bounds.

Parameters
bounds

Definition at line 153 of file Bounds.cs.

◆ Encapsulate() [2/2]

void FalcoEngine.Bounds.Encapsulate ( Vector3  point)

Grows the Bounds to include the point.

Parameters
point

Definition at line 144 of file Bounds.cs.

◆ Equals() [1/2]

bool FalcoEngine.Bounds.Equals ( Bounds  other)

Definition at line 114 of file Bounds.cs.

◆ Equals() [2/2]

override bool FalcoEngine.Bounds.Equals ( object  other)

Definition at line 105 of file Bounds.cs.

◆ Expand() [1/2]

void FalcoEngine.Bounds.Expand ( float  amount)

Expand the bounds by increasing its size by amount along each side.

Parameters
amount

Definition at line 163 of file Bounds.cs.

◆ Expand() [2/2]

void FalcoEngine.Bounds.Expand ( Vector3  amount)

Expand the bounds by increasing its size by amount along each side.

Parameters
amount

Definition at line 173 of file Bounds.cs.

◆ GetHashCode()

override int FalcoEngine.Bounds.GetHashCode ( )

Definition at line 100 of file Bounds.cs.

◆ Intersects()

bool FalcoEngine.Bounds.Intersects ( Bounds  bounds)

Does another bounding box intersect with this bounding box?

Parameters
bounds

Definition at line 182 of file Bounds.cs.

◆ operator!=()

static bool FalcoEngine.Bounds.operator!= ( Bounds  lhs,
Bounds  rhs 
)
static

Definition at line 124 of file Bounds.cs.

◆ operator==()

static bool FalcoEngine.Bounds.operator== ( Bounds  lhs,
Bounds  rhs 
)
static

Definition at line 119 of file Bounds.cs.

◆ SetMinMax()

void FalcoEngine.Bounds.SetMinMax ( Vector3  min,
Vector3  max 
)

Sets the bounds to the min and max value of the box.

Parameters
min
max

Definition at line 134 of file Bounds.cs.

◆ ToString() [1/2]

override string FalcoEngine.Bounds.ToString ( )

Returns a nicely formatted string for the bounds.

Parameters
format

Definition at line 191 of file Bounds.cs.

◆ ToString() [2/2]

string FalcoEngine.Bounds.ToString ( string  format)

Returns a nicely formatted string for the bounds.

Parameters
format

Definition at line 200 of file Bounds.cs.

Property Documentation

◆ center

Vector3 FalcoEngine.Bounds.center
getset

The center of the bounding box.

Definition at line 17 of file Bounds.cs.

◆ extents

Vector3 FalcoEngine.Bounds.extents
getset

The extents of the Bounding Box. This is always half of the size of the Bounds.

Definition at line 47 of file Bounds.cs.

◆ max

Vector3 FalcoEngine.Bounds.max
getset

The maximal point of the box. This is always equal to center+extents.

Definition at line 77 of file Bounds.cs.

◆ min

Vector3 FalcoEngine.Bounds.min
getset

The minimal point of the box. This is always equal to center-extents.

Definition at line 62 of file Bounds.cs.

◆ size

Vector3 FalcoEngine.Bounds.size
getset

The total size of the box. This is always twice as large as the extents.

Definition at line 32 of file Bounds.cs.


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