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

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

#include "lvecBase4.h"

Inheritance diagram for LVecBase4d:
LPoint4d LQuaterniond LVector4d LOrientationd LRotationd

Public Types

enum  { num_components = 4, is_int = 0 }
 
typedef const double * const_iterator
 
typedef LSimpleMatrix< double, 1, 4 > EVector4
 
typedef const double * iterator
 
typedef double numeric_type
 

Public Member Functions

 LVecBase4d (const LVecBase4d &copy)
 
 LVecBase4d (const UnalignedLVecBase4d &copy)
 
 LVecBase4d (double fill_value)
 
 LVecBase4d (double x, double y, double z, double w)
 
 LVecBase4d (const LVecBase3d &copy, double w)
 
 LVecBase4d (const LPoint3d &point)
 Constructs an LVecBase4 from an LPoint3. More...
 
 LVecBase4d (const LVector3d &vector)
 Constructs an LVecBase4 from an LVector3. More...
 
 LVecBase4d (const EVector4 &v)
 
size_t add_hash (size_t hash) const
 Adds the vector into the running hash. More...
 
size_t add_hash (size_t hash, double threshold) const
 Adds the vector into the running hash. More...
 
void add_to_cell (int i, double value)
 
void add_w (double value)
 
void add_x (double value)
 
void add_y (double value)
 
void add_z (double value)
 
bool almost_equal (const LVecBase4d &other, double threshold) const
 Returns true if two vectors are memberwise equal within a specified tolerance. More...
 
bool almost_equal (const LVecBase4d &other) const
 Returns true if two vectors are memberwise equal within a default tolerance based on the numeric type. More...
 
iterator begin ()
 Returns an iterator that may be used to traverse the elements of the matrix, STL-style. More...
 
const_iterator begin () const
 Returns an iterator that may be used to traverse the elements of the matrix, STL-style. More...
 
int compare_to (const LVecBase4d &other) const
 This flavor of compare_to uses a default threshold value based on the numeric type. More...
 
int compare_to (const LVecBase4d &other, double threshold) const
 Sorts vectors lexicographically, componentwise. More...
 
void componentwise_mult (const LVecBase4d &other)
 
double dot (const LVecBase4d &other) const
 
iterator end ()
 Returns an iterator that may be used to traverse the elements of the matrix, STL-style. More...
 
const_iterator end () const
 Returns an iterator that may be used to traverse the elements of the matrix, STL-style. More...
 
void extract_data (float *)
 
void fill (double fill_value)
 Sets each element of the vector to the indicated fill_value. More...
 
LVecBase4d fmax (const LVecBase4d &other) const
 
LVecBase4d fmin (const LVecBase4d &other) const
 
void generate_hash (ChecksumHashGenerator &hashgen) const
 Adds the vector to the indicated hash generator. More...
 
void generate_hash (ChecksumHashGenerator &hashgen, double threshold) const
 Adds the vector to the indicated hash generator. More...
 
double get_cell (int i) const
 
const double * get_data () const
 Returns the address of the first of the four data elements in the vector. More...
 
size_t get_hash () const
 Returns a suitable hash for phash_map. More...
 
size_t get_hash (double threshold) const
 Returns a suitable hash for phash_map. More...
 
int get_num_components () const
 Returns the number of elements in the vector, four. More...
 
double get_w () const
 
double get_x () const
 
double get_y () const
 
double get_z () const
 
bool is_nan () const
 Returns true if any component of the vector is not-a-number, false otherwise. More...
 
double length () const
 Returns the length of the vector, by the Pythagorean theorem. More...
 
double length_squared () const
 Returns the square of the vector's length, cheap and easy. More...
 
bool normalize ()
 Normalizes the vector in place. More...
 
LVecBase4d normalized () const
 Normalizes the vector and returns the normalized vector as a copy. More...
 
bool operator!= (const LVecBase4d &other) const
 
LVecBase4d operator* (double scalar) const
 
void operator*= (double scalar)
 
LVecBase4d operator+ (const LVecBase4d &other) const
 
void operator+= (const LVecBase4d &other)
 
LVecBase4d operator- () const
 
LVecBase4d operator- (const LVecBase4d &other) const
 
void operator-= (const LVecBase4d &other)
 
LVecBase4d operator/ (double scalar) const
 
void operator/= (double scalar)
 
bool operator< (const LVecBase4d &other) const
 This performs a lexicographical comparison. More...
 
LVecBase4doperator= (const LVecBase4d &copy)
 
LVecBase4doperator= (const UnalignedLVecBase4d &copy)
 
LVecBase4doperator= (double fill_value)
 
bool operator== (const LVecBase4d &other) const
 
