C# Class Glare.Box3i

A three-dimensional box that uses Int32 elements.
Show file Open project: Burton-Radons/Alexandria Class Usage Examples

Public Properties

Property Type Description
Max Vector3i
Min Vector3i
Zero Box3i

Public Methods

Method Description
Box3i ( Int32 minX, Int32 minY, Int32 minZ, Int32 maxX, Int32 maxY, Int32 maxZ ) : System

Create a Box3i by providing minimum and maximum extents.
Box3i ( Vector3i min, Vector3i max ) : System

Create a Box3i by providing minimum and maximum extents.
Distance ( Vector3i point ) : double

Get the closest distance between this Box3i and the Vector3i.
Intersect ( Frustum frustum ) : Containment

Get the intersection between a Box3i and a Frustum.
Intersect ( Vector3i point ) : Containment

Get the intersection type between this box and the point.
NearestPointTo ( Vector3i point ) : Vector3i

Get the nearest point between this Box3i and a Vector3i. If the Vector3i is inside this Box3i, it is returned untouched.
NearestPointTo ( Vector3i &point, Vector3i &result ) : void

Get the nearest point between this Box3i and a Vector3i. If the Vector3i is inside this Box3i, it is returned untouched.
Overlaps ( Vector3i point ) : bool

Get whether this Box3i inclusively intersects with the Vector3i.
Random ( Random rng ) : Vector3i

Get a random position within the box.
Random ( Random rng, Vector3i &result ) : void

Get a random position within the box.
Relative ( Int32 minX, Int32 minY, Int32 minZ, Int32 sizeX, Int32 sizeY, Int32 sizeZ ) : Box3i

Create a Box3i by providing the minimum extent and the size of each side.
Relative ( Vector3i min, Vector3i size ) : Box3i

Create a Box3i by providing the minimum extent and the size of each side.
Relative ( Int32 minX, Int32 minY, Int32 minZ, Int32 sizeX, Int32 sizeY, Int32 sizeZ, Box3i &result ) : void

Create a Box3i by providing the minimum extent and the size of each side.
Relative ( Vector3i min, Vector3i size, Box3i &result ) : void

Create a Box3i by providing the minimum extent and the size of each side.
ToString ( ) : string

Convert to a string representation of the Box3i.
ToString ( string format, IFormatProvider provider ) : string

Convert to a string representation of the Box3i.

Method Details

Box3i() public method

Create a Box3i by providing minimum and maximum extents.
public Box3i ( Int32 minX, Int32 minY, Int32 minZ, Int32 maxX, Int32 maxY, Int32 maxZ ) : System
minX System.Int32
minY System.Int32
minZ System.Int32
maxX System.Int32
maxY System.Int32
maxZ System.Int32
return System

Box3i() public method

Create a Box3i by providing minimum and maximum extents.
public Box3i ( Vector3i min, Vector3i max ) : System
min Vector3i
max Vector3i
return System

Distance() public method

Get the closest distance between this Box3i and the Vector3i.
public Distance ( Vector3i point ) : double
point Vector3i
return double

Intersect() public method

Get the intersection between a Box3i and a Frustum.
public Intersect ( Frustum frustum ) : Containment
frustum Frustum
return Containment

Intersect() public method

Get the intersection type between this box and the point.
public Intersect ( Vector3i point ) : Containment
point Vector3i
return Containment

NearestPointTo() public method

Get the nearest point between this Box3i and a Vector3i. If the Vector3i is inside this Box3i, it is returned untouched.
public NearestPointTo ( Vector3i point ) : Vector3i
point Vector3i
return Vector3i

NearestPointTo() public method

Get the nearest point between this Box3i and a Vector3i. If the Vector3i is inside this Box3i, it is returned untouched.
public NearestPointTo ( Vector3i &point, Vector3i &result ) : void
point Vector3i
result Vector3i
return void

Overlaps() public method

Get whether this Box3i inclusively intersects with the Vector3i.
public Overlaps ( Vector3i point ) : bool
point Vector3i
return bool

Random() public method

Get a random position within the box.
public Random ( Random rng ) : Vector3i
rng System.Random
return Vector3i

Random() public method

Get a random position within the box.
public Random ( Random rng, Vector3i &result ) : void
rng System.Random
result Vector3i
return void

Relative() public static method

Create a Box3i by providing the minimum extent and the size of each side.
public static Relative ( Int32 minX, Int32 minY, Int32 minZ, Int32 sizeX, Int32 sizeY, Int32 sizeZ ) : Box3i
minX System.Int32
minY System.Int32
minZ System.Int32
sizeX System.Int32
sizeY System.Int32
sizeZ System.Int32
return Box3i

Relative() public static method

Create a Box3i by providing the minimum extent and the size of each side.
public static Relative ( Vector3i min, Vector3i size ) : Box3i
min Vector3i
size Vector3i
return Box3i

Relative() public static method

Create a Box3i by providing the minimum extent and the size of each side.
public static Relative ( Int32 minX, Int32 minY, Int32 minZ, Int32 sizeX, Int32 sizeY, Int32 sizeZ, Box3i &result ) : void
minX System.Int32
minY System.Int32
minZ System.Int32
sizeX System.Int32
sizeY System.Int32
sizeZ System.Int32
result Box3i
return void

Relative() public static method

Create a Box3i by providing the minimum extent and the size of each side.
public static Relative ( Vector3i min, Vector3i size, Box3i &result ) : void
min Vector3i
size Vector3i
result Box3i
return void

ToString() public method

Convert to a string representation of the Box3i.
public ToString ( ) : string
return string

ToString() public method

Convert to a string representation of the Box3i.
public ToString ( string format, IFormatProvider provider ) : string
format string
provider IFormatProvider
return string

Property Details

Max public property

The maximum extents of the Box3i.
public Vector3i Max
return Vector3i

Min public property

The minimum extents of the Box3i.
public Vector3i Min
return Vector3i

Zero public static property

Get an empty Box3i centred on the origin.
public static Box3i,Glare Zero
return Box3i