Orientation.h

Go to the documentation of this file.

// SRM SDK Release 4.4.0 - December 7, 2009

// - SRM spec. 4.4

/*
 *                             NOTICE
 * 
 * This software is provided openly and freely for use in representing and
 * interchanging environmental data & databases.
 * 
 * This software was developed for use by the United States Government with
 * unlimited rights.  The software was developed under contract
 * DASG60-02-D-0006 TO-193 by Science Applications International Corporation.
 * The software is unclassified and is deemed as Distribution A, approved
 * for Public Release.
 * 
 * Use by others is permitted only upon the ACCEPTANCE OF THE TERMS AND
 * CONDITIONS, AS STIPULATED UNDER THE FOLLOWING PROVISIONS:
 * 
 *    1. Recipient may make unlimited copies of this software and give
 *       copies to other persons or entities as long as the copies contain
 *       this NOTICE, and as long as the same copyright notices that
 *       appear on, or in, this software remain.
 * 
 *    2. Trademarks. All trademarks belong to their respective trademark
 *       holders.  Third-Party applications/software/information are
 *       copyrighted by their respective owners.
 * 
 *    3. Recipient agrees to forfeit all intellectual property and
 *       ownership rights for any version created from the modification
 *       or adaptation of this software, including versions created from
 *       the translation and/or reverse engineering of the software design.
 * 
 *    4. Transfer.  Recipient may not sell, rent, lease, or sublicense
 *       this software.  Recipient may, however enable another person
 *       or entity the rights to use this software, provided that this
 *       AGREEMENT and NOTICE is furnished along with the software and
 *       /or software system utilizing this software.
 * 
 *       All revisions, modifications, created by the Recipient, to this
 *       software and/or related technical data shall be forwarded by the
 *       Recipient to the Government at the following address:
 * 
 *         SMDC
 *         Attention SEDRIS (TO193) TPOC
 *         P.O. Box 1500
 *         Hunstville, AL  35807-3801
 * 
 *         or via electronic mail to:  [email protected]
 * 
 *    5. No Warranty. This software is being delivered to you AS IS
 *       and there is no warranty, EXPRESS or IMPLIED, as to its use
 *       or performance.
 * 
 *       The RECIPIENT ASSUMES ALL RISKS, KNOWN AND UNKNOWN, OF USING
 *       THIS SOFTWARE.  The DEVELOPER EXPRESSLY DISCLAIMS, and the
 *       RECIPIENT WAIVES, ANY and ALL PERFORMANCE OR RESULTS YOU MAY
 *       OBTAIN BY USING THIS SOFTWARE OR DOCUMENTATION.  THERE IS
 *       NO WARRANTY, EXPRESS OR, IMPLIED, AS TO NON-INFRINGEMENT OF
 *       THIRD PARTY RIGHTS, MERCHANTABILITY, OR FITNESS FOR ANY
 *       PARTICULAR PURPOSE.  IN NO EVENT WILL THE DEVELOPER, THE
 *       UNITED STATES GOVERNMENT OR ANYONE ELSE ASSOCIATED WITH THE
 *       DEVELOPMENT OF THIS SOFTWARE BE HELD LIABLE FOR ANY CONSEQUENTIAL,
 *       INCIDENTAL OR SPECIAL DAMAGES, INCLUDING ANY LOST PROFITS
 *       OR LOST SAVINGS WHATSOEVER.
 */

// SRM_OTHERS_GOES_HERE

// $Id: Orientation.h,v 1.47 2009/11/06 21:40:40 worleym Exp $

#ifndef _Orientation_h
#define _Orientation_h

#if !defined(_WIN32)
#define EXPORT_SRM_CPP_DLL
#elif defined(BUILD_SRM_CPP) /* SRM CPP Case */
#if !defined(EXPORT_SRM_CPP_DLL)
#if defined(_LIB)
#define EXPORT_SRM_CPP_DLL
#elif defined(_USRDLL)
#define EXPORT_SRM_CPP_DLL __declspec(dllexport)
#else
#define EXPORT_SRM_CPP_DLL __declspec(dllimport)
#endif
#endif
#else /* SRM C Case */
#define EXPORT_SRM_CPP_DLL
#endif /* _WIN32 && EXPORT_DLL */

