Navigation: Up   Table of Contents   Package Overview   Bibliography   Index   Title   Acknowledging CGAL

CGAL::Iso_cuboid_3<Kernel>

Definition

An object s of the data type Iso_cuboid_3<Kernel> is a cuboid in the Euclidean space 3 with edges parallel to the x, y and z axis of the coordinate system.

Although they are represented in a canonical form by only two vertices, namely the lexicographically smallest and largest vertex with respect to Cartesian xyz coordinates, we provide functions for ``accessing'' the other vertices as well.

Iso-oriented cuboids and bounding boxes are quite similar. The difference however is that bounding boxes have always double coordinates, whereas the coordinate type of an iso-oriented cuboid is chosen by the user.

Creation

Iso_cuboid_3<Kernel> c ( Point_3<Kernel> p, Point_3<Kernel> q);
introduces an iso-oriented cuboid c with diagonal opposite vertices p and q. Note that the object is brought in the canonical form.


Iso_cuboid_3<Kernel> c ( Point_3<Kernel> p, Point_3<Kernel> q, int);
introduces an iso-oriented cuboid c with diagonal opposite vertices p and q. The int argument value is only used to distinguish the two overloaded functions.
Precondition: p.x()<=q.x(), p.y()<=q.y() and p.z()<=q.z().


Iso_cuboid_3<Kernel> c ( Point_3<Kernel> left,
Point_3<Kernel> right,
Point_3<Kernel> bottom,
Point_3<Kernel> top,
Point_3<Kernel> far,
Point_3<Kernel> close);
introduces an iso-oriented cuboid c whose minimal x coordinate is the one of left, the maximal x coordinate is the one of right, the minimal y coordinate is the one of bottom, the maximal y coordinate is the one of top, the minimal z coordinate is the one of far, the maximal z coordinate is the one of close.


Iso_cuboid_3<Kernel> c ( Kernel::RT min_hx,
Kernel::RT min_hy,
Kernel::RT min_hz,
Kernel::RT max_hx,
Kernel::RT max_hy,
Kernel::RT max_hz,
Kernel::RT hw = RT(1));
introduces an iso-oriented cuboid c with diagonal opposite vertices (min_hx/hw, min_hy/hw, min_hz/hw) and (max_hx/hw, max_hy/hw, max_hz/hw).
Precondition: hw ≠ 0.

Operations

bool c.operator== ( c2) const Test for equality: two iso-oriented cuboid are equal, iff their lower left and their upper right vertices are equal.

bool c.operator!= ( c2) const Test for inequality.

Point_3<Kernel> c.vertex ( int i) const returns the i'th vertex modulo 8 of c. starting with the lower left vertex.

Point_3<Kernel> c.operator[] ( int i) const returns vertex(i), as indicated in the figure below:

vertex order of an iso-cuboid

Point_3<Kernel> c.min () const returns the smallest vertex of c (= vertex(0)).

Point_3<Kernel> c.max () const returns the largest vertex of c (= vertex(7)).

Kernel::FT c.xmin () const returns smallest Cartesian x-coordinate in c.
Kernel::FT c.ymin () const returns smallest Cartesian y-coordinate in c.
Kernel::FT c.zmin () const returns smallest Cartesian z-coordinate in c.
Kernel::FT c.xmax () const returns largest Cartesian x-coordinate in c.
Kernel::FT c.ymax () const returns largest Cartesian y-coordinate in c.
Kernel::FT c.zmax () const returns largest Cartesian z-coordinate in c.

Kernel::FT c.min_coord ( int i) const returns i-th Cartesian coordinate of the smallest vertex of c.
Precondition: 0 ≤ i ≤ 2.

Kernel::FT c.max_coord ( int i) const returns i-th Cartesian coordinate of the largest vertex of c.
Precondition: 0 ≤ i ≤ 2.

Predicates

bool c.is_degenerate () const c is degenerate, if all vertices are coplanar.

Bounded_side c.bounded_side ( Point_3<Kernel> p) const
returns either ON_UNBOUNDED_SIDE, ON_BOUNDED_SIDE, or the constant ON_BOUNDARY, depending on where point p is.

bool c.has_on_boundary ( Point_3<Kernel> p) const
bool c.has_on_bounded_side ( Point_3<Kernel> p) const
bool c.has_on_unbounded_side ( Point_3<Kernel> p) const

Miscellaneous

Kernel::FT c.volume () const returns the volume of c.

Bbox_3 c.bbox () const returns a bounding box containing c.

Iso_cuboid_3<Kernel> c.transform ( Aff_transformation_3<Kernel> t) const
returns the iso-oriented cuboid obtained by applying t on the smallest and the largest of c.
Precondition: The angle at a rotation must be a multiple of π/2, otherwise the resulting cuboid does not have the same size. Note that rotating about an arbitrary angle can even result in a degenerate iso-oriented cuboid.

See Also

Kernel::IsoCuboid_3

Next: Line_3<Kernel>
Navigation: Up   Table of Contents   Package Overview   Bibliography   Index   Title   Acknowledging CGAL
CGAL Open Source Project. Release 3.9. 26 September 2011.