Panda3D
Public Member Functions | Static Public Member Functions

Vec3 Class Reference

This is a three-component vector distance (as opposed to a three-component point, which represents a particular point in space). More...

Inheritance diagram for Vec3:
VBase3

List of all members.

Public Member Functions

 Vec3 ()
 Vec3 (VBase3 const copy)
 Vec3 (float x, float y, float z)
 Vec3 (float fill_value)
unsigned int addHash (unsigned int hash)
 Adds the vector into the running hash.
unsigned int addHash (unsigned int hash, float threshold)
 Adds the vector into the running hash.
 addToCell (int i, float value)
 addX (float value)
 addY (float value)
 addZ (float value)
bool almostEqual (VBase3 const other)
 Returns true if two vectors are memberwise equal within a default tolerance based on the numeric type.
bool almostEqual (VBase3 const other, float threshold)
 Returns true if two vectors are memberwise equal within a specified tolerance.
float angleDeg (Vec3 const other)
 Returns the angle between this vector and the other one, expressed in degrees.
float angleRad (Vec3 const other)
 Returns the unsigned angle between this vector and the other one, expressed in radians.
int compareTo (VBase3 const other, float threshold)
 Sorts vectors lexicographically, componentwise.
int compareTo (VBase3 const other)
 This flavor of compare_to uses a default threshold value based on the numeric type.
Vec3 cross (VBase3 const other)
 crossInto (VBase3 const other)
float dot (VBase3 const other)
 fill (float fill_value)
 Sets each element of the vector to the indicated fill_value.
VBase3 fmax (VBase3 const other)
VBase3 fmin (VBase3 const other)
PyObject getattr (string attr_name)
 This is used to implement swizzle masks.
float getCell (int i)
 getData ()
 Returns the address of the first of the three data elements in the vector.
unsigned int getHash (float threshold)
 Returns a suitable hash for phash_map.
unsigned int getHash ()
 Returns a suitable hash for phash_map.
int getNumComponents ()
 Returns the number of elements in the vector, three.
VBase3 getStandardizedHpr ()
 Try to un-spin the hpr to a standard form.
float getX ()
Vec2 getXy ()
 Returns a 2-component vector that shares just the first two components of this vector.
Vec2 getXz ()
 Returns a 2-component vector that shares just the first and last components of this vector.
float getY ()
Vec2 getYz ()
 Returns a 2-component vector that shares just the last two components of this vector.
float getZ ()
bool isNan ()
 Returns true if any component of the vector is not-a-number, false otherwise.
float length ()
 Returns the length of the vector, by the Pythagorean theorem.
float lengthSquared ()
 Returns the square of the vector's length, cheap and easy.
bool normalize ()
 Normalizes the vector in place.
 operator new (unsigned int size)
bool operator!= (VBase3 const other)
Vec3 operator* (float scalar)
VBase3 operator*= (float scalar)
VBase3 operator+ (VBase3 const other)
Vec3 operator+ (Vec3 const other)
VBase3 operator+= (VBase3 const other)
VBase3 operator- (VBase3 const other)
Vec3 operator- (Vec3 const other)
Vec3 operator- ()
VBase3 operator-= (VBase3 const other)
Vec3 operator/ (float scalar)
VBase3 operator/= (float scalar)
bool operator< (VBase3 const other)
 This performs a lexicographical comparison.
Vec3 operator= (float fill_value)
Vec3 operator= (VBase3 const copy)
bool operator== (VBase3 const other)
 operator[] (int i)
float operator[] (int i)
 output (ostream out)
Vec3 project (VBase3 const onto)
 Returns a new vector representing the projection of this vector onto another one.
 pythonRepr (ostream out, string class_name)
PyObject reduce (PyObject self)
 This special Python method is implement to provide support for the pickle module.
float relativeAngleDeg (Vec3 const other)
 This method is deprecated.
float relativeAngleRad (Vec3 const other)
 This method is deprecated.
 set (float x, float y, float z)
int setattr (PyObject self, string attr_name, PyObject assign)
 This is used to implement write masks.
 setCell (int i, float value)
 setitem (int i, float v)
 setX (float value)
 setY (float value)
 setZ (float value)
float signedAngleDeg (Vec3 const other, Vec3 const ref)
 Returns the signed angle between two vectors.
float signedAngleRad (Vec3 const other, Vec3 const ref)
 returns the signed angle between two vectors.

Static Public Member Functions

static Vec3 back (CoordinateSystem cs)
 Returns the back vector for the given coordinate system.
static Vec3 back ()
 Returns the back vector for the given coordinate system.
static Vec3 down (CoordinateSystem cs)
 Returns the down vector for the given coordinate system.
static Vec3 down ()
 Returns the down vector for the given coordinate system.
static Vec3 forward (CoordinateSystem cs)
 Returns the forward vector for the given coordinate system.
static Vec3 forward ()
 Returns the forward vector for the given coordinate system.
static TypeHandle getClassType ()
static Vec3 left (CoordinateSystem cs)
 Returns the left vector for the given coordinate system.
static Vec3 left ()
 Returns the left vector for the given coordinate system.
static Vec3 rfu (float right, float fwd, float up, CoordinateSystem cs)
 Returns a vector that is described by its right, forward, and up components, in whatever way the coordinate system represents that vector.
static Vec3 rfu (float right, float fwd, float up)
 Returns a vector that is described by its right, forward, and up components, in whatever way the coordinate system represents that vector.
static Vec3 right (CoordinateSystem cs)
 Returns the right vector for the given coordinate system.
static Vec3 right ()
 Returns the right vector for the given coordinate system.
static int size ()
 Returns 3: the number of components of a LVecBase3.
static Vec3 const unitX ()
 Returns a unit X vector.
static Vec3 const unitY ()
 Returns a unit Y vector.
static Vec3 const unitZ ()
 Returns a unit Z vector.
static Vec3 up ()
 Returns the up vector for the given coordinate system.
static Vec3 up (CoordinateSystem cs)
 Returns the up vector for the given coordinate system.
static Vec3 const zero ()
 Returns a zero-length vector.

Detailed Description

This is a three-component vector distance (as opposed to a three-component point, which represents a particular point in space).

Some of the methods are slightly different between LPoint3 and LVector3; in particular, subtraction of two points yields a vector, while addition of a vector and a point yields a point.


Constructor & Destructor Documentation

Vec3 ( )
Vec3 ( VBase3 const  copy)
Vec3 ( float  fill_value)
Vec3 ( float  x,
float  y,
float  z 
)

Member Function Documentation

unsigned int addHash ( unsigned int  hash) [inherited]

Adds the vector into the running hash.

unsigned int addHash ( unsigned int  hash,
float  threshold 
) [inherited]

Adds the vector into the running hash.

addToCell ( int  i,
float  value 
) [inherited]
addX ( float  value) [inherited]
addY ( float  value) [inherited]
addZ ( float  value) [inherited]
bool almostEqual ( VBase3 const  other) [inherited]

Returns true if two vectors are memberwise equal within a default tolerance based on the numeric type.

bool almostEqual ( VBase3 const  other,
float  threshold 
) [inherited]

Returns true if two vectors are memberwise equal within a specified tolerance.

float angleDeg ( Vec3 const  other)

Returns the angle between this vector and the other one, expressed in degrees.

Both vectors should be initially normalized.

float angleRad ( Vec3 const  other)

Returns the unsigned angle between this vector and the other one, expressed in radians.

Both vectors should be initially normalized.

static Vec3 back ( CoordinateSystem  cs) [static]

Returns the back vector for the given coordinate system.

static Vec3 back ( ) [static]

Returns the back vector for the given coordinate system.

int compareTo ( VBase3 const  other) [inherited]

This flavor of compare_to uses a default threshold value based on the numeric type.

int compareTo ( VBase3 const  other,
float  threshold 
) [inherited]

Sorts vectors lexicographically, componentwise.

Returns a number less than 0 if this vector sorts before the other one, greater than zero if it sorts after, 0 if they are equivalent (within the indicated tolerance).

Vec3 cross ( VBase3 const  other)

Reimplemented from VBase3.

crossInto ( VBase3 const  other) [inherited]
float dot ( VBase3 const  other) [inherited]
static Vec3 down ( ) [static]

Returns the down vector for the given coordinate system.

static Vec3 down ( CoordinateSystem  cs) [static]

Returns the down vector for the given coordinate system.

fill ( float  fill_value) [inherited]

Sets each element of the vector to the indicated fill_value.

This is particularly useful for initializing to zero.

VBase3 fmax ( VBase3 const  other) [inherited]
VBase3 fmin ( VBase3 const  other) [inherited]
static Vec3 forward ( ) [static]

Returns the forward vector for the given coordinate system.

static Vec3 forward ( CoordinateSystem  cs) [static]

Returns the forward vector for the given coordinate system.

PyObject getattr ( string  attr_name)

This is used to implement swizzle masks.

Reimplemented from VBase3.

float getCell ( int  i) [inherited]
static TypeHandle getClassType ( ) [static]

Reimplemented from VBase3.

getData ( ) [inherited]

Returns the address of the first of the three data elements in the vector.

The remaining elements occupy the next positions consecutively in memory.

unsigned int getHash ( ) [inherited]

Returns a suitable hash for phash_map.

unsigned int getHash ( float  threshold) [inherited]

Returns a suitable hash for phash_map.

int getNumComponents ( ) [inherited]

Returns the number of elements in the vector, three.

VBase3 getStandardizedHpr ( ) [inherited]

Try to un-spin the hpr to a standard form.

Like all standards, someone decides between many arbitrary possible standards. This function assumes that 0 and 360 are the same, as is 720 and -360. Also 180 and -180 are the same. Another example is -90 and 270. Each element will be in the range -180.0 to 179.99999. The original usage of this function is for human readable output.

It doesn't work so well for asserting that foo_hpr is roughly equal to bar_hpr. Try using LQuaternionf.is_same_direction() for that. See Also: get_standardized_rotation, LQuaternion.is_same_direction

float getX ( ) [inherited]
Vec2 getXy ( )

Returns a 2-component vector that shares just the first two components of this vector.

Reimplemented from VBase3.

Vec2 getXz ( )

Returns a 2-component vector that shares just the first and last components of this vector.

Reimplemented from VBase3.

float getY ( ) [inherited]
Vec2 getYz ( )

Returns a 2-component vector that shares just the last two components of this vector.

Reimplemented from VBase3.

float getZ ( ) [inherited]
bool isNan ( ) [inherited]

Returns true if any component of the vector is not-a-number, false otherwise.

static Vec3 left ( CoordinateSystem  cs) [static]

Returns the left vector for the given coordinate system.

static Vec3 left ( ) [static]

Returns the left vector for the given coordinate system.

float length ( ) [inherited]

Returns the length of the vector, by the Pythagorean theorem.

float lengthSquared ( ) [inherited]

Returns the square of the vector's length, cheap and easy.

bool normalize ( ) [inherited]

Normalizes the vector in place.

Returns true if the vector was normalized, false if it was a zero-length vector.

operator new ( unsigned int  size) [inherited]
bool operator!= ( VBase3 const  other) [inherited]
Vec3 operator* ( float  scalar)

Reimplemented from VBase3.

VBase3 operator*= ( float  scalar) [inherited]
VBase3 operator+ ( VBase3 const  other)

Reimplemented from VBase3.

Vec3 operator+ ( Vec3 const  other)
VBase3 operator+= ( VBase3 const  other) [inherited]
Vec3 operator- ( Vec3 const  other)
Vec3 operator- ( )

Reimplemented from VBase3.

