C# Class Glare.Box4i

A four-dimensional box that uses Int32 elements.

ファイルを表示 Open project: Burton-Radons/Alexandria Class Usage Examples

Public Properties

Property	Type	Description
Max	Vector4i
Min	Vector4i
Zero	Box4i

Public Methods

Method	Description
Box4i ( Int32 minX, Int32 minY, Int32 minZ, Int32 minW, Int32 maxX, Int32 maxY, Int32 maxZ, Int32 maxW ) : System	Create a Box4i by providing minimum and maximum extents.
Box4i ( Vector4i min, Vector4i max ) : System	Create a Box4i by providing minimum and maximum extents.
Distance ( Vector4i point ) : double	Get the closest distance between this Box4i and the Vector4i.
Intersect ( Vector4i point ) : Containment	Get the intersection type between this box and the point.
NearestPointTo ( Vector4i point ) : Vector4i	Get the nearest point between this Box4i and a Vector4i. If the Vector4i is inside this Box4i, it is returned untouched.
NearestPointTo ( Vector4i &point, Vector4i &result ) : void	Get the nearest point between this Box4i and a Vector4i. If the Vector4i is inside this Box4i, it is returned untouched.
Overlaps ( Vector4i point ) : bool	Get whether this Box4i inclusively intersects with the Vector4i.
Random ( Random rng ) : Vector4i	Get a random position within the box.
Random ( Random rng, Vector4i &result ) : void	Get a random position within the box.
Relative ( Int32 minX, Int32 minY, Int32 minZ, Int32 minW, Int32 sizeX, Int32 sizeY, Int32 sizeZ, Int32 sizeW ) : Box4i	Create a Box4i by providing the minimum extent and the size of each side.
Relative ( Vector4i min, Vector4i size ) : Box4i	Create a Box4i by providing the minimum extent and the size of each side.
Relative ( Int32 minX, Int32 minY, Int32 minZ, Int32 minW, Int32 sizeX, Int32 sizeY, Int32 sizeZ, Int32 sizeW, Box4i &result ) : void	Create a Box4i by providing the minimum extent and the size of each side.
Relative ( Vector4i min, Vector4i size, Box4i &result ) : void	Create a Box4i by providing the minimum extent and the size of each side.
ToString ( ) : string	Convert to a string representation of the Box4i.
ToString ( string format, IFormatProvider provider ) : string	Convert to a string representation of the Box4i.

Method Details

Box4i() public method

Create a Box4i by providing minimum and maximum extents.

public Box4i ( Int32 minX, Int32 minY, Int32 minZ, Int32 minW, Int32 maxX, Int32 maxY, Int32 maxZ, Int32 maxW ) : System
minX	System.Int32
minY	System.Int32
minZ	System.Int32
minW	System.Int32
maxX	System.Int32
maxY	System.Int32
maxZ	System.Int32
maxW	System.Int32
return	System

Box4i() public method

Create a Box4i by providing minimum and maximum extents.

public Box4i ( Vector4i min, Vector4i max ) : System
min	Vector4i
max	Vector4i
return	System

Distance() public method

Get the closest distance between this Box4i and the Vector4i.

public Distance ( Vector4i point ) : double
point	Vector4i
return	double

Intersect() public method

Get the intersection type between this box and the point.

public Intersect ( Vector4i point ) : Containment
point	Vector4i
return	Containment

NearestPointTo() public method

Get the nearest point between this Box4i and a Vector4i. If the Vector4i is inside this Box4i, it is returned untouched.

public NearestPointTo ( Vector4i point ) : Vector4i
point	Vector4i
return	Vector4i

NearestPointTo() public method

Get the nearest point between this Box4i and a Vector4i. If the Vector4i is inside this Box4i, it is returned untouched.

public NearestPointTo ( Vector4i &point, Vector4i &result ) : void
point	Vector4i
result	Vector4i
return	void

Overlaps() public method

Get whether this Box4i inclusively intersects with the Vector4i.

public Overlaps ( Vector4i point ) : bool
point	Vector4i
return	bool

Random() public method

Get a random position within the box.

public Random ( Random rng ) : Vector4i
rng	System.Random
return	Vector4i

Random() public method

Get a random position within the box.

public Random ( Random rng, Vector4i &result ) : void
rng	System.Random
result	Vector4i
return	void

Relative() public static method

Create a Box4i by providing the minimum extent and the size of each side.

public static Relative ( Int32 minX, Int32 minY, Int32 minZ, Int32 minW, Int32 sizeX, Int32 sizeY, Int32 sizeZ, Int32 sizeW ) : Box4i
minX	System.Int32
minY	System.Int32
minZ	System.Int32
minW	System.Int32
sizeX	System.Int32
sizeY	System.Int32
sizeZ	System.Int32
sizeW	System.Int32
return	Box4i

Relative() public static method

Create a Box4i by providing the minimum extent and the size of each side.

public static Relative ( Vector4i min, Vector4i size ) : Box4i
min	Vector4i
size	Vector4i
return	Box4i

Relative() public static method

Create a Box4i by providing the minimum extent and the size of each side.

public static Relative ( Int32 minX, Int32 minY, Int32 minZ, Int32 minW, Int32 sizeX, Int32 sizeY, Int32 sizeZ, Int32 sizeW, Box4i &result ) : void
minX	System.Int32
minY	System.Int32
minZ	System.Int32
minW	System.Int32
sizeX	System.Int32
sizeY	System.Int32
sizeZ	System.Int32
sizeW	System.Int32
result	Box4i
return	void

Relative() public static method

Create a Box4i by providing the minimum extent and the size of each side.

public static Relative ( Vector4i min, Vector4i size, Box4i &result ) : void
min	Vector4i
size	Vector4i
result	Box4i
return	void

ToString() public method

Convert to a string representation of the Box4i.

public ToString ( ) : string
return	string

ToString() public method

Convert to a string representation of the Box4i.

public ToString ( string format, IFormatProvider provider ) : string
format	string
provider	IFormatProvider
return	string

Property Details

Max public_oe property

The maximum extents of the Box4i.

public Vector4i Max
return	Vector4i

Min public_oe property

The minimum extents of the Box4i.

public Vector4i Min
return	Vector4i

Zero public_oe static_oe property

Get an empty Box4i centred on the origin.

public static Box4i Zero
return	Box4i