paella/Code/include/Geometry/Rotation.hpp

86 lines
3.0 KiB
C++

////////////////////////////////////////////////////////////////////////////////
//
// Paella
// Copyright (C) 2015 - Thomas FORGIONE, Emilie JALRAS, Marion LENFANT, Thierry MALON, Amandine PAILLOUX
// Authors :
// Thomas FORGIONE
// Emilie JALRAS
// Marion LENFANT
// Thierry MALON
// Amandine PAILLOUX
//
// This file is part of the project Paella
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
// you must not claim that you wrote the original software.
// If you use this software in a product, an acknowledgment
// in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
// and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
////////////////////////////////////////////////////////////////////////////////
#ifndef ROTATION_HPP
#define ROTATION_HPP
#include <GL/gl.h>
#include <Geometry/Vector.hpp>
namespace geo
{
//////////////////////////////////////////
/// \ingroup geometry
/// \brief Class that wraps an OpenGL rotation
/////////////////////////////////////////
class Rotation
{
public:
////////////////////////////////////
/// \brief Default constructor
///
/// Creates the identity rotation
////////////////////////////////////
Rotation();
////////////////////////////////////
/// \brief Apply the OpenGL rotation
////////////////////////////////////
void operator()() const;
////////////////////////////////////
/// \brief Allows acces to elements of rotation
/// \param i index of the angle to extract
///
/// \return a reference to theta if i == 0, to phi if i == 1, to psi if i == 2.
/// throws a std::out_of_range exception else.
////////////////////////////////////
float& operator[](std::size_t i);
////////////////////////////////////
/// \brief Allows acces to elements of rotation
/// \param i index of the angle to extract
///
/// \return a reference to theta if i == 0, to phi if i == 1, to psi if i == 2.
/// throws a std::out_of_range exception else.
////////////////////////////////////
float const& operator[](std::size_t i) const;
float theta; ///< angle theta of the rotation
float phi; ///< angle phi of the rotation
float psi; ///< angle psi of the rotation
Vector3<float> center; ///< center of the rotation
};
} // namespace geo
#endif // ROTATION_HPP