zqb_lith_engine.hpp

/* zqb_lith_engine.hpp */
/* $Id: zqb_lith_engine.hpp 20080 2009-12-15 15:57:52Z vlad $ */
#ifndef __zqb_lith_engine_hpp
#define __zqb_lith_engine_hpp

#include <fstream>

#include <math.h>
#include <string>

#include <qnamespace.h>
#include <qcolor.h>
#include <qrect.h>
#include <qpoint.h>
#include <qpen.h>
#include <qbrush.h>
#include <qpainter.h>
#include <qfont.h>
#include <qpixmap.h>
#include <qsize.h>
#include <qbitmap.h>

using namespace std;

#define LITH_PAT_SCALE      0.1

#define LITH_LP_FILENAME        "LithBase.lp"   
/*****************************************************************************************
 *
 * General definitions.
 *
 */

/*********************************************************************
 *
 * Logical constants
 *
 */

enum hcp_Logic
  {
    hcpL_FALSE = 0, // Logical "FALSE"
    hcpL_TRUE       // Logical "TRUE"
  };

/*********************************************************************
 *
 * Routine status (kind of return code)
 *
 */

enum hcp_Status
  {
    // Common return codes {
    hcpS_VOID = 0,          // Void or dummy return code
    hcpS_OK = 1,                // Normal return code (all is OK)
    hcpS_BAD = 2,           // Something wrong !
    
    hcpS_BAD_PARAMETER = 100,       // Bad parameter value
    // Common return codes }
    
    // Alien routines return codes {
    hcpS_BAD_CREATE_ENHANCED = 200, // Bad return code of CreateEnhanced routine
    hcpS_BAD_CLOSE_ENHANCED = 201,      // Bad return code of CloseEnhanced routine
    // Alien routines return codes }
    
    // File stream i/o routines return codes {
    hcpS_FSIO_UNKNOWN = 300,        // Unknown file stream status
    
    hcpS_FSIO_BAD_OPEN_FILE = 301,      // Bad return code of open file routine
    hcpS_FSIO_BAD_FILE_DATA = 302,      // Bad or incorrect file data
    
    hcpS_FSIO_GOODBIT = 303,        // No error condition
    hcpS_FSIO_EOFBIT = 304,     // End of file reached
    hcpS_FSIO_FAILBIT = 305,        // A possibly recoverable formatting or conversion error
    hcpS_FSIO_BADBIT = 306      // A severe i/o error or unknown state
    // File stream i/o routines return codes {
  };

/*********************************************************************
 *
 * Size units
 *
 */

enum hcp_Units
  {
    hcpU_DEFAULT = 0,   // Default units (defined by user)
    hcpU_MILLIMETERS,   // Millimeters
    hcpU_INCHES     // Inches
  };

/*
 *  Auxiliary routines
 */

/*********************************************************************
 *
 * Units conversion tool
 *
 */

hcp_Status hcp_aux_ConvertUnits (hcp_Units, int &);

/*********************************************************************
 *
 * Bounding rectangle units conversion
 *
 */

hcp_Status hcp_aux_BoundsUnitsConvert (hcp_Units, QRect *);

/*********************************************************************
 *
 * Searching minimal and maximal vector values
 *
 */

hcp_Status hcp_aux_SearchVectMinMax (int n, float *, float &, float &);

/*****************************************************************************************
 *
 * Picture object definitions.
 *
 */

/*********************************************************************
 *
 * Picture object configuration
 *
 */

typedef struct
{
  std::string   pict_filename;  // Picture filename
  std::string   pict_desc;  // Picture description
  
  hcp_Units pict_units; // Picture size units
  
  int       pict_width; // Picture width
  int       pict_height;    // Picture height
  
  hcp_Logic enable_frame;   // Enable bounding frame
  hcp_Logic transp_backgr;  // Enable transparent background (dummy if enable_frame value is hcpL_FALSE)
  
} hcp_PictConfig;

/*********************************************************************
 *
 * Picture object
 *
 */

class hcp_Picture
{
  
private:
  
  hcp_PictConfig    pict_config;                // Current configuration of picture object
  
public:
  
  hcp_Status    Config (hcp_PictConfig *);      // Configure picture object
  
  //hcp_Status  CreatePicture (HDC, CMetaFileDC *) const;   // Create new picture with current configuration
  //hcp_Status  ClosePicture (CMetaFileDC *) const; // Close current picture
  
};

