Box

N-dimensional half-open interval [a, b[.

struct Box (

T

int N

) {

alias bound_t = Vector!(T, N);

this(bound_t min_, bound_t max_);

this(T min_, T max_);

this(T min_x, T min_y, T max_x, T max_y);

this(T min_x, T min_y, T min_z, T max_x, T max_y, T max_z);

bound_t size [@property getter];

bound_t size [@property setter];

bound_t center [@property getter];

static if(N >= 1)

T width [@property getter];

static if(N >= 1)

T width [@property setter];

static if(N >= 2)

T height [@property getter];

static if(N >= 2)

T height [@property setter];

static if(N >= 3)

T depth [@property getter];

static if(N >= 3)

T depth [@property setter];

T volume [@property getter];

bool empty [@property getter];

bool contains(bound_t point);

static if(N >= 2)

bool contains(T x, T y);

static if(N >= 3)

bool contains(T x, T y, T z);

bool contains(Box other);

real squaredDistance(bound_t point);

real distance(bound_t point);

real squaredDistance(Box o);

real distance(Box o);

Box intersection(Box o);

bool intersects(Box other);

Box grow(bound_t space);

Box shrink(bound_t space);

Box grow(T space);

Box translate(bound_t offset);

Box scaleByFactor(float scale);

static if(N == 2)

Box scaleByFactor(float scaleX, float scaleY);

static if(N >= 2)

Box translate(T x, T y);

static if(N >= 3)

Box translate(T x, T y, T z);

Box shrink(T space);

Box expand(bound_t point);

Box expand(Box other);

bool isSorted();

Box opAssign(U x);

bool opEquals(U other);

static if(N == 2)

static Box rectangle(T x, T y, T width, T height);

}

Constructors

this this(bound_t min_, bound_t max_): Construct a box which extends between 2 points. Boundaries: min is inside the box, max is just outside.
this this(T min_, T max_): Undocumented in source.
this this(T min_x, T min_y, T max_x, T max_y): Undocumented in source.
this this(T min_x, T min_y, T min_z, T max_x, T max_y, T max_z): Undocumented in source.

Members

Aliases

bound_t alias bound_t = Vector!(T, N): Undocumented in source.

Functions

abs Box abs()
contains bool contains(bound_t point)
contains bool contains(T x, T y)
contains bool contains(T x, T y, T z)
contains bool contains(Box other)
distance real distance(bound_t point): Euclidean distance from a point.
distance real distance(Box o): Euclidean distance from another box.
expand Box expand(bound_t point): Expands the box to include point.
expand Box expand(Box other): Expands the box to include another box. This function deals with empty boxes correctly.
grow Box grow(bound_t space): Extends the area of this Box.
grow Box grow(T space): Extends the area of this Box.
intersection Box intersection(Box o): Assumes sorted boxes. This function deals with empty boxes correctly.
intersects bool intersects(Box other): Assumes sorted boxes. This function deals with empty boxes correctly.
isSorted bool isSorted()
opAssign Box opAssign(U x): Assign with another box.
opCast U opCast(): Cast to other box types.
opEquals bool opEquals(U other)
scaleByFactor Box scaleByFactor(float scale): Scale the box by factor scale, and round the result to integer if needed.
scaleByFactor Box scaleByFactor(float scaleX, float scaleY): Scale the box by factor scaleX horizontally and scaleY vetically. Round the result to integer if needed.
shrink Box shrink(bound_t space): Shrink the area of this Box. The box might became unsorted.
shrink Box shrink(T space): Shrinks the area of this Box.
squaredDistance real squaredDistance(bound_t point): Euclidean squared distance from a point.
squaredDistance real squaredDistance(Box o): Euclidean squared distance from another box.
translate Box translate(bound_t offset): Translate this Box.
translate Box translate(T x, T y): Translate this Box by x, y.
translate Box translate(T x, T y, T z): Translate this Box by x, y.

Properties

center bound_t center [@property getter]
depth T depth [@property getter]
depth T depth [@property setter]: Sets depth of the box assuming min point is the pivot.
empty bool empty [@property getter]
height T height [@property getter]
height T height [@property setter]: Sets height of the box assuming min point is the pivot.
size bound_t size [@property getter]
size bound_t size [@property setter]: Sets size of the box assuming min point is the pivot.
volume T volume [@property getter]
width T width [@property getter]
width T width [@property setter]: Sets width of the box assuming min point is the pivot.

Static functions

rectangle Box rectangle(T x, T y, T width, T height): Helper function to create rectangle with a given point, width and height.

Variables

max bound_t max;: Undocumented in source.
min bound_t min;: Undocumented in source.

Meta

Source

See Implementation

dplug math box aliases

enums

isBox

functions

structs

Box

templates