Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes
LVecBase3f Class Reference

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

#include "lvecBase3.h"

Inheritance diagram for LVecBase3f:
LPoint3f LVector3f

List of all members.

Public Types

typedef const float * const_iterator
typedef const float * iterator

Public Member Functions

 LVecBase3f (const LVecBase3f &copy)
 LVecBase3f (float fill_value)
 LVecBase3f (float x, float y, float z)
 LVecBase3f (const EVector3 &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)
void add_z (float value)
bool almost_equal (const LVecBase3f &other, float threshold) const
 Returns true if two vectors are memberwise equal within a specified tolerance.
bool almost_equal (const LVecBase3f &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 LVecBase3f &other) const
 This flavor of compare_to uses a default threshold value based on the numeric type.
int compare_to (const LVecBase3f &other, float threshold) const
 Sorts vectors lexicographically, componentwise.
LVecBase3f cross (const LVecBase3f &other) const
void cross_into (const LVecBase3f &other)
float dot (const LVecBase3f &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.
LVecBase3f fmax (const LVecBase3f &other)
LVecBase3f fmin (const LVecBase3f &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 three 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, three.
LVecBase3f get_standardized_hpr () const
 Try to un-spin the hpr to a standard form.
float get_x () const
LVecBase2f get_xy () const
 Returns a 2-component vector that shares just the first two components of this vector.
LVecBase2f get_xz () const
 Returns a 2-component vector that shares just the first and last components of this vector.
float get_y () const
LVecBase2f get_yz () const
 Returns a 2-component vector that shares just the last two components of this vector.
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.
bool normalize ()
 Normalizes the vector in place.
bool operator!= (const LVecBase3f &other) const
LVecBase3f operator* (float scalar) const
void operator*= (float scalar)
LVecBase3f operator+ (const LVecBase3f &other) const
void operator+= (const LVecBase3f &other)
LVecBase3f operator- () const
LVecBase3f operator- (const LVecBase3f &other) const
void operator-= (const LVecBase3f &other)
LVecBase3f operator/ (float scalar) const
void operator/= (float scalar)
bool operator< (const LVecBase3f &other) const
 This performs a lexicographical comparison.
LVecBase3foperator= (const LVecBase3f &copy)
LVecBase3foperator= (float fill_value)
bool operator== (const LVecBase3f &other) const
float operator[] (int i) const
float & operator[] (int i)
void output (ostream &out) const
LVecBase3f project (const LVecBase3f &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)
void set_cell (int i, float value)
void set_x (float value)
void set_y (float value)
void set_z (float value)
typedef UNALIGNED_LINMATH_MATRIX (float, 1, 3) EVector3
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 3: the number of components of a LVecBase3.
static const LVecBase3funit_x ()
 Returns a unit X vector.
static const LVecBase3funit_y ()
 Returns a unit Y vector.
static const LVecBase3funit_z ()
 Returns a unit Z vector.
static const LVecBase3fzero ()
 Returns a zero-length vector.

Public Attributes

EVector3 _v

Detailed Description

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

Definition at line 98 of file lvecBase3.h.


Member Function Documentation

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

Adds the vector into the running hash.

Definition at line 935 of file lvecBase3.h.

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

Adds the vector into the running hash.

Definition at line 946 of file lvecBase3.h.

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

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

Definition at line 1144 of file lvecBase3.h.

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

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

Definition at line 614 of file lvecBase3.h.

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

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

Definition at line 636 of file lvecBase3.h.

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

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

Definition at line 878 of file lvecBase3.h.

Referenced by TransformState::compare_to(), and BillboardEffect::compare_to_impl().

int LVecBase3f::compare_to ( const LVecBase3f 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 893 of file lvecBase3.h.

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

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

Definition at line 625 of file lvecBase3.h.

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

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

Definition at line 647 of file lvecBase3.h.

void LVecBase3f::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 659 of file lvecBase3.h.

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

Adds the vector to the indicated hash generator.

Definition at line 1167 of file lvecBase3.h.

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

Adds the vector to the indicated hash generator.

Definition at line 1178 of file lvecBase3.h.

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

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

The remaining elements occupy the next positions consecutively in memory.

Definition at line 593 of file lvecBase3.h.

Referenced by DXGraphicsStateGuardian8::bind_light(), and DXGraphicsStateGuardian9::bind_light().

size_t LVecBase3f::get_hash ( ) const [inline]

Returns a suitable hash for phash_map.

Definition at line 913 of file lvecBase3.h.

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

Returns a suitable hash for phash_map.

Definition at line 924 of file lvecBase3.h.

int LVecBase3f::get_num_components ( ) const [inline]

Returns the number of elements in the vector, three.

Definition at line 603 of file lvecBase3.h.

Try to un-spin the hpr to a standard form.

Like all standards, someone decides between many arbitrary possible standards. This function assumes that 0 and 360 are the same, as is 720 and -360. Also 180 and -180 are the same. Another example is -90 and 270. Each element will be in the range -180.0 to 179.99999. The original usage of this function is for human readable output.

It doesn't work so well for asserting that foo_hpr is roughly equal to bar_hpr. Try using LQuaternionf::is_same_direction() for that. See Also: get_standardized_rotation, LQuaternion::is_same_direction

Definition at line 864 of file lvecBase3.h.

LVecBase2f LVecBase3f::get_xy ( ) const [inline]

Returns a 2-component vector that shares just the first two components of this vector.

Reimplemented in LVector3f, and LPoint3f.

Definition at line 518 of file lvecBase3.h.

LVecBase2f LVecBase3f::get_xz ( ) const [inline]

Returns a 2-component vector that shares just the first and last components of this vector.

Reimplemented in LVector3f, and LPoint3f.

Definition at line 529 of file lvecBase3.h.

LVecBase2f LVecBase3f::get_yz ( ) const [inline]

Returns a 2-component vector that shares just the last two components of this vector.

Reimplemented in LVector3f, and LPoint3f.

Definition at line 540 of file lvecBase3.h.

bool LVecBase3f::is_nan ( ) const [inline]

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

Definition at line 424 of file lvecBase3.h.

Referenced by PhysxActor::add_force(), PhysxActor::add_force_at_local_pos(), PhysxActor::add_force_at_pos(), PhysicsObject::add_impact(), PhysicsObject::add_impulse(), PhysxActor::add_local_force(), PhysxActor::add_local_force_at_local_pos(), PhysxActor::add_local_force_at_pos(), PhysicsObject::add_local_impact(), PhysicsObject::add_local_impulse(), PhysxActor::add_local_torque(), PhysxActor::add_torque(), BoundingSphere::around_points(), BoundingBox::around_points(), PhysxCloth::attach_vertex_to_global_pos(), PhysxCloth::attach_vertex_to_shape(), BoundingBox::BoundingBox(), BoundingSphere::BoundingSphere(), PhysxBounds3::bounds_of_obb(), PhysxUtilLib::box_box_intersect(), PhysxCapsule::compute_direction(), PhysxSegment::compute_direction(), PhysxCapsule::compute_point(), PhysxSegment::compute_point(), PhysxBounds3::contain(), PhysxSphere::contains(), IntersectionBoundingVolume::contains_lineseg(), UnionBoundingVolume::contains_lineseg(), BoundingSphere::contains_lineseg(), BoundingBox::contains_lineseg(), IntersectionBoundingVolume::contains_point(), UnionBoundingVolume::contains_point(), BoundingSphere::contains_point(), BoundingBox::contains_point(), BoundingSphere::extend_by_point(), BoundingBox::extend_by_point(), PhysxActor::get_local_point_velocity(), PhysxActor::get_point_velocity(), PhysxBounds3::include(), PhysxActor::move_global_pos(), PhysxUtilLib::point_obb_sqr_dist(), PhysxUtilLib::ray_aabb_intersect(), PhysxUtilLib::ray_capsule_intersect(), PhysxUtilLib::ray_obb_intersect(), PhysxUtilLib::ray_sphere_intersect(), PhysxUtilLib::ray_tri_intersect(), PhysicsObject::reset_position(), PhysxUtilLib::segment_aabb_intersect(), PhysxUtilLib::segment_box_intersect(), PhysxUtilLib::segment_obb_intersect(), PhysxBounds3::set(), BulletHingeConstraint::set_axis(), PhysxSphere::set_center(), PhysxBox::set_center(), PhysxBounds3::set_center_extents(), BulletWheel::set_chassis_connection_point_cs(), CollisionEntry::set_contact_normal(), CollisionEntry::set_contact_pos(), PhysxBoxForceFieldShapeDesc::set_dimensions(), PhysxBoxShapeDesc::set_dimensions(), PhysxRay::set_direction(), CLerpNodePathInterval::set_end_hpr(), CLerpNodePathInterval::set_end_pos(), CLerpNodePathInterval::set_end_quat(), CLerpNodePathInterval::set_end_scale(), CLerpNodePathInterval::set_end_shear(), PhysxBox::set_extents(), PhysxCloth::set_external_acceleration(), Lens::set_frustum_from_corners(), PhysxActor::set_global_pos(), PhysxController::set_global_speed(), PhysxSceneDesc::set_gravity(), PhysxScene::set_gravity(), CollisionEntry::set_interior_point(), PhysxController::set_local_speed(), PhysxBounds3::set_max(), PhysxBounds3::set_min(), PhysxRay::set_origin(), PhysxCapsule::set_origin_direction(), PhysxSegment::set_origin_direction(), PhysxSegment::set_p0(), PhysxCapsule::set_p0(), PhysxSegment::set_p1(), PhysxCapsule::set_p1(), PhysxPlaneShapeDesc::set_plane(), PfmFile::set_point(), PhysicsObject::set_position(), CLerpNodePathInterval::set_start_hpr(), CLerpNodePathInterval::set_start_pos(), CLerpNodePathInterval::set_start_scale(), CLerpNodePathInterval::set_start_shear(), CollisionEntry::set_surface_normal(), CollisionEntry::set_surface_point(), PhysxSphericalJointDesc::set_swing_axis(), PhysicsObject::set_velocity(), Lens::set_view_hpr(), Lens::set_view_vector(), BulletWheel::set_wheel_axle_cs(), BulletWheel::set_wheel_direction_cs(), PhysxCloth::set_wind_acceleration(), PhysxUtilLib::sweep_box_box(), PhysxUtilLib::sweep_box_capsule(), PhysxUtilLib::sweep_box_sphere(), PhysxUtilLib::sweep_capsule_capsule(), PhysxUtilLib::sweep_sphere_capsule(), PhysxUtilLib::swept_spheres_intersect(), PhysxBounds3::transform(), and PhysxUtilLib::tri_box_intersect().

float LVecBase3f::length ( ) const [inline]
float LVecBase3f::length_squared ( ) const [inline]

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

Definition at line 706 of file lvecBase3.h.

Referenced by CollisionHandlerHighestEvent::add_entry(), ObstacleAvoidance::obstacle_detection(), and Lens::set_frustum_from_corners().

bool LVecBase3f::normalize ( ) [inline]
bool LVecBase3f::operator< ( const LVecBase3f 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 791 of file lvecBase3.h.

LVecBase3f LVecBase3f::project ( const LVecBase3f 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 LPoint3f, and LVector3f.

Definition at line 777 of file lvecBase3.h.

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

Reads the vector from the Datagram using get_float32() or get_float64().

See write_datagram_fixed().

Definition at line 1216 of file lvecBase3.h.

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

Returns 3: the number of components of a LVecBase3.

Definition at line 413 of file lvecBase3.h.

Referenced by CollisionPolygon::fillin(), and CollisionPolygon::xform().

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

Returns a unit X vector.

Reimplemented in LVector3f, and LPoint3f.

Definition at line 352 of file lvecBase3.h.

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

Returns a unit Y vector.

Reimplemented in LVector3f, and LPoint3f.

Definition at line 362 of file lvecBase3.h.

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

Returns a unit Z vector.

Reimplemented in LVector3f, and LPoint3f.

Definition at line 372 of file lvecBase3.h.

void LVecBase3f::write_datagram ( Datagram destination) const [inline]
void LVecBase3f::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 1197 of file lvecBase3.h.

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

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