Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes

LVector3f Class Reference

This is a three-component vector distance (as opposed to a three-component point, which represents a particular point in space). More...

#include "lvector3.h"

Inheritance diagram for LVector3f:
LVecBase3f

List of all members.

Public Types

typedef const float * const_iterator
typedef const float * iterator

Public Member Functions

 LVector3f (const LVecBase3f &copy)
 LVector3f (float fill_value)
 LVector3f (float x, float y, float z)
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.
float angle_deg (const LVector3f &other) const
 Returns the angle between this vector and the other one, expressed in degrees.
float angle_rad (const LVector3f &other) const
 Returns the unsigned angle between this vector and the other one, expressed in radians.
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, float threshold) const
 Sorts vectors lexicographically, componentwise.
int compare_to (const LVecBase3f &other) const
 This flavor of compare_to uses a default threshold value based on the numeric type.
LVector3f 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
LVector2f get_xy () const
 Returns a 2-component vector that shares just the first two components of this vector.
LVector2f get_xz () const
 Returns a 2-component vector that shares just the first and last components of this vector.
float get_y () const
LVector2f 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
LVector3f operator* (float scalar) const
void operator*= (float scalar)
LVector3f operator+ (const LVector3f &other) const
LVecBase3f operator+ (const LVecBase3f &other) const
void operator+= (const LVecBase3f &other)
LVecBase3f operator- (const LVecBase3f &other) const
LVector3f operator- () const
LVector3f operator- (const LVector3f &other) const
void operator-= (const LVecBase3f &other)
LVector3f operator/ (float scalar) const
void operator/= (float scalar)
bool operator< (const LVecBase3f &other) const
 This performs a lexicographical comparison.
LVector3foperator= (float fill_value)
LVector3foperator= (const LVecBase3f &copy)
bool operator== (const LVecBase3f &other) const
float operator[] (int i) const
float & operator[] (int i)
void output (ostream &out) const
LVector3f project (const LVecBase3f &onto) const
 Returns a new vector representing the projection of this vector onto another one.
void read_datagram (DatagramIterator &source)
 Function to read itself from a datagramIterator.
float relative_angle_deg (const LVector3f &other) const
 This method is deprecated.
float relative_angle_rad (const LVector3f &other) const
 This method is deprecated.
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)
float signed_angle_deg (const LVector3f &other, const LVector3f &ref) const
 Returns the signed angle between two vectors.
float signed_angle_rad (const LVector3f &other, const LVector3f &ref) const
 returns the signed angle between two vectors.
void write_datagram (Datagram &destination) const
 Function to write itself into a datagram.

Static Public Member Functions

static LVector3f back (CoordinateSystem cs=CS_default)
 Returns the back vector for the given coordinate system.
static LVector3f down (CoordinateSystem cs=CS_default)
 Returns the down vector for the given coordinate system.
static LVector3f forward (CoordinateSystem cs=CS_default)
 Returns the forward vector for the given coordinate system.
static TypeHandle get_class_type ()
static void init_type ()
static LVector3f left (CoordinateSystem cs=CS_default)
 Returns the left vector for the given coordinate system.
static LVector3f rfu (float right, float fwd, float up, CoordinateSystem cs=CS_default)
 Returns a vector that is described by its right, forward, and up components, in whatever way the coordinate system represents that vector.
static LVector3f right (CoordinateSystem cs=CS_default)
 Returns the right vector for the given coordinate system.
static int size ()
 Returns 3: the number of components of a LVecBase3.
static const LVector3funit_x ()
 Returns a unit X vector.
static const LVector3funit_y ()
 Returns a unit Y vector.
static const LVector3funit_z ()
 Returns a unit Z vector.
static LVector3f up (CoordinateSystem cs=CS_default)
 Returns the up vector for the given coordinate system.
static const LVector3fzero ()
 Returns a zero-length vector.

Public Attributes

