#include <BALL/VIEW/MODELS/colorProcessor.h>
Public Types | |
typedef HashSet< const Composite * > | CompositeSet |
A HashSet with the used Composites, see also Representation. | |
typedef HashGrid3< const Atom * > | AtomGrid |
a threedimensioal grid with the pointers to the atoms | |
typedef HashGridBox3< const Atom * > | AtomBox |
a single box in the threedimensional grid | |
Public Member Functions | |
ColorProcessor () | |
Default Constructor. | |
ColorProcessor (const ColorProcessor &color_calculator) | |
Copy constructor. | |
virtual | ~ColorProcessor () |
Destructor. | |
virtual void | clear () |
void | set (const ColorProcessor &color_calculator) |
Assignment. | |
virtual bool | start () |
const ColorProcessor & | operator= (const ColorProcessor &color_calculator) |
bool | updateAlwaysNeeded () |
void | setDefaultColor (const ColorRGBA &color) |
const ColorRGBA & | getDefaultColor () const |
virtual Processor::Result | operator() (GeometricObject *&object) |
virtual void | getColor (const Composite &composite, ColorRGBA &color_to_be_set) |
Size | getTransparency () const |
virtual void | setTransparency (Size value) |
void | setComposites (const List< const Composite * > *composites) |
const List< const Composite * > * | getComposites () |
Return a pointer to the Composites. | |
void | clearAtomGrid () |
void | setAdditionalGridDistance (float distance) |
float | getAdditionalGridDistance () const |
void | setMinGridSpacing (float spacing) |
AtomGrid & | getAtomGrid () |
virtual void | dump (std::ostream &s=std::cout, Size depth=0) const |
void | setModelType (ModelType type) |
virtual void | createAtomGrid (const Composite *from_mesh=0) |
const Atom * | getClosestItem (const Vector3 &v) const |
Protected Member Functions | |
virtual void | colorMeshFromGrid_ (Mesh &mesh) |
virtual bool | canUseMeshShortcut_ (const Composite &) |
Protected Attributes | |
bool | update_always_needed_ |
ColorRGBA | default_color_ |
ColorRGBA | selection_color_ |
Size | transparency_ |
const List< const Composite * > * | composites_ |
AtomGrid | atom_grid_ |
ModelType | model_type_ |
const Composite * | last_composite_of_grid_ |
float | additional_grid_distance_ |
float | min_spacing_ |
Calculating colors for given GeometricObject instances. This class defines the interface and basic algorithms to colorize geometric objects, e.g. Sphere, Tube, TwoColoredTube, etc. Derived classes implement special ways to colorize, e.g. by charge or element. They have to overload the method getColor(Composite, ColorRGBA).
If no color can be calculated for a GeometricObject, e.g. if it has no Composite, the default color is set.
A bit tricky is the coloring of meshes. The goal was to give every triangle of a mesh a color according to its nearest Atom. To do so, a threedimensional HashGrid3 is used. It is computed, when the ColorProcessor first encounters a Mesh in the operator (). For this a pointer to the HashSet with the used Composite instances exists, which is set by the Representation.
typedef HashGridBox3<const Atom*> BALL::VIEW::ColorProcessor::AtomBox |
a single box in the threedimensional grid
typedef HashGrid3<const Atom*> BALL::VIEW::ColorProcessor::AtomGrid |
a threedimensioal grid with the pointers to the atoms
typedef HashSet<const Composite*> BALL::VIEW::ColorProcessor::CompositeSet |
A HashSet with the used Composites, see also Representation.
BALL::VIEW::ColorProcessor::ColorProcessor | ( | ) |
Default Constructor.
BALL::VIEW::ColorProcessor::ColorProcessor | ( | const ColorProcessor & | color_calculator | ) |
Copy constructor.
virtual BALL::VIEW::ColorProcessor::~ColorProcessor | ( | ) | [virtual] |
Destructor.
virtual void BALL::VIEW::ColorProcessor::clear | ( | ) | [virtual] |
Explicit default initialization. Reset the state of the default_color_ to red ( "FF0000FF"
). The grid is cleared and the pointer to the CompositeSet is set to NULL.
void BALL::VIEW::ColorProcessor::clearAtomGrid | ( | ) |
virtual void BALL::VIEW::ColorProcessor::colorMeshFromGrid_ | ( | Mesh & | mesh | ) | [protected, virtual] |
Reimplemented in BALL::VIEW::AtomDistanceColorProcessor.
virtual void BALL::VIEW::ColorProcessor::createAtomGrid | ( | const Composite * | from_mesh = 0 | ) | [virtual] |
virtual void BALL::VIEW::ColorProcessor::dump | ( | std::ostream & | s = std::cout , |
Size | depth = 0 |
||
) | const [virtual] |
Internal value dump. Dump the current state of this ColorProcessor to the output ostream s with dumping depth depth.
s | output stream where to output the state of this ColorProcessor |
depth | the dumping depth |
float BALL::VIEW::ColorProcessor::getAdditionalGridDistance | ( | ) | const [inline] |
AtomGrid& BALL::VIEW::ColorProcessor::getAtomGrid | ( | ) | [inline] |
virtual void BALL::VIEW::ColorProcessor::getColor | ( | const Composite & | composite, |
ColorRGBA & | color_to_be_set | ||
) | [virtual] |
Calculate a color for a Composite. The given ColorRGBA instance is set to the calculated color. This method is called by the operator() method. Here it just sets the default color. You have to overload this operator in derived classes.
Reimplemented in BALL::VIEW::ElementColorProcessor, BALL::VIEW::ResidueNumberColorProcessor, BALL::VIEW::PositionColorProcessor, BALL::VIEW::ResidueNameColorProcessor, BALL::VIEW::AtomChargeColorProcessor, BALL::VIEW::AtomDistanceColorProcessor, BALL::VIEW::TemperatureFactorColorProcessor, BALL::VIEW::OccupancyColorProcessor, BALL::VIEW::ForceColorProcessor, BALL::VIEW::SecondaryStructureColorProcessor, and BALL::VIEW::ResidueTypeColorProcessor.
Return a pointer to the Composites.
const ColorRGBA& BALL::VIEW::ColorProcessor::getDefaultColor | ( | ) | const [inline] |
Non-mutable inspection of the default color.
Size BALL::VIEW::ColorProcessor::getTransparency | ( | ) | const [inline] |
virtual Processor::Result BALL::VIEW::ColorProcessor::operator() | ( | GeometricObject *& | object | ) | [virtual] |
Calculate a color for a GeometricObject.
Reimplemented from BALL::UnaryProcessor< GeometricObject * >.
Reimplemented in BALL::VIEW::AtomDistanceColorProcessor.
const ColorProcessor& BALL::VIEW::ColorProcessor::operator= | ( | const ColorProcessor & | color_calculator | ) |
Assignment operator. Calls set.
void BALL::VIEW::ColorProcessor::set | ( | const ColorProcessor & | color_calculator | ) |
Assignment.
void BALL::VIEW::ColorProcessor::setAdditionalGridDistance | ( | float | distance | ) | [inline] |
Set the pointer to the CompositeSet. This method is called by Representation::setColorProcessor and Representation::update.
void BALL::VIEW::ColorProcessor::setDefaultColor | ( | const ColorRGBA & | color | ) |
Change the default color.
void BALL::VIEW::ColorProcessor::setMinGridSpacing | ( | float | spacing | ) | [inline] |
void BALL::VIEW::ColorProcessor::setModelType | ( | ModelType | type | ) | [inline] |
virtual void BALL::VIEW::ColorProcessor::setTransparency | ( | Size | value | ) | [virtual] |
Set the transparency. To be overloaded in derived classes
Reimplemented in BALL::VIEW::ElementColorProcessor, BALL::VIEW::ResidueNameColorProcessor, BALL::VIEW::SecondaryStructureColorProcessor, and BALL::VIEW::ResidueTypeColorProcessor.
virtual bool BALL::VIEW::ColorProcessor::start | ( | ) | [virtual] |
start method
Reimplemented from BALL::UnaryProcessor< GeometricObject * >.
Reimplemented in BALL::VIEW::InterpolateColorProcessor, BALL::VIEW::ResidueNumberColorProcessor, and BALL::VIEW::PositionColorProcessor.
bool BALL::VIEW::ColorProcessor::updateAlwaysNeeded | ( | ) | [inline] |
Some coloring processors need only to be applied to a Representation if the hierarchy of the Representations Composite is changed, or the Composites Names or Type (like SecondaryStructure::Type) is changed. As this is seldom the case, we can speedup the call to Representation::update() in most cases. This method defines if a ColoringMethod needs to be applied in all cases. The default value is false. Initialise the member update_always_needed_ to true in derived classes, if the derived ColorProcessor shall always be applied.
AtomGrid BALL::VIEW::ColorProcessor::atom_grid_ [protected] |
const List<const Composite*>* BALL::VIEW::ColorProcessor::composites_ [protected] |
ColorRGBA BALL::VIEW::ColorProcessor::default_color_ [protected] |
const Composite* BALL::VIEW::ColorProcessor::last_composite_of_grid_ [protected] |
float BALL::VIEW::ColorProcessor::min_spacing_ [protected] |
ModelType BALL::VIEW::ColorProcessor::model_type_ [protected] |
Size BALL::VIEW::ColorProcessor::transparency_ [protected] |