RenderablePlugin.h

Go to the documentation of this file.

/*           *
            ***
           *****
   *********************       Mercenaries Engineering SARL
     *****************              Copyright (C) 2020
       *************
         *********        http://www.mercenaries-engineering.com
        ***********
       ****     ****
      **           **                                            
*/
# pragma once
# include "Maquina/Macros.h"

MAQUINA_IGNORE_WARNINGS_BEGIN
# include <ImathMatrix.h>
# include <ImathColor.h>
MAQUINA_IGNORE_WARNINGS_END

# include "Maquina/NodeDelegate.h"
# include "Maquina/NodePlugin.h"
# include "Maquina/RenderTargets.h"

namespace maquina
{
  struct RenderParameters {
    enum ShadingType{ SHADED, WIREFRAME, WIREFRAME_ON_SHADED };
    enum SelectType{ CONTROLLER, MANIPULATOR, GEOMETRY };
    enum LightingMode{ PBR, SIMPLE, FLAT, SILHOUETTE, COUNT };
    enum class CullingType{ style_back_unless_double_sided, style_back, off};
    enum class RenderTargetAttachment{ color = 0, ids = 1, position = 3, normal = 4 };
    enum class RenderPass{ before_all, after_all };
    std::wstring env_map_path;
    Imath::M44d camera_projection;
    Imath::M44d world_to_camera;
    Imath::V4i viewport = Imath::V4i{0}; //x, y, width, height
    Imath::Color4f ambient_light;
    Imath::Color4f background_color;
    RenderTargets render_targets;
    /* The id of the rendering viewport. Viewport IDs may be sparse. When deleted, a viewport informs the renderable plugins
    to free any viewport specific data using RenderablePlugin::free_viewport_data. */
    uint64_t viewport_identifier = 0;
    float near_clip = 0.1f;
    float far_clip = 1000.f;
    float time = 0;
    uint8_t subdivision_level = 0; //0, 1 or 2
    uint8_t lighting_mode = 0; //PBR, SIMPLE, FLAT, SILHOUETTE
    uint8_t shading_mode = 0; //WIREFRAME, WIREFRAME_ON_SHADED or SHADED
    uint8_t select_mode = 0;  //CONTROLLER, MANIPULATOR, GEOMETRY
    uint8_t msaa_samples = 0;
    bool smooth_shading = true;
    bool use_textures = false;
    uint8_t culling_mode = 0; //style_back_unless_double_sided, style_back, off
    bool is_playing = false;
    bool force_picking = false;
    std::shared_ptr<NodeDelegate> camera; // The camera node delegate path
  };

  struct PickingResult {
    PickingResult() = default;
    PickingResult( const std::string& path, float depth ) 
      : node_delegate_path{ path }, normalized_depth{ depth } 
    {}
    bool empty() const { return node_delegate_path.empty(); }
    std::string node_delegate_path;
    float normalized_depth;
  };

  class MAQUINA_EXPORT RenderablePlugin : public NodePlugin
  {
  public:
    RenderablePlugin( Node* node ) : NodePlugin( node ) {}
    virtual ~RenderablePlugin() {}

    virtual void release_GL_resources() {};

    virtual void render( const RenderParameters& parameters ) = 0;
    virtual void pick( const RenderParameters& parameters, Imath::V2i position, std::vector< PickingResult >& picked );
    virtual void select( const RenderParameters& parameters, const Imath::V4i& trap, std::vector< std::string >& delegate_paths );
    static void cache( const Plug& plug );
    static void uncache( const Plug& plug );

    virtual void free_viewport_data(uint64_t viewport_identifier) {}

    virtual int rendering_order() = 0;

  };
}