BALL::BoundingBoxProcessor Class Reference
[Geometric property processors.]

#include <BALL/STRUCTURE/geometricProperties.h>

Inheritance diagram for BALL::BoundingBoxProcessor:
Inheritance graph
[legend]

List of all members.

Public Member Functions

Processor related methods.

virtual bool start ()
virtual bool finish ()
virtual Processor::Result operator() (Atom &atom)
virtual Processor::Result operator() (const Vector3 &v)
Accessors

SimpleBox3 getBox () const
const Vector3getLower () const
const Vector3getUpper () const

Private Attributes

Vector3 lower_
Vector3 upper_

Detailed Description

Bounding box creating processor. This class iterates over all atoms of a given molecular object and determines the lowest and the highest coordinates occuring. It returns two coordinates ( getLower , getUpper ) describing the smallest cuboid (whose sides are parallel to the planes defined by the corrdinate axes) enclosing all atoms of the molecular object.

This processor is useful to determine the extent of a molecular object if you want to define a THashGrid or alike objects.
The coordinates returned by getLower and getUpper are only valid, if the processor has been applied to a molecular object containing atoms.

Definition at line 56 of file geometricProperties.h.


Member Function Documentation

virtual bool BALL::BoundingBoxProcessor::finish (  )  [virtual]

finish method

Reimplemented from BALL::UnaryProcessor< Atom >.

SimpleBox3 BALL::BoundingBoxProcessor::getBox (  )  const

Return the bounding box

const Vector3& BALL::BoundingBoxProcessor::getLower (  )  const

Returns the lower corner of the bounding box

const Vector3& BALL::BoundingBoxProcessor::getUpper (  )  const

Returns the upper corner of the bounding box

virtual Processor::Result BALL::BoundingBoxProcessor::operator() ( const Vector3 v  )  [virtual]
virtual Processor::Result BALL::BoundingBoxProcessor::operator() ( Atom  )  [inline, virtual]

operator ()

Reimplemented from BALL::UnaryProcessor< Atom >.

Definition at line 77 of file geometricProperties.h.

virtual bool BALL::BoundingBoxProcessor::start (  )  [virtual]

start method

Reimplemented from BALL::UnaryProcessor< Atom >.


Member Data Documentation

Definition at line 110 of file geometricProperties.h.

Definition at line 111 of file geometricProperties.h.

Generated by  doxygen 1.6.3