Panda3D
 All Classes Functions Variables Enumerations
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
LVecBase3i Class Reference

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

#include "lvecBase3.h"

Inheritance diagram for LVecBase3i:
LPoint3i LVector3i

Public Types

enum  { num_components = 3, is_int = 0 }
 
typedef const int * const_iterator
 
typedef LSimpleMatrix< int, 1, 3 > EVector3
 
typedef const int * iterator
 
typedef int numeric_type
 

Public Member Functions

 LVecBase3i (const LVecBase3i &copy)
 
 LVecBase3i (int fill_value)
 
 LVecBase3i (int x, int y, int z)
 
 LVecBase3i (const LVecBase2i &copy, int z)
 
 LVecBase3i (const EVector3 &v)
 
size_t add_hash (size_t hash) const
 Adds the vector into the running hash. More...
 
size_t add_hash (size_t hash, int threshold) const
 Adds the vector into the running hash. More...
 
void add_to_cell (int i, int value)
 
void add_x (int value)
 
void add_y (int value)
 
void add_z (int value)
 
bool almost_equal (const LVecBase3i &other, int threshold) const
 Returns true if two vectors are memberwise equal within a specified tolerance. More...
 
bool almost_equal (const LVecBase3i &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 LVecBase3i &other) const
 This flavor of compare_to uses a default threshold value based on the numeric type. More...
 
int compare_to (const LVecBase3i &other, int threshold) const
 Sorts vectors lexicographically, componentwise. More...
 
void componentwise_mult (const LVecBase3i &other)
 
LVecBase3i cross (const LVecBase3i &other) const
 
void cross_into (const LVecBase3i &other)
 
