// llsphere.h
/**
 * @file llsphere.cpp
 * @author Andrew Meadows
 * @brief Simple sphere implementation for basic geometric operations
 *
 * $LicenseInfo:firstyear=2007&license=viewergpl$
 * 
 * Copyright (c) 2007-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_SPHERE_H
#define LL_SPHERE_H

#include "stdtypes.h"
#include "v3math.h"
#include <iostream>
#include <vector>

class LLSphere
{
public:
	LLSphere();
	LLSphere( const LLVector3& center, F32 radius );

	void set( const LLVector3& center, F32 radius );
	void setCenter( const LLVector3& center );
	void setRadius( F32 radius );

	const LLVector3& getCenter() const;
	F32 getRadius() const;

	// returns TRUE if this sphere completely contains other_sphere
	BOOL contains(const LLSphere& other_sphere) const;

	// returns TRUE if this sphere overlaps other_sphere
	BOOL overlaps(const LLSphere& other_sphere) const;

	// returns overlap distance
	// negative overlap is closest approach
	F32 getOverlap(const LLSphere& other_sphere) const;

	// removes any spheres that are contained in others
	static void collapse(std::vector<LLSphere>& sphere_list);

	// returns minimum sphere bounding sphere for a set of spheres
	static LLSphere getBoundingSphere(const LLSphere& first_sphere, const LLSphere& second_sphere);
	static LLSphere getBoundingSphere(const std::vector<LLSphere>& sphere_list);

	bool operator==(const LLSphere& rhs) const;

	friend std::ostream& operator<<( std::ostream& output_stream, const LLSphere& line );

protected:
	LLVector3 mCenter;
	F32 mRadius;
};


#endif