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

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

#include "lvecBase2.h"

Inheritance diagram for LVecBase2i:
LPoint2i LVector2i

Public Types

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

Public Member Functions

 LVecBase2i (const LVecBase2i &copy)
 
 LVecBase2i (int fill_value)
 
 LVecBase2i (int x, int y)
 
 LVecBase2i (const EVector2 &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)
 
bool almost_equal (const LVecBase2i &other, int threshold) const
 Returns true if two vectors are memberwise equal within a specified tolerance. More...
 
bool almost_equal (const LVecBase2i &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 LVecBase2i &other) const
 This flavor of compare_to uses a default threshold value based on the numeric type. More...
 
int compare_to (const LVecBase2i &other, int threshold) const
 Sorts vectors lexicographically, componentwise. More...
 
void componentwise_mult (const LVecBase2i &other)
 
int dot (const LVecBase2i &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...
 
LVecBase2i fmax (const LVecBase2i &other) const
 
LVecBase2i fmin (const LVecBase2i &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 two 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, two. More...
 
int get_x () const
 
int get_y () 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 LVecBase2i &other) const
 
LVecBase2i operator* (int scalar) const
 
void operator*= (int scalar)
 
LVecBase2i operator+ (const LVecBase2i &other) const
 
void operator+= (const LVecBase2i &other)
 
LVecBase2i operator- () const
 
LVecBase2i operator- (const LVecBase2i &other) const
 
void operator-= (const LVecBase2i &other)
 
LVecBase2i operator/ (int scalar) const
 
void operator/= (int scalar)
 
bool operator< (const LVecBase2i &other) const
 This performs a lexicographical comparison. More...
 
LVecBase2ioperator= (const LVecBase2i &copy)
 
LVecBase2ioperator= (int fill_value)
 
bool operator== (const LVecBase2i &other) const
 
int operator[] (int i) const
 
int & operator[] (int i)
 
void output (ostream &out) const
 
LVecBase2i project (const LVecBase2i &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)
 
void set_cell (int i, int value)
 
void set_x (int value)
 
void set_y (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 2: the number of components of a LVecBase2. More...
 
static const LVecBase2iunit_x ()
 Returns a unit X vector. More...
 
static const LVecBase2iunit_y ()
 Returns a unit Y vector. More...
 
static const LVecBase2izero ()
 Returns a zero-length vector. More...
 

Public Attributes

EVector2 _v
 

Detailed Description

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

Definition at line 2328 of file lvecBase2.h.

Member Function Documentation

size_t LVecBase2i::add_hash ( size_t  hash) const
inline

Adds the vector into the running hash.

Definition at line 3009 of file lvecBase2.h.

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

Adds the vector into the running hash.

Definition at line 3075 of file lvecBase2.h.

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

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

Definition at line 3285 of file lvecBase2.h.

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

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

Definition at line 3298 of file lvecBase2.h.

LVecBase2i::iterator LVecBase2i::begin ( )
inline

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

Definition at line 2784 of file lvecBase2.h.

LVecBase2i::const_iterator LVecBase2i::begin ( ) const
inline

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

Definition at line 2806 of file lvecBase2.h.

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

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

Definition at line 2977 of file lvecBase2.h.

int LVecBase2i::compare_to ( const LVecBase2i 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 3047 of file lvecBase2.h.

LVecBase2i::iterator LVecBase2i::end ( )
inline

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

Definition at line 2795 of file lvecBase2.h.

LVecBase2i::const_iterator LVecBase2i::end ( ) const
inline

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

Definition at line 2817 of file lvecBase2.h.

void LVecBase2i::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 2829 of file lvecBase2.h.

void LVecBase2i::generate_hash ( ChecksumHashGenerator hashgen) const
inline

Adds the vector to the indicated hash generator.

Definition at line 3027 of file lvecBase2.h.

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

Adds the vector to the indicated hash generator.

Definition at line 3089 of file lvecBase2.h.

const int * LVecBase2i::get_data ( ) const
inline

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

The next element occupies the next position consecutively in memory.

Definition at line 2763 of file lvecBase2.h.

size_t LVecBase2i::get_hash ( ) const
inline

Returns a suitable hash for phash_map.

Definition at line 2998 of file lvecBase2.h.

size_t LVecBase2i::get_hash ( int  threshold) const
inline

Returns a suitable hash for phash_map.

Definition at line 3064 of file lvecBase2.h.

int LVecBase2i::get_num_components ( ) const
inline

Returns the number of elements in the vector, two.

Definition at line 2773 of file lvecBase2.h.

bool LVecBase2i::is_nan ( ) const
inline

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

Definition at line 2653 of file lvecBase2.h.

int LVecBase2i::length ( ) const
inline

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

Definition at line 2886 of file lvecBase2.h.

int LVecBase2i::length_squared ( ) const
inline

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

Definition at line 2869 of file lvecBase2.h.

bool LVecBase2i::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 2903 of file lvecBase2.h.

bool LVecBase2i::operator< ( const LVecBase2i 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 2939 of file lvecBase2.h.

LVecBase2i LVecBase2i::project ( const LVecBase2i 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 2924 of file lvecBase2.h.

void LVecBase2i::read_datagram ( DatagramIterator source)
inline

Reads the vector from the Datagram using get_stdfloat().

Definition at line 3384 of file lvecBase2.h.

void LVecBase2i::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 3346 of file lvecBase2.h.

int LVecBase2i::size ( )
inlinestatic

Returns 2: the number of components of a LVecBase2.

Definition at line 2642 of file lvecBase2.h.

const LVecBase2i & LVecBase2i::unit_x ( )
inlinestatic

Returns a unit X vector.

Definition at line 2591 of file lvecBase2.h.

const LVecBase2i & LVecBase2i::unit_y ( )
inlinestatic

Returns a unit Y vector.

Definition at line 2601 of file lvecBase2.h.

void LVecBase2i::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 3368 of file lvecBase2.h.

void LVecBase2i::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 3326 of file lvecBase2.h.

const LVecBase2i & LVecBase2i::zero ( )
inlinestatic

Returns a zero-length vector.

Definition at line 2581 of file lvecBase2.h.

Referenced by GeomVertexReader::get_data2i().


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