/**
 * @file lltoolpie.h
 * @brief LLToolPie class header file
 *
 * $LicenseInfo:firstyear=2001&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#ifndef LL_TOOLPIE_H
#define LL_TOOLPIE_H

#include "lltool.h"
#include "lluuid.h"
#include "llviewerwindow.h" // for LLPickInfo
#include "llhudeffectblob.h" // for LLPointer<LLHudEffectBlob>, apparently

class LLViewerObject;
class LLObjectSelection;

class LLToolPie : public LLTool, public LLSingleton<LLToolPie>
{
    LLSINGLETON(LLToolPie);
    LOG_CLASS(LLToolPie);
public:

    // Virtual functions inherited from LLMouseHandler
    virtual bool        handleAnyMouseClick(S32 x, S32 y, MASK mask, EMouseClickType clicktype, bool down) override;
    virtual bool        handleMouseDown(S32 x, S32 y, MASK mask) override;
    virtual bool        handleRightMouseDown(S32 x, S32 y, MASK mask) override;
    virtual bool        handleMouseUp(S32 x, S32 y, MASK mask) override;
    virtual bool        handleRightMouseUp(S32 x, S32 y, MASK mask) override;
    virtual bool        handleHover(S32 x, S32 y, MASK mask) override;
    virtual bool        handleDoubleClick(S32 x, S32 y, MASK mask) override;
    bool                handleScrollWheelAny(S32 x, S32 y, S32 clicks_x, S32 clicks_y);
    virtual bool        handleScrollWheel(S32 x, S32 y, S32 clicks) override;
    virtual bool        handleScrollHWheel(S32 x, S32 y, S32 clicks) override;
    virtual bool        handleToolTip(S32 x, S32 y, MASK mask) override;

    virtual void        render() override;

    virtual void        stopEditing() override;

    virtual void        onMouseCaptureLost() override;
    virtual void        handleSelect() override;
    virtual void        handleDeselect() override;
    virtual LLTool*     getOverrideTool(MASK mask) override;

    LLPickInfo&         getPick() { return mPick; }
    U8                  getClickAction() { return mClickAction; }
    LLViewerObject*     getClickActionObject() { return mClickActionObject; }
    LLObjectSelection*  getLeftClickSelection() { return (LLObjectSelection*)mLeftClickSelection; }
    void                resetSelection();
    bool                walkToClickedLocation();
    bool                teleportToClickedLocation();
    void                stopClickToWalk();

    static void         selectionPropertiesReceived();

    static void         showAvatarInspector(const LLUUID& avatar_id);
    static void         showObjectInspector(const LLUUID& object_id);
    static void         showObjectInspector(const LLUUID& object_id, const S32& object_face);
    static void         playCurrentMedia(const LLPickInfo& info);
    static void         VisitHomePage(const LLPickInfo& info);

private:
    bool outsideSlop        (S32 x, S32 y, S32 start_x, S32 start_y);
    bool handleLeftClickPick();
    bool handleRightClickPick();
    bool useClickAction     (MASK mask, LLViewerObject* object,LLViewerObject* parent);

    void showVisualContextMenuEffect();
    ECursorType cursorFromObject(LLViewerObject* object);

    bool handleMediaClick(const LLPickInfo& info);
    bool handleMediaDblClick(const LLPickInfo& info);
    bool handleMediaHover(const LLPickInfo& info);
    bool handleMediaMouseUp();
    bool handleTooltipLand(std::string line, std::string tooltip_msg);
    bool handleTooltipObject( LLViewerObject* hover_object, std::string line, std::string tooltip_msg);

    void steerCameraWithMouse(S32 x, S32 y);
    void startCameraSteering();
    void stopCameraSteering();
    bool inCameraSteerMode();

private:
    bool                mMouseButtonDown;
    bool                mMouseOutsideSlop;      // for this drag, has mouse moved outside slop region
    S32                 mMouseDownX;
    S32                 mMouseDownY;
    S32                 mMouseSteerX;
    S32                 mMouseSteerY;
    LLPointer<LLHUDEffectBlob>  mAutoPilotDestination;
    LLPointer<LLHUDEffectBlob>  mMouseSteerGrabPoint;
    bool                mClockwise;
    LLUUID              mMediaMouseCaptureID;
    LLPickInfo          mPick;
    LLPickInfo          mHoverPick;
    LLPickInfo          mSteerPick;
    LLPointer<LLViewerObject> mClickActionObject;
    U8                  mClickAction;
    LLSafeHandle<LLObjectSelection> mLeftClickSelection;
    bool                mClickActionBuyEnabled;
    bool                mClickActionPayEnabled;
    LLFrameTimer mDoubleClickTimer;
};

#endif