esg::Sphere

Sphere Class Reference

#include <Sphere.h>

Inheritance diagram for Sphere:

Geometry ESGObject Hemisphere List of all members.

Public Member Functions

 Sphere ()
 Sphere (const Vector3 &c, float r)
 Sphere (float x, float y, float z, float r)
 Sphere (const Geometry &g)
 Sphere (const Geometry &g1, const Geometry &g2)
 Sphere (SceneGraphObject &obj)
 Sphere (List< SceneGraphObject > &list)
virtual void rayIntersection (PointEnv *pPE, int mask, const Vector3 &origin, const Vector3 &direction, float maxD=MAXFLOAT)
virtual bool mapToUV (const Vector3 &v, Vector2 &uv)
virtual void randomSample (int mask, PointEnv &pe, double *pdf)
virtual bool randomDirection (const Vector3 &pov, Vector3 &dir, double *pdf)
virtual Interval extent (const Vector3 &direction) const
virtual Vector3 centroid (void) const
virtual double radius (void) const
virtual double radius (const Vector3 &centroid) const
virtual Geometry * clone (const Matrix4 *pTrMat) const
virtual bool separation (Geometry &geom, Vector3 *pDir)
virtual double distance (const Geometry &geom, Vector3 *pDir)
virtual void dump (const char *intent, const char *tab)
Vector3 centre (void) const
void setCentre (const Vector3 &)
void setCentre (float x, float y, float z)
void setRadius (float radius)
virtual void __debug ()
void insideOut (bool b)
Interval extent (float x, float y, float z) const
Geometry * clone (void) const
Mesh * mesh (int density=0) const

Static Public Attributes

static const float EPS = 1e-03
 epsilon variation (tolerance) of zero

Protected Member Functions

virtual Mesh * _mesh (int) const
virtual void _duplicate_attributes (const Geometry &)
virtual void _rotateX (float)
virtual void _rotateY (float)
virtual void _rotateZ (float)
virtual void _rotate (float, const Vector3 &)
virtual void _rotate (const Matrix3 &)
virtual void _translate (float, float, float)
virtual void _transform (const Matrix4 &)
virtual void _scale (float)
void _translate (const Vector3 &v)

Protected Attributes

float _radius
float _radius2
 _radius^2
double _epsPlus
 (_radius + Geometry::EPS)^2
double _epsMinus
 (_radius - Geometry::EPS)^2
Vector3 _centre
bool _insideOut

Detailed Description

Sphere

Definition at line 15 of file Sphere.h.

Constructor & Destructor Documentation

Sphere (   ) 
 

Constructor - unit sphere with center in the origin

Definition at line 83 of file Sphere.cc.

References Sphere::_centre, Sphere::_epsMinus, Sphere::_epsPlus, Sphere::_radius, Sphere::_radius2, and Geometry::EPS.

Referenced by Sphere::clone().

Sphere (  const Vector3 &  c,
float  r
) 
 

Constructor

Parameters:
c centre
r radius

Definition at line 92 of file Sphere.cc.

References Sphere::_centre, Sphere::_epsMinus, Sphere::_epsPlus, Sphere::_radius, Sphere::_radius2, and Geometry::EPS.

Sphere (  float  x,
float  y,
float  z,
float  r
) 
 

Constructor

Parameters:
x x coordinate of centre
y y coordinate of centre
z z coordinate of centre
r radius

Definition at line 102 of file Sphere.cc.

References Sphere::_centre, Sphere::_epsMinus, Sphere::_epsPlus, Sphere::_radius, Sphere::_radius2, and Geometry::EPS.

Sphere (  const Geometry &  g  ) 
 

Constructor - sphere packing some geometry

Parameters:
g geometry

Definition at line 111 of file Sphere.cc.

References Sphere::_centre, Sphere::_epsMinus, Sphere::_epsPlus, Sphere::_radius, Sphere::_radius2, Geometry::centroid(), Geometry::EPS, and Geometry::radius().

Sphere (  const Geometry &  g1,
const Geometry &  g2
) 
 

Constructor - sphere packing two geometries

