pluginbase.Helpers.Coords.Volume Struct Reference

Represent a 3D axis-aligned volume More...

Inheritance diagram for pluginbase.Helpers.Coords.Volume:

Public Member Functions
	Volume (Vector3i pt, Size3i size)
	Volume (Vector3i pt, int cubeSize)
	Volume (int x, int y, int z, int width, int length, int height)
	Volume (int x, int y, int z, int cubeSize)
Volume	NormalForm ()
	Creates the normal-form volume (That is, the size will always be positive) More...
bool	PointIn (Vector3i pt)
bool	Intersects (Volume otherVolume)
	Check if this volume intersects the other volume More...
override int	GetHashCode ()
bool	Equals (Volume cube)
override bool	Equals (object obj)
override string	ToString ()

Static Public Member Functions
static Volume	RadiusAround (Vector3i pt, int radius)
	Creates a volume around a point, with a radius of size More...
static Volume	RadiusBelow (Vector3i pt, int radius)
	Creates a volume around a point, with a radius of size, but that doesn't go above a point More...
static Volume	RadiusPlaneZ (Vector3i pt, int radius, int depth)
	Creates a radius around a plane with a z-depth More...
static Volume	FromPointCloud (IEnumerable< Vector3i > points)
	From a set of Vector3i points, returns a volume that holds them all. Will have at least size-1 if it has any points . Will be zero, otherwise More...
static Volume	FromPoints (Vector3i a, Vector3i b)
	Provides a normal-form volume that represents the space between two points More...

Public Attributes
Vector3i	Point
Size3i	Size
Vector3i	Center => new Vector3i(this.Point.X + this.Size.Width / 2, this.Point.Y + this.Size.Length / 2, this.Point.Z + this.Size.Height / 2)
	Approximate center of the volume (integer rounded) More...

Static Public Attributes
static readonly Volume	Zero = new Volume()

Properties
int	Left [get]
int	Right [get]
int	Bottom [get]
int	Top [get]
int	Floor [get]
int	Ceiling [get]
bool	IsCubic [get]

Detailed Description

Represent a 3D axis-aligned volume

Constructor & Destructor Documentation

Volume() [1/4]

pluginbase.Helpers.Coords.Volume.Volume	(	Vector3i	pt,
		Size3i	size
	)

        {
            Point = pt;
            Size = size;
        }

Volume() [2/4]

pluginbase.Helpers.Coords.Volume.Volume	(	Vector3i	pt,
		int	cubeSize
	)

        {
            Point = pt;
            Size = new Size3i(cubeSize);
        }

Volume() [3/4]

pluginbase.Helpers.Coords.Volume.Volume	(	int	x,
		int	y,
		int	z,
		int	width,
		int	length,
		int	height
	)

        {
            Point = new Vector3i(x,y,z);
            Size = new Size3i(width, length, height);
        }

Volume() [4/4]

pluginbase.Helpers.Coords.Volume.Volume	(	int	x,
		int	y,
		int	z,
		int	cubeSize
	)

        {
            Point = new Vector3i(x,y,z);
            Size = new Size3i(cubeSize);
        }

Member Function Documentation

Equals() [1/2]

bool pluginbase.Helpers.Coords.Volume.Equals

(

Volume

cube

)

        {
            return this.Size == cube.Size && this.Point == cube.Point;
        }

Equals() [2/2]

override bool pluginbase.Helpers.Coords.Volume.Equals

(

object

obj

)

        {
            if (obj is Volume)
            {
                return this.Equals((Volume)obj);
            }
            return false;
        }

FromPointCloud()

static Volume pluginbase.Helpers.Coords.Volume.FromPointCloud ( IEnumerable< Vector3i >  points )

static

From a set of Vector3i points, returns a volume that holds them all. Will have at least size-1 if it has any points . Will be zero, otherwise

Returns

The point cloud.

Parameters

points

Points.

        {
            if (!points.Any())
                return Volume.Zero;

            Vector3i min = new Vector3i(int.MaxValue, int.MaxValue, int.MaxValue);
            Vector3i max = new Vector3i(int.MinValue, int.MinValue, int.MinValue);
            foreach (Vector3i pt in points)
            {
                if (pt.X < min.X) min.X = pt.X;
                if (pt.Y < min.Y) min.Y = pt.Y;
                if (pt.Z < min.Z) min.Z = pt.Z;

                if (pt.X > max.X) max.X = pt.X;
                if (pt.Y > max.Y) max.Y = pt.Y;
                if (pt.Z > max.Z) max.Z = pt.Z;
            }
            return new Volume(min, (Size3i)(max - min + Vector3i.One));
        }

