xsvector3.h

Go to the documentation of this file.

/* +---------------------------------------------------------------------------+
   |                     Mobile Robot Programming Toolkit (MRPT)               |
   |                          http://www.mrpt.org/                             |
   |                                                                           |
   | Copyright (c) 2005-2017, Individual contributors, see AUTHORS file        |
   | See: http://www.mrpt.org/Authors - All rights reserved.                   |
   | Released under BSD License. See details in http://www.mrpt.org/License    |
   +---------------------------------------------------------------------------+ */
#ifndef XSVECTOR3_H
#define XSVECTOR3_H

#include "xsvector.h"

struct XsVector3;
#ifdef __cplusplus
extern "C" {
#else
typedef struct XsVector3 XsVector3;
#endif

XSTYPES_DLL_API void XsVector3_construct(XsVector3* thisPtr, const XsReal* src);
XSTYPES_DLL_API void XsVector3_assign(XsVector3* thisPtr, const XsReal* src);
XSTYPES_DLL_API void XsVector3_destruct(XsVector3* thisPtr);
XSTYPES_DLL_API void XsVector3_copy(XsVector* copy, XsVector3 const* src);

#ifdef __cplusplus
} // extern "C"
#endif

#ifdef __cplusplus
/* This is allowed since the C standard says that no padding appears before the first member of a struct.
        Basically we're defining a union between a C++ inherited type and a C encapsulated type.
*/
struct XsVector3 : public XsVector {
XSCPPPROTECTED
#else
struct XsVector3 {
        XsVector m_vector;              //!< The underlying vector
#endif
        XsReal XSCCONST m_fixedData[3];                         //!< Fixed size storage for the components in the vector

#ifdef __cplusplus
public:
        //! \brief Constructs an empty vector3
        XsVector3()     : XsVector(m_fixedData, 3, XSDF_FixedSize)
        {
                //XsVector3_construct(this, 0);
        }

        //! \brief Constructs a vector3 from an \a other XsVector
        XsVector3(XsVector3 const& other) : XsVector(other, m_fixedData, 3, XSDF_FixedSize)
        {
        }

        //! \brief Constructs a vector3 from an \a other XsVector
        XsVector3(XsVector const& other) : XsVector(other, m_fixedData, 3, XSDF_FixedSize)
        {
        }
        
        //! \brief Constructs a vector3 using the values \a x, \a y, \a z
        XsVector3(XsReal x, XsReal y, XsReal z) : XsVector(m_fixedData, 3, XSDF_FixedSize)
        {
                m_fixedData[0] = x;
                m_fixedData[1] = y;
                m_fixedData[2] = z;
        }

        //! \brief Return a 3-element zero vector
        static XsVector3 zero3()
        {
                return XsVector3(XsMath_zero, XsMath_zero, XsMath_zero);
        }

//      using XsVector::operator=;
//      using XsVector::operator[];
#endif
};

#endif // file guard