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

Inheritance diagram for VBase2D:

Public Member Functions
	VBase2D ()
	VBase2D (VBase2D const copy)
	VBase2D (double x, double y)
	VBase2D (double fill_value)
unsigned int	addHash (unsigned int hash)
	Adds the vector into the running hash.
unsigned int	addHash (unsigned int hash, double threshold)
	Adds the vector into the running hash.
	addToCell (int i, double value)
	addX (double value)
	addY (double value)
bool	almostEqual (VBase2D const other)
	Returns true if two vectors are memberwise equal within a default tolerance based on the numeric type.
bool	almostEqual (VBase2D const other, double threshold)
	Returns true if two vectors are memberwise equal within a specified tolerance.
int	compareTo (VBase2D const other)
	This flavor of compare_to uses a default threshold value based on the numeric type.
int	compareTo (VBase2D const other, double threshold)
	Sorts vectors lexicographically, componentwise.
double	dot (VBase2D const other)
	fill (double fill_value)
	Sets each element of the vector to the indicated fill_value.
VBase2D	fmax (VBase2D const other)
VBase2D	fmin (VBase2D const other)
	generateHash (ChecksumHashGenerator hashgen)
	Adds the vector to the indicated hash generator.
	generateHash (ChecksumHashGenerator hashgen, double threshold)
	Adds the vector to the indicated hash generator.
PyObject	getattr (string attr_name)
double	getCell (int i)
	getData ()
	Returns the address of the first of the two data elements in the vector.
unsigned int	getHash ()
	Returns a suitable hash for phash_map.
unsigned int	getHash (double threshold)
	Returns a suitable hash for phash_map.
int	getNumComponents ()
	Returns the number of elements in the vector, two.
double	getX ()
double	getY ()
bool	isNan ()
	Returns true if any component of the vector is not-a-number, false otherwise.
double	length ()
	Returns the length of the vector, by the Pythagorean theorem.
double	lengthSquared ()
	Returns the square of the vector's length, cheap and easy.
bool	normalize ()
	Normalizes the vector in place.
	operator new (unsigned int size)
bool	operator!= (VBase2D const other)
VBase2D	operator* (double scalar)
VBase2D	operator*= (double scalar)
VBase2D	operator+ (VBase2D const other)
VBase2D	operator+= (VBase2D const other)
VBase2D	operator- ()
VBase2D	operator- (VBase2D const other)
VBase2D	operator-= (VBase2D const other)
VBase2D	operator/ (double scalar)
VBase2D	operator/= (double scalar)
bool	operator< (VBase2D const other)
	This performs a lexicographical comparison.
VBase2D	operator= (VBase2D const copy)
VBase2D	operator= (double fill_value)
bool	operator== (VBase2D const other)
	operator[] (int i)
double	operator[] (int i)
	output (ostream out)
VBase2D	project (VBase2D const onto)
	Returns a new vector representing the projection of this vector onto another one.
	pythonRepr (ostream out, string class_name)
	readDatagram (DatagramIterator source)
	Reads the vector from the Datagram using get_stdfloat().
	readDatagramFixed (DatagramIterator source)
	Reads the vector from the Datagram using get_float32() or get_float64().
PyObject	reduce (PyObject self)
	set (double x, double y)
int	setattr (PyObject self, string attr_name, PyObject assign)
	setCell (int i, double value)
	setitem (int i, double v)
	setX (double value)
	setY (double value)
	writeDatagram (Datagram destination)
	Writes the vector to the Datagram using add_stdfloat().
	writeDatagramFixed (Datagram destination)
	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	getClassType ()
static int	size ()
	Returns 2: the number of components of a LVecBase2.
static VBase2D const	unitX ()
	Returns a unit X vector.
static VBase2D const	unitY ()
	Returns a unit Y vector.
static VBase2D const	zero ()
	Returns a zero-length vector.

Detailed Description

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

Constructor & Destructor Documentation

VBase2D ( )

VBase2D ( VBase2D const copy )

VBase2D ( double fill_value )

VBase2D	(	double	x,
		double	y
	)

Member Function Documentation

unsigned int addHash ( unsigned int hash )