union {
   float   data [3]
   struct {
      float   _0
      float   _1
      float   _2
   }   v
_v

Detailed Description

This is a three-component vector distance (as opposed to a three-component point, which represents a particular point in space).

Some of the methods are slightly different between LPoint3 and LVector3; in particular, subtraction of two points yields a vector, while addition of a vector and a point yields a point.

Definition at line 94 of file lvector3.h.


Member Function Documentation

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

Adds the vector into the running hash.

Definition at line 933 of file lvecBase3.h.

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

Adds the vector into the running hash.

Definition at line 944 of file lvecBase3.h.

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

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

Definition at line 1104 of file lvecBase3.h.

Referenced by NurbsCurveResult::adaptive_sample(), ParametricCurve::convert_to_hermite(), ColorScaleAttrib::fillin(), ACMatrixSwitchType::output_value(), and FltToEggLevelState::set_transform().

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

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

Definition at line 1118 of file lvecBase3.h.

float LVector3f::angle_deg ( const LVector3f other) const [inline]

Returns the angle between this vector and the other one, expressed in degrees.

Both vectors should be initially normalized.

Definition at line 420 of file lvector3.h.

Referenced by GeoMipTerrain::make_slope_image().

float LVector3f::angle_rad ( const LVector3f other) const [inline]

Returns the unsigned angle between this vector and the other one, expressed in radians.

Both vectors should be initially normalized.

Definition at line 400 of file lvector3.h.

LVector3f LVector3f::back ( CoordinateSystem  cs = CS_default) [inline, static]

Returns the back vector for the given coordinate system.

Definition at line 601 of file lvector3.h.

Referenced by WindowFramework::load_default_model().

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

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

Definition at line 636 of file lvecBase3.h.

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

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

Definition at line 658 of file lvecBase3.h.

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

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

Definition at line 876 of file lvecBase3.h.

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

int LVecBase3f::compare_to ( const LVecBase3f other,
float  threshold 
) const [inline, inherited]

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 891 of file lvecBase3.h.

LVector3f LVector3f::down ( CoordinateSystem  cs = CS_default) [inline, static]

Returns the down vector for the given coordinate system.

Definition at line 579 of file lvector3.h.

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

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

Definition at line 647 of file lvecBase3.h.

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

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

Definition at line 669 of file lvecBase3.h.

void LVecBase3f::fill ( float  fill_value) [inline, inherited]

Sets each element of the vector to the indicated fill_value.

This is particularly useful for initializing to zero.

Definition at line 681 of file lvecBase3.h.

LVector3f LVector3f::forward ( CoordinateSystem  cs = CS_default) [inline, static]
void LVecBase3f::generate_hash ( ChecksumHashGenerator hashgen) const [inline, inherited]

Adds the vector to the indicated hash generator.

Definition at line 1157 of file lvecBase3.h.

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

Adds the vector to the indicated hash generator.

Definition at line 1168 of file lvecBase3.h.

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

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 615 of file lvecBase3.h.

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

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

Returns a suitable hash for phash_map.

Definition at line 922 of file lvecBase3.h.

size_t LVecBase3f::get_hash ( ) const [inline, inherited]

Returns a suitable hash for phash_map.

Definition at line 911 of file lvecBase3.h.

int LVecBase3f::get_num_components ( ) const [inline, inherited]

Returns the number of elements in the vector, three.

Definition at line 625 of file lvecBase3.h.

LVecBase3f LVecBase3f::get_standardized_hpr ( ) const [inline, inherited]

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 862 of file lvecBase3.h.

LVector2f LVector3f::get_xy ( ) const [inline]

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

Reimplemented from LVecBase3f.

Definition at line 294 of file lvector3.h.

LVector2f LVector3f::get_xz ( ) const [inline]

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

Reimplemented from LVecBase3f.

Definition at line 305 of file lvector3.h.

LVector2f LVector3f::get_yz ( ) const [inline]

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

Reimplemented from LVecBase3f.

Definition at line 316 of file lvector3.h.

bool LVecBase3f::is_nan ( ) const [inline, inherited]

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

Definition at line 446 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(), PhysxSegment::compute_direction(), PhysxCapsule::compute_direction(), PhysxSegment::compute_point(), PhysxCapsule::compute_point(), PhysxBounds3::contain(), PhysxSphere::contains(), BoundingSphere::contains_lineseg(), BoundingBox::contains_lineseg(), 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(), PhysxSphere::set_center(), PhysxBox::set_center(), PhysxBounds3::set_center_extents(), PhysxBoxShapeDesc::set_dimensions(), PhysxBoxForceFieldShapeDesc::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(), PhysxController::set_local_speed(), PhysxBounds3::set_max(), PhysxBounds3::set_min(), PhysxRay::set_origin(), PhysxSegment::set_origin_direction(), PhysxCapsule::set_origin_direction(), PhysxSegment::set_p0(), PhysxCapsule::set_p0(), PhysxSegment::set_p1(), PhysxCapsule::set_p1(), PhysxPlaneShapeDesc::set_plane(), PhysicsObject::set_position(), CLerpNodePathInterval::set_start_hpr(), CLerpNodePathInterval::set_start_pos(), CLerpNodePathInterval::set_start_scale(), CLerpNodePathInterval::set_start_shear(), PhysxSphericalJointDesc::set_swing_axis(), PhysicsObject::set_velocity(), Lens::set_view_hpr(), Lens::set_view_vector(), 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().

LVector3f LVector3f::left ( CoordinateSystem  cs = CS_default) [inline, static]

Returns the left vector for the given coordinate system.

Definition at line 590 of file lvector3.h.

Referenced by PerspectiveLens::compute_projection_mat().

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

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

Definition at line 720 of file lvecBase3.h.

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

bool LVecBase3f::normalize ( ) [inline, inherited]
bool LVecBase3f::operator< ( const LVecBase3f other) const [inline, inherited]

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 793 of file lvecBase3.h.

LVector3f LVector3f::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 from LVecBase3f.

Definition at line 388 of file lvector3.h.

void LVecBase3f::read_datagram ( DatagramIterator source) [inline, inherited]
float LVector3f::relative_angle_deg ( const LVector3f other) const [inline]

This method is deprecated.

Do not use.

Definition at line 478 of file lvector3.h.

float LVector3f::relative_angle_rad ( const LVector3f other) const [inline]

This method is deprecated.

Do not use.

Definition at line 468 of file lvector3.h.

LVector3f LVector3f::rfu ( float  right,
float  fwd,
float  up,
CoordinateSystem  cs = CS_default 
) [inline, static]

Returns a vector that is described by its right, forward, and up components, in whatever way the coordinate system represents that vector.

Definition at line 615 of file lvector3.h.

Referenced by PGItem::mouse_to_local(), PGSliderBar::recompute(), PGSliderBar::remanage(), PGScrollFrame::setup(), PGSliderBar::setup_scroll_bar(), and PGSliderBar::setup_slider().

LVector3f LVector3f::right ( CoordinateSystem  cs = CS_default) [inline, static]

Returns the right vector for the given coordinate system.

Definition at line 537 of file lvector3.h.

Referenced by TextPropertiesManager::set_graphic().

float LVector3f::signed_angle_deg ( const LVector3f other,
const LVector3f ref 
) const [inline]

Returns the signed angle between two vectors.

The angle is positive if the rotation from this vector to other is clockwise when looking in the direction of the ref vector.

Vectors (except the ref vector) should be initially normalized.

Definition at line 457 of file lvector3.h.

float LVector3f::signed_angle_rad ( const LVector3f other,
const LVector3f ref 
) const [inline]

returns the signed angle between two vectors.

The angle is positive if the rotation from this vector to other is clockwise when looking in the direction of the ref vector.

Vectors (except the ref vector) should be initially normalized.

Definition at line 436 of file lvector3.h.

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

Returns 3: the number of components of a LVecBase3.

Definition at line 435 of file lvecBase3.h.

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

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

Returns a unit X vector.

Reimplemented from LVecBase3f.

Definition at line 263 of file lvector3.h.

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

Returns a unit Y vector.

Reimplemented from LVecBase3f.

Definition at line 273 of file lvector3.h.

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

Returns a unit Z vector.

Reimplemented from LVecBase3f.

Definition at line 283 of file lvector3.h.

LVector3f LVector3f::up ( CoordinateSystem  cs = CS_default) [inline, static]
void LVecBase3f::write_datagram ( Datagram destination) const [inline, inherited]
const LVector3f & LVector3f::zero ( ) [inline, static]

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