/**
 * @file llmaniprotate.h
 * @brief LLManipRotate class definition
 *
 * $LicenseInfo:firstyear=2002&license=viewergpl$
 *
 * Copyright (c) 2002-2009, Linden Research, Inc.
 *
 * Second Life Viewer Source Code
 * The source code in this file ("Source Code") is provided by Linden Lab
 * to you under the terms of the GNU General Public License, version 2.0
 * ("GPL"), unless you have obtained a separate licensing agreement
 * ("Other License"), formally executed by you and Linden Lab.  Terms of
 * the GPL can be found in doc/GPL-license.txt in this distribution, or
 * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
 *
 * There are special exceptions to the terms and conditions of the GPL as
 * it is applied to this Source Code. View the full text of the exception
 * in the file doc/FLOSS-exception.txt in this software distribution, or
 * online at
 * http://secondlifegrid.net/programs/open_source/licensing/flossexception
 *
 * By copying, modifying or distributing this software, you acknowledge
 * that you have read and understood your obligations described above,
 * and agree to abide by those obligations.
 *
 * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
 * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
 * COMPLETENESS OR PERFORMANCE.
 * $/LicenseInfo$
 */

#ifndef LL_LLMANIPROTATE_H
#define LL_LLMANIPROTATE_H

#include "llquaternion.h"
#include "llvector3.h"
#include "llvector4.h"

#include "llmanip.h"
#include "lltool.h"
#include "llviewerobject.h"

class LLToolComposite;
class LLColor4;

class LLManipRotate : public LLManip
{
protected:
	LOG_CLASS(LLManipRotate);

public:
	class ManipulatorHandle
	{
	public:
		LLVector3	mAxisU;
		LLVector3	mAxisV;
		U32			mManipID;

		ManipulatorHandle(LLVector3 axis_u, LLVector3 axis_v, U32 id)
		:	mAxisU(axis_u),
			mAxisV(axis_v),
			mManipID(id)
		{
		}
	};

	LLManipRotate(LLToolComposite* composite);

	virtual bool	handleMouseDown(S32 x, S32 y, MASK mask);
	virtual bool	handleMouseUp(S32 x, S32 y, MASK mask);
	virtual bool	handleHover(S32 x, S32 y, MASK mask);
	virtual void	render();

	virtual void	handleSelect();

	virtual bool	handleMouseDownOnPart(S32 x, S32 y, MASK mask);
	virtual void	highlightManipulators(S32 x, S32 y);
	virtual bool	canAffectSelection();

private:
	void			updateHoverView();

	void			drag(S32 x, S32 y);
	LLVector3		projectToSphere(F32 x, F32 y, bool* on_sphere);

	void			renderSnapGuides();
	void			renderActiveRing(F32 radius, F32 width,
									 const LLColor4& center_color,
									 const LLColor4& side_color);

	bool			updateVisiblity();
	LLVector3		findNearestPointOnRing(S32 x, S32 y,
										   const LLVector3& center,
										   const LLVector3& axis);

	LLQuaternion	dragUnconstrained(S32 x, S32 y);
	LLQuaternion	dragConstrained(S32 x, S32 y);
	LLVector3		getConstraintAxis();
	S32				getObjectAxisClosestToMouse(LLVector3& axis);

	// Utility functions
	static bool			getSnapEnabled();
	static void			mouseToRay(S32 x, S32 y, LLVector3* ray_pt,
								   LLVector3* ray_dir);
	static LLVector3	intersectMouseWithSphere(S32 x, S32 y,
												 const LLVector3& sphere_center,
												 F32 sphere_radius);
	static LLVector3	intersectRayWithSphere(const LLVector3& ray_pt,
											   const LLVector3& ray_dir,
											   const LLVector3& sphere_center,
											   F32 sphere_radius);

private:
	LLVector3d			mRotationCenter;
	LLCoordGL			mCenterScreen;
	LLQuaternion		mRotation;

	LLVector3			mMouseDown;
	LLVector3			mMouseCur;
	F32					mRadiusMeters;

	LLVector3			mCenterToCam;
	LLVector3			mCenterToCamNorm;
	F32					mCenterToCamMag;
	LLVector3			mCenterToProfilePlane;
	F32					mCenterToProfilePlaneMag;

	LLVector4			mManipulatorVertices[6];
	LLVector4			mManipulatorScales;

	bool				mSmoothRotate;
	bool				mCamEdgeOn;
};

#endif  // LL_LLMANIPROTATE_H