Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
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

Public Types

enum  { num_components = 2, is_int = 0 }
 
typedef const float * const_iterator
 
typedef LSimpleMatrix< float, 1, 2 > EVector2
 
typedef const float * iterator
 
typedef float numeric_type
 

Public Member Functions

 LVecBase2f (const LVecBase2f &copy)
 
 LVecBase2f (float fill_value)
 
 LVecBase2f (float x, float y)
 
 LVecBase2f (const EVector2 &v)
 
size_t add_hash (size_t hash) const
 Adds the vector into the running hash. More...
 
size_t add_hash (size_t hash, float threshold) const
 Adds the vector into the running hash. More...
 
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. More...
 
bool almost_equal (const LVecBase2f &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 LVecBase2f &other) const
 This flavor of compare_to uses a default threshold value based on the numeric type. More...
 
int compare_to (const LVecBase2f &other, float threshold) const
 Sorts vectors lexicographically, componentwise. More...
 
void componentwise_mult (const LVecBase2f &other)
 
float dot (const LVecBase2f &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 fill (float fill_value)
 Sets each element of the vector to the indicated fill_value. More...
 
LVecBase2f fmax (const LVecBase2f &other) const
 
LVecBase2f fmin (const LVecBase2f &other) const
 
void generate_hash (ChecksumHashGenerator &hashgen) const
 Adds the vector to the indicated hash generator. More...
 
void generate_hash (ChecksumHashGenerator &hashgen, float threshold) const
 Adds the vector to the indicated hash generator. More...
 
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. More...
 
size_t get_hash () const
 Returns a suitable hash for phash_map. More...
 
size_t get_hash (float threshold) const
 Returns a suitable hash for phash_map. More...
 
int get_num_components () const
 Returns the number of elements in the vector, two. More...
 
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. More...
 
float length () const
 Returns the length of the vector, by the Pythagorean theorem. More...
 
float length_squared () const
 Returns the square of the vector's length, cheap and easy. More...
 
bool normalize ()
 Normalizes the vector in place. More...
 
LVecBase2f normalized () const
 Normalizes the vector and returns the normalized vector as a copy. More...
 
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. More...
 
LVecBase2foperator= (const LVecBase2f &copy)
 
LVecBase2foperator= (float fill_value)
 
bool operator== (const LVecBase2f &other) const
 
float operator[] (int i) const
 
float & operator[] (int i)
 
void output (ostream &out) const
 
LVecBase2f project (const LVecBase2f &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 (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
 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 2: the number of components of a LVecBase2. More...
 
static const LVecBase2funit_x ()
 Returns a unit X vector. More...
 
static const LVecBase2funit_y ()
 Returns a unit Y vector. More...
 
static const LVecBase2fzero ()
 Returns a zero-length vector. More...
 

Public Attributes

EVector2 _v
 

Detailed Description

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

Definition at line 105 of file lvecBase2.h.

Member Function Documentation

◆ add_hash() [1/2]

size_t LVecBase2f::add_hash ( size_t  hash) const
inline

Adds the vector into the running hash.

Definition at line 803 of file lvecBase2.h.

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

◆ add_hash() [2/2]

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

Adds the vector into the running hash.

Definition at line 868 of file lvecBase2.h.

References floating_point_hash< Key >::add_hash().

◆ almost_equal() [1/2]

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 1078 of file lvecBase2.h.

◆ almost_equal() [2/2]

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 1091 of file lvecBase2.h.

◆ begin() [1/2]

LVecBase2f::iterator LVecBase2f::begin ( )
inline

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

Definition at line 562 of file lvecBase2.h.

◆ begin() [2/2]

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 584 of file lvecBase2.h.

◆ compare_to() [1/2]

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 771 of file lvecBase2.h.

◆ compare_to() [2/2]

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 840 of file lvecBase2.h.

◆ end() [1/2]

LVecBase2f::iterator LVecBase2f::end ( )
inline

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

Definition at line 573 of file lvecBase2.h.

◆ end() [2/2]

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 595 of file lvecBase2.h.

◆ fill()

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 607 of file lvecBase2.h.

◆ generate_hash() [1/2]

void LVecBase2f::generate_hash ( ChecksumHashGenerator hashgen) const
inline

Adds the vector to the indicated hash generator.

Definition at line 820 of file lvecBase2.h.

References ChecksumHashGenerator::add_int().

◆ generate_hash() [2/2]

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

Adds the vector to the indicated hash generator.

Definition at line 882 of file lvecBase2.h.

References ChecksumHashGenerator::add_fp().

◆ get_data()

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 541 of file lvecBase2.h.

Referenced by Shader::get_language().

◆ get_hash() [1/2]

size_t LVecBase2f::get_hash ( ) const
inline

Returns a suitable hash for phash_map.

Definition at line 792 of file lvecBase2.h.

◆ get_hash() [2/2]

size_t LVecBase2f::get_hash ( float  threshold) const
inline

Returns a suitable hash for phash_map.

Definition at line 857 of file lvecBase2.h.

◆ get_num_components()

int LVecBase2f::get_num_components ( ) const
inline

Returns the number of elements in the vector, two.

Definition at line 551 of file lvecBase2.h.

Referenced by Shader::get_language().

◆ is_nan()

bool LVecBase2f::is_nan ( ) const
inline

◆ length()

float LVecBase2f::length ( ) const
inline

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

Definition at line 664 of file lvecBase2.h.

Referenced by PolylightEffect::cull_callback(), CollisionBox::dist_to_polygon(), and CollisionPolygon::get_test_pcollector().

◆ length_squared()

float LVecBase2f::length_squared ( ) const
inline

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

Definition at line 647 of file lvecBase2.h.

Referenced by project(), LVecBase2d::project(), and LVecBase2i::project().

◆ normalize()

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 681 of file lvecBase2.h.

◆ normalized()

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

◆ operator<()

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 733 of file lvecBase2.h.

◆ project()

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.

Definition at line 718 of file lvecBase2.h.

References length_squared().

◆ read_datagram()

void LVecBase2f::read_datagram ( DatagramIterator source)
inline

Reads the vector from the Datagram using get_stdfloat().

Definition at line 1177 of file lvecBase2.h.

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

Referenced by CollisionPolygon::write_datagram(), and CollisionBox::write_datagram().

◆ read_datagram_fixed()

void LVecBase2f::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 1139 of file lvecBase2.h.

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

◆ size()

int LVecBase2f::size ( )
inlinestatic

Returns 2: the number of components of a LVecBase2.

Definition at line 420 of file lvecBase2.h.

Referenced by CollisionPolygon::get_collision_origin().

◆ unit_x()

const LVecBase2f & LVecBase2f::unit_x ( )
inlinestatic

Returns a unit X vector.

Definition at line 369 of file lvecBase2.h.

◆ unit_y()

const LVecBase2f & LVecBase2f::unit_y ( )
inlinestatic

Returns a unit Y vector.

Definition at line 379 of file lvecBase2.h.

◆ write_datagram()

void LVecBase2f::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 1161 of file lvecBase2.h.

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

◆ write_datagram_fixed()

void LVecBase2f::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 1119 of file lvecBase2.h.

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

◆ zero()

const LVecBase2f & LVecBase2f::zero ( )
inlinestatic

Returns a zero-length vector.

Definition at line 359 of file lvecBase2.h.

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


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