double operator[] (int i) const
 
double & operator[] (int i)
 
void output (ostream &out) const
 
LVecBase4d project (const LVecBase4d &onto) const
 Returns a new vector representing the projection of this vector onto another one. More...
 
void read_datagram (DatagramIterator &source)
 Reads the vector from the Datagram using get_stdfloat(). More...
 
void read_datagram_fixed (DatagramIterator &source)
 Reads the vector from the Datagram using get_float32() or get_float64(). More...
 
void set (double x, double y, double z, double w)
 
void set_cell (int i, double value)
 
void set_w (double value)
 
void set_x (double value)
 
void set_y (double value)
 
void set_z (double value)
 
void write_datagram (Datagram &destination) const
 Writes the vector to the Datagram using add_stdfloat(). More...
 
void write_datagram_fixed (Datagram &destination) const
 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 get_class_type ()
 
static void init_type ()
 
static int size ()
 Returns 4: the number of components of a LVecBase4. More...
 
static const LVecBase4dunit_w ()
 Returns a unit W vector. More...
 
static const LVecBase4dunit_x ()
 Returns a unit X vector. More...
 
static const LVecBase4dunit_y ()
 Returns a unit Y vector. More...
 
static const LVecBase4dunit_z ()
 Returns a unit Z vector. More...
 
static const LVecBase4dzero ()
 Returns a zero-length vector. More...
 

Public Attributes

EVector4 _v
 

Detailed Description

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

Definition at line 1677 of file lvecBase4.h.

Constructor & Destructor Documentation

◆ LVecBase4d() [1/2]

LVecBase4d::LVecBase4d ( const LPoint3d point)
inline

Constructs an LVecBase4 from an LPoint3.

The w coordinate is set to 1.0.

Definition at line 2029 of file lvecBase4.h.

◆ LVecBase4d() [2/2]

LVecBase4d::LVecBase4d ( const LVector3d vector)
inline

Constructs an LVecBase4 from an LVector3.

The w coordinate is set to 0.0.

Definition at line 2040 of file lvecBase4.h.

Member Function Documentation

◆ add_hash() [1/2]

size_t LVecBase4d::add_hash ( size_t  hash) const
inline

Adds the vector into the running hash.

Definition at line 2592 of file lvecBase4.h.

References integer_hash< Key, Compare >::add_hash().

◆ add_hash() [2/2]

size_t LVecBase4d::add_hash ( size_t  hash,
double  threshold 
) const
inline

Adds the vector into the running hash.

Definition at line 2668 of file lvecBase4.h.

References floating_point_hash< Key >::add_hash().

◆ almost_equal() [1/2]

bool LVecBase4d::almost_equal ( const LVecBase4d other,
double  threshold 
) const
inline

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

Definition at line 2905 of file lvecBase4.h.

◆ almost_equal() [2/2]

bool LVecBase4d::almost_equal ( const LVecBase4d other) const
inline

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

Definition at line 2920 of file lvecBase4.h.

◆ begin() [1/2]

LVecBase4d::iterator LVecBase4d::begin ( )
inline

Returns an iterator that may be used to traverse the elements of the matrix, STL-style.

Definition at line 2333 of file lvecBase4.h.

◆ begin() [2/2]

LVecBase4d::const_iterator LVecBase4d::begin ( ) const
inline

Returns an iterator that may be used to traverse the elements of the matrix, STL-style.

Definition at line 2355 of file lvecBase4.h.

◆ compare_to() [1/2]

int LVecBase4d::compare_to ( const LVecBase4d other) const
inline

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

Definition at line 2554 of file lvecBase4.h.

◆ compare_to() [2/2]

int LVecBase4d::compare_to ( const LVecBase4d other,
double  threshold 
) const
inline

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

Definition at line 2634 of file lvecBase4.h.

◆ end() [1/2]

LVecBase4d::iterator LVecBase4d::end ( )
inline

Returns an iterator that may be used to traverse the elements of the matrix, STL-style.

Definition at line 2344 of file lvecBase4.h.

◆ end() [2/2]

LVecBase4d::const_iterator LVecBase4d::end ( ) const
inline

Returns an iterator that may be used to traverse the elements of the matrix, STL-style.

Definition at line 2366 of file lvecBase4.h.

◆ fill()

void LVecBase4d::fill ( double  fill_value)
inline

Sets each element of the vector to the indicated fill_value.

This is particularly useful for initializing to zero.

Definition at line 2378 of file lvecBase4.h.

◆ generate_hash() [1/2]

void LVecBase4d::generate_hash ( ChecksumHashGenerator hashgen) const
inline

Adds the vector to the indicated hash generator.

Definition at line 2611 of file lvecBase4.h.

References ChecksumHashGenerator::add_int().

◆ generate_hash() [2/2]

void LVecBase4d::generate_hash ( ChecksumHashGenerator hashgen,
double  threshold 
) const
inline

Adds the vector to the indicated hash generator.

Definition at line 2684 of file lvecBase4.h.

References ChecksumHashGenerator::add_fp().

◆ get_data()

const double * LVecBase4d::get_data ( ) const
inline

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

The remaining elements occupy the next positions consecutively in memory.

Definition at line 2312 of file lvecBase4.h.

Referenced by Shader::get_language(), and XFileDataObject::set().

◆ get_hash() [1/2]

size_t LVecBase4d::get_hash ( ) const
inline

Returns a suitable hash for phash_map.

Definition at line 2581 of file lvecBase4.h.

◆ get_hash() [2/2]

size_t LVecBase4d::get_hash ( double  threshold) const
inline

Returns a suitable hash for phash_map.

Definition at line 2657 of file lvecBase4.h.

◆ get_num_components()

int LVecBase4d::get_num_components ( ) const
inline

Returns the number of elements in the vector, four.

Definition at line 2322 of file lvecBase4.h.

Referenced by Shader::get_language().

◆ is_nan()

bool LVecBase4d::is_nan ( ) const
inline

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

Definition at line 2142 of file lvecBase4.h.

◆ length()

double LVecBase4d::length ( ) const
inline

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

Definition at line 2445 of file lvecBase4.h.

◆ length_squared()

double LVecBase4d::length_squared ( ) const
inline

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

Definition at line 2428 of file lvecBase4.h.

◆ normalize()

bool LVecBase4d::normalize ( )
inline

Normalizes the vector in place.

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

Definition at line 2462 of file lvecBase4.h.

◆ normalized()

LVecBase4d LVecBase4d::normalized ( ) const
inline

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.

Definition at line 2483 of file lvecBase4.h.

◆ operator<()

bool LVecBase4d::operator< ( const LVecBase4d other) const
inline

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

Definition at line 2514 of file lvecBase4.h.

◆ project()

LVecBase4d LVecBase4d::project ( const LVecBase4d onto) const
inline

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

The resulting vector will be a scalar multiple of onto.

Definition at line 2499 of file lvecBase4.h.

References LVecBase4f::length_squared().

◆ read_datagram()

void LVecBase4d::read_datagram ( DatagramIterator source)
inline

Reads the vector from the Datagram using get_stdfloat().

Definition at line 3024 of file lvecBase4.h.

References DatagramIterator::get_int32(), and DatagramIterator::get_stdfloat().

◆ read_datagram_fixed()

void LVecBase4d::read_datagram_fixed ( DatagramIterator source)
inline

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

See write_datagram_fixed().

Definition at line 2976 of file lvecBase4.h.

References DatagramIterator::get_float32(), DatagramIterator::get_float64(), and DatagramIterator::get_int32().

◆ size()

int LVecBase4d::size ( )
inlinestatic

Returns 4: the number of components of a LVecBase4.

Definition at line 2131 of file lvecBase4.h.

◆ unit_w()

const LVecBase4d & LVecBase4d::unit_w ( )
inlinestatic

Returns a unit W vector.

Definition at line 2099 of file lvecBase4.h.

◆ unit_x()

const LVecBase4d & LVecBase4d::unit_x ( )
inlinestatic

Returns a unit X vector.

Definition at line 2069 of file lvecBase4.h.

◆ unit_y()

const LVecBase4d & LVecBase4d::unit_y ( )
inlinestatic

Returns a unit Y vector.

Definition at line 2079 of file lvecBase4.h.

◆ unit_z()

const LVecBase4d & LVecBase4d::unit_z ( )
inlinestatic

Returns a unit Z vector.

Definition at line 2089 of file lvecBase4.h.

◆ write_datagram()

void LVecBase4d::write_datagram ( Datagram destination) const
inline

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.

Definition at line 3004 of file lvecBase4.h.

References Datagram::add_int32(), and Datagram::add_stdfloat().

◆ write_datagram_fixed()

void LVecBase4d::write_datagram_fixed ( Datagram destination) const
inline

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.

Definition at line 2950 of file lvecBase4.h.

References Datagram::add_float32(), Datagram::add_float64(), and Datagram::add_int32().

◆ zero()

const LVecBase4d & LVecBase4d::zero ( )
inlinestatic

Returns a zero-length vector.

Definition at line 2059 of file lvecBase4.h.

Referenced by EggVertex::get_aux(), and GeomVertexReader::get_data4d().


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