ManipulatorPlugin.h

Go to the documentation of this file.

/*

             *
            ***
           *****
   *********************       Mercenaries Engineering SARL
     *****************              Copyright (C) 2018
       *************
         *********        http://www.mercenaries-engineering.com
        ***********
       ****     ****
      **           **

*/
#pragma once

#include "Array.h"
#include "NodePlugin.h"
#include "NodeDelegate.h"

  namespace maquina
  {
    class CameraContext;
    class InteractionContext;

    class MAQUINA_EXPORT ManipulatorPlugin : public NodePlugin
    {
    public:

      enum class Space
      {
        world,
        parent,
        object,
        view
      };

      enum class Axis
      {
        x,
        y,
        z,
        mx,
        my,
        mz
      };

      ManipulatorPlugin(Node *node) : NodePlugin(node) {}


      Node controller(const char *ctrl_name) const;

      static float float_controller(
        const Imath::V2i& original_pos,
        const Imath::V2i& pos,
        int modifiers,
        float original_value,
        float slider_min=0.f,
        float slider_max=1.f,
        float min=-FLT_MAX,
        float max=FLT_MAX,
        float mouse_range = 500.f
        );

      static void translate_controller(
        const std::shared_ptr<maquina::NodeDelegate>& nd,
        const Imath::V3d& delta_world,
        const Imath::M44d& initial_matrix,
        const Imath::M44d& initial_world_matrix,
        float frame,
        maquina::NodeDelegate::TransformUserData* user_data,
        bool use_current_parent_matrix = false);

      static Imath::V3d translate_controller(
        const Imath::V3d& initial_world_position,
        const Imath::M44d& original_ctrl_matrix,
        const CameraContext& camera,
        const Imath::V2i& original_pos,
        float original_depth,
        const Imath::V2i& pos,
        int modifiers,
        Space space,
        const char* mode);

      static Imath::V3d translate_view(
        const Imath::V3d& initial_world_position, 
        const CameraContext& camera,
        const Imath::V2i& original_pos,
        float original_depth,
        const Imath::V2i& pos,
        int modifiers);

      static Imath::V3d translate_plane(
        const Imath::M44d& original_ctrl_matrix,
        const CameraContext& camera,
        const Imath::V2i& original_pos,
        float original_depth,
        const Imath::V2i& pos,
        int modifiers,
        const Imath::V3d& _plane_normal,
        Space space);

      static Imath::V3d translate_axis(
        const Imath::M44d& original_ctrl_matrix,
        const CameraContext& camera,
        const Imath::V2i& original_pos,
        float original_depth,
        const Imath::V2i& pos,
        const Imath::V3d& axis,
        Space space);

      static void rotate_controller(const std::shared_ptr<maquina::NodeDelegate>& nd, const Imath::V3d& axis, double angle, Space space,
        const Imath::M44d& initial_matrix, const Imath::M44d& initial_world_matrix, float frame, maquina::NodeDelegate::TransformUserData* user_data);
      static void rotate_gimbal_controller(Node& controller, const Imath::V3d& gimbal, const Imath::V3d& original, const ModificationContext& mc);

      static Imath::Quatd rotate_controller(
        int& lock_axis,
        int& major_axis,
        const char*& cursor,
        const Imath::V3d& initial_world_position,
        const Imath::M44d& original_ctrl_matrix,
        const CameraContext& camera,
        const Imath::V2i& original_pos,
        float original_depth,
        const Imath::V2i& pos,
        int modifiers,
        int nd_flags,
        float angle_speed = 0.01f);

      static const Imath::M44d to_world(Space space, const Imath::M44d& object, const Imath::M44d& world);

      static const Imath::V3d& axis(Axis axis);
      static Imath::V3d axis(const Imath::M44d& matrix, Axis axis);

      static Array rotate_help(const char* rotate_mode);
      static Array translate_help(const char* rotate_mode);

      virtual Node default_controller();
      void add_controller_cache_dependency( const Plug& plug );

      void remove_controller_cache_dependency( const Plug& plug );
      virtual void on_mouse_press(const CameraContext& camera, const InteractionContext& interaction);

      virtual void on_mouse_move(const CameraContext& camera, const InteractionContext& interaction);

      virtual void on_mouse_release(const CameraContext& camera, const InteractionContext& interaction);

      virtual std::string get_cursor();

      virtual Array get_help(const char *tool);

      virtual Array get_status(const char *tool);

      static float manipulation_frame();

      std::shared_ptr<maquina::NodeDelegate> node_delegate() const override;
    };
  }