Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
LVecBase3d Class Reference

This is the base class for all three-component vectors and points. More...

Inheritance diagram for LVecBase3d:
LPoint3d LVector3d

Public Types

enum  { num_components = 3, is_int = 0 }
 

Public Member Functions

object __getattr__ (str attr_name)
 
 __init__ ()
 
 __init__ (const LVecBase2d copy, double z)
 
 __init__ (const LVecBase3d)
 
 __init__ (double fill_value)
 
 __init__ (double x, double y, double z)
 
object __ipow__ (double exponent)
 
LVecBase3d __pow__ (double exponent)
 
object __reduce__ ()
 
str __repr__ ()
 
int __setattr__ (str attr_name, object assign)
 
int addHash (int hash)
 Adds the vector into the running hash. More...
 
int addHash (int hash, double threshold)
 Adds the vector into the running hash. More...
 
 addToCell (int i, double value)
 
 addX (double value)
 
 addY (double value)
 
 addZ (double value)
 
bool almostEqual (const LVecBase3d other)
 Returns true if two vectors are memberwise equal within a default tolerance based on the numeric type. More...
 
bool almostEqual (const LVecBase3d other, double threshold)
 Returns true if two vectors are memberwise equal within a specified tolerance. More...
 
int compareTo (const LVecBase3d other)
 This flavor of compare_to uses a default threshold value based on the numeric type. More...
 
int compareTo (const LVecBase3d other, double threshold)
 Sorts vectors lexicographically, componentwise. More...
 
 componentwiseMult (const LVecBase3d other)
 
LVecBase3d cross (const LVecBase3d other)
 
 crossInto (const LVecBase3d other)
 
double dot (const LVecBase3d other)
 
 fill (double fill_value)
 Sets each element of the vector to the indicated fill_value. More...
 
LVecBase3d fmax (const LVecBase3d other)
 
LVecBase3d fmin (const LVecBase3d other)
 
 generateHash (ChecksumHashGenerator hashgen)
 Adds the vector to the indicated hash generator. More...
 
 generateHash (ChecksumHashGenerator hashgen, double threshold)
 Adds the vector to the indicated hash generator. More...
 
double getCell (int i)
 
 getData ()
 Returns the address of the first of the three data elements in the vector. More...
 
int getHash ()
 Returns a suitable hash for phash_map. More...
 
int getHash (double threshold)
 Returns a suitable hash for phash_map. More...
 
LVecBase3d getStandardizedHpr ()
 Try to un-spin the hpr to a standard form. More...
 
double getX ()
 
LVecBase2d getXy ()
 Returns a 2-component vector that shares just the first two components of this vector. More...
 
LVecBase2d getXz ()
 Returns a 2-component vector that shares just the first and last components of this vector. More...
 
double getY ()
 
LVecBase2d getYz ()
 Returns a 2-component vector that shares just the last two components of this vector. More...
 
double getZ ()
 
bool isNan ()
 Returns true if any component of the vector is not-a-number, false otherwise. More...
 
double length ()
 Returns the length of the vector, by the Pythagorean theorem. More...
 
double lengthSquared ()
 Returns the square of the vector's length, cheap and easy. More...
 
bool normalize ()
 Normalizes the vector in place. More...
 
LVecBase3d normalized ()
 Normalizes the vector and returns the normalized vector as a copy. More...
 
bool operator != (const LVecBase3d other)
 
LVecBase3d operator * (double scalar)
 
LVecBase3d operator *= (double scalar)
 
LVecBase3d operator - ()
 
LVecBase3d operator - (const LVecBase3d other)
 
LVecBase3d operator -= (const LVecBase3d other)
 
 operator [] (int i, double assign_val)
 
double operator [] (int i)
 
 operator new (int size)
 
LVecBase3d operator+ (const LVecBase3d other)
 
LVecBase3d operator+= (const LVecBase3d other)
 
LVecBase3d operator/ (double scalar)
 
LVecBase3d operator/= (double scalar)
 
bool operator< (const LVecBase3d other)
 
LVecBase3d operator= (const LVecBase3d copy)
 
LVecBase3d operator= (double fill_value)
 
bool operator== (const LVecBase3d other)
 
 output (Ostream out)
 