Adds the vector into the running hash.

unsigned int addHash	(	unsigned int	hash,
		double	threshold
	)

Adds the vector into the running hash.

addToCell	(	int	i,
		double	value
	)

addX ( double value )

addY ( double value )

bool almostEqual ( VBase2D const other )

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

bool almostEqual	(	VBase2D const	other,
		double	threshold
	)

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

int compareTo ( VBase2D const other )

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

int compareTo	(	VBase2D const	other,
		double	threshold
	)

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).

double dot ( VBase2D const other )

fill ( double fill_value )

Sets each element of the vector to the indicated fill_value.

This is particularly useful for initializing to zero.

VBase2D fmax ( VBase2D const other )

VBase2D fmin ( VBase2D const other )

generateHash ( ChecksumHashGenerator hashgen )

Adds the vector to the indicated hash generator.

generateHash	(	ChecksumHashGenerator	hashgen,
		double	threshold
	)

Adds the vector to the indicated hash generator.

PyObject getattr ( string attr_name )

Reimplemented in Vec2D, and Point2D.

double getCell ( int i )

static TypeHandle getClassType ( ) [static]

Reimplemented in Vec2D, and Point2D.

getData ( )

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

The next element occupies the next position consecutively in memory.

unsigned int getHash ( )

Returns a suitable hash for phash_map.

unsigned int getHash ( double threshold )

Returns a suitable hash for phash_map.

int getNumComponents ( )

Returns the number of elements in the vector, two.

double getX ( )

double getY ( )

bool isNan ( )

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

double length ( )

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

double lengthSquared ( )

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

bool normalize ( )

Normalizes the vector in place.

Returns true if the vector was normalized, false if it was a zero-length vector.

operator new ( unsigned int size )

bool operator!= ( VBase2D const other )

VBase2D operator* ( double scalar )

Reimplemented in Vec2D, and Point2D.

VBase2D operator*= ( double scalar )

VBase2D operator+ ( VBase2D const other )

Reimplemented in Vec2D, and Point2D.

VBase2D operator+= ( VBase2D const other )

VBase2D operator- ( )

Reimplemented in Vec2D, and Point2D.

VBase2D operator- ( VBase2D const other )

Reimplemented in Vec2D, and Point2D.

VBase2D operator-= ( VBase2D const other )

VBase2D operator/ ( double scalar )

Reimplemented in Vec2D, and Point2D.

VBase2D operator/= ( double scalar )

bool operator< ( VBase2D const other )

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().

VBase2D operator= ( double fill_value )

Reimplemented in Vec2D, and Point2D.

VBase2D operator= ( VBase2D const copy )

Reimplemented in Vec2D, and Point2D.

bool operator== ( VBase2D const other )

operator[] ( int i )

double operator[] ( int i )

output ( ostream out )

VBase2D project ( VBase2D const onto )

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 Vec2D, and Point2D.

pythonRepr	(	ostream	out,
		string	class_name
	)

Reimplemented in Vec2D, and Point2D.

readDatagram ( DatagramIterator source )

Reads the vector from the Datagram using get_stdfloat().

readDatagramFixed ( DatagramIterator source )

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

See write_datagram_fixed().

PyObject reduce ( PyObject self )

set	(	double	x,
		double	y
	)

int setattr	(	PyObject	self,
		string	attr_name,
		PyObject	assign
	)

Reimplemented in Vec2D, and Point2D.

setCell	(	int	i,
		double	value
	)

setitem	(	int	i,
		double	v
	)

setX ( double value )

setY ( double value )

static int size ( ) [static]

Returns 2: the number of components of a LVecBase2.

static VBase2D const unitX ( ) [static]

Returns a unit X vector.

Reimplemented in Vec2D, and Point2D.

static VBase2D const unitY ( ) [static]

Returns a unit Y vector.

Reimplemented in Vec2D, and Point2D.

writeDatagram ( Datagram destination )

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.

writeDatagramFixed ( Datagram destination )

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.

static VBase2D const zero ( ) [static]

Returns a zero-length vector.

Reimplemented in Vec2D, and Point2D.

VBase2D Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation