BALL::VIEW::AtomDistanceColorProcessor Class Reference
[Model Processors]
#include <BALL/VIEW/MODELS/standardColorProcessor.h>
List of all members.
Detailed Description
AtomDistanceColorProcessor class. AtomDistanceColorProcessor can be choosen in the class DisplayProperties to color the atoms in multiple AtomContainer according to their distance. There are two colors for the distance of Atom objects. A color for the null distance and a color for the max distance. If a distance of an Atom object to another atom object (stored in different atom containers) lies between the null and the max distance, the resulting color will be interpolated according to the distance.
Member Typedef Documentation
Constructor & Destructor Documentation
BALL::VIEW::AtomDistanceColorProcessor::AtomDistanceColorProcessor |
( |
|
) |
|
Default Constructor. Initialize to:
- distance set to 10
- null distance color set to red ("FF0000FF").
- max distance color set to blue ("00FF00FF").
- See also:
- ColorRGBA
Construct with copying the colors and the distance.
Member Function Documentation
virtual void BALL::VIEW::AtomDistanceColorProcessor::addAtom |
( |
const Atom & |
atom |
) |
[virtual] |
Calculate the distance color of the given Atom by interpolating the null and max distance color according to the previously calculated distance color (see calculateDistances()) of the given atom. Access to the calculated color with the method ColorProcessor::getColor.
- Parameters:
-
| atom | the Atom whose distance color should be computed |
void BALL::VIEW::AtomDistanceColorProcessor::calculateDistances |
( |
|
) |
|
Calculate the distances. If this method is called the distances of all previously inserted Atom objects to each other are calculated. Only Atom objects are used for the distance calculation that have not the same root. All other atom objects will keep the max distance as set with the method setDistance(). Use this method after all atom containers have applied this processor.
void BALL::VIEW::AtomDistanceColorProcessor::colorGeometricObject_ |
( |
GeometricObject & |
object |
) |
[private] |
virtual void BALL::VIEW::AtomDistanceColorProcessor::colorMeshFromGrid_ |
( |
Mesh & |
mesh |
) |
[private, virtual] |
virtual bool BALL::VIEW::AtomDistanceColorProcessor::finish |
( |
|
) |
[virtual] |
virtual void BALL::VIEW::AtomDistanceColorProcessor::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.
float BALL::VIEW::AtomDistanceColorProcessor::getDistance |
( |
|
) |
const |
Inspection of the max distance.
const ColorRGBA& BALL::VIEW::AtomDistanceColorProcessor::getMaxDistanceColor |
( |
|
) |
const |
const ColorRGBA& BALL::VIEW::AtomDistanceColorProcessor::getNullDistanceColor |
( |
|
) |
const |
Non-mutable inspection of the null distance color.
void BALL::VIEW::AtomDistanceColorProcessor::setDistance |
( |
float |
distance |
) |
[inline] |
Change the max distance. Every new Atom object is inserted into the AtomDistanceColorProcessor with this max distance. If the method calculateDistances() is called the distances of the inserted atoms are calculated.
- Parameters:
-
| distance | the new max distance |
void BALL::VIEW::AtomDistanceColorProcessor::setMaxDistanceColor |
( |
const ColorRGBA & |
color |
) |
|
Change the max distance color. If the calculated distance between two Atom objects becomes the max distance or greater this color will be used to color these two atoms. Otherwise the color will be interpolated between this color and the null distance color according to the calculated distance.
- Parameters:
-
| color | the new max distance color |
- See also:
- getMaxDistanceColor
-
setNullDistanceColor
-
ColorRGBA
void BALL::VIEW::AtomDistanceColorProcessor::setNullDistanceColor |
( |
const ColorRGBA & |
color |
) |
|
Change the null distance color. If the calculated distance between two Atom objects becomes 0, this color will be used to color these two atoms. Otherwise the color will be interpolated between this color and the max distance color according to the calculated distance.
- Parameters:
-
| color | the new null distance color |
- See also:
- getNullDistanceColor
-
setMaxDistanceColor
-
ColorRGBA
void BALL::VIEW::AtomDistanceColorProcessor::setShowSelected |
( |
bool |
state |
) |
[inline] |
bool BALL::VIEW::AtomDistanceColorProcessor::showSelected |
( |
|
) |
[inline] |
Member Data Documentation