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

Planed Class Reference

An abstract mathematical description of a plane. More...

#include "plane.h"

Inheritance diagram for Planed:
LVecBase4d LVecBase4d

List of all members.

Public Types

typedef const double * const_iterator
typedef const double * iterator

Public Member Functions

 Planed ()
 Creates a default plane.
 Planed (const LVecBase4d &copy)
 Planed (const LVector3d &normal, const LPoint3d &point)
 Constructs a plane given a surface normal vector and a point within the plane.
 Planed (double a, double b, double c, double d)
 Constructs a plane given the four terms of the plane equation.
 Planed (const LVecBase4d &copy)
 Planed (const LPoint3d &a, const LPoint3d &b, const LPoint3d &c)
 Constructs a plane given three counter-clockwise points, as seen from the front of the plane (that is, viewed from the end of the normal vector, looking down).
 Planed (const LPoint3d &a, const LPoint3d &b, const LPoint3d &c)
 Planed (const LVector3d &normal, const LPoint3d &point)
 Planed (double a, double b, double c, double d)
size_t add_hash (size_t hash) const
 Adds the vector into the running hash.
size_t add_hash (size_t hash, double threshold) const
 Adds the vector into the running hash.
void add_to_cell (int i, double value)
void add_w (double value)
void add_x (double value)
void add_y (double value)
void add_z (double value)
bool almost_equal (const LVecBase4d &other, double threshold) const
 Returns true if two vectors are memberwise equal within a specified tolerance.
bool almost_equal (const LVecBase4d &other) const
 Returns true if two vectors are memberwise equal within a default tolerance based on the numeric type.
const_iterator begin () const
 Returns an iterator that may be used to traverse the elements of the matrix, STL-style.
iterator begin ()
 Returns an iterator that may be used to traverse the elements of the matrix, STL-style.
int compare_to (const LVecBase4d &other) const
 This flavor of compare_to uses a default threshold value based on the numeric type.
int compare_to (const LVecBase4d &other, double threshold) const
 Sorts vectors lexicographically, componentwise.
double dist_to_plane (const LPoint3d &point) const
double dist_to_plane (const LPoint3d &point) const
 Returns the straight-line shortest distance from the point to the plane.
