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

LVecBase2d Class Reference

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

#include "lvecBase2.h"

Inheritance diagram for LVecBase2d:
LPoint2d LVector2d

List of all members.

Public Types

typedef const double * const_iterator
typedef const double * iterator

Public Member Functions

 LVecBase2d (const LVecBase2d &copy)
 LVecBase2d (double fill_value)
 LVecBase2d (double x, double y)
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)
bool almost_equal (const LVecBase2d &other, double threshold) const
 Returns true if two vectors are memberwise equal within a specified tolerance.
bool almost_equal (const LVecBase2d &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 LVecBase2d &other) const
 This flavor of compare_to uses a default threshold value based on the numeric type.
int compare_to (const LVecBase2d &other, double threshold) const
 Sorts vectors lexicographically, componentwise.
double dot (const LVecBase2d &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.
LVecBase2d fmax (const LVecBase2d &other)
LVecBase2d fmin (const LVecBase2d &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 two 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, two.
double get_x () const
double get_y () 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 LVecBase2d &other) const
LVecBase2d operator* (double scalar) const
void operator*= (double scalar)
LVecBase2d operator+ (const LVecBase2d &other) const
void operator+= (const LVecBase2d &other)
LVecBase2d operator- () const
LVecBase2d operator- (const LVecBase2d &other) const
void operator-= (const LVecBase2d &other)
LVecBase2d operator/ (double scalar) const
void operator/= (double scalar)
bool operator< (const LVecBase2d &other) const
 This performs a lexicographical comparison.
LVecBase2doperator= (double fill_value)
LVecBase2doperator= (const LVecBase2d &copy)
bool operator== (const LVecBase2d &other) const
double & operator[] (int i)
double operator[] (int i) const
void output (ostream &out) const
LVecBase2d project (const LVecBase2d &onto) const
 Returns a new vector representing the projection of this vector onto another one.
void read_datagram (DatagramIterator &source)
 Function to read itself from a datagramIterator.
void set (double x, double y)
void set_cell (int i, double value)
void set_x (double value)
void set_y (double value)
void write_datagram (Datagram &destination) const
 Function to write itself into a datagram.

Static Public Member Functions

static TypeHandle get_class_type ()
static void init_type ()
static int size ()
 Returns 2: the number of components of a LVecBase2.
static const LVecBase2dunit_x ()
 Returns a unit X vector.
static const LVecBase2dunit_y ()
 Returns a unit Y vector.
static const LVecBase2dzero ()
 Returns a zero-length vector.

Public Attributes

union {
   double   data [2]
   struct {
      double   _0
      double   _1
   }   v
_v

Detailed Description

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

Definition at line 1090 of file lvecBase2.h.


Member Function Documentation

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

Adds the vector into the running hash.

Definition at line 1767 of file lvecBase2.h.

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

Adds the vector into the running hash.

Definition at line 1778 of file lvecBase2.h.

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

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

Definition at line 1917 of file lvecBase2.h.

Referenced by TextureReference::is_equivalent().

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

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

Definition at line 1930 of file lvecBase2.h.

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

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

Definition at line 1540 of file lvecBase2.h.

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

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

Definition at line 1562 of file lvecBase2.h.

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

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

Definition at line 1713 of file lvecBase2.h.

int LVecBase2d::compare_to ( const LVecBase2d 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 1728 of file lvecBase2.h.

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

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

Definition at line 1551 of file lvecBase2.h.

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

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

Definition at line 1573 of file lvecBase2.h.

void LVecBase2d::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 1585 of file lvecBase2.h.

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

Adds the vector to the indicated hash generator.

Definition at line 1966 of file lvecBase2.h.

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

Adds the vector to the indicated hash generator.

Definition at line 1976 of file lvecBase2.h.

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

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

The next element occupies the next position consecutively in memory.

Definition at line 1519 of file lvecBase2.h.

Referenced by XFileDataObject::set().

size_t LVecBase2d::get_hash ( ) const [inline]

Returns a suitable hash for phash_map.

Definition at line 1745 of file lvecBase2.h.

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

Returns a suitable hash for phash_map.

Definition at line 1756 of file lvecBase2.h.

int LVecBase2d::get_num_components ( ) const [inline]

Returns the number of elements in the vector, two.

Definition at line 1529 of file lvecBase2.h.

bool LVecBase2d::is_nan ( ) const [inline]

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

Definition at line 1413 of file lvecBase2.h.

double LVecBase2d::length ( ) const [inline]

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

Definition at line 1610 of file lvecBase2.h.

double LVecBase2d::length_squared ( ) const [inline]

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

Definition at line 1621 of file lvecBase2.h.

bool LVecBase2d::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 1633 of file lvecBase2.h.

bool LVecBase2d::operator< ( const LVecBase2d 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 1679 of file lvecBase2.h.

LVecBase2d LVecBase2d::project ( const LVecBase2d 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 LPoint2d, and LVector2d.

Definition at line 1665 of file lvecBase2.h.

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

Function to read itself from a datagramIterator.

Definition at line 2003 of file lvecBase2.h.

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

Returns 2: the number of components of a LVecBase2.

Definition at line 1402 of file lvecBase2.h.

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

Returns a unit X vector.

Reimplemented in LPoint2d, and LVector2d.

Definition at line 1338 of file lvecBase2.h.

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

Returns a unit Y vector.

Reimplemented in LPoint2d, and LVector2d.

Definition at line 1348 of file lvecBase2.h.

void LVecBase2d::write_datagram ( Datagram destination) const [inline]

Function to write itself into a datagram.

Definition at line 1987 of file lvecBase2.h.

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

Returns a zero-length vector.

Reimplemented in LPoint2d, and LVector2d.

Definition at line 1328 of file lvecBase2.h.


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