Public Member Functions | Public Attributes | List of all members
PxVec2 Class Reference

2 Element vector class. More...

#include <PxVec2.h>

Public Member Functions

PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 ()
 default constructor leaves data uninitialized. More...
 
PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 (PxZERO r)
 zero constructor. More...
 
PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 (PxReal a)
 Assigns scalar parameter to all elements. More...
 
PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 (PxReal nx, PxReal ny)
 Initializes from 2 scalar parameters. More...
 
PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 (const PxVec2 &v)
 Copy ctor. More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE PxVec2
operator= (const PxVec2 &p)
 Assignment operator. More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE PxReal
operator[] (int index)
 element access More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE const PxReal
operator[] (int index) const
 element access More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE bool 
operator== (const PxVec2 &v) const
 returns true if the two vectors are exactly equal. More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE bool 
operator!= (const PxVec2 &v) const
 returns true if the two vectors are not exactly equal. More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE bool 
isZero () const
 tests for exact zero vector More...
 
PX_CUDA_CALLABLE PX_INLINE bool isFinite () const
 returns true if all 2 elems of the vector are finite (not NAN or INF, etc.) More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE bool 
isNormalized () const
 is normalized - used by API parameter validation More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE PxReal 
magnitudeSquared () const
 returns the squared magnitude More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE PxReal 
magnitude () const
 returns the magnitude More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE PxVec2 
operator- () const
 negation More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE PxVec2 
operator+ (const PxVec2 &v) const
 vector addition More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE PxVec2 
operator- (const PxVec2 &v) const
 vector difference More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE PxVec2 
operator* (PxReal f) const
 scalar post-multiplication More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE PxVec2 
operator/ (PxReal f) const
 scalar division More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE PxVec2
operator+= (const PxVec2 &v)
 vector addition More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE PxVec2
operator-= (const PxVec2 &v)
 vector difference More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE PxVec2
operator*= (PxReal f)
 scalar multiplication More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE PxVec2
operator/= (PxReal f)
 scalar division More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE PxReal 
dot (const PxVec2 &v) const
 returns the scalar product of this and other. More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE PxVec2 
getNormalized () const
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE PxReal 
normalize ()
 normalizes the vector in place More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE PxVec2 
multiply (const PxVec2 &a) const
 a[i] * b[i], for all i. More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE PxVec2 
minimum (const PxVec2 &v) const
 element-wise minimum More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE float 
minElement () const
 returns MIN(x, y); More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE PxVec2 
maximum (const PxVec2 &v) const
 element-wise maximum More...
 
PX_CUDA_CALLABLE
PX_FORCE_INLINE float 
maxElement () const
 returns MAX(x, y); More...
 

Public Attributes

PxReal x
 
PxReal y
 

Detailed Description

2 Element vector class.

This is a 2-dimensional vector class with public data members.

Constructor & Destructor Documentation

PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2::PxVec2 ( )
inline

default constructor leaves data uninitialized.

PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2::PxVec2 ( PxZERO  r)
inline

zero constructor.

References PX_UNUSED().

PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2::PxVec2 ( PxReal  a)
inlineexplicit

Assigns scalar parameter to all elements.

Useful to initialize to zero or one.

Parameters
[in]aValue to assign to elements.
PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2::PxVec2 ( PxReal  nx,
PxReal  ny 
)
inline

Initializes from 2 scalar parameters.

Parameters
[in]nxValue to initialize X component.
[in]nyValue to initialize Y component.
PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2::PxVec2 ( const PxVec2 v)
inline

Copy ctor.

Member Function Documentation

PX_CUDA_CALLABLE PX_FORCE_INLINE PxReal PxVec2::dot ( const PxVec2 v) const
inline

returns the scalar product of this and other.

References x, and y.

PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 PxVec2::getNormalized ( ) const
inline

return a unit vector

References PxRecipSqrt().

PX_CUDA_CALLABLE PX_INLINE bool PxVec2::isFinite ( ) const
inline

returns true if all 2 elems of the vector are finite (not NAN or INF, etc.)

References PxIsFinite().

PX_CUDA_CALLABLE PX_FORCE_INLINE bool PxVec2::isNormalized ( ) const
inline

is normalized - used by API parameter validation

References PxAbs().

PX_CUDA_CALLABLE PX_FORCE_INLINE bool PxVec2::isZero ( ) const
inline

tests for exact zero vector

PX_CUDA_CALLABLE PX_FORCE_INLINE PxReal PxVec2::magnitude ( ) const
inline

returns the magnitude

References PxSqrt().

PX_CUDA_CALLABLE PX_FORCE_INLINE PxReal PxVec2::magnitudeSquared ( ) const
inline

returns the squared magnitude

Avoids calling PxSqrt()!

PX_CUDA_CALLABLE PX_FORCE_INLINE float PxVec2::maxElement ( ) const
inline

returns MAX(x, y);

References PxMax().

PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 PxVec2::maximum ( const PxVec2 v) const
inline

element-wise maximum

References PxMax(), x, and y.

PX_CUDA_CALLABLE PX_FORCE_INLINE float PxVec2::minElement ( ) const
inline

returns MIN(x, y);

References PxMin().

PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 PxVec2::minimum ( const PxVec2 v) const
inline

element-wise minimum

References PxMin(), x, and y.

PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 PxVec2::multiply ( const PxVec2 a) const
inline

a[i] * b[i], for all i.

References x, and y.

PX_CUDA_CALLABLE PX_FORCE_INLINE PxReal PxVec2::normalize ( )
inline

normalizes the vector in place

PX_CUDA_CALLABLE PX_FORCE_INLINE bool PxVec2::operator!= ( const PxVec2 v) const
inline

returns true if the two vectors are not exactly equal.

References x, and y.

PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 PxVec2::operator* ( PxReal  f) const
inline

scalar post-multiplication

PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2& PxVec2::operator*= ( PxReal  f)
inline

scalar multiplication

PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 PxVec2::operator+ ( const PxVec2 v) const
inline

vector addition

References x, and y.

PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2& PxVec2::operator+= ( const PxVec2 v)
inline

vector addition

References x, and y.

PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 PxVec2::operator- ( ) const
inline

negation

PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 PxVec2::operator- ( const PxVec2 v) const
inline

vector difference

References x, and y.

PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2& PxVec2::operator-= ( const PxVec2 v)
inline

vector difference

References x, and y.

PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2 PxVec2::operator/ ( PxReal  f) const
inline

scalar division

PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2& PxVec2::operator/= ( PxReal  f)
inline

scalar division

PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec2& PxVec2::operator= ( const PxVec2 p)
inline

Assignment operator.

References x, and y.

PX_CUDA_CALLABLE PX_FORCE_INLINE bool PxVec2::operator== ( const PxVec2 v) const
inline

returns true if the two vectors are exactly equal.

References x, and y.

PX_CUDA_CALLABLE PX_FORCE_INLINE PxReal& PxVec2::operator[] ( int  index)
inline

element access

References PX_ASSERT.

PX_CUDA_CALLABLE PX_FORCE_INLINE const PxReal& PxVec2::operator[] ( int  index) const
inline

element access

References PX_ASSERT.

Member Data Documentation

PxReal PxVec2::x
PxReal PxVec2::y

The documentation for this class was generated from the following file:


Copyright © 2008-2015 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com