Panda3D
Public Member Functions | Static Public Member Functions

Plane Class Reference

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

Inheritance diagram for Plane:
VBase4

List of all members.

Public Member Functions

 Plane ()
 Creates a default plane.
 Plane (Point3 const a, Point3 const b, Point3 const 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).
 Plane (Vec3 const normal, Point3 const point)
 Constructs a plane given a surface normal vector and a point within the plane.
 Plane (float a, float b, float c, float d)
 Constructs a plane given the four terms of the plane equation.
 Plane (VBase4 const copy)
unsigned int addHash (unsigned int hash)
 Adds the vector into the running hash.
unsigned int addHash (unsigned int hash, float threshold)
 Adds the vector into the running hash.
 addToCell (int i, float value)
 addW (float value)
 addX (float value)
 addY (float value)
 addZ (float value)
bool almostEqual (VBase4 const other)
 Returns true if two vectors are memberwise equal within a default tolerance based on the numeric type.
bool almostEqual (VBase4 const other, float threshold)
 Returns true if two vectors are memberwise equal within a specified tolerance.
int compareTo (VBase4 const other, float threshold)
 Sorts vectors lexicographically, componentwise.
int compareTo (VBase4 const other)
 This flavor of compare_to uses a default threshold value based on the numeric type.
float distToPlane (Point3 const point)
 Returns the straight-line shortest distance from the point to the plane.
float dot (VBase4 const other)
 fill (float fill_value)
 Sets each element of the vector to the indicated fill_value.
VBase4 fmax (VBase4 const other)
VBase4 fmin (VBase4 const other)
PyObject getattr (string attr_name)
 This is used to implement swizzle masks.
float getCell (int i)
 getData ()
 Returns the address of the first of the four data elements in the vector.
unsigned int getHash ()
 Returns a suitable hash for phash_map.
unsigned int getHash (float threshold)
 Returns a suitable hash for phash_map.
Vec3 getNormal ()
 Returns the surface normal of the plane.
int getNumComponents ()
 Returns the number of elements in the vector, four.
Point3 getPoint ()
 Returns an arbitrary point in the plane.
Mat4 getReflectionMat ()
 This computes a transform matrix that reflects the universe to the other side of the plane, as in a mirror.
float getW ()
float getX ()
float getY ()
float getZ ()
bool intersectsLine (Point3 intersection_point, Point3 const p1, Point3 const p2)
 Returns true if the plane intersects the infinite line passing through points p1 and p2, false if the line is parallel.
bool intersectsPlane (Point3 from, Vec3 delta, PlaneBase const other)
 Returns true if the two planes intersect, false if they do not.
bool isNan ()
 Returns true if any component of the vector is not-a-number, false otherwise.
float length ()
 Returns the length of the vector, by the Pythagorean theorem.
float 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!= (VBase4 const other)
VBase4 operator* (float scalar)
PlaneBase operator* (Mat3 const mat)
 Transforms the plane by the indicated matrix.
PlaneBase operator* (Mat4 const mat)
 Transforms the plane by the indicated matrix.
VBase4 operator*= (float scalar)
PlaneBase operator*= (Mat4 const mat)
 Transforms the plane by the indicated matrix.
VBase4 operator+ (VBase4 const other)
VBase4 operator+= (VBase4 const other)
PlaneBase operator- ()
 Returns the same plane facing the opposite direction.
VBase4 operator- (VBase4 const other)
VBase4 operator-= (VBase4 const other)
VBase4 operator/ (float scalar)
VBase4 operator/= (float scalar)
bool operator< (VBase4 const other)
 This performs a lexicographical comparison.
bool operator== (VBase4 const other)
 operator[] (int i)
float operator[] (int i)
 output (ostream out)
VBase4 project (VBase4 const onto)
 Returns a new vector representing the projection of this vector onto another one.
Point3 project (Point3 const point)
 Returns the point within the plane nearest to the indicated point in space.
 pythonRepr (ostream out, string class_name)
PyObject reduce (PyObject self)
 This special Python method is implement to provide support for the pickle module.
 set (float x, float y, float z, float w)
int setattr (PyObject self, string attr_name, PyObject assign)
 This is used to implement write masks.
 setCell (int i, float value)
 setitem (int i, float v)
 setW (float value)
 setX (float value)
 setY (float value)
 setZ (float value)
 write (ostream out)
 write (ostream out, int indent_level)
 xform (Mat4 const mat)
 Transforms the plane by the indicated matrix.

Static Public Member Functions

static TypeHandle getClassType ()
static int size ()
 Returns 4: the number of components of a LVecBase4.
static VBase4 const unitW ()
 Returns a unit W vector.
static VBase4 const unitX ()
 Returns a unit X vector.
static VBase4 const unitY ()
 Returns a unit Y vector.
static VBase4 const unitZ ()
 Returns a unit Z vector.
static VBase4 const zero ()
 Returns a zero-length vector.

Detailed Description

An abstract mathematical description of a plane.

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


Constructor & Destructor Documentation

Plane ( )

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.

Plane ( Point3 const  a,
Point3 const  b,
Point3 const  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).

Plane ( VBase4 const  copy)
Plane ( Vec3 const  normal,
Point3 const  point 
)

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

Plane ( float  a,
float  b,
float  c,
float  d 
)

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


Member Function Documentation

unsigned int addHash ( unsigned int  hash) [inherited]

Adds the vector into the running hash.

unsigned int addHash ( unsigned int  hash,
float  threshold 
) [inherited]

Adds the vector into the running hash.

addToCell ( int  i,
float  value 
) [inherited]
addW ( float  value) [inherited]
addX ( float  value) [inherited]
addY ( float  value) [inherited]
addZ ( float  value) [inherited]
bool almostEqual ( VBase4 const  other) [inherited]

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

bool almostEqual ( VBase4 const  other,
float  threshold 
) [inherited]

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

int compareTo ( VBase4 const  other) [inherited]

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

int compareTo ( VBase4 const  other,
float  threshold 
) [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).

float distToPlane ( Point3 const  point)

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.

float dot ( VBase4 const  other) [inherited]
fill ( float  fill_value) [inherited]

Sets each element of the vector to the indicated fill_value.

This is particularly useful for initializing to zero.

VBase4 fmax ( VBase4 const  other) [inherited]
VBase4 fmin ( VBase4 const  other) [inherited]
PyObject getattr ( string  attr_name) [inherited]

This is used to implement swizzle masks.

Reimplemented in Vec4, and Point4.

float getCell ( int  i) [inherited]
static TypeHandle getClassType ( ) [static, inherited]

Reimplemented in Vec4, Point4, Quat, LRotationf, and LOrientationf.

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

unsigned int getHash ( ) [inherited]

Returns a suitable hash for phash_map.

unsigned int getHash ( float  threshold) [inherited]

Returns a suitable hash for phash_map.

Vec3 getNormal ( )

Returns the surface normal of the plane.

int getNumComponents ( ) [inherited]

Returns the number of elements in the vector, four.

Point3 getPoint ( )

Returns an arbitrary point in the plane.

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

Mat4 getReflectionMat ( )

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

float getW ( ) [inherited]
float getX ( ) [inherited]
float getY ( ) [inherited]
float getZ ( ) [inherited]
bool intersectsLine ( Point3  intersection_point,
Point3 const  p1,
Point3 const  p2 
)

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.

bool intersectsPlane ( Point3  from,
Vec3  delta,
PlaneBase const  other 
)

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.

bool isNan ( ) [inherited]

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

float length ( ) [inherited]

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

float lengthSquared ( ) [inherited]

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

bool normalize ( ) [inherited]

Normalizes the vector in place.

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

Reimplemented in Quat.

operator new ( unsigned int  size) [inherited]
bool operator!= ( VBase4 const  other) [inherited]
VBase4 operator* ( float  scalar) [inherited]

Reimplemented in Vec4, Point4, Quat, and LRotationf.

PlaneBase operator* ( Mat4 const  mat)

Transforms the plane by the indicated matrix.

PlaneBase operator* ( Mat3 const  mat)

Transforms the plane by the indicated matrix.

VBase4 operator*= ( float  scalar) [inherited]
PlaneBase operator*= ( Mat4 const  mat)

Transforms the plane by the indicated matrix.

VBase4 operator+ ( VBase4 const  other) [inherited]

Reimplemented in Vec4, and Point4.

VBase4 operator+= ( VBase4 const  other) [inherited]
VBase4 operator- ( VBase4 const  other) [inherited]

Reimplemented in Vec4, and Point4.

PlaneBase operator- ( )

Returns the same plane facing the opposite direction.

Reimplemented from VBase4.

VBase4 operator-= ( VBase4 const  other) [inherited]
VBase4 operator/ ( float  scalar) [inherited]

Reimplemented in Vec4, Point4, Quat, and LRotationf.

VBase4 operator/= ( float  scalar) [inherited]
bool operator< ( VBase4 const  other) [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().

bool operator== ( VBase4 const  other) [inherited]
operator[] ( int  i) [inherited]
float operator[] ( int  i) [inherited]
output ( ostream  out)

Reimplemented from VBase4.

VBase4 project ( VBase4 const  onto) [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 Vec4, and Point4.

Point3 project ( Point3 const  point)

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

pythonRepr ( ostream  out,
string  class_name 
) [inherited]

Reimplemented in Vec4, and Point4.

PyObject reduce ( PyObject  self) [inherited]

This special Python method is implement to provide support for the pickle module.

set ( float  x,
float  y,
float  z,
float  w 
) [inherited]
int setattr ( PyObject  self,
string  attr_name,
PyObject  assign 
) [inherited]

This is used to implement write masks.

Reimplemented in Vec4, and Point4.

setCell ( int  i,
float  value 
) [inherited]
setitem ( int  i,
float  v 
) [inherited]
setW ( float  value) [inherited]
setX ( float  value) [inherited]
setY ( float  value) [inherited]
setZ ( float  value) [inherited]
static int size ( ) [static, inherited]

Returns 4: the number of components of a LVecBase4.

static VBase4 const unitW ( ) [static, inherited]

Returns a unit W vector.

Reimplemented in Vec4, and Point4.

static VBase4 const unitX ( ) [static, inherited]

Returns a unit X vector.

Reimplemented in Vec4, and Point4.

static VBase4 const unitY ( ) [static, inherited]

Returns a unit Y vector.

Reimplemented in Vec4, and Point4.

static VBase4 const unitZ ( ) [static, inherited]

Returns a unit Z vector.

Reimplemented in Vec4, and Point4.

write ( ostream  out)
write ( ostream  out,
int  indent_level 
)
xform ( Mat4 const  mat)

Transforms the plane by the indicated matrix.

static VBase4 const zero ( ) [static, inherited]

Returns a zero-length vector.

Reimplemented in Vec4, and Point4.

 All Classes Namespaces Functions Variables Enumerations Enumerator Properties