OBox Class Reference

The box class. More...

#include <3d.h>

Inheritance diagram for OBox:

Collaboration diagram for OBox:

Public Member Functions
	OBox ()
	Default constructor. More...
	OBox (const OBox &box)
	Copy constructor. More...
	OBox (const OCoord3D &min, const OCoord3D &max)
	OBox (double x1, double y1, double z1, double x2, double y2, double z2)
virtual	~OBox ()
	Destructor. More...
virtual OBox &	operator= (const OBox &box)
virtual bool	operator== (const OBox &box) const
virtual bool	operator!= (const OBox &box) const
virtual bool	isInside (const OPoint3D &pt) const
	Test whether the point is inside the box or not. More...
virtual bool	isInside2D (const OPoint3D &pt) const
	Test whether the point is inside the box or not (from upper point of view). More...
virtual bool	isInContact (const OBox &box) const
	Test whether the boxes are in contact or not. More...
virtual void	Enlarge (const OPoint3D &pt)
	Enlarge the box with the point if the point is outside the box. More...
virtual void	Enlarge (float x, float y, float z)
	Enlarge the box with the point (x,y, z) if the point is outside the box. More...
virtual void	Enlarge (const OBox &box)
	Enlarge this box with the box passed if this box does not contain the box passed. More...
virtual void	Translate (const OPoint3D &vectorTranslate)
	Translate this box. More...

Public Attributes
OPoint3D	_min
	Minimal coordinates of the OBox. More...
OPoint3D	_max
	Maximal coordinates of the OBox. More...

Detailed Description

The box class.

Definition at line 1293 of file 3d.h.

Constructor & Destructor Documentation

OBox() [1/4]

OBox::OBox

(

)

Default constructor.

Definition at line 1486 of file 3d.cpp.

OBox() [2/4]

OBox::OBox

(

const OBox &

box

)

Copy constructor.

Definition at line 1491 of file 3d.cpp.

OBox() [3/4]

OBox::OBox	(	const OCoord3D &	min,
		const OCoord3D &	max
	)

Definition at line 1497 of file 3d.cpp.

OBox() [4/4]

OBox::OBox	(	double	x1,
		double	y1,
		double	z1,
		double	x2,
		double	y2,
		double	z2
	)

Definition at line 1503 of file 3d.cpp.

~OBox()

virtual OBox::~OBox ( )

inlinevirtual

Destructor.

Definition at line 1303 of file 3d.h.

Member Function Documentation

Enlarge() [1/3]

void OBox::Enlarge ( const OBox &  box )

virtual

Enlarge this box with the box passed if this box does not contain the box passed.

Parameters

box	The box to test.

Definition at line 1660 of file 3d.cpp.

Enlarge() [2/3]

void OBox::Enlarge ( const OPoint3D &  pt )

virtual

Enlarge the box with the point if the point is outside the box.

Parameters

pt	The point to test/make it larger.

Definition at line 1614 of file 3d.cpp.

Here is the caller graph for this function:

Enlarge() [3/3]

void OBox::Enlarge ( float  x, float  y, float  z  )

virtual

Enlarge the box with the point (x,y, z) if the point is outside the box.

Parameters

x	X coordinate of the point to test
y	Y coordinate of the point to test
z	Z coordinate of the point to test

Definition at line 1654 of file 3d.cpp.

Here is the call graph for this function:

isInContact()

bool OBox::isInContact ( const OBox &  box ) const

virtual

Test whether the boxes are in contact or not.

Parameters

box	The box to test.

Definition at line 1585 of file 3d.cpp.

isInside()

bool OBox::isInside ( const OPoint3D &  pt ) const

virtual

Test whether the point is inside the box or not.

Parameters

pt	The point to test.

Reimplemented in OBox2.

Definition at line 1535 of file 3d.cpp.

Here is the caller graph for this function:

isInside2D()

bool OBox::isInside2D ( const OPoint3D &  pt ) const

virtual

Test whether the point is inside the box or not (from upper point of view).

Parameters

pt	The point to test.

Reimplemented in OBox2.

Definition at line 1564 of file 3d.cpp.

Here is the caller graph for this function:

operator!=()

virtual bool OBox::operator!= ( const OBox &  box ) const

inlinevirtual

Definition at line 1307 of file 3d.h.

Here is the call graph for this function:

operator=()

OBox & OBox::operator= ( const OBox &  box )

virtual

Definition at line 1509 of file 3d.cpp.

Here is the caller graph for this function:

operator==()

bool OBox::operator== ( const OBox &  box ) const

virtual

Definition at line 1519 of file 3d.cpp.

Here is the caller graph for this function:

Translate()

void OBox::Translate ( const OPoint3D &  vectorTranslate )

virtual

Translate this box.

Parameters

vectorTranslate

Translation.

Definition at line 1688 of file 3d.cpp.

Here is the caller graph for this function:

Member Data Documentation

_max

OPoint3D OBox::_max

Maximal coordinates of the OBox.

Definition at line 1372 of file 3d.h.

_min

OPoint3D OBox::_min

Minimal coordinates of the OBox.

Definition at line 1371 of file 3d.h.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/code-tympan-fbessou/checkouts/latest/Tympan/models/common/3d.h
• /home/docs/checkouts/readthedocs.org/user_builds/code-tympan-fbessou/checkouts/latest/Tympan/models/common/3d.cpp