/*****************************************************************************************
 *
 * Lithology object definitions.
 *
 */

/*********************************************************************
 *
 * Lithology commands
 *
 */

#define hcp_MAX_LCMD_LENGTH     50  // Maximal amount of chars in lithology command

#define hcp_MAX_LOCALIZ_LENGTH      3   // Maximal amount of chars in localization name
#define hcp_MAX_PATTERN_DESC_LENGTH 50  // Maximal amount of chars in current localization of lithology pattern name

// System commands {
#define hcp_LCMD_PATTERN_ID     "LithPattern"       // Lithology pattern identification [int]

#define hcp_LCMD_START_PATTERN      "StartPattern"      // Start of lithology pattern body block []
#define hcp_LCMD_END_PATTERN        "EndPattern"        // End of lithology pattern body block []

#define hcp_LCMD_PATTERN_DESC_ID        "LithPatternDesc"   // Start of lithology pattern description block [int]
#define hcp_LCMD_END_PATTERN_DESC       "EndPatternDesc"        // End of lithology pattern description block []
// System commands }

// Lithology pattern configuration {
#define hcp_LCMD_PATTERN_WIDTH      "PatternWidth"      // Lithology pattern width [int]
#define hcp_LCMD_PATTERN_HEIGHT     "PatternHeight"     // Lithology pattern height [int]
// Lithology pattern configuration }

// Base graphic primitives {
#define hcp_LCMD_POINT          "Point"         // Draw point [int,int, int, int, int,int,int]
#define hcp_LCMD_LINE           "Line"          // Draw line [int,int, int,int, int, int,int,int]
#define hcp_LCMD_ARC            "Arc"           // Draw arc [int,int, int,int, float,float, int, int,int,int]
// Base graphic primitives }

// Lithology pattern description commands {
#define hcp_LCMD_PATTERN_NAME       "PatternName"       // Lithology pattern name in specified localization [char[hcp_MAX_LOCALIZ_LENGTH], char[hcp_MAX_PATTERN_DESC_LENGHT]]
// Lithology pattern description commands }

/*********************************************************************
 *
 * Lithology object data configuration
 *
 */

typedef struct
{
  std::string   lp_filename;        // Lithology patterns data file
  std::string   lpd_filename;       // Lithology patterns description file
  
  float     ptrn_scale;     // Lithology pattern scale
  
} hcp_LithDataConfig;

/*********************************************************************
 *
 * Lithology pattern configuration
 *
 */

typedef struct
{
  int   ptrn_width; // Lithology pattern width
  int   ptrn_height;    // Lithology pattern height
  
} hcp_LithPtrnConfig;

/*********************************************************************
 *
 * Lithology pattern description
 *
 */

typedef struct
{
  char  *localization;  // Localization name
  char  *ptrn_name; // Lithology pattern name in current localization
  
} hcp_LithPtrnDesc;

/*********************************************************************
 *
 * Lithology legend styles
 *
 */

enum hcp_LegendStyle
  {
    hcpLS_HORIZONTAL = 0,   // Horizontal lithology legend
    hcpLS_VERTICAL, // Vertical lithology legend
    hcpLS_BOX,      // Box like lithology legend
    hcpLS_MANUAL        // User style lithology legend
  };

/*********************************************************************
 *
 * Lithology legend configuration
 *
 */

typedef struct
{
  hcp_LegendStyle   legend_style;   // Lithology legend drawing style
  
  int           element_step_x; // Lithology legend elements step by X axis
  int           element_step_y; // Lithology legend elements step by Y axis
  
  int           element_width;  // Lithology legend elements width
  int           element_height; // Lithology legend elements height

  const char        *font_family;   // Font family
  
} hcp_LegendConfig;

/*********************************************************************
 *
 * Lithology object
 *
 */

class hcp_Lith
{
  
private:
  
  hcp_LithDataConfig    lith_data_config;   // Current lithology object data configuration
  
  // Auxiliary
  hcp_Status        aux_IFStream (ifstream *) const;        // In-file stream status check
  hcp_Status        aux_FindNext (ifstream *, char*) const; // Find next lithology command in file
  
public:
  
  // Configuration
  hcp_Status        AttachLithData (hcp_LithDataConfig *);      // Attach new lithology data
  
