TrackballManipulator.hpp

Go to the documentation of this file.

/**************************************************************************************/
/*                                                                                    */
/*  Visualization Library                                                             */
/*  http://visualizationlibrary.org                                                   */
/*                                                                                    */
/*  Copyright (c) 2005-2020, Michele Bosi                                             */
/*  All rights reserved.                                                              */
/*                                                                                    */
/*  Redistribution and use in source and binary forms, with or without modification,  */
/*  are permitted provided that the following conditions are met:                     */
/*                                                                                    */
/*  - Redistributions of source code must retain the above copyright notice, this     */
/*  list of conditions and the following disclaimer.                                  */
/*                                                                                    */
/*  - Redistributions in binary form must reproduce the above copyright notice, this  */
/*  list of conditions and the following disclaimer in the documentation and/or       */
/*  other materials provided with the distribution.                                   */
/*                                                                                    */
/*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND   */
/*  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED     */
/*  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE            */
/*  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR  */
/*  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES    */
/*  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;      */
/*  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON    */
/*  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT           */
/*  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS     */
/*  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                      */
/*                                                                                    */
/**************************************************************************************/

#ifndef TrackballManipulator_INCLUDE_ONCE
#define TrackballManipulator_INCLUDE_ONCE

#include <vlGraphics/UIEventListener.hpp>
#include <vlGraphics/Camera.hpp>
#include <vlCore/Vector3.hpp>

namespace vl
{
  class Transform;
  class Rendering;
  class SceneManager;
  class ActorCollection;

  //------------------------------------------------------------------------------
  // TrackballManipulator
  //------------------------------------------------------------------------------
  class VLGRAPHICS_EXPORT TrackballManipulator: public UIEventListener
  {
    VL_INSTRUMENT_CLASS(vl::TrackballManipulator, UIEventListener)

  public:
    typedef enum { NoMode, RotationMode, TranslationMode, ZoomMode } ETrackballMode;

  public:
    TrackballManipulator(): mMode(NoMode),
      mRotationButton(LeftButton), mTranslationButton(MiddleButton), mZoomButton(RightButton),
      mRotationSpeed(1.0f),        mTranslationSpeed(1.0f),          mZoomSpeed(1.0f)
    {
      VL_DEBUG_SET_OBJECT_NAME()
    }

    // --- UIEventListener ---

    virtual void mouseDownEvent(EMouseButton, int x, int y);

    virtual void mouseUpEvent(EMouseButton, int x, int y);

    virtual void mouseMoveEvent(int x, int y);

    virtual void enableEvent(bool enabled);

    virtual void initEvent() {}

    virtual void destroyEvent() {}

    virtual void updateEvent() {}

    virtual void addedListenerEvent(OpenGLContext*) {}

    virtual void removedListenerEvent(OpenGLContext*) {}

    virtual void mouseWheelEvent(int) {}

    virtual void keyPressEvent(unsigned short, EKey) {}

    virtual void keyReleaseEvent(unsigned short, EKey) {}

    virtual void resizeEvent(int, int) {}

    virtual void fileDroppedEvent(const std::vector<String>&) {}

    virtual void visibilityEvent(bool) {}

    // --- user methods ---

    void setCamera(Camera* camera) { mCamera = camera; }

    Camera* camera() { return mCamera.get(); }

    void setPivot(vec3 pivot) { mPivot = pivot; }

    vec3 pivot() const { return mPivot; }

    void setTransform(Transform* tr) { mTransform = tr; }

    Transform* transform() { return mTransform.get(); }

    int rotationButton() const { return mRotationButton; }

    void setRotationButton(int mouse_button) { mRotationButton = mouse_button; }

    int zoomButton() const { return mZoomButton; }

    void setZoomButton(int mouse_button) { mZoomButton = mouse_button; }

    int translationButton() const { return mTranslationButton; }

    void setTranslationButton(int mouse_button) { mTranslationButton = mouse_button; }

    float rotationSpeed() const { return mRotationSpeed; }

    void setRotationSpeed(float speed) { mRotationSpeed = speed; }

    float zoomSpeed() const { return mZoomSpeed; }

    void setZoomSpeed(float speed) { mZoomSpeed = speed; }

    float translationSpeed() const { return mTranslationSpeed; }

    void setTranslationSpeed(float speed) { mTranslationSpeed = speed; }

    void adjustView(const AABB& aabb, const vec3& dir, const vec3& up, real bias=1.0f);

    void adjustView(ActorCollection& actors, const vec3& dir, const vec3& up, real bias=1.0f);

    void adjustView(SceneManager* scene, const vec3& dir, const vec3& up, real bias=1.0f);

    void adjustView(Rendering* rendering, const vec3& dir, const vec3& up, real bias=1.0f);

    // --- Advanced methods ---

    mat4 trackballRotation(int x, int y);

    vec3 computeVector(int x, int y);

    ETrackballMode mode() const { return mMode; }

  protected:
    ref<Camera> mCamera;
    ivec2 mMouseStart;
    mat4 mStartMatrix;
    vec3 mPivot;
    vec3 mStartCameraPos;
    vec3 mStartPivot;
    ref<Transform> mTransform;
    ETrackballMode mMode;
    int mRotationButton;
    int mTranslationButton;
    int mZoomButton;
    float mRotationSpeed;
    float mTranslationSpeed;
    float mZoomSpeed;
  };
}

#endif