BALL 1.5.0
|
#include <BALL/VIEW/KERNEL/representation.h>
Public Types | |
Enums | |
enum | Properties { PROPERTY__ALWAYS_FRONT = 0 , PROPERTY__IS_COORDINATE_SYSTEM } |
Properties. More... | |
Public Member Functions | |
Constructors and Destuctor | |
Representation () | |
Representation (ModelType model_type, DrawingPrecision drawing_precision, DrawingMode drawing_mode) | |
Representation (const Representation &representation) | |
virtual | ~Representation () |
![]() | |
BALL_INLINE | PropertyManager () |
Default constructor. | |
BALL_INLINE | PropertyManager (const PropertyManager &property_manager) |
Copy constructor. | |
virtual | ~PropertyManager () |
Destructor. | |
virtual void | destroy () |
Clears all properties. | |
void | set (const PropertyManager &property_manager) |
const PropertyManager & | operator= (const PropertyManager &property_manager) |
void | get (PropertyManager &property_manager) const |
void | swap (PropertyManager &property_manager) |
BitVector & | getBitVector () |
const BitVector & | getBitVector () const |
operator BitVector & () | |
void | setProperty (Property property) |
void | clearProperty (Property property) |
void | toggleProperty (Property property) |
Size | countProperties () const |
const NamedProperty & | getNamedProperty (Position index) const |
NamedProperty & | getNamedProperty (Position index) |
void | setProperty (const NamedProperty &property) |
void | setProperty (const std::string &name) |
void | setProperty (const std::string &name, bool value) |
void | setProperty (const std::string &name, int value) |
void | setProperty (const std::string &name, unsigned int value) |
void | setProperty (const std::string &name, float value) |
void | setProperty (const std::string &name, double value) |
void | setProperty (const std::string &name, const std::string &value) |
void | setProperty (const std::string &name, const PersistentObject &value) |
const NamedProperty & | getProperty (const std::string &name) const |
NamedPropertyIterator | beginNamedProperty () |
NamedPropertyIterator | endNamedProperty () |
void | clearProperty (const std::string &name) |
Size | countNamedProperties () const |
bool | hasProperty (Property property) const |
Query for an unnamed property. | |
bool | hasProperty (const std::string &name) const |
Query for a named property. | |
bool | operator== (const PropertyManager &pm) const |
bool | operator!= (const PropertyManager &pm) const |
Inequality operator. | |
void | write (PersistenceManager &pm) const |
Persistent stream writing. | |
bool | read (PersistenceManager &pm) |
Persistent stream reading. | |
bool | isValid () const |
void | dump (std::ostream &s=std::cout, Size depth=0) const |
Friends | |
class | UpdateRepresentationThread |
class | RepresentationManager |
Representation A Representation is a collection of geometric objects for a group of composites and a given model, for example a surface. An instance of Representation manages the memory for the geometric objects, the ColorProcessor and the ModelProcessor. So when a Representation is destroyed, so are its geometric objects and processors. It stores the drawing precision and mode.
Definition at line 57 of file representation.h.
Properties.
Enumerator | |
---|---|
PROPERTY__ALWAYS_FRONT | |
PROPERTY__IS_COORDINATE_SYSTEM |
Definition at line 71 of file representation.h.
BALL::VIEW::Representation::Representation | ( | ) |
Default Constructor
BALL::VIEW::Representation::Representation | ( | ModelType | model_type, |
DrawingPrecision | drawing_precision, | ||
DrawingMode | drawing_mode | ||
) |
BALL::VIEW::Representation::Representation | ( | const Representation & | representation | ) |
Copy constructor
|
virtual |
Destructor
|
virtual |
Clears all properties.
Reimplemented from BALL::PropertyManager.
void BALL::VIEW::Representation::clearGeometricObjects | ( | ) |
Clear and destroy all stored GeometricObject.
|
protected |
|
inline |
Definition at line 212 of file representation.h.
void BALL::VIEW::Representation::dump | ( | std::ostream & | s = std::cout , |
Size | depth = 0 |
||
) | const |
Dum to ostream for debugging.
|
inline |
Definition at line 206 of file representation.h.
void BALL::VIEW::Representation::enableModelUpdate | ( | bool | state | ) |
ColoringMethod BALL::VIEW::Representation::getColoringMethod | ( | ) | const |
ColorProcessor * BALL::VIEW::Representation::getColorProcessor | ( | ) |
String BALL::VIEW::Representation::getCompositeName | ( | ) | const |
Returns a human-readable, potentially abbreviated string describing the molecular entity this representation belongs to.
|
inline |
Definition at line 157 of file representation.h.
DrawingMode BALL::VIEW::Representation::getDrawingMode | ( | ) | const |
DrawingPrecision BALL::VIEW::Representation::getDrawingPrecision | ( | ) | const |
GeometricObjectList & BALL::VIEW::Representation::getGeometricObjects | ( | ) |
const GeometricObjectList & BALL::VIEW::Representation::getGeometricObjects | ( | ) | const |
const PreciseTime & BALL::VIEW::Representation::getModelBuildTime | ( | ) | const |
Get the time when the model was builded This is needed for updating the Representation, after the vector of atom attributes was modified.
const ModelInformation & BALL::VIEW::Representation::getModelInformation | ( | ) | const |
ModelProcessor * BALL::VIEW::Representation::getModelProcessor | ( | ) |
const ModelProcessor * BALL::VIEW::Representation::getModelProcessor | ( | ) | const |
ModelType BALL::VIEW::Representation::getModelType | ( | ) | const |
String BALL::VIEW::Representation::getName | ( | ) | const |
String BALL::VIEW::Representation::getProperties | ( | ) | const |
Get a descpription string (nr triangles and geometric objects, transparency, mode)
float BALL::VIEW::Representation::getSurfaceDrawingPrecision | ( | ) | const |
Size BALL::VIEW::Representation::getTransparency | ( | ) | const |
get transparency (0 - 255)
void BALL::VIEW::Representation::insert | ( | GeometricObject & | object | ) |
bool BALL::VIEW::Representation::isHidden | ( | ) | const |
bool BALL::VIEW::Representation::isValid | ( | ) | const |
Check if drawing mode, transparency and drawing precision have reasonable values.
|
inline |
Definition at line 209 of file representation.h.
bool BALL::VIEW::Representation::needsUpdate | ( | ) | const |
Returns true, if Representation needs to be updated. Called by GeometricControl. Uses needs_update_.
|
inline |
Needed for MSVC.
Definition at line 262 of file representation.h.
const Representation & BALL::VIEW::Representation::operator= | ( | const Representation & | rep | ) |
bool BALL::VIEW::Representation::operator== | ( | const Representation & | object | ) | const |
void BALL::VIEW::Representation::setColoringMethod | ( | ColoringMethod | type | ) |
void BALL::VIEW::Representation::setColorProcessor | ( | ColorProcessor * | processor | ) |
void BALL::VIEW::Representation::setComposite | ( | const Composite * | composite | ) |
void BALL::VIEW::Representation::setComposites | ( | const std::list< const Composite * > & | composites | ) |
void BALL::VIEW::Representation::setDrawingMode | ( | DrawingMode | mode | ) |
void BALL::VIEW::Representation::setDrawingPrecision | ( | DrawingPrecision | precision | ) |
|
inline |
Definition at line 150 of file representation.h.
void BALL::VIEW::Representation::setHidden | ( | bool | state | ) |
void BALL::VIEW::Representation::setModelInformation | ( | const ModelInformation & | mi | ) |
Set a custom ModelInformation e.g. when new models were added external of the library.
void BALL::VIEW::Representation::setModelProcessor | ( | ModelProcessor * | processor | ) |
void BALL::VIEW::Representation::setModelType | ( | ModelType | type | ) |
void BALL::VIEW::Representation::setName | ( | const String & | name | ) |
void BALL::VIEW::Representation::setNeedsUpdate | ( | bool | state = true | ) |
void BALL::VIEW::Representation::setSurfaceDrawingPrecision | ( | float | precision | ) |
void BALL::VIEW::Representation::setTransparency | ( | Size | value | ) |
set transparency (0 - 255)
String BALL::VIEW::Representation::toString | ( | ) | const |
Get a String containing all settings for Usage in project files.
void BALL::VIEW::Representation::update | ( | bool | rebuild | ) |
Apply ModelProcessor (if rebuild) and ColorProcessor. The usage of these processors can be disabled, either by setting a NULL-pointer accordingly or call enableColoringUpdate(false) and enableModelUpdate(false).
|
protected |
Wrapper method for multithreading. Can be called by update() directly, or by the RepresentationManager' s UpdateRepresentationThread.
|
friend |
Definition at line 61 of file representation.h.
|
friend |
Definition at line 60 of file representation.h.
|
protected |
Definition at line 316 of file representation.h.
|
protected |
Definition at line 301 of file representation.h.
|
protected |
Definition at line 292 of file representation.h.
|
protected |
Definition at line 328 of file representation.h.
|
protected |
Definition at line 304 of file representation.h.
|
protected |
Definition at line 338 of file representation.h.
|
protected |
Definition at line 280 of file representation.h.
|
protected |
Definition at line 283 of file representation.h.
|
protected |
Definition at line 322 of file representation.h.
|
protected |
Definition at line 319 of file representation.h.
|
staticprotected |
Definition at line 333 of file representation.h.
|
protected |
Definition at line 307 of file representation.h.
|
staticprotected |
Definition at line 336 of file representation.h.
|
protected |
Definition at line 298 of file representation.h.
|
protected |
Definition at line 289 of file representation.h.
|
protected |
Definition at line 325 of file representation.h.
|
protected |
Definition at line 330 of file representation.h.
|
protected |
Definition at line 310 of file representation.h.
|
protected |
Definition at line 313 of file representation.h.
|
protected |
Definition at line 286 of file representation.h.
|
protected |
Definition at line 295 of file representation.h.