vbl_bounding_box< T, DIM > Class Template Reference

#include <vbl_bounding_box.h>

Inheritance diagram for vbl_bounding_box< T, DIM >:

[legend]List of all members.

---

Detailed Description

template<class T, int DIM>
class vbl_bounding_box< T, DIM >

A class to hold and update a bounding box.

Save valuable time not writing

    if (x > xmax).....

Definition at line 173 of file vbl_bounding_box.h.

Public Member Functions
	vbl_bounding_box_base ()
	Construct an empty bounding box.
void	update (Tconst &x)
	Incorporate 1d point x.
void	update (Tconst &x, Tconst &y)
	Incorporate 2d point x, y.
void	update (Tconst &x, Tconst &y, Tconst &z)
	Incorporate 3d point x, y, z.
void	update (Tconst *point)
	Incorporate DIM-d point.
int	dimension () const
	return dimension.
void	reset ()
	Reset to empty.
bool	empty () const
	Return initialisation status.
bool	inside (const T &x, const T &y) const
	is a 2D point inside the bounding box.
bool	inside (const T &x, const T &y, const T &z) const
	is a 3D point inside the bounding box.
bool	inside (Tconst *point)
	inside test for arbitrary dimension.
T	volume () const
	return "volume".
vcl_ostream &	print (vcl_ostream &s) const
Tconst *	min () const
T *	min ()
Tconst *	max () const
T *	max ()
Tconst &	xmin () const
Tconst &	xmax () const
Tconst &	ymin () const
Tconst &	ymax () const
Tconst &	zmin () const
Tconst &	zmax () const

---

Member Function Documentation

int vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::dimension (   )  const [inline, inherited]

return dimension. Definition at line 63 of file vbl_bounding_box.h.

bool vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::empty (   )  const [inline, inherited]

Return initialisation status. Definition at line 83 of file vbl_bounding_box.h.

bool vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::inside (  T const *  point  )  [inline, inherited]

inside test for arbitrary dimension. Definition at line 105 of file vbl_bounding_box.h.

bool vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::inside (  const T &  x, const T &  y, const T &  z )  const [inline, inherited]

is a 3D point inside the bounding box. Definition at line 95 of file vbl_bounding_box.h.

bool vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::inside (  const T &  x, const T &  y )  const [inline, inherited]

is a 2D point inside the bounding box. Definition at line 86 of file vbl_bounding_box.h.

T * vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::max (   )  [inline, inherited]

Definition at line 128 of file vbl_bounding_box.h.

T const* vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::max (   )  const [inline, inherited]

Definition at line 125 of file vbl_bounding_box.h.

T * vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::min (   )  [inline, inherited]

Definition at line 127 of file vbl_bounding_box.h.

T const* vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::min (   )  const [inline, inherited]

Definition at line 124 of file vbl_bounding_box.h.

vcl_ostream& vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::print (  vcl_ostream &  s  )  const [inherited]

void vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::reset (   )  [inline, inherited]

Reset to empty. Definition at line 80 of file vbl_bounding_box.h.

void vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::update (  T const *  point  )  [inline, inherited]

Incorporate DIM-d point. Definition at line 66 of file vbl_bounding_box.h.

void vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::update (  T const &  x, T const &  y, T const &  z )  [inline, inherited]

Incorporate 3d point x, y, z. Definition at line 56 of file vbl_bounding_box.h.

void vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::update (  T const &  x, T const &  y )  [inline, inherited]

Incorporate 2d point x, y. Definition at line 49 of file vbl_bounding_box.h.

void vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::update (  T const &  x  )  [inline, inherited]

Incorporate 1d point x. Definition at line 43 of file vbl_bounding_box.h.

vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::vbl_bounding_box_base (   )  [inline, inherited]

Construct an empty bounding box. Definition at line 40 of file vbl_bounding_box.h.

T vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::volume (   )  const [inline, inherited]

return "volume". Definition at line 114 of file vbl_bounding_box.h.

T const& vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::xmax (   )  const [inline, inherited]

Definition at line 131 of file vbl_bounding_box.h.

T const& vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::xmin (   )  const [inline, inherited]

Definition at line 130 of file vbl_bounding_box.h.

T const& vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::ymax (   )  const [inline, inherited]

Definition at line 133 of file vbl_bounding_box.h.

T const& vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::ymin (   )  const [inline, inherited]

Definition at line 132 of file vbl_bounding_box.h.

T const& vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::zmax (   )  const [inline, inherited]

Definition at line 135 of file vbl_bounding_box.h.

T const& vbl_bounding_box_base< T , vbl_bounding_box_DIM< DIM > >::zmin (   )  const [inline, inherited]

Definition at line 134 of file vbl_bounding_box.h.

---

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

• core/vbl/vbl_bounding_box.h

---