C# Class Glare.Box4

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

Public Properties

Property Type Description
Max System.Vector4
Min System.Vector4
Zero Box4

Public Methods

Method Description
Box4 ( Length minX, Length minY, Length minZ, Length minW, Length maxX, Length maxY, Length maxZ, Length maxW ) : System

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

Create a Box4 by providing minimum and maximum extents.
Distance ( System.Vector4 point ) : Length

Get the closest distance between this Box4 and the Vector4.
Intersect ( System.Vector4 point ) : Containment

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

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

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

Get whether this Box4 inclusively intersects with the Vector4.
Random ( Random rng ) : System.Vector4

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

Get a random position within the box.
Relative ( Length minX, Length minY, Length minZ, Length minW, Length sizeX, Length sizeY, Length sizeZ, Length sizeW ) : Box4

Create a Box4 by providing the minimum extent and the size of each side.
Relative ( System.Vector4 min, System.Vector4 size ) : Box4

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

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

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

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

Convert to a string representation of the Box4.

Method Details

Box4() public method

Create a Box4 by providing minimum and maximum extents.
public Box4 ( Length minX, Length minY, Length minZ, Length minW, Length maxX, Length maxY, Length maxZ, Length maxW ) : System
minX Length
minY Length
minZ Length
minW Length
maxX Length
maxY Length
maxZ Length
maxW Length
return System

Box4() public method

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

Distance() public method

Get the closest distance between this Box4 and the Vector4.
public Distance ( System.Vector4 point ) : Length
point System.Vector4
return Length

Intersect() public method

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

NearestPointTo() public method

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

NearestPointTo() public method

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

Overlaps() public method

Get whether this Box4 inclusively intersects with the Vector4.
public Overlaps ( System.Vector4 point ) : bool
point System.Vector4
return bool

Random() public method

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

Random() public method

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

Relative() public static method

Create a Box4 by providing the minimum extent and the size of each side.
public static Relative ( Length minX, Length minY, Length minZ, Length minW, Length sizeX, Length sizeY, Length sizeZ, Length sizeW ) : Box4
minX Length
minY Length
minZ Length
minW Length
sizeX Length
sizeY Length
sizeZ Length
sizeW Length
return Box4

Relative() public static method

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

Relative() public static method

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

Relative() public static method

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

ToString() public method

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

ToString() public method

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

Property Details

Max public property

The maximum extents of the Box4.
public Vector4,System Max
return System.Vector4

Min public property

The minimum extents of the Box4.
public Vector4,System Min
return System.Vector4

Zero public static property

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