Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
LVecBase4f Class Reference

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

#include "lvecBase4.h"

Inheritance diagram for LVecBase4f:
LPoint4f LQuaternionf LVector4f LOrientationf LRotationf

Public Types

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

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 LVecBase3f &copy, float w)
 
 LVecBase4f (const LPoint3f &point)
 Constructs an LVecBase4 from an LPoint3. More...
 
 LVecBase4f (const LVector3f &vector)
 Constructs an LVecBase4 from an LVector3. More...
 
 LVecBase4f (const EVector4 &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_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. More...
 
bool almost_equal (const LVecBase4f &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 LVecBase4f &other) const
 This flavor of compare_to uses a default threshold value based on the numeric type. More...
 
int compare_to (const LVecBase4f &other, float threshold) const
 Sorts vectors lexicographically, componentwise. More...
 
void componentwise_mult (const LVecBase4f &other)
 
float dot (const LVecBase4f &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 extract_data (float *)
 
void fill (float fill_value)
 Sets each element of the vector to the indicated fill_value. More...
 
LVecBase4f fmax (const LVecBase4f &other) const
 
LVecBase4f fmin (const LVecBase4f &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 four 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, four. More...
 
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. 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...
 
LVecBase4f normalized () const
 Normalizes the vector and returns the normalized vector as a copy. More...
 
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. More...
 
LVecBase4foperator= (const LVecBase4f &copy)
 
LVecBase4foperator= (const UnalignedLVecBase4f &copy)
 
LVecBase4foperator= (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. 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, 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(). 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 4: the number of components of a LVecBase4. More...
 
static const LVecBase4funit_w ()
 Returns a unit W vector. More...
 
static const LVecBase4funit_x ()
 Returns a unit X vector. More...
 
static const LVecBase4funit_y ()
 Returns a unit Y vector. More...
 
static const LVecBase4funit_z ()
 Returns a unit Z vector. More...
 
static const LVecBase4fzero ()
 Returns a zero-length vector. More...
 

Public Attributes

EVector4 _v
 

Detailed Description

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

Definition at line 111 of file lvecBase4.h.

Constructor & Destructor Documentation

◆ LVecBase4f() [1/2]

LVecBase4f::LVecBase4f ( const LPoint3f point)
inline

Constructs an LVecBase4 from an LPoint3.

The w coordinate is set to 1.0.

Definition at line 463 of file lvecBase4.h.

◆ LVecBase4f() [2/2]

LVecBase4f::LVecBase4f ( const LVector3f vector)
inline

Constructs an LVecBase4 from an LVector3.

The w coordinate is set to 0.0.

Definition at line 474 of file lvecBase4.h.

Member Function Documentation

◆ add_hash() [1/2]

size_t LVecBase4f::add_hash ( size_t  hash) const
inline

Adds the vector into the running hash.

Definition at line 1026 of file lvecBase4.h.

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

◆ add_hash() [2/2]

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

Adds the vector into the running hash.

Definition at line 1102 of file lvecBase4.h.

References floating_point_hash< Key >::add_hash().

◆ almost_equal() [1/2]

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 1339 of file lvecBase4.h.

Referenced by EggVertexPool::check_overall_color(), MultitexReducer::flatten(), EggLoader::make_polyset(), and QtessSurface::tesselate_auto().

◆ almost_equal() [2/2]

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 1354 of file lvecBase4.h.

◆ begin() [1/2]

LVecBase4f::iterator LVecBase4f::begin ( )
inline

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

Definition at line 767 of file lvecBase4.h.

◆ begin() [2/2]

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 789 of file lvecBase4.h.

◆ compare_to() [1/2]

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 988 of file lvecBase4.h.

Referenced by XFileMaterial::apply_to_egg(), EggAttributes::compare_to(), Material::compare_to(), XFileVertex::set_from_egg(), and StandardMunger::StandardMunger().

◆ compare_to() [2/2]

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 1068 of file lvecBase4.h.

◆ end() [1/2]

LVecBase4f::iterator LVecBase4f::end ( )
inline

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

Definition at line 778 of file lvecBase4.h.

◆ end() [2/2]

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 800 of file lvecBase4.h.

◆ fill()

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 812 of file lvecBase4.h.

◆ generate_hash() [1/2]

void LVecBase4f::generate_hash ( ChecksumHashGenerator hashgen) const
inline

Adds the vector to the indicated hash generator.

Definition at line 1045 of file lvecBase4.h.

References ChecksumHashGenerator::add_int().

◆ generate_hash() [2/2]

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

Adds the vector to the indicated hash generator.

Definition at line 1118 of file lvecBase4.h.

References ChecksumHashGenerator::add_fp().

◆ get_data()

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 746 of file lvecBase4.h.

Referenced by DXGraphicsStateGuardian9::bind_light(), GraphicsStateGuardian::fetch_specified_part(), DXGraphicsStateGuardian9::get_index_type(), Shader::get_language(), and QtessSurface::tesselate_auto().

◆ get_hash() [1/2]

size_t LVecBase4f::get_hash ( ) const
inline

Returns a suitable hash for phash_map.

Definition at line 1015 of file lvecBase4.h.

◆ get_hash() [2/2]

size_t LVecBase4f::get_hash ( float  threshold) const
inline

Returns a suitable hash for phash_map.

Definition at line 1091 of file lvecBase4.h.

◆ get_num_components()

int LVecBase4f::get_num_components ( ) const
inline

Returns the number of elements in the vector, four.

Definition at line 756 of file lvecBase4.h.

Referenced by Shader::get_language().

◆ is_nan()

bool LVecBase4f::is_nan ( ) const
inline

◆ length()

float LVecBase4f::length ( ) const
inline

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

Definition at line 879 of file lvecBase4.h.

◆ length_squared()

float LVecBase4f::length_squared ( ) const
inline

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

Definition at line 862 of file lvecBase4.h.

Referenced by project(), LVecBase4d::project(), and LVecBase4i::project().

◆ normalize()

bool LVecBase4f::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 896 of file lvecBase4.h.

◆ normalized()

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

◆ operator<()

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 948 of file lvecBase4.h.

◆ project()

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.

Definition at line 933 of file lvecBase4.h.

References length_squared().

◆ read_datagram()

void LVecBase4f::read_datagram ( DatagramIterator source)
inline

◆ read_datagram_fixed()

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 1410 of file lvecBase4.h.

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

◆ size()

int LVecBase4f::size ( )
inlinestatic

Returns 4: the number of components of a LVecBase4.

Definition at line 565 of file lvecBase4.h.

Referenced by ObjToEggConverter::convert_file().

◆ unit_w()

const LVecBase4f & LVecBase4f::unit_w ( )
inlinestatic

Returns a unit W vector.

Definition at line 533 of file lvecBase4.h.

◆ unit_x()

const LVecBase4f & LVecBase4f::unit_x ( )
inlinestatic

Returns a unit X vector.

Definition at line 503 of file lvecBase4.h.

◆ unit_y()

const LVecBase4f & LVecBase4f::unit_y ( )
inlinestatic

Returns a unit Y vector.

Definition at line 513 of file lvecBase4.h.

◆ unit_z()

const LVecBase4f & LVecBase4f::unit_z ( )
inlinestatic

Returns a unit Z vector.

Definition at line 523 of file lvecBase4.h.

◆ write_datagram()

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 1438 of file lvecBase4.h.

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

Referenced by CubicCurveseg::register_with_read_factory(), ColorAttrib::write_datagram(), ScissorEffect::write_datagram(), RenderModeAttrib::write_datagram(), Material::write_datagram(), ColorBlendAttrib::write_datagram(), SamplerState::write_datagram(), and TextureStage::write_datagram().

◆ write_datagram_fixed()

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 1384 of file lvecBase4.h.

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

◆ zero()

const LVecBase4f & LVecBase4f::zero ( )
inlinestatic

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