#include "Exception.h"
#include <string>

namespace srm
{
class EXPORT_SRM_CPP_DLL Orientation
{
public:
    static const SRM_Long_Float epsilon;

    virtual Orientation & operator=(const Orientation &other);

    virtual SRM_Matrix_3x3 getMatrix3x3() const;

    virtual SRM_Axis_Angle_Params getAxisAngle() const;

    virtual SRM_Euler_Angles_ZXZ_Params getEulerAnglesZXZ() const;

    virtual SRM_Tait_Bryan_Angles_Params getTaitBryanAngles() const;

    virtual SRM_Quaternion_Params getQuaternion() const;

    virtual void setMatrix3x3(const SRM_Matrix_3x3 & params);

    virtual void setMatrix3x3
    (SRM_Long_Float a11, SRM_Long_Float a12, SRM_Long_Float a13,
     SRM_Long_Float a21, SRM_Long_Float a22, SRM_Long_Float a23,
     SRM_Long_Float a31, SRM_Long_Float a32, SRM_Long_Float a33);

    virtual void setAxisAngle(const SRM_Axis_Angle_Params & params);

    virtual void setAxisAngle(const SRM_Vector_3D & axis, SRM_Long_Float angle);

    virtual void setEulerAnglesZXZ(const SRM_Euler_Angles_ZXZ_Params & params);

    virtual void setEulerAnglesZXZ
    (
        SRM_Long_Float spin,
        SRM_Long_Float nutation,
        SRM_Long_Float precession
    );

    virtual void setTaitBryanAngles
    (
        const SRM_Tait_Bryan_Angles_Params & params
    );

    virtual void setTaitBryanAngles
    (
        SRM_Long_Float roll,
        SRM_Long_Float pitch,
        SRM_Long_Float yaw
    );

    virtual void setQuaternion(const SRM_Quaternion_Params & params );

    virtual void setQuaternion
    (
        SRM_Long_Float e0,
        SRM_Long_Float e1,
        SRM_Long_Float e2,
        SRM_Long_Float e3
    );

    virtual std::string toString() const = 0;

    virtual SRM_Ori_Rep_Type getOriRep() const = 0;

    virtual SRM_Vector_3D transformVector(const SRM_Vector_3D &vec ) const;

    static bool equivalence
    (
        const Orientation    &instance1,
        const Orientation    &instance2,
              SRM_Long_Float  tolerance = Orientation::epsilon
    );

    virtual bool equivalence
    (
        const Orientation    &compare_instance,
              SRM_Long_Float  tolerance = Orientation::epsilon
    ) const
    {
        return equivalence(*this, compare_instance, tolerance);
    }

    bool operator==( Orientation & rhs );

private:
    mutable SRM_Matrix_3x3 _matrix_base;
    mutable bool _internal_data_is_current;

protected:
    Orientation();
    const SRM_Matrix_3x3 & _get_matrix_base() const;
    const SRM_Matrix_3x3 & _get_matrix_base_unch() const;
    void _set_matrix_base(const SRM_Matrix_3x3 & matrix_base ) const;
    bool _get_internal_data_is_current() const;
    void _set_internal_data_is_current( bool internal_data_is_current) const;
    virtual void _updateIntData() const = 0;
    virtual void _updateRepData() = 0;
};


class EXPORT_SRM_CPP_DLL OrientationMatrix : public Orientation
{
public:
    OrientationMatrix();

    OrientationMatrix
    (SRM_Long_Float a11, SRM_Long_Float a12, SRM_Long_Float a13,
     SRM_Long_Float a21, SRM_Long_Float a22, SRM_Long_Float a23,
     SRM_Long_Float a31, SRM_Long_Float a32, SRM_Long_Float a33);

