PxVec2.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2015, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, related documentation
 * and any modifications thereto.  Any use, reproduction, disclosure or
 * distribution of this software and related documentation without an express
 * license agreement from NVIDIA CORPORATION is strictly prohibited.
 */
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.  


#ifndef PX_FOUNDATION_PX_VEC2_H
#define PX_FOUNDATION_PX_VEC2_H

#include "foundation/PxMath.h"

#ifndef PX_DOXYGEN
namespace physx
{
#endif


class PxVec2
{
public:

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2() {}


    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2(PxZERO r): x(0.0f), y(0.0f) 
    {
        PX_UNUSED(r);
    }

    explicit PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2(PxReal a): x(a), y(a) {}

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2(PxReal nx, PxReal ny): x(nx), y(ny){}

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2(const PxVec2& v): x(v.x), y(v.y) {}

    //Operators

    PX_CUDA_CALLABLE PX_FORCE_INLINE    PxVec2& operator=(const PxVec2& p)          { x = p.x; y = p.y; return *this;       }

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxReal& operator[](int index)
    {
        PX_ASSERT(index>=0 && index<=1);

        return reinterpret_cast<PxReal*>(this)[index];
    }

    PX_CUDA_CALLABLE PX_FORCE_INLINE const PxReal& operator[](int index) const
    {
        PX_ASSERT(index>=0 && index<=1);

        return reinterpret_cast<const PxReal*>(this)[index];
    }

    PX_CUDA_CALLABLE PX_FORCE_INLINE bool operator==(const PxVec2&v) const  { return x == v.x && y == v.y; }

    PX_CUDA_CALLABLE PX_FORCE_INLINE bool operator!=(const PxVec2&v) const  { return x != v.x || y != v.y; }

    PX_CUDA_CALLABLE PX_FORCE_INLINE bool isZero()  const                   { return x==0.0f && y==0.0f;            }

    PX_CUDA_CALLABLE PX_INLINE bool isFinite() const
    {
        return PxIsFinite(x) && PxIsFinite(y);
    }

    PX_CUDA_CALLABLE PX_FORCE_INLINE bool isNormalized() const
    {
        const float unitTolerance = 1e-4f;
        return isFinite() && PxAbs(magnitude()-1)<unitTolerance;
    }

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxReal magnitudeSquared() const        {   return x * x + y * y;                   }

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxReal magnitude() const               {   return PxSqrt(magnitudeSquared());      }

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 operator -() const
    {
        return PxVec2(-x, -y);
    }

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 operator +(const PxVec2& v) const       {   return PxVec2(x + v.x, y + v.y);    }

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 operator -(const PxVec2& v) const       {   return PxVec2(x - v.x, y - v.y);    }

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 operator *(PxReal f) const              {   return PxVec2(x * f, y * f);            }

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 operator /(PxReal f) const
    {
        f = 1.0f / f;   // PT: inconsistent notation with operator /=
        return PxVec2(x * f, y * f);
    }

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2& operator +=(const PxVec2& v)
    {
        x += v.x;
        y += v.y;
        return *this;
    }
    
    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2& operator -=(const PxVec2& v)
    {
        x -= v.x;
        y -= v.y;
        return *this;
    }

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2& operator *=(PxReal f)
    {
        x *= f;
        y *= f;
        return *this;
    }
    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2& operator /=(PxReal f)
    {
        f = 1.0f/f; // PT: inconsistent notation with operator /
        x *= f;
        y *= f;
        return *this;
    }

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxReal dot(const PxVec2& v) const      
    {   
        return x * v.x + y * v.y;               
    }

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 getNormalized() const
    {
        const PxReal m = magnitudeSquared();
        return m>0.0f ? *this * PxRecipSqrt(m) : PxVec2(0,0);
    }

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxReal normalize()
    {
        const PxReal m = magnitude();
        if (m>0.0f) 
            *this /= m;
        return m;
    }

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 multiply(const PxVec2& a) const
    {
        return PxVec2(x*a.x, y*a.y);
    }

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 minimum(const PxVec2& v) const
    { 
        return PxVec2(PxMin(x, v.x), PxMin(y,v.y)); 
    }

    PX_CUDA_CALLABLE PX_FORCE_INLINE float minElement() const
    {
        return PxMin(x, y);
    }
    
    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 maximum(const PxVec2& v) const
    { 
        return PxVec2(PxMax(x, v.x), PxMax(y,v.y)); 
    } 

    PX_CUDA_CALLABLE PX_FORCE_INLINE float maxElement() const
    {
        return PxMax(x, y);
    }

    PxReal x,y;
};

PX_CUDA_CALLABLE static PX_FORCE_INLINE PxVec2 operator *(PxReal f, const PxVec2& v)
{
    return PxVec2(f * v.x, f * v.y);
}

#ifndef PX_DOXYGEN
} // namespace physx
#endif

#endif // PX_FOUNDATION_PX_VEC2_H