BALL::VIEW::Box

BALL::VIEW::Box Class Reference
[Geometric Objects]

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

Inheritance diagram for BALL::VIEW::Box:
BALL::VIEW::GeometricObject BALL::TBox3< float >

List of all members.


Public Member Functions

Constructors
 Box ()
 Box (const Box &box)
 Box (const Vector3 &point, const Vector3 &right_vector=Vector3(0, 1, 0), const Vector3 &height_vector=Vector3(-1, 0, 0), float depth=1)
Destructors


virtual ~Box ()
virtual void clear ()
Assignment methods
void set (const Box &box)
const Box & operator= (const Box &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

Detailed Description

Box class. An instance of this class represents an instance of the geometric representation of a threedimensional box. The class Box is derived from the classes GeometricObject and Box3. See these classes for further information concerning interface and additional methods.

Constructor & Destructor Documentation

BALL::VIEW::Box::Box (  ) 

Default Constructor. Construct new Box. The properties of this Box are set to:

  • color - to the color black
  • width, depth, height - to zero
  • rigth_vector to 0, 1, 0
    Returns:
    Box new constructed Box
BALL::VIEW::Box::Box ( const Box &  box  ) 

Copy constructor with cloning facility.

BALL::VIEW::Box::Box ( const Vector3 &  point,
const Vector3 &  right_vector = Vector3(0, 1, 0),
const Vector3 &  height_vector = Vector3(-1, 0, 0),
float  depth = 1 
)
virtual BALL::VIEW::Box::~Box (  )  [virtual]

Destructor.

Member Function Documentation

virtual void BALL::VIEW::Box::clear (  )  [virtual]

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

Reimplemented from BALL::VIEW::GeometricObject.

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

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

Parameters:
s output stream where to output the value of this Box
depth the dumping depth
See also:

GeometricObject::dump

Box::dump

Reimplemented from BALL::VIEW::GeometricObject.

virtual void BALL::VIEW::Box::getVertices ( vector< Vector3 > &  vertices  )  const [virtual]

Reimplemented from BALL::VIEW::GeometricObject.

virtual bool BALL::VIEW::Box::isValid (  )  const [virtual]

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

See also:

GeometricObject::isValid

Box3::isValid

Reimplemented from BALL::VIEW::GeometricObject.

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

Assignment operator.

void BALL::VIEW::Box::set ( const Box &  box  ) 

Assignment.