Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes
LVecBase3d Class Reference

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

#include "lvecBase3.h"

Inheritance diagram for LVecBase3d:
LPoint3d LVector3d

List of all members.

Public Types

typedef const double * const_iterator
typedef const double * iterator

Public Member Functions

 LVecBase3d (const LVecBase3d &copy)
 LVecBase3d (double fill_value)
 LVecBase3d (double x, double y, double z)
 LVecBase3d (const EVector3 &v)
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_x (double value)
void add_y (double value)
void add_z (double value)
bool almost_equal (const LVecBase3d &other, double threshold) const
 Returns true if two vectors are memberwise equal within a specified tolerance.
bool almost_equal (const LVecBase3d &other) const
 Returns true if two vectors are memberwise equal within a default tolerance based on the numeric type.
iterator begin ()
 Returns an iterator that may be used to traverse the elements of the matrix, STL-style.
const_iterator begin () const
 Returns an iterator that may be used to traverse the elements of the matrix, STL-style.
int compare_to (const LVecBase3d &other) const
 This flavor of compare_to uses a default threshold value based on the numeric type.
int compare_to (const LVecBase3d &other, double threshold) const
 Sorts vectors lexicographically, componentwise.
LVecBase3d cross (const LVecBase3d &other) const
void cross_into (const LVecBase3d &other)
double dot (const LVecBase3d &other) const
iterator end ()
 Returns an iterator that may be used to traverse the elements of the matrix, STL-style.
const_iterator end () const
 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.