VBase3 operator- ( VBase3 const  other)

Reimplemented from VBase3.

VBase3 operator-= ( VBase3 const  other) [inherited]
Vec3 operator/ ( float  scalar)

Reimplemented from VBase3.

VBase3 operator/= ( float  scalar) [inherited]
bool operator< ( VBase3 const  other) [inherited]

This performs a lexicographical comparison.

It's of questionable mathematical meaning, but sometimes has a practical purpose for sorting unique vectors, especially in an STL container. Also see compare_to().

Vec3 operator= ( float  fill_value)

Reimplemented from VBase3.

Vec3 operator= ( VBase3 const  copy)

Reimplemented from VBase3.

bool operator== ( VBase3 const  other) [inherited]
operator[] ( int  i) [inherited]
float operator[] ( int  i) [inherited]
output ( ostream  out) [inherited]
Vec3 project ( VBase3 const  onto)

Returns a new vector representing the projection of this vector onto another one.

The resulting vector will be a scalar multiple of onto.

Reimplemented from VBase3.

pythonRepr ( ostream  out,
string  class_name 
)

Reimplemented from VBase3.

PyObject reduce ( PyObject  self) [inherited]

This special Python method is implement to provide support for the pickle module.

float relativeAngleDeg ( Vec3 const  other)

This method is deprecated.

Do not use.

float relativeAngleRad ( Vec3 const  other)

This method is deprecated.

Do not use.

static Vec3 rfu ( float  right,
float  fwd,
float  up,
CoordinateSystem  cs 
) [static]

Returns a vector that is described by its right, forward, and up components, in whatever way the coordinate system represents that vector.

INLINE_LINMATH FLOATNAME(LVector3) & FLOATNAME(LVector3)::

static Vec3 rfu ( float  right,
float  fwd,
float  up 
) [static]

Returns a vector that is described by its right, forward, and up components, in whatever way the coordinate system represents that vector.

INLINE_LINMATH FLOATNAME(LVector3) & FLOATNAME(LVector3)::

static Vec3 right ( CoordinateSystem  cs) [static]

Returns the right vector for the given coordinate system.

static Vec3 right ( ) [static]

Returns the right vector for the given coordinate system.

set ( float  x,
float  y,
float  z 
) [inherited]
int setattr ( PyObject  self,
string  attr_name,
PyObject  assign 
)

This is used to implement write masks.

Reimplemented from VBase3.

setCell ( int  i,
float  value 
) [inherited]
setitem ( int  i,
float  v 
) [inherited]
setX ( float  value) [inherited]
setY ( float  value) [inherited]
setZ ( float  value) [inherited]
float signedAngleDeg ( Vec3 const  other,
Vec3 const  ref 
)

Returns the signed angle between two vectors.

The angle is positive if the rotation from this vector to other is clockwise when looking in the direction of the ref vector.

Vectors (except the ref vector) should be initially normalized.

float signedAngleRad ( Vec3 const  other,
Vec3 const  ref 
)

returns the signed angle between two vectors.

The angle is positive if the rotation from this vector to other is clockwise when looking in the direction of the ref vector.

Vectors (except the ref vector) should be initially normalized.

static int size ( ) [static, inherited]

Returns 3: the number of components of a LVecBase3.

static Vec3 const unitX ( ) [static]

Returns a unit X vector.

Reimplemented from VBase3.

static Vec3 const unitY ( ) [static]

Returns a unit Y vector.

Reimplemented from VBase3.

static Vec3 const unitZ ( ) [static]

Returns a unit Z vector.

Reimplemented from VBase3.

static Vec3 up ( CoordinateSystem  cs) [static]

Returns the up vector for the given coordinate system.

static Vec3 up ( ) [static]

Returns the up vector for the given coordinate system.

static Vec3 const zero ( ) [static]

Returns a zero-length vector.

Reimplemented from VBase3.

 All Classes Namespaces Functions Variables Enumerations Enumerator Properties