int dot (const LVecBase3i &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 fill (int fill_value)
 Sets each element of the vector to the indicated fill_value. More...
 
LVecBase3i fmax (const LVecBase3i &other) const
 
LVecBase3i fmin (const LVecBase3i &other) const
 
void generate_hash (ChecksumHashGenerator &hashgen) const
 Adds the vector to the indicated hash generator. More...
 
void generate_hash (ChecksumHashGenerator &hashgen, int threshold) const
 Adds the vector to the indicated hash generator. More...
 
int get_cell (int i) const
 
const int * get_data () const
 Returns the address of the first of the three data elements in the vector. More...
 
size_t get_hash () const
 Returns a suitable hash for phash_map. More...
 
size_t get_hash (int threshold) const
 Returns a suitable hash for phash_map. More...
 
int get_num_components () const
 Returns the number of elements in the vector, three. More...
 
LVecBase3i get_standardized_hpr () const
 Try to un-spin the hpr to a standard form. More...
 
int get_x () const
 
LVecBase2i get_xy () const
 Returns a 2-component vector that shares just the first two components of this vector. More...
 
LVecBase2i get_xz () const
 Returns a 2-component vector that shares just the first and last components of this vector. More...
 
int get_y () const
 
LVecBase2i get_yz () const
 Returns a 2-component vector that shares just the last two components of this vector. More...
 
int get_z () const
 
bool is_nan () const
 Returns true if any component of the vector is not-a-number, false otherwise. More...
 
int length () const
 Returns the length of the vector, by the Pythagorean theorem. More...
 
int length_squared () const
 Returns the square of the vector's length, cheap and easy. More...
 
bool normalize ()
 Normalizes the vector in place. More...
 
bool operator!= (const LVecBase3i &other) const
 
LVecBase3i operator* (int scalar) const
 
void operator*= (int scalar)
 
LVecBase3i operator+ (const LVecBase3i &other) const
 
void operator+= (const LVecBase3i &other)
 
LVecBase3i operator- () const
 
LVecBase3i operator- (const LVecBase3i &other) const
 
void operator-= (const LVecBase3i &other)
 
LVecBase3i operator/ (int scalar) const
 
void operator/= (int scalar)
 
bool operator< (const LVecBase3i &other) const
 This performs a lexicographical comparison. More...
 
LVecBase3ioperator= (const LVecBase3i &copy)
 
LVecBase3ioperator= (int fill_value)
 
bool operator== (const LVecBase3i &other) const
 
int operator[] (int i) const
 
int & operator[] (int i)
 
void output (ostream &out) const
 
LVecBase3i project (const LVecBase3i &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 (int x, int y, int z)
 
void set_cell (int i, int value)
 
void set_x (int value)
 
void set_y (int value)
 
void set_z (int 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 3: the number of components of a LVecBase3. More...
 
static const LVecBase3iunit_x ()
 Returns a unit X vector. More...
 
static const LVecBase3iunit_y ()
 Returns a unit Y vector. More...
 
static const LVecBase3iunit_z ()
 Returns a unit Z vector. More...
 
static const LVecBase3izero ()
 Returns a zero-length vector. More...
 

Public Attributes

EVector3 _v
 

Detailed Description

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

Definition at line 2756 of file lvecBase3.h.

Member Function Documentation

size_t LVecBase3i::add_hash ( size_t  hash) const
inline

Adds the vector into the running hash.

Definition at line 3609 of file lvecBase3.h.

size_t LVecBase3i::add_hash ( size_t  hash,
int  threshold 
) const
inline

Adds the vector into the running hash.

Definition at line 3681 of file lvecBase3.h.

bool LVecBase3i::almost_equal ( const LVecBase3i other,
int  threshold 
) const
inline

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

Definition at line 3915 of file lvecBase3.h.

bool LVecBase3i::almost_equal ( const LVecBase3i other) const
inline

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

Definition at line 3929 of file lvecBase3.h.

LVecBase3i::iterator LVecBase3i::begin ( )
inline

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

Definition at line 3308 of file lvecBase3.h.

LVecBase3i::const_iterator LVecBase3i::begin ( ) const
inline

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

Definition at line 3330 of file lvecBase3.h.

int LVecBase3i::compare_to ( const LVecBase3i other) const
inline

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

Definition at line 3574 of file lvecBase3.h.

int LVecBase3i::compare_to ( const LVecBase3i other,
int  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 3650 of file lvecBase3.h.

LVecBase3i::iterator LVecBase3i::end ( )
inline

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

Definition at line 3319 of file lvecBase3.h.

LVecBase3i::const_iterator LVecBase3i::end ( ) const
inline

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

Definition at line 3341 of file lvecBase3.h.

void LVecBase3i::fill ( int  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 3353 of file lvecBase3.h.

void LVecBase3i::generate_hash ( ChecksumHashGenerator hashgen) const
inline

Adds the vector to the indicated hash generator.

Definition at line 3628 of file lvecBase3.h.

void LVecBase3i::generate_hash ( ChecksumHashGenerator hashgen,
int  threshold 
) const
inline

Adds the vector to the indicated hash generator.

Definition at line 3696 of file lvecBase3.h.

const int * LVecBase3i::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 3287 of file lvecBase3.h.

size_t LVecBase3i::get_hash ( ) const
inline

Returns a suitable hash for phash_map.

Definition at line 3598 of file lvecBase3.h.

size_t LVecBase3i::get_hash ( int  threshold) const
inline

Returns a suitable hash for phash_map.

Definition at line 3670 of file lvecBase3.h.

int LVecBase3i::get_num_components ( ) const
inline

Returns the number of elements in the vector, three.

Definition at line 3297 of file lvecBase3.h.

LVecBase3i LVecBase3i::get_standardized_hpr ( ) const
inline

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

LVecBase2i LVecBase3i::get_xy ( ) const
inline

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

Definition at line 3212 of file lvecBase3.h.

LVecBase2i LVecBase3i::get_xz ( ) const
inline

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

Definition at line 3223 of file lvecBase3.h.

LVecBase2i LVecBase3i::get_yz ( ) const
inline

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

Definition at line 3234 of file lvecBase3.h.

bool LVecBase3i::is_nan ( ) const
inline

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

Definition at line 3114 of file lvecBase3.h.

int LVecBase3i::length ( ) const
inline

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

Definition at line 3416 of file lvecBase3.h.

int LVecBase3i::length_squared ( ) const
inline

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

Definition at line 3399 of file lvecBase3.h.

bool LVecBase3i::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 3433 of file lvecBase3.h.

bool LVecBase3i::operator< ( const LVecBase3i 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 3487 of file lvecBase3.h.

LVecBase3i LVecBase3i::project ( const LVecBase3i 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 3455 of file lvecBase3.h.

void LVecBase3i::read_datagram ( DatagramIterator source)
inline

Reads the vector from the Datagram using get_stdfloat().

Definition at line 4024 of file lvecBase3.h.

void LVecBase3i::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 3981 of file lvecBase3.h.

int LVecBase3i::size ( )
inlinestatic

Returns 3: the number of components of a LVecBase3.

Definition at line 3103 of file lvecBase3.h.

const LVecBase3i & LVecBase3i::unit_x ( )
inlinestatic

Returns a unit X vector.

Definition at line 3042 of file lvecBase3.h.

const LVecBase3i & LVecBase3i::unit_y ( )
inlinestatic

Returns a unit Y vector.

Definition at line 3052 of file lvecBase3.h.

const LVecBase3i & LVecBase3i::unit_z ( )
inlinestatic

Returns a unit Z vector.

Definition at line 3062 of file lvecBase3.h.

void LVecBase3i::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 4006 of file lvecBase3.h.

void LVecBase3i::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 3958 of file lvecBase3.h.

const LVecBase3i & LVecBase3i::zero ( )
inlinestatic

Returns a zero-length vector.

Definition at line 3032 of file lvecBase3.h.

Referenced by GeomVertexReader::get_data3i(), and ComputeNode::get_dispatch().


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