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

#include "lvecBase4.h"

Inheritance diagram for LVecBase4f:

Public Types
typedef const float *	const_iterator
typedef const float *	iterator
Public Member Functions
	LVecBase4f (const LVecBase4f &copy)
	LVecBase4f (const UnalignedLVecBase4f &copy)
	LVecBase4f (float fill_value)
	LVecBase4f (float x, float y, float z, float w)
	LVecBase4f (const EVector4 &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_w (float value)
void	add_x (float value)
void	add_y (float value)
void	add_z (float value)
bool	almost_equal (const LVecBase4f &other, float threshold) const
	Returns true if two vectors are memberwise equal within a specified tolerance.
bool	almost_equal (const LVecBase4f &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 LVecBase4f &other) const
	This flavor of compare_to uses a default threshold value based on the numeric type.
int	compare_to (const LVecBase4f &other, float threshold) const
	Sorts vectors lexicographically, componentwise.
float	dot (const LVecBase4f &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.
LVecBase4f	fmax (const LVecBase4f &other)
LVecBase4f	fmin (const LVecBase4f &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 four 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, four.
float	get_w () const
float	get_x () const
float	get_y () const
float	get_z () 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.
typedef	LINMATH_MATRIX (float, 1, 4) EVector4
bool	normalize ()
	Normalizes the vector in place.
bool	operator!= (const LVecBase4f &other) const
LVecBase4f	operator* (float scalar) const
void	*operator=** (float scalar)
LVecBase4f	operator+ (const LVecBase4f &other) const
void	operator+= (const LVecBase4f &other)
LVecBase4f	operator- () const
LVecBase4f	operator- (const LVecBase4f &other) const
void	operator-= (const LVecBase4f &other)
LVecBase4f	operator/ (float scalar) const
void	operator/= (float scalar)
bool	operator< (const LVecBase4f &other) const
	This performs a lexicographical comparison.
LVecBase4f &	operator= (const LVecBase4f &copy)
LVecBase4f &	operator= (const UnalignedLVecBase4f &copy)
LVecBase4f &	operator= (float fill_value)
bool	operator== (const LVecBase4f &other) const
float	operator[] (int i) const
float &	operator[] (int i)
void	output (ostream &out) const
LVecBase4f	project (const LVecBase4f &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, float z, float w)
void	set_cell (int i, float value)
void	set_w (float value)
void	set_x (float value)
void	set_y (float value)
void	set_z (float value)
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 4: the number of components of a LVecBase4.
static const LVecBase4f &	unit_w ()
	Returns a unit W vector.
static const LVecBase4f &	unit_x ()
	Returns a unit X vector.
static const LVecBase4f &	unit_y ()
	Returns a unit Y vector.
static const LVecBase4f &	unit_z ()
	Returns a unit Z vector.
static const LVecBase4f &	zero ()
	Returns a zero-length vector.
Public Attributes
EVector4	_v

Detailed Description

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

Definition at line 98 of file lvecBase4.h.

Member Function Documentation

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

Adds the vector into the running hash.

Definition at line 948 of file lvecBase4.h.

Referenced by ColorAttrib::get_hash_impl(), ColorScaleAttrib::get_hash_impl(), ScissorAttrib::get_hash_impl(), and ColorBlendAttrib::get_hash_impl().

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

Adds the vector into the running hash.

Definition at line 959 of file lvecBase4.h.

bool LVecBase4f::almost_equal	(	const LVecBase4f &	other,
		float	threshold
	)		const `[inline]`

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

Definition at line 1142 of file lvecBase4.h.

Referenced by EggVertexPool::check_overall_color(), ColorScaleAttrib::fillin(), and EggLoader::make_polyset().

bool LVecBase4f::almost_equal ( const LVecBase4f & other ) const [inline]

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

Definition at line 1157 of file lvecBase4.h.

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

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

Definition at line 685 of file lvecBase4.h.

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

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

Definition at line 707 of file lvecBase4.h.

int LVecBase4f::compare_to ( const LVecBase4f & other ) const [inline]

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

Definition at line 888 of file lvecBase4.h.

Referenced by EggAttributes::compare_to(), Material::compare_to(), TransformState::compare_to(), StandardMunger::compare_to_impl(), ColorAttrib::compare_to_impl(), ColorScaleAttrib::compare_to_impl(), ScissorAttrib::compare_to_impl(), ScissorEffect::compare_to_impl(), ColorBlendAttrib::compare_to_impl(), StandardMunger::geom_compare_to_impl(), and EggMaterial::sorts_less_than().

int LVecBase4f::compare_to	(	const LVecBase4f &	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 903 of file lvecBase4.h.

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

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

Definition at line 696 of file lvecBase4.h.

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

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

Definition at line 718 of file lvecBase4.h.

void LVecBase4f::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 730 of file lvecBase4.h.

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

Adds the vector to the indicated hash generator.

Definition at line 1181 of file lvecBase4.h.

void LVecBase4f::generate_hash	(	ChecksumHashGenerator &	hashgen,
		float	threshold
	)		const `[inline]`

Adds the vector to the indicated hash generator.

Definition at line 1192 of file lvecBase4.h.

const float * LVecBase4f::get_data ( ) const [inline]

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

The remaining elements occupy the next positions consecutively in memory.

Definition at line 664 of file lvecBase4.h.

Referenced by DXGraphicsStateGuardian8::bind_light(), DXGraphicsStateGuardian9::bind_light(), GraphicsStateGuardian::fetch_specified_part(), DXGraphicsStateGuardian8::get_light_color(), and DXGraphicsStateGuardian9::get_light_color().

size_t LVecBase4f::get_hash ( ) const [inline]

Returns a suitable hash for phash_map.

Definition at line 926 of file lvecBase4.h.

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

Returns a suitable hash for phash_map.

Definition at line 937 of file lvecBase4.h.

int LVecBase4f::get_num_components ( ) const [inline]

Returns the number of elements in the vector, four.

Definition at line 674 of file lvecBase4.h.

bool LVecBase4f::is_nan ( ) const [inline]

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

Definition at line 498 of file lvecBase4.h.

Referenced by PhysicsObject::add_local_torque(), PhysicsObject::add_torque(), PhysicsObject::reset_orientation(), CLerpNodePathInterval::set_end_color(), CLerpNodePathInterval::set_end_color_scale(), CLerpNodePathInterval::set_end_hpr(), CLerpNodePathInterval::set_end_quat(), PfmFile::set_point4(), PhysicsObject::set_rotation(), CLerpNodePathInterval::set_start_color(), CLerpNodePathInterval::set_start_color_scale(), and CLerpNodePathInterval::set_start_quat().

float LVecBase4f::length ( ) const [inline]

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

Definition at line 763 of file lvecBase4.h.

float LVecBase4f::length_squared ( ) const [inline]

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

Definition at line 779 of file lvecBase4.h.

bool LVecBase4f::normalize ( ) [inline]

Normalizes the vector in place.

Returns true if the vector was normalized, false if it was a zero-length vector.

Reimplemented in LQuaternionf.

Definition at line 796 of file lvecBase4.h.

bool LVecBase4f::operator< ( const LVecBase4f & 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 848 of file lvecBase4.h.

LVecBase4f LVecBase4f::project ( const LVecBase4f & 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 LPoint4f, and LVector4f.

Definition at line 834 of file lvecBase4.h.

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

Reads the vector from the Datagram using get_stdfloat().

Definition at line 1269 of file lvecBase4.h.

Referenced by Texture::do_fillin_body(), ScissorAttrib::fillin(), ColorAttrib::fillin(), ColorScaleAttrib::fillin(), ScissorEffect::fillin(), Fog::fillin(), Material::fillin(), ColorBlendAttrib::fillin(), NurbsCurve::fillin(), CubicCurveseg::fillin(), TextureStage::fillin(), and TransformState::fillin().

void LVecBase4f::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 1233 of file lvecBase4.h.

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

Returns 4: the number of components of a LVecBase4.

Definition at line 487 of file lvecBase4.h.

const LVecBase4f & LVecBase4f::unit_w ( ) [inline, static]

Returns a unit W vector.

Reimplemented in LPoint4f, and LVector4f.

Definition at line 455 of file lvecBase4.h.

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

Returns a unit X vector.

Reimplemented in LPoint4f, and LVector4f.

Definition at line 425 of file lvecBase4.h.

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

Returns a unit Y vector.

Reimplemented in LPoint4f, and LVector4f.

Definition at line 435 of file lvecBase4.h.

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

Returns a unit Z vector.

Reimplemented in LPoint4f, and LVector4f.

Definition at line 445 of file lvecBase4.h.

void LVecBase4f::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 1256 of file lvecBase4.h.

Referenced by Texture::do_write_datagram_body(), ScissorAttrib::write_datagram(), ColorAttrib::write_datagram(), ColorScaleAttrib::write_datagram(), ScissorEffect::write_datagram(), Fog::write_datagram(), Material::write_datagram(), ColorBlendAttrib::write_datagram(), NurbsCurve::write_datagram(), CubicCurveseg::write_datagram(), TextureStage::write_datagram(), and TransformState::write_datagram().

void LVecBase4f::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 1212 of file lvecBase4.h.

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

Returns a zero-length vector.

Reimplemented in LPoint4f, and LVector4f.

Definition at line 415 of file lvecBase4.h.

Referenced by NurbsBasisVector::append_segment(), EggGroup::clear_blend_color(), GeomVertexData::copy_from(), NurbsCurve::get_cv(), GeomVertexReader::get_data4f(), PhysxActor::get_global_quat(), NurbsSurfaceEvaluator::get_vertex(), NurbsCurveEvaluator::get_vertex(), LineSegs::get_vertex_color(), ColorAttrib::make_from_bam(), ScissorEffect::make_from_bam(), NurbsCurveResult::NurbsCurveResult(), and NurbsCurve::rebuild_curveseg().

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

panda/src/linmath/lvecBase4.h
panda/src/linmath/lvecBase4.cxx

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation