Plane Class Reference

Representation of a unit plane in the y=0 plane from (-.5,0,-.5) to (.5,0,.5). More...

#include <Plane.h>

Inheritance diagram for Plane:

Implicit Transformable Shape Intersectable SSEAligned

List of all members.

Public Member Functions

Initialization routines
virtual void init ()
 Precomputes world-space surface area.
Intersection routines
virtual real_t getIntersection (const Ray &ray, SurfacePoint &pt)
 Tests the given ray with this object for intersection. If a valid intersection exists, its "t" value will be returned and the given SurfacePoint will be initialized with enough data for this object to later fill in all relevant information lazily (world space normal at intersection point, uv coordinates, etc.).
virtual bool intersects (const Ray &ray, real_t tMax=INFINITY)
 Used for occlusion/visibility testing where you don't necessarily care about anything other than whether or not an intersection exists. (generally faster than getIntersection).
Core functionality
virtual void preview ()
Sampling functionality
virtual Point3 getPosition (const UV &uv)

Protected Member Functions

virtual void _getUV (SurfacePoint &pt) const
virtual void _getGeometricNormal (SurfacePoint &pt) const
virtual real_t _getSurfaceArea ()


Detailed Description

Representation of a unit plane in the y=0 plane from (-.5,0,-.5) to (.5,0,.5).

Author:
Travis Fischer (fisch0920@gmail.com)

Matthew Jacobs (jacobs.mh@gmail.com)

Date:
Fall 2008

Definition at line 17 of file Plane.h.


Member Function Documentation

void Plane::init (  )  [virtual]

Precomputes world-space surface area.

Reimplemented from Implicit.

Definition at line 18 of file Plane.cpp.

real_t Plane::getIntersection ( const Ray ray,
SurfacePoint pt 
) [virtual]

Tests the given ray with this object for intersection. If a valid intersection exists, its "t" value will be returned and the given SurfacePoint will be initialized with enough data for this object to later fill in all relevant information lazily (world space normal at intersection point, uv coordinates, etc.).

Note:
if you only care about whether or not an intersection exists and don't actually need to know the exact intersection point, see the intersects method instead.
Returns:
the smallest positive "t" value of any intersections found, or INFINITY if no valid intersection exists

Implements Intersectable.

Definition at line 24 of file Plane.cpp.

bool Plane::intersects ( const Ray ray,
real_t  tMax = INFINITY 
) [virtual]

Used for occlusion/visibility testing where you don't necessarily care about anything other than whether or not an intersection exists. (generally faster than getIntersection).

Note:
default implementation defers to getIntersection
Returns:
whether or not the given ray intersects this object with a positive "t" value greater than EPSILON and less than the given tMax

Reimplemented from Intersectable.

Definition at line 39 of file Plane.cpp.

void Plane::preview (  )  [virtual]

Display a crude OpenGL preview of this shape

Note:
Default implementation sets the ModelView matrix appropriately with respect to this Transformable's transformation

Reimplemented from Transformable.

Definition at line 66 of file Plane.cpp.

Point3 Plane::getPosition ( const UV uv  )  [virtual]

Returns:
the point on the surface of this shape corresponding to the given UV coordinates

Reimplemented from Transformable.

Definition at line 90 of file Plane.cpp.

void Plane::_getUV ( SurfacePoint pt  )  const [protected, virtual]

Implements Shape.

Definition at line 51 of file Plane.cpp.

void Plane::_getGeometricNormal ( SurfacePoint pt  )  const [protected, virtual]

Implements Shape.

Definition at line 60 of file Plane.cpp.

real_t Plane::_getSurfaceArea (  )  [protected, virtual]

Returns:
the total surface area of this shape in world-space

Reimplemented from Shape.

Definition at line 94 of file Plane.cpp.


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

Generated on 28 Feb 2009 for Milton by doxygen 1.5.6