  // Lithology patterns {
  hcp_Status        LithPtrnExist (int) const;          // Lithology pattern existence  
  hcp_Status        ConfigLithPtrn (int, hcp_LithPtrnConfig *) const;   // Configure lithology pattern
  hcp_Status        LocalizeLithPtrn (int, char*, char*) const;     // Localize lithology pattern
  
  hcp_Status        DrawLithPtrnDesc (QPainter *, char [],
                      int, int, int, const char *) const;       // Draw lithology pattern description
  
  hcp_Status        DrawFluid (QPainter *, hcp_Units, QRect *,      // Draw fluid
                   int) const;
  hcp_Status        DrawLithPtrn (QPainter *, hcp_Units, int,int,   // Draw lithology pattern
                      int, QRect *, hcp_Logic) const;

  hcp_Status        Fill (QPainter *, hcp_Units, int, QRect *, hcp_Logic) const;    // Fill rectangle by specified lithology pattern
  // Lithology patterns }
  
};

/*
 *  Exported lithology routines
 */

/*********************************************************************
 *
 * Create new file with lithology
 *
 */

hcp_Status hcp_core_NewLithology (QPainter *, hcp_PictConfig *, hcp_LithDataConfig *,
                  int, int, int,
                  int, float *, float *, int *, int *, int *,
                  float, float);

/*********************************************************************
 *
 * Create new file with lithology legend
 *
 */

hcp_Status hcp_core_NewLegend (QPainter *, hcp_PictConfig *,
                   hcp_LithDataConfig *, hcp_LegendConfig *,
                   int, int *, char [], int);

/*********************************************************************
 *
 * Localize one lithology pattern
 *
 */

hcp_Status hcp_core_LocalizeLithPtrn (hcp_LithDataConfig *, int, char [], char []);

/*****************************************************************************************
 *
 * Graphic definitions.
 *
 */

#define hcp_PI      3.1415926535897 // Pi constant
#define hcp_ARC_APPROX  10.0        // Arc aproximation constant

/*********************************************************************
 *
 * Point styles
 *
 */

enum hcp_PointStyle
  {
    hcpPS_SQUARE = 0,   // Square point
    hcpPS_ELLIPTIC  // Elliptic point (most similar point emulation)
  };

/*********************************************************************
 *
 * Point configuration
 *
 */

typedef struct
{
  int       pnt_width;  // Point width (!) Warning: this value has no units conversion
  QColor    pnt_color;  // Point color
  
  hcp_PointStyle    pnt_style;  // Point style
  
} hcp_PointConfig;

/*********************************************************************
 *
 * Line configuration
 *
 */

typedef struct
{
  int       line_width; // Line width
  QColor    line_color; // Line color
  
} hcp_LineConfig;

/*
 *  Base graphic primitives
 */

/*********************************************************************
 *
 * Point
 *
 */

hcp_Status hcp_Point (QPainter *, QRect *, int, int, hcp_Units, hcp_PointConfig *, hcp_Logic);

/*********************************************************************
 *
 * Line
 *
 */

hcp_Status hcp_Line (QPainter *, QRect *, int, int, int, int, hcp_Units, hcp_LineConfig *, hcp_Logic);

/*********************************************************************
 *
 * Arc
 *
 */

hcp_Status hcp_Arc (QPainter *, QRect *, QRect *, double, double, hcp_Units, hcp_LineConfig *, hcp_Logic);

/*
 *  Auxiliary graphic routines.
 */

/*********************************************************************
 *
 * Searching intersection point of bounding rectangle and line
 *
 */

hcp_Status hcp_graux_BoundsIntersect (QRect *, double, double, double, double, double &, double &);

/*********************************************************************
 *
 * Searching all intersection points of bounding rectangle and line
 *
 */

hcp_Status hcp_graux_BoundsAllIntersect (QRect *, double, double, double, double, double &, double &, double &, double &);

class
ZqbLithEngine
{
public:

  hcp_Lith      hcpLith;
  hcp_Status        rStatus;
  hcp_LithPtrnConfig    rLithPtrnConfig;
  hcp_LithDataConfig    rLithDataConfig;

  ZqbLithEngine (const char *lp_filename_s, const char *lpd_filename_s, float scale_factor);

  QBitmap*  getRaster (int lith_code);
};

#endif /* zqb_lith_engine.hpp */