Parameters:
g1 first geometry
g1 second geometry

Definition at line 120 of file Sphere.cc.

References Sphere::_centre, Sphere::_epsMinus, Sphere::_epsPlus, Sphere::_radius, Sphere::_radius2, Geometry::centroid(), Geometry::EPS, and Geometry::radius().

Sphere (  SceneGraphObject &  obj  ) 
 

Constructor - sphere packing SG object

Parameters:
obj scene graph object

Definition at line 151 of file Sphere.cc.

References Sphere::_centre, Sphere::_epsMinus, Sphere::_epsPlus, Sphere::_radius, Sphere::_radius2, Geometry::EPS, Explorer::explore(), RadiusExplorer::result(), and POGExplorer::result().

Sphere (  List< SceneGraphObject > &  list  ) 
 

Constructor - sphere packing many SG objects stored in list

Parameters:
list list of SG objects

Definition at line 167 of file Sphere.cc.

References Sphere::_centre, Sphere::_epsMinus, Sphere::_epsPlus, Sphere::_radius, Sphere::_radius2, Geometry::EPS, Explorer::explore(), List::firstItem(), MAXFLOAT, List::nextItem(), RadiusExplorer::result(), and POGExplorer::result().

Member Function Documentation

virtual void __debug (  void   )  [inline, virtual]
 

For debugging purposes

Reimplemented from Geometry.

Definition at line 145 of file Sphere.h.

void _duplicate_attributes (  const Geometry &   )  [protected, virtual]
 

Reimplemented from Geometry.

Reimplemented in Hemisphere.

Definition at line 19 of file Sphere.cc.

References Sphere::_centre, Sphere::_epsMinus, Sphere::_epsPlus, Sphere::_radius, Sphere::_radius2, and Geometry::EPS.

Referenced by Hemisphere::_duplicate_attributes(), and Sphere::clone().

Mesh * _mesh (  int   )  const [protected, virtual]
 

Implements Geometry.

Reimplemented in Hemisphere.

Definition at line 8 of file Sphere.cc.

References Sphere::_centre, Sphere::_radius, Mesh::scale(), and Mesh::translate().

void _rotate (  const Matrix3 &   )  [protected, virtual]
 

Implements Geometry.

Reimplemented in Hemisphere.

Definition at line 56 of file Sphere.cc.

References Sphere::_centre.

void _rotate (  float  ,
const Vector3 & 
)  [protected, virtual]
 

Implements Geometry.

Reimplemented in Hemisphere.

Definition at line 49 of file Sphere.cc.

References Sphere::_centre.

void _rotateX (  float   )  [protected, virtual]
 

Implements Geometry.

Reimplemented in Hemisphere.

Definition at line 28 of file Sphere.cc.

References Sphere::_centre.

void _rotateY (  float   )  [protected, virtual]
 

Implements Geometry.

Reimplemented in Hemisphere.

Definition at line 35 of file Sphere.cc.

References Sphere::_centre.

void _rotateZ (  float   )  [protected, virtual]
 

Implements Geometry.

Reimplemented in Hemisphere.

Definition at line 42 of file Sphere.cc.

References Sphere::_centre.

void _scale (  float   )  [protected, virtual]
 

Implements Geometry.

Definition at line 71 of file Sphere.cc.

References Sphere::_centre, Sphere::_epsMinus, Sphere::_epsPlus, Sphere::_radius, Sphere::_radius2, and Geometry::EPS.

void _transform (  const Matrix4 &   )  [protected, virtual]
 

Implements Geometry.

Reimplemented in Hemisphere.

Definition at line 66 of file Sphere.cc.

References Sphere::_centre.

Referenced by Sphere::clone().

void _translate (  const Vector3 &  v  )  [inline, protected, inherited]
 

Definition at line 38 of file Geometry.h.

void _translate (  float  ,
float  ,
float 
)  [protected, virtual]
 

Implements Geometry.

Definition at line 61 of file Sphere.cc.

References Sphere::_centre.

Vector3 centre (  void   )  const [inline]
 

Returns:
centre of the sphere

Definition at line 123 of file Sphere.h.

