A class that represents a bounding cone for a spot light's area of effect. More...

#include <omGraphicsBoundingCone.h>

Public Member Functions
	BoundingCone (const Vector3 &newVertex, const Vector3 &newAxis, Real newTheta, Real newHeight)
	Create a BoundingCone object with the specified vertex, axis direction, half angle, and height. More...

const Vector3 &	getVertex () const
	Get the position of the vertex (tip) of the cone. More...

void	setVertex (const Vector3 &newVertex)
	Set the position of the vertex (tip) of the cone. More...

const Vector3 &	getAxis () const
	Get the normalized direction of the cone's axis from the vertex to the base's center. More...

void	setAxis (const Vector3 &newAxis)
	Set the normalized direction of the cone's axis from the vertex to the base's center. More...

Real	getHeight () const
	Get the extent of the cone from the base's center along the cone's axis. More...

void	setHeight (Real newHeight)
	Set the extent of the cone from the base's center along the cone's axis. More...

Real	getHalfAngle () const
	Get the angle in radians between the the cone's axis and the side of the cone. More...

void	setHalfAngle (Real newHalfAngle)
	Set the angle in radians between the the cone's axis and the side of the cone. More...

Real	getSineHalfAngle () const
	Get the sine of the angle in radians between the the cone's axis and the side of the cone. More...

Real	getCosineHalfAngle () const
	Get the cosine of the angle in radians between the the cone's axis and the side of the cone. More...

Bool	intersects (const Sphere3f &sphere) const
	Return whether or not this BoundingCone intersects the specified BoundingSphere. More...

Detailed Description

A class that represents a bounding cone for a spot light's area of effect.

Constructor & Destructor Documentation

om::graphics::base::BoundingCone::BoundingCone	(	const Vector3 &	newVertex,
		const Vector3 &	newAxis,
		Real	newTheta,
		Real	newHeight
	)

inline

Create a BoundingCone object with the specified vertex, axis direction, half angle, and height.

const Vector3& om::graphics::base::BoundingCone::getVertex ( ) const

inline

Get the position of the vertex (tip) of the cone.

void om::graphics::base::BoundingCone::setVertex ( const Vector3 & newVertex )

inline

Set the position of the vertex (tip) of the cone.

const Vector3& om::graphics::base::BoundingCone::getAxis ( ) const

inline

Get the normalized direction of the cone's axis from the vertex to the base's center.

void om::graphics::base::BoundingCone::setAxis ( const Vector3 & newAxis )

inline

Set the normalized direction of the cone's axis from the vertex to the base's center.

Real om::graphics::base::BoundingCone::getHeight ( ) const

inline

Get the extent of the cone from the base's center along the cone's axis.

void om::graphics::base::BoundingCone::setHeight ( Real newHeight )

inline

Set the extent of the cone from the base's center along the cone's axis.

Real om::graphics::base::BoundingCone::getHalfAngle ( ) const

inline

Get the angle in radians between the the cone's axis and the side of the cone.

void om::graphics::base::BoundingCone::setHalfAngle ( Real newHalfAngle )

inline

Set the angle in radians between the the cone's axis and the side of the cone.

Real om::graphics::base::BoundingCone::getSineHalfAngle ( ) const

inline

Get the sine of the angle in radians between the the cone's axis and the side of the cone.

Real om::graphics::base::BoundingCone::getCosineHalfAngle ( ) const

inline

Get the cosine of the angle in radians between the the cone's axis and the side of the cone.

Bool om::graphics::base::BoundingCone::intersects ( const Sphere3f & sphere ) const

inline

Return whether or not this BoundingCone intersects the specified BoundingSphere.

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