HOM_ViewerDragger.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * COMMENTS:
 */

#ifndef HOM_ViewerDragger_h
#define HOM_ViewerDragger_h

#include "HOM_API.h"
#include "HOM_Module.h"
#include "HOM_ElemPtr.h"
#include <UT/UT_Tuple.h>

class HOM_GeometryViewport;
class HOM_Handle;
class HOM_Matrix3;
class HOM_SceneViewer;
class HOM_Vector3;
class HOM_ViewerEvent;

SWIGOUT(%rename(ViewerDragger) HOM_ViewerDragger;)

class HOM_API HOM_ViewerDragger 
{
public:
    typedef std::map<std::string, hboost::any> DragValueMap;

    HOM_ViewerDragger()
    { HOM_CONSTRUCT_OBJECT(this) }

    virtual ~HOM_ViewerDragger()
    { HOM_DESTRUCT_OBJECT(this) }

    virtual std::string name() const = 0;
    virtual bool valid() const = 0;

    virtual void startDrag(HOM_ViewerEvent& event, const HOM_Vector3 & start_pos) = 0;
    virtual void startDragAcrossFloor(HOM_ViewerEvent& event, const HOM_Vector3 & start_pos) = 0;
    virtual void startDragAlongLine(
        HOM_ViewerEvent&    event, 
        const HOM_Vector3 & line_start, 
        const HOM_Vector3 & line_dir) = 0;
    virtual void startDragAlongPlane(
        HOM_ViewerEvent&    event, 
        HOM_Vector3 const&  plane_point, 
        HOM_Vector3 const&  plane_normal ) = 0;
    virtual void startDragRotate(HOM_ViewerEvent& event, const HOM_Vector3 & center_pos, 
        double radius, const HOM_Vector3 & rotate_axis, const HOM_Matrix3 & orient) = 0;

    virtual DragValueMap drag(HOM_ViewerEvent & event) = 0;
    virtual void endDrag() = 0;

    virtual HOM_Vector3 position() const = 0;
    virtual HOM_Vector3 startPosition() const = 0;
    virtual HOM_Vector3 startDirection() const = 0;
    virtual HOM_Vector3 startRotatePosition() const = 0;

    virtual HOM_GeometryViewport *viewport() = 0;    

    virtual void enableModifierKeys(bool allow) = 0;
};

#endif // HOM_ViewerDragger_h