IAngle.hpp

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (C) 2011 by Benjamin Hadorn (b_hadorn@bluewin.ch)
 *****************************************************************************
 * Project    : Zeus Math Library
 * Module     : IAngle
 * Package    : Zeus.ZeusMath.System.Interfaces
 * Author     : Martin Abbuehl
 * Date       : 27.12.2011
 * System     : Zeus-Framework
 *****************************************************************************
 * Licence:                                                                  *
 *   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; either version               *
 *   2.1 of the License, or (at your option) any later version.              *
 *                                                                           *
 *   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 St, Fifth Floor, Boston, MA 02110, USA    *
 *****************************************************************************/

/*****************************************************************************
 * Changes:
 *  27.12.2011 bha: created zeus 2.0
 *****************************************************************************/

#ifndef IAngleHPP
#define IAngleHPP

#include <zeusbase/System/Interfaces/IValueType.hpp>
#include <zeusmath/Config/PlatformDefines.hpp>


BEGIN_NAMESPACE_Zeus


/******************************************************************************/
/******************************************************************************/
class IAngle : public IValueType
{
  public:
    /******************************************************************************/
    /******************************************************************************/
    enum ESystem
    {
      etRadians = 0,
      etDegrees = 1
      // Search for OnChangeIAngle::ESystem in files if you modify this enum.
    };

    /******************************************************************************/
    /******************************************************************************/
    virtual Float MQUALIFIER getRadians() const = 0;

    /******************************************************************************/
    /******************************************************************************/
    virtual Float MQUALIFIER getDegrees() const = 0;

    /******************************************************************************/
    /******************************************************************************/
    virtual void MQUALIFIER setRadians(const Float& fAngle) = 0;

    /******************************************************************************/
    /******************************************************************************/
    virtual void MQUALIFIER setDegrees(const Float& fAngle) = 0;
    
    /******************************************************************************/
    /******************************************************************************/
    virtual void MQUALIFIER assign(const IAngle& rAngle) = 0;

    /******************************************************************************/
    /******************************************************************************/
    virtual bool MQUALIFIER isEqual(const IAngle& rAngle,
                                    bool bNormalizeToSingleCircle = false) const = 0;

    /******************************************************************************/
    /******************************************************************************/
    /******************************************************************************/
    /******************************************************************************/
    virtual Float MQUALIFIER cos() const = 0;

    /******************************************************************************/
    /******************************************************************************/
    virtual Float MQUALIFIER sin() const = 0;

    /******************************************************************************/
    /******************************************************************************/
    virtual Float MQUALIFIER tan() const = 0;

    /******************************************************************************/
    /******************************************************************************/
    virtual void MQUALIFIER normalizeToInterval(const IAngle& rAngleMin,
                                                const IAngle& rAngleMax,
                                                bool bIncludeMin, bool bIncludeMax) = 0;

    /******************************************************************************/
    /******************************************************************************/
    virtual void MQUALIFIER normalizeToSingleCircle() = 0;

    /******************************************************************************/
    /******************************************************************************/
    HIDE_ASSIGNMENT_OPERATOR(IAngle)
};

END_NAMESPACE_Zeus


#endif