FromPoints()

static Volume pluginbase.Helpers.Coords.Volume.FromPoints ( Vector3i  a, Vector3i  b  )

static

Provides a normal-form volume that represents the space between two points

Returns

The points.

Parameters

a	The alpha component.
b	The blue component.

        {
            var a1 = Vector3i.ComponentMin(a, b);
            var b1 = Vector3i.ComponentMax(a, b);
            return new Volume(a1, (Size3i)(b1 - a1));
        }

GetHashCode()

override int pluginbase.Helpers.Coords.Volume.GetHashCode

(

)

        {
            return this.Point.GetHashCode() ^ this.Size.GetHashCode();
        }

Intersects()

bool pluginbase.Helpers.Coords.Volume.Intersects

(

Volume

otherVolume

)

Check if this volume intersects the other volume

Returns

The intersects.

Parameters

otherVolume

Other volume.

        {
            var self = this.NormalForm();
            var other = otherVolume.NormalForm();

            return !(self.Left > other.Right || self.Right < other.Left
                || self.Bottom > other.Top || self.Top < other.Bottom
                || self.Floor > other.Ceiling || self.Ceiling < other.Floor);
        }

NormalForm()

Volume pluginbase.Helpers.Coords.Volume.NormalForm

(

)

Creates the normal-form volume (That is, the size will always be positive)

Returns

The form.

        {
            return FromPoints(this.Point, this.Point + this.Size);
        }

PointIn()

bool pluginbase.Helpers.Coords.Volume.PointIn

(

Vector3i

pt

)

        {
            return !(
                pt.X < this.Point.X || pt.X >= this.Point.X + this.Size.Width
                || pt.Y < this.Point.Y || pt.Y >= this.Point.Y + this.Size.Length
                || pt.Z < this.Point.Z || pt.Z >= this.Point.Z + this.Size.Height
                );
        }

RadiusAround()

static Volume pluginbase.Helpers.Coords.Volume.RadiusAround ( Vector3i  pt, int  radius  )

static

Creates a volume around a point, with a radius of size

Returns

The around.

Parameters

pt	Point.
radius	Size.

        {
            return new Volume(pt.X - radius, pt.Y - radius, pt.Z - radius, radius*2);
        }

RadiusBelow()

static Volume pluginbase.Helpers.Coords.Volume.RadiusBelow ( Vector3i  pt, int  radius  )

static

Creates a volume around a point, with a radius of size, but that doesn't go above a point

Returns

The below.

Parameters

pt	Point.
radius	Size.

        {
            return new Volume(pt.X - radius, pt.Y - radius, pt.Z - radius, radius*2, radius*2, radius);
        }

RadiusPlaneZ()

static Volume pluginbase.Helpers.Coords.Volume.RadiusPlaneZ ( Vector3i  pt, int  radius, int  depth  )

static

Creates a radius around a plane with a z-depth

Returns

The z.

Parameters

pt	Point.
radius	Radius.
depth	Depth.

        {
            return new Volume(pt.X - radius, pt.Y - radius, pt.Z, radius * 2, radius * 2, depth);
        }

ToString()

override string pluginbase.Helpers.Coords.Volume.ToString

(

)

        {
            return string.Format("[Volume: Point={0}, Size={1}]", Point, Size);
        }

Member Data Documentation

Center

Vector3i pluginbase.Helpers.Coords.Volume.Center => new Vector3i(this.Point.X + this.Size.Width / 2, this.Point.Y + this.Size.Length / 2, this.Point.Z + this.Size.Height / 2)

Approximate center of the volume (integer rounded)

The center.

Point

Vector3i pluginbase.Helpers.Coords.Volume.Point

Size

Size3i pluginbase.Helpers.Coords.Volume.Size

Zero

readonly Volume pluginbase.Helpers.Coords.Volume.Zero = new Volume()

static

Property Documentation

Bottom

int pluginbase.Helpers.Coords.Volume.Bottom

get

Ceiling

int pluginbase.Helpers.Coords.Volume.Ceiling

get

Floor

int pluginbase.Helpers.Coords.Volume.Floor

get

IsCubic

bool pluginbase.Helpers.Coords.Volume.IsCubic

get

Left

int pluginbase.Helpers.Coords.Volume.Left

get

Right

int pluginbase.Helpers.Coords.Volume.Right

get

Top

int pluginbase.Helpers.Coords.Volume.Top

get

---

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

• pluginbase/Helpers/Coords/Volume.cs