    OrientationMatrix(const SRM_Matrix_3x3 &params);

    OrientationMatrix(const Orientation &other);

    virtual Orientation & operator=(const Orientation &other);

    virtual std::string toString() const;

    virtual SRM_Ori_Rep_Type getOriRep() const
    {
        return SRM_ORI_REP_MATRIX_3X3;
    }

    static bool isValidParams(const SRM_Matrix_3x3 &params);

    static OrientationMatrix compose
    (
        const Orientation &left,
        const Orientation &right
    );

    static bool equivParams
    (
        const SRM_Matrix_3x3 &params1,
        const SRM_Matrix_3x3 &params2,
              SRM_Long_Float  tolerance = 0.0
    );

protected:
    SRM_Matrix_3x3 _matrix;

    virtual void _updateIntData() const;
    virtual void _updateRepData();
};


class EXPORT_SRM_CPP_DLL OrientationAxisAngle : public Orientation
{
public:
    OrientationAxisAngle();

    OrientationAxisAngle(const SRM_Axis_Angle_Params & params);

    OrientationAxisAngle(const SRM_Vector_3D & axis, SRM_Long_Float angle );

    OrientationAxisAngle(const Orientation &other);

    virtual Orientation & operator=(const Orientation &other);

    virtual SRM_Axis_Angle_Params getAxisAngle() const
    {
        return _axis_angle;
    }

    virtual void setAxisAngle(const SRM_Axis_Angle_Params & params);

    virtual void setAxisAngle(const SRM_Vector_3D & axis, SRM_Long_Float angle)
    {
        Orientation::setAxisAngle(axis, angle);
    }

    virtual std::string toString() const;

    virtual SRM_Ori_Rep_Type getOriRep() const
    {
        return SRM_ORI_REP_AXIS_ANGLE;
    }

    static bool isValidParams(const SRM_Axis_Angle_Params & params );

    static OrientationAxisAngle compose
    (
        const Orientation &left,
        const Orientation &right
    );

    static bool equivParams
    (
        const SRM_Axis_Angle_Params &params1,
        const SRM_Axis_Angle_Params &params2,
              SRM_Long_Float         tolerance = 0.0
    );

protected:
    SRM_Axis_Angle_Params _axis_angle;

    virtual void _updateIntData() const;
    virtual void _updateRepData();
};


class EXPORT_SRM_CPP_DLL OrientationEulerAnglesZXZ : public Orientation
{
public:
    OrientationEulerAnglesZXZ();

    OrientationEulerAnglesZXZ(const SRM_Euler_Angles_ZXZ_Params & params );

    OrientationEulerAnglesZXZ
    (
        SRM_Long_Float spin,
        SRM_Long_Float nutation,
        SRM_Long_Float precession
    );

    OrientationEulerAnglesZXZ(const Orientation &other);

    virtual Orientation & operator=(const Orientation &other);

    virtual SRM_Euler_Angles_ZXZ_Params getEulerAnglesZXZ() const
    {
        return _euler_angles;
    }

    virtual void setEulerAnglesZXZ
    (
        const SRM_Euler_Angles_ZXZ_Params & params
    );

    virtual void setEulerAnglesZXZ
    (
        SRM_Long_Float spin,
        SRM_Long_Float nutation,
        SRM_Long_Float precession
    )
    {
        Orientation::setEulerAnglesZXZ(spin, nutation, precession);
    }

    virtual std::string toString() const;

    virtual SRM_Ori_Rep_Type getOriRep() const
    {
        return SRM_ORI_REP_EULER_ANGLES_ZXZ;
    }

    static bool isValidParams(const SRM_Euler_Angles_ZXZ_Params &params);

    static OrientationEulerAnglesZXZ compose
    (
        const Orientation &left,
        const Orientation &right
    );