double dot (const LVecBase4d &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 (double fill_value)
 Sets each element of the vector to the indicated fill_value.
LVecBase4d fmax (const LVecBase4d &other)
LVecBase4d fmin (const LVecBase4d &other)
void generate_hash (ChecksumHashGenerator &hashgen) const
 Adds the vector to the indicated hash generator.
void generate_hash (ChecksumHashGenerator &hashgen, double threshold) const
 Adds the vector to the indicated hash generator.
double get_cell (int i) const
const double * get_data () const
 Returns the address of the first of the four data elements in the vector.
size_t get_hash () const
 Returns a suitable hash for phash_map.
size_t get_hash (double threshold) const
 Returns a suitable hash for phash_map.
LVector3d get_normal () const
LVector3d get_normal () const
 Returns the surface normal of the plane.
int get_num_components () const
 Returns the number of elements in the vector, four.
LPoint3d get_point () const
LPoint3d get_point () const
 Returns an arbitrary point in the plane.
LMatrix4d get_reflection_mat () const
LMatrix4d get_reflection_mat () const
 This computes a transform matrix that reflects the universe to the other side of the plane, as in a mirror.
double get_w () const
double get_x () const
double get_y () const
double get_z () const
bool intersects_line (LPoint3d &intersection_point, const LPoint3d &p1, const LPoint3d &p2) const
 Returns true if the plane intersects the infinite line passing through points p1 and p2, false if the line is parallel.
bool intersects_line (double &t, const LPoint3d &from, const LVector3d &delta) const
 This flavor of intersects_line() returns a bit more information about the nature of the intersecting point.
bool intersects_line (LPoint3d &intersection_point, const LPoint3d &p1, const LPoint3d &p2) const
bool intersects_line (double &t, const LPoint3d &from, const LVector3d &delta) const
bool intersects_parabola (double &t1, double &t2, const Parabolad &parabola) const
 Determines whether and where the indicated parabola intersects with the plane.
bool intersects_parabola (double &t1, double &t2, const Parabolad &parabola) const
bool intersects_plane (LPoint3d &from, LVector3d &delta, const Planed &other) const
 Returns true if the two planes intersect, false if they do not.
bool intersects_plane (LPoint3d &from, LVector3d &delta, const Planed &other) const
bool is_nan () const
 Returns true if any component of the vector is not-a-number, false otherwise.
double length () const
 Returns the length of the vector, by the Pythagorean theorem.
double length_squared () const
 Returns the square of the vector's length, cheap and easy.
bool normalize ()
 Normalizes the vector in place.
bool operator!= (const LVecBase4d &other) const
Planed operator* (const LMatrix3d &mat) const
 Transforms the plane by the indicated matrix.
LVecBase4d operator* (double scalar) const
Planed operator* (const LMatrix3d &mat) const
Planed operator* (const LMatrix4d &mat) const
Planed operator* (const LMatrix4d &mat) const
 Transforms the plane by the indicated matrix.
void operator*= (const LMatrix4d &mat)
 Transforms the plane by the indicated matrix.
void operator*= (double scalar)
void operator*= (const LMatrix4d &mat)
LVecBase4d operator+ (const LVecBase4d &other) const
void operator+= (const LVecBase4d &other)
LVecBase4d operator- (const LVecBase4d &other) const
Planed operator- () const
 Returns the same plane facing the opposite direction.
Planed operator- () const
void operator-= (const LVecBase4d &other)
LVecBase4d operator/ (double scalar) const
void operator/= (double scalar)
bool operator< (const LVecBase4d &other) const
 This performs a lexicographical comparison.
bool operator== (const LVecBase4d &other) const
double & operator[] (int i)
double operator[] (int i) const
void output (ostream &out) const
void output (ostream &out) const
LPoint3d project (const LPoint3d &point) const
 Returns the point within the plane nearest to the indicated point in space.
LPoint3d project (const LPoint3d &point) const
LVecBase4d project (const LVecBase4d &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.
void set (double x, double y, double z, double w)
void set_cell (int i, double value)
void set_w (double value)
void set_x (double value)
void set_y (double value)
void set_z (double value)
void write (ostream &out, int indent_level=0) const
void write (ostream &out, int indent_level=0) const
void write_datagram (Datagram &destination) const
 Function to write itself into a datagram.
void xform (const LMatrix4d &mat)
 Transforms the plane by the indicated matrix.
void xform (const LMatrix4d &mat)

Static Public Member Functions

static TypeHandle get_class_type ()
static void init_type ()
static int size ()
 Returns 4: the number of components of a LVecBase4.
static const LVecBase4dunit_w ()
 Returns a unit W vector.
static const LVecBase4dunit_x ()
 Returns a unit X vector.
static const LVecBase4dunit_y ()
 Returns a unit Y vector.
static const LVecBase4dunit_z ()
 Returns a unit Z vector.
static const LVecBase4dzero ()
 Returns a zero-length vector.

Public Attributes

union {
   double   data [4]
   struct {
      double   _0
      double   _1
      double   _2
      double   _3
   }   v
_v

Detailed Description

An abstract mathematical description of a plane.

A plane is defined by the equation Ax + By + Cz + D = 0.

Definition at line 49 of file plane.h.


Constructor & Destructor Documentation

Planed::Planed ( ) [inline]

Creates a default plane.

This plane happens to intersect the origin, perpendicular to the Z axis. It's not clear how useful a default plane is.

Definition at line 119 of file plane.h.

Planed::Planed ( const LPoint3d a,
const LPoint3d b,
const LPoint3d c 
) [inline]

Constructs a plane given three counter-clockwise points, as seen from the front of the plane (that is, viewed from the end of the normal vector, looking down).

Definition at line 146 of file plane.h.

Planed::Planed ( const LVector3d normal,
const LPoint3d point 
) [inline]

Constructs a plane given a surface normal vector and a point within the plane.

Definition at line 165 of file plane.h.

Planed::Planed ( double  a,
double  b,
double  c,
double  d 
) [inline]

Constructs a plane given the four terms of the plane equation.

Definition at line 182 of file plane.h.


Member Function Documentation

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

Adds the vector into the running hash.

Definition at line 2022 of file lvecBase4.h.

size_t LVecBase4d::add_hash ( size_t  hash,
double  threshold 
) const [inline, inherited]

Adds the vector into the running hash.

Definition at line 2033 of file lvecBase4.h.

bool LVecBase4d::almost_equal ( const LVecBase4d other,
double  threshold 
) const [inline, inherited]

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

Definition at line 2194 of file lvecBase4.h.

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

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

Definition at line 2209 of file lvecBase4.h.

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

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

Definition at line 1781 of file lvecBase4.h.

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

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

Definition at line 1803 of file lvecBase4.h.

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

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

Definition at line 1962 of file lvecBase4.h.

Referenced by EggVertex::compare_to().

int LVecBase4d::compare_to ( const LVecBase4d other,
double  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 1977 of file lvecBase4.h.

double Planed::dist_to_plane ( const LPoint3d point) const [inline]

Returns the straight-line shortest distance from the point to the plane.

The returned value is positive if the point is in front of the plane (on the side with the normal), or negative in the point is behind the plane (on the opposite side from the normal). It's zero if the point is exactly in the plane.

Definition at line 261 of file plane.h.

Referenced by EggPolygon::is_planar().

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

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

Definition at line 1792 of file lvecBase4.h.

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

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

Definition at line 1814 of file lvecBase4.h.

void LVecBase4d::fill ( double  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 1826 of file lvecBase4.h.

void LVecBase4d::generate_hash ( ChecksumHashGenerator hashgen) const [inline, inherited]

Adds the vector to the indicated hash generator.

Definition at line 2249 of file lvecBase4.h.

void LVecBase4d::generate_hash ( ChecksumHashGenerator hashgen,
double  threshold 
) const [inline, inherited]

Adds the vector to the indicated hash generator.

Definition at line 2260 of file lvecBase4.h.

const double * LVecBase4d::get_data ( ) const [inline, inherited]

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

The remaining elements occupy the next positions consecutively in memory.

Definition at line 1760 of file lvecBase4.h.

Referenced by XFileDataObject::set().

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

Returns a suitable hash for phash_map.

Definition at line 2000 of file lvecBase4.h.

size_t LVecBase4d::get_hash ( double  threshold) const [inline, inherited]

Returns a suitable hash for phash_map.

Definition at line 2011 of file lvecBase4.h.

LVector3d Planed::get_normal ( ) const [inline]

Returns the surface normal of the plane.

Definition at line 246 of file plane.h.

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

Returns the number of elements in the vector, four.

Definition at line 1770 of file lvecBase4.h.

LPoint3d Planed::get_point ( ) const

Returns an arbitrary point in the plane.

This can be used along with the normal returned by get_normal() to reconstruct the plane.

Definition at line 66 of file plane.cxx.

LMatrix4d Planed::get_reflection_mat ( ) const

This computes a transform matrix that reflects the universe to the other side of the plane, as in a mirror.

Definition at line 41 of file plane.cxx.

bool Planed::intersects_line ( double &  t,
const LPoint3d from,
const LVector3d delta 
) const [inline]

This flavor of intersects_line() returns a bit more information about the nature of the intersecting point.

The line is defined via the parametric equation from + t * delta for all real values of t.

If there is no intersection with the plane, the function returns false and leaves t undefined. If there is an intersection with the plane, the function returns true and sets t to the parametric value that defines the point of intersection. That is, t == 0.0f implies that the intersection occurred exactly at point from, and t == 1.0f implies at point from + delta, with other values of t accordingly.

Definition at line 316 of file plane.h.

bool Planed::intersects_line ( LPoint3d intersection_point,
const LPoint3d p1,
const LPoint3d p2 
) const [inline]

Returns true if the plane intersects the infinite line passing through points p1 and p2, false if the line is parallel.

The points p1 and p2 are used only to define the Euclidean line; they have no other bearing on the intersection test. If true, sets intersection_point to the point of intersection.

Definition at line 287 of file plane.h.

bool Planed::intersects_parabola ( double &  t1,
double &  t2,
const Parabolad parabola 
) const

Determines whether and where the indicated parabola intersects with the plane.

If there is no intersection with the plane, the function returns false and leaves t1 and t2 undefined. If there is an intersection with the plane, the function returns true and sets t1 and t2 to the parametric value that defines the two points of intersection. If the parabola is exactly tangent to the plane, then t1 == t2.

Definition at line 134 of file plane.cxx.

bool Planed::intersects_plane ( LPoint3d from,
LVector3d delta,
const Planed other 
) const

Returns true if the two planes intersect, false if they do not.

If they do intersect, then from and delta are filled in with the parametric representation of the line of intersection: that is, from is a point on that line, and delta is a vector showing the direction of the line.

Definition at line 92 of file plane.cxx.

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

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

Definition at line 1594 of file lvecBase4.h.

double LVecBase4d::length ( ) const [inline, inherited]

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

Definition at line 1855 of file lvecBase4.h.

double LVecBase4d::length_squared ( ) const [inline, inherited]

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

Definition at line 1866 of file lvecBase4.h.

bool LVecBase4d::normalize ( ) [inline, inherited]

Normalizes the vector in place.

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

Reimplemented in LQuaterniond.

Definition at line 1878 of file lvecBase4.h.

Planed Planed::operator* ( const LMatrix4d mat) const [inline]

Transforms the plane by the indicated matrix.

Definition at line 204 of file plane.h.

Planed Planed::operator* ( const LMatrix3d mat) const [inline]

Transforms the plane by the indicated matrix.

Definition at line 193 of file plane.h.

void Planed::operator*= ( const LMatrix4d mat) [inline]

Transforms the plane by the indicated matrix.

Definition at line 216 of file plane.h.

Planed Planed::operator- ( ) const [inline]

Returns the same plane facing the opposite direction.

Reimplemented from LVecBase4d.

Definition at line 236 of file plane.h.

bool LVecBase4d::operator< ( const LVecBase4d 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 1926 of file lvecBase4.h.

LVecBase4d LVecBase4d::project ( const LVecBase4d onto) const [inline, inherited]

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 LPoint4d, and LVector4d.

Definition at line 1912 of file lvecBase4.h.

LPoint3d Planed::project ( const LPoint3d point) const [inline]

Returns the point within the plane nearest to the indicated point in space.

Definition at line 272 of file plane.h.

void LVecBase4d::read_datagram ( DatagramIterator source) [inline, inherited]

Function to read itself from a datagramIterator.

Definition at line 2294 of file lvecBase4.h.

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

Returns 4: the number of components of a LVecBase4.

Definition at line 1583 of file lvecBase4.h.

const LVecBase4d & LVecBase4d::unit_w ( ) [inline, static, inherited]

Returns a unit W vector.

Reimplemented in LPoint4d, and LVector4d.

Definition at line 1538 of file lvecBase4.h.

const LVecBase4d & LVecBase4d::unit_x ( ) [inline, static, inherited]

Returns a unit X vector.

Reimplemented in LPoint4d, and LVector4d.

Definition at line 1508 of file lvecBase4.h.

const LVecBase4d & LVecBase4d::unit_y ( ) [inline, static, inherited]

Returns a unit Y vector.

Reimplemented in LPoint4d, and LVector4d.

Definition at line 1518 of file lvecBase4.h.

const LVecBase4d & LVecBase4d::unit_z ( ) [inline, static, inherited]

Returns a unit Z vector.

Reimplemented in LPoint4d, and LVector4d.

Definition at line 1528 of file lvecBase4.h.

void LVecBase4d::write_datagram ( Datagram destination) const [inline, inherited]

Function to write itself into a datagram.

Definition at line 2274 of file lvecBase4.h.

void Planed::xform ( const LMatrix4d mat) [inline]

Transforms the plane by the indicated matrix.

Definition at line 226 of file plane.h.

const LVecBase4d & LVecBase4d::zero ( ) [inline, static, inherited]

Returns a zero-length vector.

Reimplemented in LPoint4d, and LVector4d.

Definition at line 1498 of file lvecBase4.h.

Referenced by PNMImage::get_average_xel_a().


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