BALL  1.4.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members
BALL::VIEW::SimpleBox Class Reference

#include <BALL/VIEW/PRIMITIVES/simpleBox.h>

Inheritance diagram for BALL::VIEW::SimpleBox:
BALL::TSimpleBox3< float > BALL::VIEW::GeometricObject

Public Member Functions

Constructors
 SimpleBox ()
 
 SimpleBox (const SimpleBox &box)
 
Destructors
virtual ~SimpleBox ()
 
virtual void clear ()
 
Assignment methods
void set (const SimpleBox &box)
 
const SimpleBoxoperator= (const SimpleBox &box)
 
debuggers and diagnostics
virtual bool isValid () const
 
virtual void dump (std::ostream &s=std::cout, Size depth=0) const
 
virtual void getVertices (vector< Vector3 > &vertices) const
 
- Public Member Functions inherited from BALL::TSimpleBox3< float >
 TSimpleBox3 ()
 
 TSimpleBox3 (const TSimpleBox3 &box)
 
 TSimpleBox3 (const TVector3< float > &a, const TVector3< float > &b)
 
 TSimpleBox3 (const float &ax, const float &ay, const float &az, const float &bx, const float &by, const float &bz)
 
virtual ~TSimpleBox3 ()
 
void set (const TSimpleBox3 &box)
 
void set (const TVector3< float > &lower, const TVector3< float > &upper)
 
void set (const float &ax, const float &ay, const float &az, const float &bx, const float &by, const float &bz)
 
const TSimpleBox3operator= (const TSimpleBox3 &box)
 
void get (TSimpleBox3 &box) const
 
void get (TVector3< float > &lower, TVector3< float > &upper) const
 
void get (float &ax, float &ay, float &az, float &bx, float &by, float &bz) const
 
void swap (TSimpleBox3 &box)
 
float getSurface () const
 
float getVolume () const
 
float getWidth () const
 
float getHeight () const
 
float getDepth () const
 
void join (const TSimpleBox3 &box)
 
bool operator== (const TSimpleBox3 &box) const
 
bool operator!= (const TSimpleBox3 &box) const
 
bool has (const TVector3< float > &point, bool on_surface=false) const
 
bool isIntersecting (const TSimpleBox3 &box) const
 
bool isValid () const
 
void dump (std::ostream &s=std::cout, Size depth=0) const
 
- Public Member Functions inherited from BALL::VIEW::GeometricObject
 GeometricObject ()
 
 GeometricObject (const GeometricObject &object)
 
virtual ~GeometricObject ()
 
void set (const GeometricObject &object)
 
GeometricObjectoperator= (const GeometricObject &object)
 
void swap (GeometricObject &object)
 
void setComposite (const Composite *composite)
 
const CompositegetComposite () const
 
void setColor (const ColorRGBA &color)
 
void setColor (const ColorUnit &red, const ColorUnit &green, const ColorUnit &blue, const ColorUnit &alpha=(float) 1)
 
const ColorRGBAgetColor () const
 
ColorRGBAgetColor ()
 
void getColor (ColorUnit &red, ColorUnit &green, ColorUnit &blue, ColorUnit &alpha) const
 
void getColors (HashSet< String > &colors)
 Insert the colors of this object into the hashset. More...
 
bool operator== (const GeometricObject &object) const
 Needed for MSVC. More...
 
bool operator< (const GeometricObject &object) const
 Needed for MSVC. More...
 

Additional Inherited Members

- Public Attributes inherited from BALL::TSimpleBox3< float >
TVector3< floata
 
TVector3< floatb
 

Detailed Description

SimpleBox class. An instance of this class represents an instance of the geometric representation of a simple box. A simpleBox is a box whose sides are parallel to the coordinate axes. The class SimpleBox is derived from the classes GeometricObject and SimpleBox3. See these classes for further information concerning interface and additional methods.

Definition at line 33 of file simpleBox.h.

Constructor & Destructor Documentation

BALL::VIEW::SimpleBox::SimpleBox ( )

Default Constructor. The properties of this SimpleBox are set to:

  • color - to the color black
BALL::VIEW::SimpleBox::SimpleBox ( const SimpleBox box)

Copy constructor with cloning facility.

virtual BALL::VIEW::SimpleBox::~SimpleBox ( )
virtual

Destructor.

Member Function Documentation

virtual void BALL::VIEW::SimpleBox::clear ( )
virtual

Explicit default initialization. Calls GeometricObject::clear Calls SimpleBox3::clear

Reimplemented from BALL::VIEW::GeometricObject.

virtual void BALL::VIEW::SimpleBox::dump ( std::ostream &  s = std::cout,
Size  depth = 0 
) const
virtual

Internal value dump. Dump the current value of this SimpleBox to the output ostream s with dumping depth depth. Calls GeometricObject::dump. Calls SimpleBox3::dump.

Parameters
soutput stream where to output the value of this SimpleBox
depththe dumping depth
See Also
GeometricObject::dump
SimpleBox::dump

Reimplemented from BALL::VIEW::GeometricObject.

virtual void BALL::VIEW::SimpleBox::getVertices ( vector< Vector3 > &  vertices) const
virtual

Reimplemented from BALL::VIEW::GeometricObject.

virtual bool BALL::VIEW::SimpleBox::isValid ( ) const
virtual

Internal state and consistency self-validation. Initiate self-validation of the internal state and data structure consistencies of this SimpleBox. If the internal state of this SimpleBox is correct (self-validated) and consistent true is returned, false otherwise. Calls GeometricObject::isValid. Calls SimpleBox3::isValid.

See Also
GeometricObject::isValid
SimpleBox3::isValid

Reimplemented from BALL::VIEW::GeometricObject.

const SimpleBox& BALL::VIEW::SimpleBox::operator= ( const SimpleBox box)

Assignment operator.

void BALL::VIEW::SimpleBox::set ( const SimpleBox box)

Assignment.