Main Page | Modules | Namespace List | Class Hierarchy | Class List | Namespace Members | Class Members

Other classes
[Kernel]


Classes

class  VIEW::CompositeManager
 Management of Composites. More...
class  VIEW::ModelInformation
 ModelInformation class. More...

defines

#define VIEW_DEFAULT_PORT   20000
 The default port for the VIEW::Server.
#define BALL_ASSIGN_NAME(OBJ)   OBJ->setObjectName(#OBJ);
 Assign the name of a QObject to its variable name, needed e.g.

General enumerations, methods and typedefs

These predefined types are used in VIEW for portability and comprehensibility.

enum  VIEW::EventsIDs { VIEW::MESSAGE_EVENT = 60000, VIEW::LOG_EVENT }
 Enumeration of Events These events are used to communicate between different threads. More...

Enumerations for Representations and Renderer

Enums and methods to describe the models and drawing methods.

enum  VIEW::DrawingMode { DRAWING_MODE_DOTS = 0, DRAWING_MODE_WIREFRAME, DRAWING_MODE_SOLID, DRAWING_MODE_TOON }
 Enumeration for Drawing Modes.
enum  VIEW::DrawingPrecision {
  DRAWING_PRECISION_INVALID = -1, DRAWING_PRECISION_LOW = 0, DRAWING_PRECISION_MEDIUM, DRAWING_PRECISION_HIGH,
  DRAWING_PRECISION_ULTRA
}
 Enumeration for Drawing Precisions.
enum  VIEW::ModelType {
  VIEW::MODEL_LINES = 0, VIEW::MODEL_STICK, VIEW::MODEL_BALL_AND_STICK, VIEW::MODEL_VDW,
  VIEW::MODEL_SE_SURFACE, VIEW::MODEL_SA_SURFACE, VIEW::MODEL_BACKBONE, VIEW::MODEL_CARTOON,
  VIEW::MODEL_RIBBON, VIEW::MODEL_HBONDS, MODEL_FORCES, VIEW::MODEL_LABEL = 100,
  VIEW::MODEL_CONTOUR_SURFACE, MODEL_GRID_SLICE, MODEL_GRID_VOLUME, MODEL_FIELD_LINES,
  MODEL_INFORMATIONS, VIEW::MODEL_UNKNOWN = 200
}
 This properties define the available models. More...
enum  VIEW::ColoringMethod {
  COLORING_ELEMENT = 0, COLORING_RESIDUE_INDEX, COLORING_RESIDUE_NAME, COLORING_SECONDARY_STRUCTURE,
  COLORING_ATOM_CHARGE, COLORING_DISTANCE, COLORING_TEMPERATURE_FACTOR, COLORING_OCCUPANCY,
  COLORING_FORCES, COLORING_RESIDUE_TYPE, COLORING_CHAIN, COLORING_MOLECULE,
  COLORING_CUSTOM, COLORING_UNKNOWN = 200
}
 Enumeration for Coloring Methods. More...
BALL_VIEW_EXPORT String vector3ToString (const Vector3 &v) throw ()
BALL_VIEW_EXPORT bool stringToVector3 (const String &data, Vector3 &v) throw ()
BALL_VIEW_EXPORT String VIEW::createFloatString (float value, Size precision) throw ()
 create a string from a float and cut after a given number of digits after the dot
BALL_VIEW_EXPORT MainControl * VIEW::getMainControl () throw ()
 Get MainControl This method is only to be used for code, which is not part of a ModularWidget.
BALL_VIEW_EXPORT String VIEW::createTemporaryFilename () throw ()
 Create a temporary filename in the users home dir.
BALL_VIEW_EXPORT Vector3 getNormal (const Vector3 &v) throw ()
BALL_VIEW_EXPORT void VIEW::logString (const String &data)
 thread safe output to logview
BALL_VIEW_EXPORT void processDropEvent (QDropEvent *e)
BALL_VIEW_EXPORT Camera VIEW::focusCamera (Composite *composite)
 Focus the camera on a Composite Sends a SceneMessage.
BALL_VIEW_EXPORT Camera VIEW::focusCamera (const List< Vector3 > &points)
 Focus the camera on a list of points, e.g.
BALL_VIEW_EXPORT String VIEW::getDataPath ()
 Get the first defined data path, this should be the content of the environment variable BALLVIEW_DATA_PATH.
BALL_VIEW_EXPORT String ascii (const QString &str)
BALL_VIEW_EXPORT ColorRGBA getColor (const QLabel *label)
BALL_VIEW_EXPORT void setColor (const QLabel *label, const ColorRGBA &color)
BALL_VIEW_EXPORT QColor chooseColor (QLabel *label)
BALL_VIEW_EXPORT void setTextColor (QLabel *label, const ColorRGBA &color)
BALL_VIEW_EXPORT void VIEW::cubicInterpolation (const Vector3 &a, const Vector3 &b, const Vector3 &tangent_a, const Vector3 &tangent_b, std::vector< Vector3 > &interpolated_values)
 Uses the de-Casteljou algorithm to evalute a cubic Hermite interpolation polynomial at interpolated_values.size() equidistant values.
BALL_VIEW_EXPORT void subdivideTriangle (vector< Vector3 > &results, Vector3 &v1, Vector3 &v2, Vector3 &v3, Size precision) throw ()
BALL_VIEW_EXPORT vector< Vector3 > createSphere (Size precision)
BALL_VIEW_EXPORT void calculateHistogramEqualization (const vector< float > &values, vector< float > &normalized_values, bool use_absolute_values=false)
BALL_VIEW_EXPORT void VIEW::calculateRandomPoints (const RegularData3D &grid, Size nr_points, vector< Vector3 > &resulting_points)
 calcualte a random set of points, dependening of the field strength of a grid
BALL_VIEW_EXPORT float VIEW::SurfaceDrawingPrecisions [4]
 Mapping from the enum to the float values of Surfaces.
BALL_VIEW_EXPORT Composite VIEW::composite_to_be_ignored_for_colorprocessors_
 A special Composite, which is ignored by all ColoringProcessors, the GeometricObjects, which have this Composite set, will be colored by the default color.
float VIEW::icosaeder_vertices [12][3]
 Code to refine a icosaeder:.
Position icosaeder_indices [20][3]

Detailed Description

Here we find the CompositeManager , which handles the creation, storing and deletion of Composite instances. The class MolecularInformation provides means to get names for molecular objects. Also there a serveral enumerations and methods, e.g. for model types of Representation 's.

Define Documentation

#define BALL_ASSIGN_NAME (  OBJ   )     OBJ->setObjectName(#OBJ);
 

Assign the name of a QObject to its variable name, needed e.g.

for the GUI testing

#define VIEW_DEFAULT_PORT   20000
 

The default port for the VIEW::Server.

Default port is 20000.

See also:
Server

Enumeration Type Documentation

enum ColoringMethod
 

Enumeration for Coloring Methods.

Add new coloring methods before COLORING_CUSTOM.

enum EventsIDs
 

Enumeration of Events These events are used to communicate between different threads.

Have a look at QWidget::customEvent(QCustomEvent) to learn about QT and its events concept. This enum is used to give every type of derived QCustomEvent its individual type id.

Enumeration values:
MESSAGE_EVENT  An event with a contained VIEW message.
LOG_EVENT  Event to print output from a Thread.

enum ModelType
 

This properties define the available models.

Add new model entries directly before MODEL_LABEL if you want them to show up in the DisplayProperties dialog! You may have to modify the following methods, if you add a new ModelType:

See also:
getModelName(ModelType type)

getColoringName(ColoringMethod type)

isSurfaceModel(ModelType type)

modelMuteableByDisplayProperties(ModelType type)

modelMustBeRebuild(ModelType type)

Function Documentation

BALL_VIEW_EXPORT void cubicInterpolation (  const Vector3 &  a,
const Vector3 &  b,
const Vector3 &  tangent_a,
const Vector3 &  tangent_b,
std::vector< Vector3 > &  interpolated_values
) 
 

Uses the de-Casteljou algorithm to evalute a cubic Hermite interpolation polynomial at interpolated_values.size() equidistant values.

BALL_VIEW_EXPORT Camera focusCamera (  const List< Vector3 > &  points  ) 
 

Focus the camera on a list of points, e.g.

atoms or geometric objects. Sends a SceneMessage.

BALL_VIEW_EXPORT Camera focusCamera (  Composite *  composite  ) 
 

Focus the camera on a Composite Sends a SceneMessage.

BALL_VIEW_EXPORT String getDataPath (   ) 
 

Get the first defined data path, this should be the content of the environment variable BALLVIEW_DATA_PATH.

We also sort out double slashes and make sure a slash is at the end.

BALL_VIEW_EXPORT MainControl* getMainControl (   )  throw ()
 

Get MainControl This method is only to be used for code, which is not part of a ModularWidget.

On Windows, it uses the following cast:\ MainControl* mc = dynamic_cast<MainControl*>(qApp->mainWidget());\ On all other platforms, it uses MainControl::getInstance(0);

Variable Documentation

BALL_VIEW_EXPORT Composite VIEW::composite_to_be_ignored_for_colorprocessors_
 

A special Composite, which is ignored by all ColoringProcessors, the GeometricObjects, which have this Composite set, will be colored by the default color.