    static bool equivParams
    (
        const SRM_Euler_Angles_ZXZ_Params &params1,
        const SRM_Euler_Angles_ZXZ_Params &params2,
              SRM_Long_Float               tolerance = 0.0
    );

protected:
    SRM_Euler_Angles_ZXZ_Params _euler_angles;

    virtual void _updateIntData() const;
    virtual void _updateRepData();
};


class EXPORT_SRM_CPP_DLL OrientationTaitBryanAngles : public Orientation
{
public:
    OrientationTaitBryanAngles();

    OrientationTaitBryanAngles(const SRM_Tait_Bryan_Angles_Params &params);

    OrientationTaitBryanAngles
    (
        SRM_Long_Float roll,
        SRM_Long_Float pitch,
        SRM_Long_Float yaw
    );

    OrientationTaitBryanAngles(const Orientation &other);

    virtual Orientation & operator=(const Orientation &other);

    virtual SRM_Tait_Bryan_Angles_Params getTaitBryanAngles() const
    {
        return _tait_bryan_angles;
    }

    virtual void setTaitBryanAngles
    (
        const SRM_Tait_Bryan_Angles_Params & params
    );

    virtual void setTaitBryanAngles
    (
        SRM_Long_Float roll,
        SRM_Long_Float pitch,
        SRM_Long_Float yaw
    )
    {
        Orientation::setTaitBryanAngles(roll, pitch, yaw);
    }

    virtual std::string toString() const;

    virtual SRM_Ori_Rep_Type getOriRep() const
    {
        return SRM_ORI_REP_TAIT_BRYAN_ANGLES;
    }

    static bool isValidParams(const SRM_Tait_Bryan_Angles_Params & params );

    static OrientationTaitBryanAngles compose
    (
        const Orientation &left,
        const Orientation &right
    );

    static bool equivParams
    (
        const SRM_Tait_Bryan_Angles_Params &params1,
        const SRM_Tait_Bryan_Angles_Params &params2,
              SRM_Long_Float                tolerance = 0.0
    );

protected:
    SRM_Tait_Bryan_Angles_Params _tait_bryan_angles;

    virtual void _updateIntData() const;
    virtual void _updateRepData();
};


class EXPORT_SRM_CPP_DLL OrientationQuaternion : public Orientation
{
public:
    OrientationQuaternion();

    OrientationQuaternion(const SRM_Quaternion_Params &params);

    OrientationQuaternion
    (
        SRM_Long_Float e0,
        SRM_Long_Float e1,
        SRM_Long_Float e2,
        SRM_Long_Float e3
    );

    OrientationQuaternion(const Orientation &other);

    virtual Orientation & operator=(const Orientation &other);

    virtual SRM_Quaternion_Params getQuaternion() const
    {
        return _quaternion;
    }

    virtual void setQuaternion(const SRM_Quaternion_Params & params );

    virtual void setQuaternion
    (
        SRM_Long_Float e0,
        SRM_Long_Float e1,
        SRM_Long_Float e2,
        SRM_Long_Float e3
    )
    {
        Orientation::setQuaternion(e0, e1, e2, e3);
    }

    virtual std::string toString() const;

    virtual SRM_Ori_Rep_Type getOriRep() const
    {
        return SRM_ORI_REP_QUATERNION;
    }

    static bool isValidParams(const SRM_Quaternion_Params &params );

    static OrientationQuaternion compose
    (
        const Orientation &left,
        const Orientation &right
    );

    static bool equivParams
    (
        const SRM_Quaternion_Params &params1,
        const SRM_Quaternion_Params &params2,
              SRM_Long_Float         tolerance = 0.0
    );

protected:
    SRM_Quaternion_Params _quaternion;

    virtual void _updateIntData() const;
    virtual void _updateRepData();
};

} // namespace srm

#endif // _Orientation_h

---

Spatial Reference Model C++ API	Version 4.4 - December 7, 2009
Copyright © 2009 SEDRIS™	Docs by Doxygen 1.3.2