BALL 1.5.0
Loading...
Searching...
No Matches
BALL::VIEW::ElementColorProcessor Class Reference

#include <BALL/VIEW/MODELS/standardColorProcessor.h>

Inheritance diagram for BALL::VIEW::ElementColorProcessor:
BALL::VIEW::ColorProcessor BALL::UnaryProcessor< GeometricObject * > BALL::UnaryFunctor< GeometricObject *, Processor::Result >

Constructors

HashMap< Position, ColorRGBAcolor_map_
 ElementColorProcessor ()
void setTransparency (Size value)
virtual void getColor (const Composite &composite, ColorRGBA &color_to_be_set)
HashMap< Position, ColorRGBA > & getColorMap ()
const HashMap< Position, ColorRGBA > & getColorMap () const

Additional Inherited Members

Public Types inherited from BALL::VIEW::ColorProcessor
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 Types inherited from BALL::UnaryFunctor< GeometricObject *, Processor::Result >
typedef Processor::Result result_type
typedef GeometricObject * argument_type
typedef GeometricObject *& argument_reference
typedef const GeometricObject *& const_argument_reference
typedef GeometricObject ** argument_pointer
typedef const GeometricObject ** const_argument_pointer
Public Member Functions inherited from BALL::VIEW::ColorProcessor
 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 ColorProcessoroperator= (const ColorProcessor &color_calculator)
bool updateAlwaysNeeded ()
void setDefaultColor (const ColorRGBA &color)
const ColorRGBAgetDefaultColor () const
virtual Processor::Result operator() (GeometricObject *&object)
Size getTransparency () const
void setComposites (const std::list< const Composite * > *composites)
const std::list< const Composite * > * getComposites ()
 Return a pointer to the Composites.
void clearAtomGrid ()
void setAdditionalGridDistance (float distance)
float getAdditionalGridDistance () const
void setMinGridSpacing (float spacing)
AtomGridgetAtomGrid ()
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 AtomgetClosestItem (const Vector3 &v) const
Public Member Functions inherited from BALL::UnaryProcessor< GeometricObject * >
 UnaryProcessor ()
virtual ~UnaryProcessor ()
virtual bool finish ()
virtual Processor::Result operator() (GeometricObject *&)
Protected Member Functions inherited from BALL::VIEW::ColorProcessor
virtual void colorMeshFromGrid_ (Mesh &mesh)
virtual bool canUseMeshShortcut_ (const Composite &)
Protected Attributes inherited from BALL::VIEW::ColorProcessor
bool update_always_needed_
ColorRGBA default_color_
ColorRGBA selection_color_
Size transparency_
const std::list< const Composite * > * composites_
AtomGrid atom_grid_
ModelType model_type_
const Compositelast_composite_of_grid_
float additional_grid_distance_
float min_spacing_

Detailed Description

ElementColorProcessor class. The class ElementColorProcessor is derived from the class ColorProcessor. It is used for calculating element colors of a given Atom object. In the constructor a ColorMap, that contains all colors corresponding to the element symbols of atoms, is initialised. The ColorProcessor can be set in the class DisplayProperties to color an entire molecular object in its element colors.

Definition at line 49 of file standardColorProcessor.h.

Constructor & Destructor Documentation

◆ ElementColorProcessor()

BALL::VIEW::ElementColorProcessor::ElementColorProcessor ( )

Default Constructor. Initialize the internal ColorMap to contain all element colors with element numbers as names.

Member Function Documentation

◆ getColor()

virtual void BALL::VIEW::ElementColorProcessor::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 from BALL::VIEW::ColorProcessor.

◆ getColorMap() [1/2]

HashMap< Position, ColorRGBA > & BALL::VIEW::ElementColorProcessor::getColorMap ( )
inline

Definition at line 73 of file standardColorProcessor.h.

◆ getColorMap() [2/2]

const HashMap< Position, ColorRGBA > & BALL::VIEW::ElementColorProcessor::getColorMap ( ) const
inline

Definition at line 76 of file standardColorProcessor.h.

◆ setTransparency()

void BALL::VIEW::ElementColorProcessor::setTransparency ( Size value)
virtual

Set the transparency. To be overloaded in derived classes

Reimplemented from BALL::VIEW::ColorProcessor.

Member Data Documentation

◆ color_map_

HashMap<Position, ColorRGBA> BALL::VIEW::ElementColorProcessor::color_map_
protected

Definition at line 81 of file standardColorProcessor.h.