Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::Sphere Class Reference

A sphere primitive, mostly used for bounds checking. More...

#include <OgreSphere.h>

List of all members.

Public Methods

 Sphere ()
 Standard constructor - creates a unit sphere around the origin.

 Sphere (const Vector3 &center, Real radius)
 Constructor allowing arbitrary spheres.

Real getRadius (void) const
 Returns the radius of the sphere.

void setRadius (Real radius)
 Sets the radius of the sphere.

const Vector3getCenter (void) const
 Returns the center point of the sphere.

void setCenter (const Vector3 &center)
 Sets the center point of the sphere.

bool intersects (const Sphere &s) const
 Returns whether or not this sphere interects another sphere.

bool intersects (const AxisAlignedBox &box) const
 Returns whether or not this sphere interects a box.

bool intersects (const Plane &plane) const
 Returns whether or not this sphere interects a plane.

bool intersects (const Vector3 &v) const
 Returns whether or not this sphere interects a point.


Protected Attributes

Real mRadius
Vector3 mCenter


Detailed Description

A sphere primitive, mostly used for bounds checking.

Remarks:
A sphere in math texts is normally represented by the function x^2 + y^2 + z^2 = r^2 (for sphere's centered on the origin). Ogre stores spheres simply as a center point and a radius.

Definition at line 42 of file OgreSphere.h.


Constructor & Destructor Documentation

Ogre::Sphere::Sphere  
 

Standard constructor - creates a unit sphere around the origin.

Definition at line 49 of file OgreSphere.h.

Ogre::Sphere::Sphere const Vector3   center,
Real    radius
 

Constructor allowing arbitrary spheres.

Parameters:
center  The center point of the sphere.
radius  The radius of the sphere.

Definition at line 54 of file OgreSphere.h.

References Ogre::Real.


Member Function Documentation

const Vector3& Ogre::Sphere::getCenter void    const
 

Returns the center point of the sphere.

Definition at line 64 of file OgreSphere.h.

Referenced by Ogre::intersect(), Ogre::PlaneBoundedVolume::intersects(), Ogre::Math::intersects(), Ogre::Frustum::isVisible(), and Ogre::Frustum::projectSphere().

Real Ogre::Sphere::getRadius void    const
 

Returns the radius of the sphere.

Definition at line 58 of file OgreSphere.h.

References Ogre::Real.

Referenced by Ogre::intersect(), Ogre::PlaneBoundedVolume::intersects(), Ogre::Math::intersects(), Ogre::Frustum::isVisible(), Ogre::Frustum::projectSphere(), and Ogre::SceneManager::ShadowCasterSceneQueryListener::queryResult().

bool Ogre::Sphere::intersects const Vector3   v const
 

Returns whether or not this sphere interects a point.

Definition at line 86 of file OgreSphere.h.

bool Ogre::Sphere::intersects const Plane   plane const
 

Returns whether or not this sphere interects a plane.

Definition at line 81 of file OgreSphere.h.

bool Ogre::Sphere::intersects const AxisAlignedBox   box const
 

Returns whether or not this sphere interects a box.

Definition at line 76 of file OgreSphere.h.

bool Ogre::Sphere::intersects const Sphere &    s const
 

Returns whether or not this sphere interects another sphere.

Definition at line 70 of file OgreSphere.h.

References Ogre::Vector3::length(), mCenter, and mRadius.

Referenced by Ogre::DefaultSphereSceneQuery::execute().

void Ogre::Sphere::setCenter const Vector3   center
 

Sets the center point of the sphere.

Definition at line 67 of file OgreSphere.h.

Referenced by Ogre::BillboardSet::billboardVisible(), Ogre::DefaultSphereSceneQuery::execute(), Ogre::SceneManager::findLightsAffectingFrustum(), and Ogre::MovableObject::getWorldBoundingSphere().

void Ogre::Sphere::setRadius Real    radius
 

Sets the radius of the sphere.

Definition at line 61 of file OgreSphere.h.

References Ogre::Real.

Referenced by Ogre::BillboardSet::billboardVisible(), Ogre::DefaultSphereSceneQuery::execute(), Ogre::SceneManager::findLightsAffectingFrustum(), and Ogre::MovableObject::getWorldBoundingSphere().


Member Data Documentation

Vector3 Ogre::Sphere::mCenter [protected]
 

Definition at line 46 of file OgreSphere.h.

Referenced by intersects().

Real Ogre::Sphere::mRadius [protected]
 

Definition at line 45 of file OgreSphere.h.

Referenced by intersects().


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

Copyright © 2002-2003 by The OGRE Team
Last modified Fri May 14 23:27:18 2004