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

#include "lvecBase2.h"

Inheritance diagram for LVecBase2f:

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)
	LVecBase2f (const EVector2 &v)
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.
LVecBase2f &	operator= (const LVecBase2f &copy)
LVecBase2f &	operator= (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.
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 (float x, float y)
void	set_cell (int i, float value)
void	set_x (float value)
void	set_y (float value)
typedef	UNALIGNED_LINMATH_MATRIX (float, 1, 2) EVector2
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 2: the number of components of a LVecBase2.
static const LVecBase2f &	unit_x ()
	Returns a unit X vector.
static const LVecBase2f &	unit_y ()
	Returns a unit Y vector.
static const LVecBase2f &	zero ()
	Returns a zero-length vector.
Public Attributes
EVector2	_v

Detailed Description

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

Definition at line 97 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 775 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 786 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 951 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 964 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 530 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 552 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 721 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 736 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 541 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 563 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 575 of file lvecBase2.h.

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

Adds the vector to the indicated hash generator.

Definition at line 986 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 996 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 509 of file lvecBase2.h.

size_t LVecBase2f::get_hash ( ) const [inline]

Returns a suitable hash for phash_map.

Definition at line 753 of file lvecBase2.h.

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

Returns a suitable hash for phash_map.

Definition at line 764 of file lvecBase2.h.

int LVecBase2f::get_num_components ( ) const [inline]

Returns the number of elements in the vector, two.

Definition at line 519 of file lvecBase2.h.

bool LVecBase2f::is_nan ( ) const [inline]

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

Definition at line 403 of file lvecBase2.h.

Referenced by CLerpNodePathInterval::set_end_tex_offset(), CLerpNodePathInterval::set_end_tex_scale(), Lens::set_keystone(), PfmFile::set_point2(), CLerpNodePathInterval::set_start_tex_offset(), and CLerpNodePathInterval::set_start_tex_scale().

float LVecBase2f::length ( ) const [inline]

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

Definition at line 600 of file lvecBase2.h.

Referenced by FisheyeLens::do_extrude(), and CylindricalLens::do_project().

float LVecBase2f::length_squared ( ) const [inline]

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

Definition at line 616 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 633 of file lvecBase2.h.

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

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

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

Reads the vector from the Datagram using get_stdfloat().

Definition at line 1060 of file lvecBase2.h.

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

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

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

Returns 2: the number of components of a LVecBase2.

Definition at line 392 of file lvecBase2.h.

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

Returns a unit X vector.

Reimplemented in LPoint2f, and LVector2f.

Definition at line 341 of file lvecBase2.h.

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

Returns a unit Y vector.

Reimplemented in LPoint2f, and LVector2f.

Definition at line 351 of file lvecBase2.h.

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

Referenced by MouseRecorder::record_frame().

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

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

Returns a zero-length vector.

Reimplemented in LPoint2f, and LVector2f.

Definition at line 331 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:

panda/src/linmath/lvecBase2.h
panda/src/linmath/lvecBase2.cxx

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation