rsdl_bounding_box Class Reference

#include <rsdl_bounding_box.h>

List of all members.

---

Detailed Description

Definition at line 25 of file rsdl_bounding_box.h.

Public Member Functions
	rsdl_bounding_box (const rsdl_point &min_point, const rsdl_point &max_point)
	Construct a region to enclose two points.
	rsdl_bounding_box (const rsdl_bounding_box &old)
	Copy constructor.
rsdl_bounding_box &	operator= (const rsdl_bounding_box &old)
	Assignment operator.
double &	min_cartesian (unsigned int i)
	Mutable access to lower bound cartesian value in dimension i.
unsigned int	num_cartesian () const
	Number of cartesian dimensions.
unsigned int	num_angular () const
	Number of angular dimensions.
const double &	min_cartesian (unsigned int i) const
	Constant access to lower bound cartesian value in dimension i.
double &	max_cartesian (unsigned int i)
	Mutable access to upper bound cartesian value in dimension i.
const double &	max_cartesian (unsigned int i) const
	Constant access to upper bound cartesian value in dimension i.
double &	min_angular (unsigned int i)
	Mutable access to lower bound angular value in dimension i.
const double &	min_angular (unsigned int i) const
	Constant access to lower bound angular value in dimension i.
double &	max_angular (unsigned int i)
	Mutable access to upper bound angular value in dimension i.
const double &	max_angular (unsigned int i) const
	Constant access to upper bound angular value in dimension i.
Private Member Functions
	rsdl_bounding_box ()
	default ctor is private!.
Private Attributes
rsdl_point	min_point_
rsdl_point	max_point_

---

Constructor & Destructor Documentation

rsdl_bounding_box::rsdl_bounding_box (   )  [inline, private]

default ctor is private!. Definition at line 28 of file rsdl_bounding_box.h.

rsdl_bounding_box::rsdl_bounding_box (  const rsdl_point &  min_point, const rsdl_point &  max_point )

Construct a region to enclose two points. Note that if the numerical value of a min angle is greater than that of a max angle, this is effectively be treated as "wrapping around". The cartesian values of the min_point and max_point are checked and reordered if inconsistent. Definition at line 6 of file rsdl_bounding_box.cxx.

rsdl_bounding_box::rsdl_bounding_box (  const rsdl_bounding_box &  old  )

Copy constructor. Definition at line 25 of file rsdl_bounding_box.cxx.

---

Member Function Documentation

const double& rsdl_bounding_box::max_angular (  unsigned int  i  )  const [inline]

Constant access to upper bound angular value in dimension i. Definition at line 74 of file rsdl_bounding_box.h.

double& rsdl_bounding_box::max_angular (  unsigned int  i  )  [inline]

Mutable access to upper bound angular value in dimension i. Definition at line 71 of file rsdl_bounding_box.h.

const double& rsdl_bounding_box::max_cartesian (  unsigned int  i  )  const [inline]

Constant access to upper bound cartesian value in dimension i. Definition at line 62 of file rsdl_bounding_box.h.

double& rsdl_bounding_box::max_cartesian (  unsigned int  i  )  [inline]

Mutable access to upper bound cartesian value in dimension i. Definition at line 59 of file rsdl_bounding_box.h.

const double& rsdl_bounding_box::min_angular (  unsigned int  i  )  const [inline]

Constant access to lower bound angular value in dimension i. Definition at line 68 of file rsdl_bounding_box.h.

double& rsdl_bounding_box::min_angular (  unsigned int  i  )  [inline]

Mutable access to lower bound angular value in dimension i. Definition at line 65 of file rsdl_bounding_box.h.

const double& rsdl_bounding_box::min_cartesian (  unsigned int  i  )  const [inline]

Constant access to lower bound cartesian value in dimension i. Definition at line 56 of file rsdl_bounding_box.h.

double& rsdl_bounding_box::min_cartesian (  unsigned int  i  )  [inline]

Mutable access to lower bound cartesian value in dimension i. Definition at line 47 of file rsdl_bounding_box.h.

unsigned int rsdl_bounding_box::num_angular (   )  const [inline]

Number of angular dimensions. Definition at line 53 of file rsdl_bounding_box.h.

unsigned int rsdl_bounding_box::num_cartesian (   )  const [inline]

Number of cartesian dimensions. Definition at line 50 of file rsdl_bounding_box.h.

rsdl_bounding_box & rsdl_bounding_box::operator= (  const rsdl_bounding_box &  old  )

Assignment operator. Definition at line 32 of file rsdl_bounding_box.cxx.

---

Member Data Documentation

rsdl_point rsdl_bounding_box::max_point_ [private]

Definition at line 78 of file rsdl_bounding_box.h.

rsdl_point rsdl_bounding_box::min_point_ [private]

Definition at line 77 of file rsdl_bounding_box.h.

---

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

• contrib/rpl/rsdl/rsdl_bounding_box.h
• contrib/rpl/rsdl/rsdl_bounding_box.cxx

---