LVecBase3d project (const LVecBase3d onto)
 Returns a new vector representing the projection of this vector onto another one. More...
 
 readDatagram (DatagramIterator source)
 Reads the vector from the Datagram using get_stdfloat(). More...
 
 readDatagramFixed (DatagramIterator source)
 Reads the vector from the Datagram using get_float32() or get_float64(). More...
 
 set (double x, double y, double z)
 
 setCell (int i, double value)
 
 setX (double value)
 
 setY (double value)
 
 setZ (double value)
 
 writeDatagram (Datagram destination)
 Writes the vector to the Datagram using add_stdfloat(). More...
 
 writeDatagramFixed (Datagram destination)
 Writes the vector to the Datagram using add_float32() or add_float64(), depending on the type of floats in the vector, regardless of the setting of Datagram::set_stdfloat_double(). More...
 

Static Public Member Functions

static TypeHandle getClassType ()
 
static int getNumComponents ()
 
static int size ()
 
static const LVecBase3d unitX ()
 Returns a unit X vector. More...
 
static const LVecBase3d unitY ()
 Returns a unit Y vector. More...
 
static const LVecBase3d unitZ ()
 Returns a unit Z vector. More...
 
static const LVecBase3d zero ()
 Returns a zero-length vector. More...
 

Public Attributes

double x
 
LVecBase2d xy
 Returns a 2-component vector that shares just the first two components of this vector. More...
 
LVecBase2d xz
 Returns a 2-component vector that shares just the first and last components of this vector. More...
 
double y
 
LVecBase2d yz
 Returns a 2-component vector that shares just the last two components of this vector. More...
 
double z
 

Detailed Description

This is the base class for all three-component vectors and points.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
num_components 
is_int 

Member Function Documentation

◆ __getattr__()

object __getattr__ ( str  attr_name)

◆ __init__() [1/5]

__init__ ( )

◆ __init__() [2/5]

__init__ ( const LVecBase2d  copy,
double  z 
)

◆ __init__() [3/5]

__init__ ( const  LVecBase3d)

◆ __init__() [4/5]

__init__ ( double  fill_value)

◆ __init__() [5/5]

__init__ ( double  x,
double  y,
double  z 
)

◆ __ipow__()

object __ipow__ ( double  exponent)

◆ __pow__()

LVecBase3d __pow__ ( double  exponent)

◆ __reduce__()

object __reduce__ ( )

◆ __repr__()

str __repr__ ( )

◆ __setattr__()

int __setattr__ ( str  attr_name,
object  assign 
)

◆ addHash() [1/2]

int addHash ( int  hash)

Adds the vector into the running hash.

◆ addHash() [2/2]

int addHash ( int  hash,
double  threshold 
)

Adds the vector into the running hash.

◆ addToCell()

addToCell ( int  i,
double  value 
)

◆ addX()

addX ( double  value)

◆ addY()

addY ( double  value)

◆ addZ()

addZ ( double  value)

◆ almostEqual() [1/2]

bool almostEqual ( const LVecBase3d  other)

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

◆ almostEqual() [2/2]

bool almostEqual ( const LVecBase3d  other,
double  threshold 
)

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

◆ compareTo() [1/2]

int compareTo ( const LVecBase3d  other)

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

◆ compareTo() [2/2]

int compareTo ( const LVecBase3d  other,
double  threshold 
)

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).

◆ componentwiseMult()

componentwiseMult ( const LVecBase3d  other)

◆ cross()

LVecBase3d cross ( const LVecBase3d  other)

◆ crossInto()

crossInto ( const LVecBase3d  other)

◆ dot()

double dot ( const LVecBase3d  other)

◆ fill()

fill ( double  fill_value)

Sets each element of the vector to the indicated fill_value.

This is particularly useful for initializing to zero.

◆ fmax()

LVecBase3d fmax ( const LVecBase3d  other)

◆ fmin()

LVecBase3d fmin ( const LVecBase3d  other)

◆ generateHash() [1/2]

generateHash ( ChecksumHashGenerator  hashgen)

Adds the vector to the indicated hash generator.

◆ generateHash() [2/2]

generateHash ( ChecksumHashGenerator  hashgen,
double  threshold 
)

Adds the vector to the indicated hash generator.

◆ getCell()

double getCell ( int  i)

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getData()

getData ( )

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

The remaining elements occupy the next positions consecutively in memory.

◆ getHash() [1/2]

int getHash ( )

Returns a suitable hash for phash_map.

◆ getHash() [2/2]

int getHash ( double  threshold)

Returns a suitable hash for phash_map.

◆ getNumComponents()

static int getNumComponents ( )
static

◆ getStandardizedHpr()

LVecBase3d getStandardizedHpr ( )

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

◆ getX()

double getX ( )

◆ getXy()

LVecBase2d getXy ( )

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

◆ getXz()

LVecBase2d getXz ( )

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

◆ getY()

double getY ( )

◆ getYz()

LVecBase2d getYz ( )

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

◆ getZ()

double getZ ( )

◆ isNan()

bool isNan ( )

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

◆ length()

double length ( )

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

◆ lengthSquared()

double lengthSquared ( )

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

◆ normalize()

bool normalize ( )

Normalizes the vector in place.

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

◆ normalized()

LVecBase3d normalized ( )

Normalizes the vector and returns the normalized vector as a copy.

If the vector was a zero-length vector, a zero length vector will be returned.

◆ operator !=()

bool operator != ( const LVecBase3d  other)

◆ operator *()

LVecBase3d operator * ( double  scalar)

◆ operator *=()

LVecBase3d operator *= ( double  scalar)

◆ operator -() [1/2]

LVecBase3d operator - ( )

◆ operator -() [2/2]

LVecBase3d operator - ( const LVecBase3d  other)

◆ operator -=()

LVecBase3d operator -= ( const LVecBase3d  other)

◆ operator []() [1/2]

operator [] ( int  i,
double  assign_val 
)

◆ operator []() [2/2]

double operator [] ( int  i)

◆ operator new()

operator new ( int  size)

◆ operator+()

LVecBase3d operator+ ( const LVecBase3d  other)

◆ operator+=()

LVecBase3d operator+= ( const LVecBase3d  other)

◆ operator/()

LVecBase3d operator/ ( double  scalar)

◆ operator/=()

LVecBase3d operator/= ( double  scalar)

◆ operator<()

bool operator< ( const LVecBase3d  other)

◆ operator=() [1/2]

LVecBase3d operator= ( const LVecBase3d  copy)

◆ operator=() [2/2]

LVecBase3d operator= ( double  fill_value)

◆ operator==()

bool operator== ( const LVecBase3d  other)

◆ output()

output ( Ostream  out)

◆ project()

LVecBase3d project ( const LVecBase3d  onto)

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

The resulting vector will be a scalar multiple of onto.

◆ readDatagram()

readDatagram ( DatagramIterator  source)

Reads the vector from the Datagram using get_stdfloat().

◆ readDatagramFixed()

readDatagramFixed ( DatagramIterator  source)

Reads the vector from the Datagram using get_float32() or get_float64().

See write_datagram_fixed().

◆ set()

set ( double  x,
double  y,
double  z 
)

◆ setCell()

setCell ( int  i,
double  value 
)

◆ setX()

setX ( double  value)

◆ setY()

setY ( double  value)

◆ setZ()

setZ ( double  value)

◆ size()

static int size ( )
static

◆ unitX()

static const LVecBase3d unitX ( )
static

Returns a unit X vector.

◆ unitY()

static const LVecBase3d unitY ( )
static

Returns a unit Y vector.

◆ unitZ()

static const LVecBase3d unitZ ( )
static

Returns a unit Z vector.

◆ writeDatagram()

writeDatagram ( Datagram  destination)

Writes the vector to the Datagram using add_stdfloat().

This is appropriate when you want to write the vector using the standard width setting, especially when you are writing a bam file.

◆ writeDatagramFixed()

writeDatagramFixed ( Datagram  destination)

Writes the vector to the Datagram using add_float32() or add_float64(), depending on the type of floats in the vector, regardless of the setting of Datagram::set_stdfloat_double().

This is appropriate when you want to write a fixed-width value to the datagram, especially when you are not writing a bam file.

◆ zero()

static const LVecBase3d zero ( )
static

Returns a zero-length vector.

Member Data Documentation

◆ x

double x

◆ xy

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

◆ xz

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

◆ y

double y

◆ yz

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

◆ z

double z