include/foundation/PxVec2.h

File members: include/foundation/PxVec2.h

// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of NVIDIA CORPORATION nor the names of its
//    contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2008-2023 NVIDIA Corporation. All rights reserved.
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.

#ifndef PX_VEC2_H
#define PX_VEC2_H

#include "foundation/PxMath.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

template<class Type>
class PxVec2T
{
  public:
    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2T()
    {
    }

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2T(PxZERO) : x(Type(0.0)), y(Type(0.0))
    {
    }

    explicit PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2T(Type a) : x(a), y(a)
    {
    }

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2T(Type nx, Type ny) : x(nx), y(ny)
    {
    }

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

    // Operators

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

    PX_CUDA_CALLABLE PX_FORCE_INLINE Type& operator[](unsigned int index)
    {
        PX_ASSERT(index <= 1);
        return reinterpret_cast<Type*>(this)[index];
    }

    PX_CUDA_CALLABLE PX_FORCE_INLINE const Type& operator[](unsigned int index) const
    {
        PX_ASSERT(index <= 1);
        return reinterpret_cast<const Type*>(this)[index];
    }

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

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

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

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

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

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

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

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

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

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

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2T operator*(Type f) const
    {
        return PxVec2T(x * f, y * f);
    }

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2T operator/(Type f) const
    {
        f = Type(1.0) / f;
        return PxVec2T(x * f, y * f);
    }

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

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

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2T& operator*=(Type f)
    {
        x *= f;
        y *= f;
        return *this;
    }

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2T& operator/=(Type f)
    {
        f = Type(1.0) / f;
        x *= f;
        y *= f;
        return *this;
    }

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

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2T getNormalized() const
    {
        const Type m = magnitudeSquared();
        return m > Type(0.0) ? *this * PxRecipSqrt(m) : PxVec2T(Type(0));
    }

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

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

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

    PX_CUDA_CALLABLE PX_FORCE_INLINE Type minElement() const
    {
        return PxMin(x, y);
    }

    PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2T maximum(const PxVec2T& v) const
    {
        return PxVec2T(PxMax(x, v.x), PxMax(y, v.y));
    }

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

    Type    x, y;
};

template<class Type>
PX_CUDA_CALLABLE static PX_FORCE_INLINE PxVec2T<Type> operator*(Type f, const PxVec2T<Type>& v)
{
    return PxVec2T<Type>(f * v.x, f * v.y);
}

typedef PxVec2T<float>  PxVec2;
typedef PxVec2T<double> PxVec2d;

#if !PX_DOXYGEN
} // namespace physx
#endif

#endif