LVecBase3d fmax (const LVecBase3d &other)
LVecBase3d fmin (const LVecBase3d &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 three 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, three.
LVecBase3d get_standardized_hpr () const
 Try to un-spin the hpr to a standard form.
double get_x () const
LVecBase2d get_xy () const
 Returns a 2-component vector that shares just the first two components of this vector.
LVecBase2d get_xz () const
 Returns a 2-component vector that shares just the first and last components of this vector.
double get_y () const
LVecBase2d get_yz () const
 Returns a 2-component vector that shares just the last two components of this vector.
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.
bool normalize ()
 Normalizes the vector in place.
bool operator!= (const LVecBase3d &other) const
LVecBase3d operator* (double scalar) const
void operator*= (double scalar)
LVecBase3d operator+ (const LVecBase3d &other) const
void operator+= (const LVecBase3d &other)
LVecBase3d operator- () const
LVecBase3d operator- (const LVecBase3d &other) const
void operator-= (const LVecBase3d &other)
LVecBase3d operator/ (double scalar) const
void operator/= (double scalar)
bool operator< (const LVecBase3d &other) const
 This performs a lexicographical comparison.
LVecBase3doperator= (const LVecBase3d &copy)
LVecBase3doperator= (double fill_value)
bool operator== (const LVecBase3d &other) const
double operator[] (int i) const
double & operator[] (int i)
void output (ostream &out) const
LVecBase3d project (const LVecBase3d &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)
void set_cell (int i, double value)
void set_x (double value)
void set_y (double value)
void set_z (double value)
typedef UNALIGNED_LINMATH_MATRIX (double, 1, 3) EVector3
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 3: the number of components of a LVecBase3.
static const LVecBase3dunit_x ()
 Returns a unit X vector.
static const LVecBase3dunit_y ()
 Returns a unit Y vector.
static const LVecBase3dunit_z ()
 Returns a unit Z vector.
static const LVecBase3dzero ()
 Returns a zero-length vector.

Public Attributes

EVector3 _v

Detailed Description

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

Definition at line 1320 of file lvecBase3.h.


Member Function Documentation

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

Adds the vector into the running hash.

Definition at line 2157 of file lvecBase3.h.

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

Adds the vector into the running hash.

Definition at line 2168 of file lvecBase3.h.

bool LVecBase3d::almost_equal ( const LVecBase3d other,
double  threshold 
) const [inline]

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

Definition at line 2352 of file lvecBase3.h.

Referenced by EggPolygon::is_planar(), and FltToEggLevelState::set_transform().

bool LVecBase3d::almost_equal ( const LVecBase3d other) const [inline]

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

Definition at line 2366 of file lvecBase3.h.

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

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

Definition at line 1836 of file lvecBase3.h.

LVecBase3d::const_iterator LVecBase3d::begin ( ) const [inline]

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

Definition at line 1858 of file lvecBase3.h.

int LVecBase3d::compare_to ( const LVecBase3d other) const [inline]

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

Definition at line 2100 of file lvecBase3.h.

Referenced by EggAttributes::compare_to(), EggVertexUV::compare_to(), and EggBinner::sorts_less().

int LVecBase3d::compare_to ( const LVecBase3d 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 2115 of file lvecBase3.h.

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

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

Definition at line 1847 of file lvecBase3.h.

LVecBase3d::const_iterator LVecBase3d::end ( ) const [inline]

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

Definition at line 1869 of file lvecBase3.h.

void LVecBase3d::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 1881 of file lvecBase3.h.

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

Adds the vector to the indicated hash generator.

Definition at line 2389 of file lvecBase3.h.

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

Adds the vector to the indicated hash generator.

Definition at line 2400 of file lvecBase3.h.

const double * LVecBase3d::get_data ( ) const [inline]

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

The remaining elements occupy the next positions consecutively in memory.

Definition at line 1815 of file lvecBase3.h.

Referenced by XFileDataObject::set().

size_t LVecBase3d::get_hash ( ) const [inline]

Returns a suitable hash for phash_map.

Definition at line 2135 of file lvecBase3.h.

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

Returns a suitable hash for phash_map.

Definition at line 2146 of file lvecBase3.h.

int LVecBase3d::get_num_components ( ) const [inline]

Returns the number of elements in the vector, three.

Definition at line 1825 of file lvecBase3.h.

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

Definition at line 2086 of file lvecBase3.h.

LVecBase2d LVecBase3d::get_xy ( ) const [inline]

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

Reimplemented in LVector3d, and LPoint3d.

Definition at line 1740 of file lvecBase3.h.

LVecBase2d LVecBase3d::get_xz ( ) const [inline]

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

Reimplemented in LVector3d, and LPoint3d.

Definition at line 1751 of file lvecBase3.h.

LVecBase2d LVecBase3d::get_yz ( ) const [inline]

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

Reimplemented in LVector3d, and LPoint3d.

Definition at line 1762 of file lvecBase3.h.

bool LVecBase3d::is_nan ( ) const [inline]

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

Definition at line 1646 of file lvecBase3.h.

double LVecBase3d::length ( ) const [inline]

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

Definition at line 1912 of file lvecBase3.h.

Referenced by EggMesherEdge::compute_length(), and EggSwitchConditionDistance::transform().

double LVecBase3d::length_squared ( ) const [inline]

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

Definition at line 1928 of file lvecBase3.h.

bool LVecBase3d::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 1945 of file lvecBase3.h.

Referenced by EggPolygon::calculate_normal(), DXFFile::compute_ocs(), EggVertexUV::transform(), and EggAttributes::transform().

bool LVecBase3d::operator< ( const LVecBase3d 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 2013 of file lvecBase3.h.

LVecBase3d LVecBase3d::project ( const LVecBase3d 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 LVector3d, and LPoint3d.

Definition at line 1999 of file lvecBase3.h.

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

Reads the vector from the Datagram using get_stdfloat().

Definition at line 2471 of file lvecBase3.h.

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

See write_datagram_fixed().

Definition at line 2438 of file lvecBase3.h.

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

Returns 3: the number of components of a LVecBase3.

Definition at line 1635 of file lvecBase3.h.

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

Returns a unit X vector.

Reimplemented in LVector3d, and LPoint3d.

Definition at line 1574 of file lvecBase3.h.

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

Returns a unit Y vector.

Reimplemented in LVector3d, and LPoint3d.

Definition at line 1584 of file lvecBase3.h.

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

Returns a unit Z vector.

Reimplemented in LVector3d, and LPoint3d.

Definition at line 1594 of file lvecBase3.h.

void LVecBase3d::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 2459 of file lvecBase3.h.

void LVecBase3d::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 2419 of file lvecBase3.h.

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

Returns a zero-length vector.

Reimplemented in LVector3d, and LPoint3d.

Definition at line 1564 of file lvecBase3.h.

Referenced by PNMImage::get_average_xel(), and GeomVertexReader::get_data3d().


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