graphics_engine.h

Go to the documentation of this file.

/*
**  graphics_engine.h
**
**  This is part of Shiokaze, a research-oriented fluid solver for computer graphics.
**  Created by Ryoichi Ando <rand@nii.ac.jp> on Jan 13, 2018.
**
**  Permission is hereby granted, free of charge, to any person obtaining a copy of
**  this software and associated documentation files (the "Software"), to deal in
**  the Software without restriction, including without limitation the rights to use,
**  copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
**  Software, and to permit persons to whom the Software is furnished to do so,
**  subject to the following conditions:
**
**  The above copyright notice and this permission notice shall be included in all copies
**  or substantial portions of the Software.
**
**  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
**  INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
**  PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
**  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
**  CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
**  OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
//
#ifndef SHKZ_GRAPHICS_ENGINE_H
#define SHKZ_GRAPHICS_ENGINE_H
//
#include <shiokaze/core/common.h>
#include <string>
#include <map>
#include <functional>
//
SHKZ_BEGIN_NAMESPACE
//
class graphics_engine {
public:
    virtual ~graphics_engine() = default;
    virtual void setup_graphics ( std::map<std::string,const void *> params=std::map<std::string,const void *>() ) = 0;
    //
    enum class FEATURE {
        OPACITY,
        _3D
    };
    virtual std::string get_graphics_engine_name () const = 0;
    virtual bool get_supported ( FEATURE feature ) const = 0;
    virtual void set_viewport( unsigned x, unsigned y, unsigned width, unsigned height ) = 0;
    virtual void get_viewport( unsigned &x, unsigned &y, unsigned &width, unsigned &height ) const = 0;
    virtual void set_2D_coordinate( double left, double right, double bottom, double top ) = 0;
    virtual void look_at( const double target[3], const double position[3], const double up[3], double fov, double near, double far ) = 0;
    virtual void clear() = 0;
    virtual void get_background_color( double color[3] ) const = 0;
    virtual void get_foreground_color( double color[3] ) const = 0;
    void color3( double r, double g, double b ) {
        double v[] = { r, g, b };
        color3v(v);
    }
    void color4( double r, double g, double b, double a ) {
        double v[] = { r, g, b, a };
        color4v(v);
    }
    template <class T> void color3v( const T *v ) {
        double v_plus_alpha[] = { v[0], v[1], v[2], 1.0 };
        color4v(v_plus_alpha);
    }
    virtual void color4v( const double *v ) = 0;
    void color4v( const float *v ) {
        double p[] = { v[0], v[1], v[2], v[3] };
        color4v(p);
    }
    void vertex2( double x, double y ) {
        double v[] = { x, y, 0.0 };
        vertex3v(v);
    }
    void vertex3( double x, double y, double z ) {
        double v[] = { x, y, z};
        vertex3v(v);
    }\
    //
    enum class MODE {
        POINTS,
        LINES,
        LINE_STRIP,
        LINE_LOOP,
        TRIANGLES,
        TRIANGLE_STRIP,
        TRIANGLE_FAN
    };
    virtual void begin( MODE mode ) = 0;
    virtual void end() = 0;
    virtual void point_size( double size ) = 0;
    virtual void line_width( double width ) = 0;
    template <class T> void vertex2v( const T *v ) {
        double v_3d_added[] = { v[0], v[1], 0.0 };
        vertex3v(v_3d_added);
    }
    virtual void vertex3v( const double *v ) = 0;
    void vertex3v( const float *v ) {
        double p[] = { v[0], v[1], v[2] };
        vertex3v(p);
    }
    virtual void draw_string( const double *v, std::string str, unsigned size=0 ) = 0;
};
//
SHKZ_END_NAMESPACE
//
#endif