Referenced by POVRayExporter::_write_sphere().

Vector3 centroid (  void   )  const [virtual]
 

Returns:
centroid (point of gravity) of the geometry

Implements Geometry.

Definition at line 400 of file Sphere.cc.

References Sphere::_centre.

Geometry* clone (  void   )  const [inline, inherited]
 

Duplicates geometry

Returns:
duplicate (clone)

Reimplemented in _Surface, and OSGPolygon.

Definition at line 155 of file Geometry.h.

Referenced by BVH::__get_edges(), BVH::__get_meshes(), ObjsInAreaExplorer::_accept_new_transformation(), SphereTree::_enlarge_bv(), FDHTree::_enlarge_bv(), BVExplorer::_iterate(), BVDistRot::BVDistRot(), and ObjsInAreaExplorer::ObjsInAreaExplorer().

Geometry * clone (  const Matrix4 *  pTrMat  )  const [virtual]
 

Duplicates and transforms geometry

Parameters:
pTrMat transformation matrix of the clone or NULL
Returns:
duplicate (clone)

Implements Geometry.

Reimplemented in Hemisphere.

Definition at line 392 of file Sphere.cc.

References Sphere::_duplicate_attributes(), Sphere::_transform(), and Sphere::Sphere().

double distance (  const Geometry &  geom,
Vector3 *  pDir
)  [virtual]
 

Computes approximate distance between this and given geometries (lower bound of distance)

Parameters:
geom geometry to check
pDir if presented then is set to normalized measured direction (vector of minimal distance)
Returns:
lower bound of distance, negative value indicates penetration, positive value indicates separation, zero indicates touch

Implements Geometry.

Reimplemented in Hemisphere.

Definition at line 429 of file Sphere.cc.

References Sphere::_centre, Sphere::_radius, Geometry::centroid(), and Geometry::radius().

Referenced by Cylinder::distance().

void dump (  const char *  intent,
const char *  tab
)  [virtual]
 

Writes information about this geometry to std. out.

Parameters:
intent free space before each line
tab free space added to intent inside description of this class

Implements Geometry.

Reimplemented in Hemisphere.

Definition at line 439 of file Sphere.cc.

References Sphere::_centre, and Sphere::_radius.

Interval extent (  float  x,
float  y,
float  z
)  const [inline, inherited]
 

Returns extent occupied by the geometry in given direction

Parameters:
x direction direction of extent - x coordinate
y direction direction of extent - y coordinate
z direction direction of extent - z coordinate
Returns:
extent of occupied space

Definition at line 124 of file Geometry.h.

Interval extent (  const Vector3 &  direction  )  const [virtual]
 

Returns extent occupied by the geometry in given direction

Parameters:
direction direction of extent
Returns:
extent of occupied space

Implements Geometry.

Reimplemented in Hemisphere.

Definition at line 381 of file Sphere.cc.

References Sphere::_centre, Sphere::_radius, Interval::max, and Interval::min.

void insideOut (  bool  b  )  [inline, inherited]
 

Inverts facet normals (turns the object inside-out)

Parameters:
b determines wehether to turn the geometry inside-out

Definition at line 56 of file Geometry.h.

bool mapToUV (  const Vector3 &  v,
Vector2 &  uv
)  [virtual]
 

Maps 3D point from surface to the UV surface representation

Parameters:
v 3D point in the world coordinates
uv UV coordinates (relative to the surface)
Returns:
true on success, false otherwise (mainly if the 3D point does not lie on the surface)

Implements Geometry.

Reimplemented in Hemisphere.

Definition at line 257 of file Sphere.cc.

References Sphere::_centre, and PI.

Referenced by Sphere::randomSample().

Mesh * mesh (  int  density = 0  )  const [inherited]
 

Returns polygonal mesh computed from this geometry

Parameters:
density mesh density
Returns:
polygonal mesh

Definition at line 24 of file Geometry.cc.

References Geometry::_insideOut, Geometry::_mesh(), and Mesh::turnInsideOut().

Referenced by BVH::__get_edges(), BVH::__get_meshes(), NurbsSurface::_mesh(), and POVRayExporter::_process_leaf().

double radius (  const Vector3 &  centroid  )  const [virtual]
 

Returns radius of minimal packing sphere having given center

Parameters:
centroid center of packing sphere
Returns:
minimal packing radius

Implements Geometry.

Reimplemented in Hemisphere.

Definition at line 410 of file Sphere.cc.

References Sphere::_centre, and Sphere::_radius.

double radius (  void   )  const [virtual]
 

Returns radius of minimal packing sphere with center in the ceontroid of the geometry

Parameters:
centroid center of packing sphere
Returns:
minimal packing radius

Reimplemented from Geometry.

Definition at line 405 of file Sphere.cc.

References Sphere::_radius.

Referenced by POVRayExporter::_write_sphere().

bool randomDirection (  const Vector3 &  pov,
Vector3 &  dir,
double *  pdf
)  [virtual]
 

Computes random direction towards the surface in accord to the point of view.

Parameters:
pov point of view
dir computed random direction
pdf if present then it is set to the value of the Probability Density Function of the random point

Implements Geometry.

Reimplemented in Hemisphere.

Definition at line 337 of file Sphere.cc.

References Sphere::_centre, Sphere::_radius, ESG_DBL_RAND, and M_PI.

void randomSample (  int  mask,
PointEnv &  pe,
double *  pdf
)  [virtual]
 

Computes random point on the surface

Parameters:
mask bitmask determining what to compute, see PointEnv.h
pe information about the computed random point on surface
pdf if present then it is set to the value of the Probability Density Function of the random point

Implements Geometry.

Reimplemented in Hemisphere.

Definition at line 307 of file Sphere.cc.

References Sphere::_centre, Sphere::_radius, Sphere::_radius2, ENV_HAVE_NORMAL, ENV_HAVE_NOTHING, ENV_HAVE_SURFACE_POINT, ENV_HAVE_UV_COORD, ENV_WANT_NORMAL, ENV_WANT_SURFACE_POINT, ENV_WANT_UV_COORD, ESG_DBL_RAND, PointEnv::intersection, M_PI, Sphere::mapToUV(), PointEnv::mask, PointEnv::normal, PointEnv::normalOrientation, PointEnv::OUTWARDS_NORMAL, and PointEnv::uvCoord.

Referenced by PointEmittance::stochasticEmission().

void rayIntersection (  PointEnv *  pPE,
int  mask,
const Vector3 &  origin,
const Vector3 &  direction,
float  maxD = MAXFLOAT
)  [virtual]
 

Computes point of intersection of ray with this geometry

Parameters:
pPE structure in which the information about intersection point is stored; must be defined (not NULL)
mask bitmask determining what to compute, see PointEnv.h
origin ray's origin
direction normalized ray's direction
maxD maximal interesting distance; if the point of intersection can't be closer than this distance then the computation stops (object is too far away)

Implements Geometry.

Reimplemented in Hemisphere.

Definition at line 199 of file Sphere.cc.

References Sphere::_centre, Sphere::_epsMinus, Sphere::_epsPlus, Sphere::_radius, Sphere::_radius2, PointEnv::distance, ENV_HAVE_DISTANCE, ENV_HAVE_INTERFERENCE, ENV_HAVE_INTERSECTION, ENV_HAVE_NORMAL, ENV_HAVE_NOTHING, ENV_HAVE_UV_COORD, ENV_WANT_INTERSECTION, ENV_WANT_NORMAL, ENV_WANT_UV_COORD, Geometry::EPS, PointEnv::intersection, PointEnv::mask, PointEnv::normal, PointEnv::normalOrientation, PointEnv::OUTWARDS_NORMAL, PI, and PointEnv::uvCoord.

bool separation (  Geometry &  geom,
Vector3 *  pDir
)  [virtual]
 

Checks if there is separation between this and given geometries

Parameters:
geom geometry to check
pDir if presented then is set to normalized direction to found separation (gap)
Returns:
true if thre is separation (gap), false otherwise

Implements Geometry.

Reimplemented in Hemisphere.

Definition at line 415 of file Sphere.cc.

References Sphere::_centre, Sphere::_radius, Geometry::centroid(), and Geometry::radius().

void setCentre (  float  x,
float  y,
float  z
) 
 

Parameters:
x new x coord. of the centre
y new y coord. of the centre
z new z coord. of the centre

Definition at line 454 of file Sphere.cc.

References Sphere::_centre.

void setCentre (  const Vector3 &   ) 
 

Parameters:
centre new centre

Definition at line 448 of file Sphere.cc.

References Sphere::_centre.

void setRadius (  float  radius  ) 
 

Parameters:
radius new radius

Definition at line 459 of file Sphere.cc.

References Sphere::_epsMinus, Sphere::_epsPlus, Sphere::_radius, Sphere::_radius2, and Geometry::EPS.

Member Data Documentation

Vector3 _centre [protected]
 

Definition at line 21 of file Sphere.h.

Referenced by Sphere::_duplicate_attributes(), Sphere::_mesh(), Sphere::_rotate(), Hemisphere::_rotate(), Sphere::_rotateX(), Hemisphere::_rotateX(), Sphere::_rotateY(), Hemisphere::_rotateY(), Sphere::_rotateZ(), Hemisphere::_rotateZ(), Sphere::_scale(), Sphere::_transform(), Hemisphere::_transform(), Sphere::_translate(), Sphere::centroid(), Sphere::distance(), Sphere::dump(), Hemisphere::dump(), Sphere::extent(), Sphere::mapToUV(), Sphere::radius(), Sphere::randomDirection(), Sphere::randomSample(), Hemisphere::randomSample(), Sphere::rayIntersection(), Hemisphere::rayIntersection(), Sphere::separation(), Sphere::setCentre(), and Sphere::Sphere().

double _epsMinus [protected]
 

(_radius - Geometry::EPS)^2

Definition at line 20 of file Sphere.h.

Referenced by Sphere::_duplicate_attributes(), Sphere::_scale(), Sphere::rayIntersection(), Hemisphere::rayIntersection(), Sphere::setRadius(), and Sphere::Sphere().

double _epsPlus [protected]
 

(_radius + Geometry::EPS)^2

Definition at line 19 of file Sphere.h.

Referenced by Sphere::_duplicate_attributes(), Sphere::_scale(), Sphere::rayIntersection(), Hemisphere::rayIntersection(), Sphere::setRadius(), and Sphere::Sphere().

bool _insideOut [protected, inherited]
 

Definition at line 23 of file Geometry.h.

Referenced by Geometry::_duplicate_attributes(), and Geometry::mesh().

float _radius [protected]
 

Definition at line 17 of file Sphere.h.

Referenced by Sphere::_duplicate_attributes(), Sphere::_mesh(), Sphere::_scale(), Sphere::distance(), Sphere::dump(), Hemisphere::dump(), Sphere::extent(), Sphere::radius(), Sphere::randomDirection(), Sphere::randomSample(), Hemisphere::randomSample(), Sphere::rayIntersection(), Hemisphere::rayIntersection(), Sphere::separation(), Sphere::setRadius(), and Sphere::Sphere().

float _radius2 [protected]
 

_radius^2

Definition at line 18 of file Sphere.h.

Referenced by Sphere::_duplicate_attributes(), Sphere::_scale(), Sphere::randomSample(), Hemisphere::randomSample(), Sphere::rayIntersection(), Hemisphere::rayIntersection(), Sphere::setRadius(), and Sphere::Sphere().

const float EPS = 1e-03 [static, inherited]
 

epsilon variation (tolerance) of zero

Definition at line 20 of file Geometry.h.

Referenced by FDH::_cut_line(), Sphere::_duplicate_attributes(), FDH::_get_corners(), FDH::_mesh(), Sphere::_scale(), Polygon::_triTriCollision(), Sphere::rayIntersection(), Polygon::rayIntersection(), Point3D::rayIntersection(), Hemisphere::rayIntersection(), Sphere::setRadius(), and Sphere::Sphere().

The documentation for this class was generated from the following files:
Generated on Wed Jun 28 12:24:34 2006 for esg by  doxygen 1.4.6