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

LVecBase2f Class Reference

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

#include "lvecBase2.h"

Inheritance diagram for LVecBase2f:
LPoint2f LVector2f

List of all members.

Public Types

typedef const float * const_iterator
typedef const float * iterator

Public Member Functions

 LVecBase2f (const LVecBase2f &copy)
 LVecBase2f (float fill_value)
 LVecBase2f (float x, float y)
size_t add_hash (size_t hash) const
 Adds the vector into the running hash.
size_t add_hash (size_t hash, float threshold) const
 Adds the vector into the running hash.
void add_to_cell (int i, float value)
void add_x (float value)
void add_y (float value)
bool almost_equal (const LVecBase2f &other, float threshold) const
 Returns true if two vectors are memberwise equal within a specified tolerance.
bool almost_equal (const LVecBase2f &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 LVecBase2f &other) const
 This flavor of compare_to uses a default threshold value based on the numeric type.
int compare_to (const LVecBase2f &other, float threshold) const
 Sorts vectors lexicographically, componentwise.
float dot (const LVecBase2f &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 (float fill_value)
 Sets each element of the vector to the indicated fill_value.
LVecBase2f fmax (const LVecBase2f &other)
LVecBase2f fmin (const LVecBase2f &other)
void generate_hash (ChecksumHashGenerator &hashgen) const
 Adds the vector to the indicated hash generator.
void generate_hash (ChecksumHashGenerator &hashgen, float threshold) const
 Adds the vector to the indicated hash generator.
float get_cell (int i) const
const float * 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 (float threshold) const
 Returns a suitable hash for phash_map.
int get_num_components () const
 Returns the number of elements in the vector, two.
float get_x () const
float get_y () const
bool is_nan () const
 Returns true if any component of the vector is not-a-number, false otherwise.
float length () const
 Returns the length of the vector, by the Pythagorean theorem.
float length_squared () const
 Returns the square of the vector's length, cheap and easy.
bool normalize ()
 Normalizes the vector in place.
bool operator!= (const LVecBase2f &other) const
LVecBase2f operator* (float scalar) const
void operator*= (float scalar)
LVecBase2f operator+ (const LVecBase2f &other) const
void operator+= (const LVecBase2f &other)
LVecBase2f operator- () const
LVecBase2f operator- (const LVecBase2f &other) const
void operator-= (const LVecBase2f &other)
LVecBase2f operator/ (float scalar) const
void operator/= (float scalar)
bool operator< (const LVecBase2f &other) const
 This performs a lexicographical comparison.
LVecBase2foperator= (float fill_value)
LVecBase2foperator= (const LVecBase2f &copy)
bool operator== (const LVecBase2f &other) const
float & operator[] (int i)
float operator[] (int i) const
void output (ostream &out) const
LVecBase2f project (const LVecBase2f &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 (float x, float y)
void set_cell (int i, float value)
void set_x (float value)
void set_y (float 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 LVecBase2funit_x ()
 Returns a unit X vector.
static const LVecBase2funit_y ()
 Returns a unit Y vector.
static const LVecBase2fzero ()
 Returns a zero-length vector.

Public Attributes

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

Detailed Description

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

Definition at line 99 of file lvecBase2.h.


Member Function Documentation

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

Adds the vector into the running hash.

Definition at line 776 of file lvecBase2.h.

size_t LVecBase2f::add_hash ( size_t  hash,
float  threshold 
) const [inline]

Adds the vector into the running hash.

Definition at line 787 of file lvecBase2.h.

bool LVecBase2f::almost_equal ( const LVecBase2f other,
float  threshold 
) const [inline]

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

Definition at line 926 of file lvecBase2.h.

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

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

Definition at line 939 of file lvecBase2.h.

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

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

Definition at line 549 of file lvecBase2.h.

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

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

Definition at line 571 of file lvecBase2.h.

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

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

Definition at line 722 of file lvecBase2.h.

int LVecBase2f::compare_to ( const LVecBase2f other,
float  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 737 of file lvecBase2.h.

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

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

Definition at line 560 of file lvecBase2.h.

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

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

Definition at line 582 of file lvecBase2.h.

void LVecBase2f::fill ( float  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 594 of file lvecBase2.h.

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

Adds the vector to the indicated hash generator.

Definition at line 975 of file lvecBase2.h.

void LVecBase2f::generate_hash ( ChecksumHashGenerator hashgen,
float  threshold 
) const [inline]

Adds the vector to the indicated hash generator.

Definition at line 985 of file lvecBase2.h.

const float * LVecBase2f::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 528 of file lvecBase2.h.

size_t LVecBase2f::get_hash ( ) const [inline]

Returns a suitable hash for phash_map.

Definition at line 754 of file lvecBase2.h.

size_t LVecBase2f::get_hash ( float  threshold) const [inline]

Returns a suitable hash for phash_map.

Definition at line 765 of file lvecBase2.h.

int LVecBase2f::get_num_components ( ) const [inline]

Returns the number of elements in the vector, two.

Definition at line 538 of file lvecBase2.h.

bool LVecBase2f::is_nan ( ) const [inline]
float LVecBase2f::length ( ) const [inline]

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

Definition at line 619 of file lvecBase2.h.

Referenced by FisheyeLens::extrude_impl(), and CylindricalLens::project_impl().

float LVecBase2f::length_squared ( ) const [inline]

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

Definition at line 630 of file lvecBase2.h.

bool LVecBase2f::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 642 of file lvecBase2.h.

Referenced by PSphereLens::project_impl(), and FisheyeLens::project_impl().

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

LVecBase2f LVecBase2f::project ( const LVecBase2f 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 LPoint2f, and LVector2f.

Definition at line 674 of file lvecBase2.h.

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

Function to read itself from a datagramIterator.

Definition at line 1012 of file lvecBase2.h.

Referenced by Lens::fillin(), CollisionPolygon::fillin(), CollisionBox::fillin(), and MouseRecorder::play_frame().

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

Returns 2: the number of components of a LVecBase2.

Definition at line 411 of file lvecBase2.h.

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

Returns a unit X vector.

Reimplemented in LPoint2f, and LVector2f.

Definition at line 347 of file lvecBase2.h.

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

Returns a unit Y vector.

Reimplemented in LPoint2f, and LVector2f.

Definition at line 357 of file lvecBase2.h.

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

Function to write itself into a datagram.

Definition at line 996 of file lvecBase2.h.

Referenced by MouseRecorder::record_frame(), and Lens::write_datagram().

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

Returns a zero-length vector.

Reimplemented in LPoint2f, and LVector2f.

Definition at line 337 of file lvecBase2.h.

Referenced by GeomVertexReader::get_data2f(), TransformState::get_pos2d(), TransformState::get_scale2d(), and NodePath::get_tex_offset().


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