VIEW/KERNEL/common.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
// $Id: common.h,v 1.40.16.4 2007/04/20 14:16:50 amoll Exp $
//

#ifndef BALL_VIEW_KERNEL_COMMON_H
#define BALL_VIEW_KERNEL_COMMON_H

#ifndef BALL_DATATYPE_STRING_H
 #include <BALL/DATATYPE/string.h>
#endif

#ifndef BALL_MATHS_VECTOR3
 #include <BALL/MATHS/vector3.h>
#endif

#ifndef BALL_CONCEPT_COMPOSITE_H
 #include <BALL/CONCEPT/composite.h>
#endif

#ifndef BALL_DATATYPE_REGULARDATA3D_H
 #include <BALL/DATATYPE/regularData3D.h>
#endif

#include <QtCore/QEvent>
#include <QtGui/QColorDialog>
#include <QtGui/QLabel>
#include <QtGui/QDropEvent>

namespace BALL
{
  namespace VIEW
  {

    class GeometricObject;
    class MainControl;
    class ColorRGBA;
    class Camera;


    #define VIEW_DEFAULT_PORT 20000

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


    enum EventsIDs
    {
      MESSAGE_EVENT = 60000,

      LOG_EVENT,

      TRANSFORMATION_EVENT_6D,
      
      HEADTRACKING_EVENT,

      MOTIONTRACKING_EVENT,

      BUTTON_PRESS_EVENT,

      BUTTON_RELEASE_EVENT,

      NOTIFICATION_EVENT,

      RENDER_TO_BUFFER_FINISHED_EVENT
    };



    enum DrawingMode
    {
      DRAWING_MODE_DOTS = 0,

      DRAWING_MODE_WIREFRAME,

      DRAWING_MODE_SOLID,
      
      DRAWING_MODE_TOON
    };

    #define BALL_VIEW_MAXIMAL_DRAWING_MODE 4

    enum DrawingPrecision
    {
      DRAWING_PRECISION_INVALID = -1,

      DRAWING_PRECISION_LOW = 0,

      DRAWING_PRECISION_MEDIUM,

      DRAWING_PRECISION_HIGH,

      DRAWING_PRECISION_ULTRA
    };
    
    #define BALL_VIEW_MAXIMAL_DRAWING_PRECISION 4

    #define BALL_VIEW_MAXIMAL_DISPLAY_LIST_OBJECT_SIZE  BALL_VIEW_MAXIMAL_DRAWING_PRECISION * BALL_VIEW_MAXIMAL_DRAWING_MODE

    BALL_VIEW_EXPORT extern float SurfaceDrawingPrecisions[4];

    enum ModelType
    {
      MODEL_LINES = 0,

      MODEL_STICK,

      MODEL_BALL_AND_STICK,
      
      MODEL_VDW,

      MODEL_SE_SURFACE,

      MODEL_SA_SURFACE,

      MODEL_BACKBONE,

      MODEL_CARTOON,

      MODEL_RIBBON,

      MODEL_HBONDS,

      MODEL_FORCES,

      // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
      // add new model types before this comment!!!!
      // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
      
      MODEL_LABEL = 100,

      MODEL_CONTOUR_SURFACE,

      MODEL_GRID_SLICE,

      MODEL_GRID_VOLUME,

      MODEL_FIELD_LINES,

      MODEL_INFORMATIONS,

      MODEL_COORDINATE_SYSTEM,
      
      MODEL_PROXIMITY_LIGHT,

      MODEL_PLANE,

      MODEL_SPHERE,

      MODEL_UNKNOWN = 200
    };


    enum 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,

      // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
      // add new coloring types before this comment!!!!
      // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
      
      COLORING_CUSTOM,

      COLORING_UNKNOWN = 200
    };

    BALL_VIEW_EXPORT extern Composite composite_to_be_ignored_for_colorprocessors_;


    BALL_VIEW_EXPORT String vector3ToString(const Vector3& v);

    BALL_VIEW_EXPORT bool stringToVector3(const String& data, Vector3& v);

    BALL_VIEW_EXPORT String createFloatString(float value, Size precision);

    BALL_VIEW_EXPORT MainControl* getMainControl();

    BALL_VIEW_EXPORT String createTemporaryFilename();

    BALL_VIEW_EXPORT Vector3 getNormal(const Vector3& v);

    class BALL_VIEW_EXPORT LogEvent
      : public QEvent
    {
      public:

        LogEvent();

        void setMessage(const String& msg) {message_ = msg;}

        String getMessage() {return message_;}

        bool isImportant() { return important_;}

        void setImportant(bool state) { important_ = state;}

        bool showOnlyInLogView() const { return only_log_;}

        void setShowOnlyInLogView(bool state) { only_log_ = state;}

      protected:
        String message_;
        bool   important_;
        bool   only_log_;
    };

    BALL_VIEW_EXPORT void logString(const String& data);

    #define BALLVIEW_DEBUG logString(String("A problem occured in ") + __FILE__ + " " + \
                           String(__LINE__) + ".  Please notify us per mail: ball@bioinf.uni-sb.de\n");

  
    BALL_VIEW_EXPORT void processDropEvent(QDropEvent* e);

    BALL_VIEW_EXPORT Camera focusCamera(Composite* composite);

    BALL_VIEW_EXPORT Camera focusCamera(const std::list<Vector3>& points);

    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 cubicInterpolation(const Vector3& a, const Vector3& b,
                                   const Vector3& tangent_a, const Vector3& tangent_b,
                                   std::vector<Vector3>& interpolated_values);

    extern float    icosaeder_vertices[12][3];
    extern Position icosaeder_indices[20][3];

    BALL_VIEW_EXPORT void subdivideTriangle(vector<Vector3>& results, Vector3& v1, Vector3& v2, Vector3& v3, Size precision);

    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 calculateRandomPoints(const RegularData3D& grid, Size nr_points, vector<Vector3>& resulting_points);


  } // namespace VIEW
} // namespace BALL

#endif // BALL_VIEW_KERNEL_COMMON_H