Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes

LVecBase4d Class Reference

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

#include "lvecBase4.h"

Inheritance diagram for LVecBase4d:
LPlaned LPlaned LPoint4d LQuaterniond LVector4d LOrientationd LRotationd

List of all members.

Public Types

typedef const double * const_iterator
typedef const double * iterator

Public Member Functions

 LVecBase4d (const LVecBase4d &copy)
 LVecBase4d (double x, double y, double z, double w)
 LVecBase4d (const EVector4 &v)
 LVecBase4d (const UnalignedLVecBase4d &copy)
 LVecBase4d (double fill_value)
size_t add_hash (size_t hash) const
 Adds the vector into the running hash.
size_t add_hash (size_t hash, double threshold) const
 Adds the vector into the running hash.
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.
bool almost_equal (const LVecBase4d &other) const
 Returns true if two vectors are memberwise equal within a default tolerance based on the numeric type.
const_iterator begin () const
 Returns an iterator that may be used to traverse the elements of the matrix, STL-style.
iterator begin ()
 Returns an iterator that may be used to traverse the elements of the matrix, STL-style.
int compare_to (const LVecBase4d &other) const
 This flavor of compare_to uses a default threshold value based on the numeric type.
int compare_to (const LVecBase4d &other, double threshold) const
 Sorts vectors lexicographically, componentwise.
double dot (const LVecBase4d &other) const
const_iterator end () const
 Returns an iterator that may be used to traverse the elements of the matrix, STL-style.
iterator end ()
 Returns an iterator that may be used to traverse the elements of the matrix, STL-style.
void fill (double fill_value)
 Sets each element of the vector to the indicated fill_value.
LVecBase4d fmax (const LVecBase4d &other)
LVecBase4d fmin (const LVecBase4d &other)
void generate_hash (ChecksumHashGenerator &hashgen) const
 Adds the vector to the indicated hash generator.
void generate_hash (ChecksumHashGenerator &hashgen, double threshold) const
 Adds the vector to the indicated hash generator.
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.
size_t get_hash () const
 Returns a suitable hash for phash_map.
size_t get_hash (double threshold) const
 Returns a suitable hash for phash_map.
int get_num_components () const
 Returns the number of elements in the vector, four.
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.
double length () const
 Returns the length of the vector, by the Pythagorean theorem.
double length_squared () const
 Returns the square of the vector's length, cheap and easy.
typedef LINMATH_MATRIX (double, 1, 4) EVector4
bool normalize ()
 Normalizes the vector in place.
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 &other) const
LVecBase4d operator- () 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.
LVecBase4doperator= (const UnalignedLVecBase4d &copy)
LVecBase4doperator= (double fill_value)
LVecBase4doperator= (const LVecBase4d &copy)
bool operator== (const LVecBase4d &other) const
double & operator[] (int i)
double operator[] (int i) const
void output (ostream &out) const
LVecBase4d project (const LVecBase4d &onto) const
 Returns a new vector representing the projection of this vector onto another one.
void read_datagram (DatagramIterator &source)
 Reads the vector from the Datagram using get_stdfloat().
void read_datagram_fixed (DatagramIterator &source)
 Reads the vector from the Datagram using get_float32() or get_float64().
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().
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().

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.
static const LVecBase4dunit_w ()
 Returns a unit W vector.
static const LVecBase4dunit_x ()
 Returns a unit X vector.
static const LVecBase4dunit_y ()
 Returns a unit Y vector.
static const LVecBase4dunit_z ()
 Returns a unit Z vector.
static const LVecBase4dzero ()
 Returns a zero-length vector.

Public Attributes

EVector4 _v

Detailed Description

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

Definition at line 1474 of file lvecBase4.h.


Member Function Documentation

size_t LVecBase4d::add_hash ( size_t  hash) const [inline]

Adds the vector into the running hash.

Definition at line 2324 of file lvecBase4.h.

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

Adds the vector into the running hash.

Definition at line 2335 of file lvecBase4.h.

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 2518 of file lvecBase4.h.

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 2533 of file lvecBase4.h.

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 2083 of file lvecBase4.h.

LVecBase4d::iterator LVecBase4d::begin ( ) [inline]

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

Definition at line 2061 of file lvecBase4.h.

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 2264 of file lvecBase4.h.

Referenced by EggVertexAux::compare_to(), and EggVertex::compare_to().

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 2279 of file lvecBase4.h.

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 2094 of file lvecBase4.h.

LVecBase4d::iterator LVecBase4d::end ( ) [inline]

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

Definition at line 2072 of file lvecBase4.h.

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 2106 of file lvecBase4.h.

void LVecBase4d::generate_hash ( ChecksumHashGenerator hashgen) const [inline]

Adds the vector to the indicated hash generator.

Definition at line 2557 of file lvecBase4.h.

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

Adds the vector to the indicated hash generator.

Definition at line 2568 of file lvecBase4.h.

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 2040 of file lvecBase4.h.

Referenced by XFileDataObject::set().

size_t LVecBase4d::get_hash ( ) const [inline]

Returns a suitable hash for phash_map.

Definition at line 2302 of file lvecBase4.h.

size_t LVecBase4d::get_hash ( double  threshold) const [inline]

Returns a suitable hash for phash_map.

Definition at line 2313 of file lvecBase4.h.

int LVecBase4d::get_num_components ( ) const [inline]

Returns the number of elements in the vector, four.

Definition at line 2050 of file lvecBase4.h.

bool LVecBase4d::is_nan ( ) const [inline]

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

Definition at line 1874 of file lvecBase4.h.

double LVecBase4d::length ( ) const [inline]

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

Definition at line 2139 of file lvecBase4.h.

double LVecBase4d::length_squared ( ) const [inline]

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

Definition at line 2155 of file lvecBase4.h.

bool LVecBase4d::normalize ( ) [inline]

Normalizes the vector in place.

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

Reimplemented in LQuaterniond.

Definition at line 2172 of file lvecBase4.h.

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 2224 of file lvecBase4.h.

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.

Reimplemented in LPoint4d, and LVector4d.

Definition at line 2210 of file lvecBase4.h.

void LVecBase4d::read_datagram ( DatagramIterator source) [inline]

Reads the vector from the Datagram using get_stdfloat().

Definition at line 2645 of file lvecBase4.h.

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 2609 of file lvecBase4.h.

int LVecBase4d::size ( ) [inline, static]

Returns 4: the number of components of a LVecBase4.

Definition at line 1863 of file lvecBase4.h.

const LVecBase4d & LVecBase4d::unit_w ( ) [inline, static]

Returns a unit W vector.

Reimplemented in LPoint4d, and LVector4d.

Definition at line 1831 of file lvecBase4.h.

const LVecBase4d & LVecBase4d::unit_x ( ) [inline, static]

Returns a unit X vector.

Reimplemented in LPoint4d, and LVector4d.

Definition at line 1801 of file lvecBase4.h.

const LVecBase4d & LVecBase4d::unit_y ( ) [inline, static]

Returns a unit Y vector.

Reimplemented in LPoint4d, and LVector4d.

Definition at line 1811 of file lvecBase4.h.

const LVecBase4d & LVecBase4d::unit_z ( ) [inline, static]

Returns a unit Z vector.

Reimplemented in LPoint4d, and LVector4d.

Definition at line 1821 of file lvecBase4.h.

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 2632 of file lvecBase4.h.

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 2588 of file lvecBase4.h.

const LVecBase4d & LVecBase4d::zero ( ) [inline, static]

Returns a zero-length vector.

Reimplemented in LPoint4d, and LVector4d.

Definition at line 1791 of file lvecBase4.h.

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


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations