PixelLightAPI  .
Public Member Functions
PLMath::Sphere Class Reference

Sphere class. More...

#include <Sphere.h>

List of all members.

Public Member Functions

PLMATH_API Sphere ()
 Default constructor setting all position components and the radius to 0.
PLMATH_API Sphere (const Sphere &cSource)
 Copy constructor.
PLMATH_API ~Sphere ()
 Destructor.
PLMATH_API Sphereoperator= (const Sphere &cSource)
 Copy operator.
PLMATH_API float GetRadius () const
 Returns the radius of the sphere.
PLMATH_API void SetRadius (float fRadius=0.0f)
 Sets the radius of the sphere.
PLMATH_API const Vector3GetPos () const
 Returns the current position.
PLMATH_API void SetPos (float fX=0.0f, float fY=0.0f, float fZ=0.0f)
 Set the current position.
PLMATH_API void SetPos (const Vector3 &vPos)
 Set the current position.

Detailed Description

Sphere class.


Constructor & Destructor Documentation

PLMATH_API PLMath::Sphere::Sphere ( )

Default constructor setting all position components and the radius to 0.

PLMATH_API PLMath::Sphere::Sphere ( const Sphere cSource)

Copy constructor.

Parameters:
[in]cSourceSource to copy from
PLMATH_API PLMath::Sphere::~Sphere ( )

Destructor.


Member Function Documentation

PLMATH_API Sphere& PLMath::Sphere::operator= ( const Sphere cSource)

Copy operator.

Parameters:
[in]cSourceSource to copy from
Returns:
Reference to this instance
PLMATH_API float PLMath::Sphere::GetRadius ( ) const

Returns the radius of the sphere.

Returns:
Sphere radius
PLMATH_API void PLMath::Sphere::SetRadius ( float  fRadius = 0.0f)

Sets the radius of the sphere.

Parameters:
[in]fRadiusSphere radius
PLMATH_API const Vector3& PLMath::Sphere::GetPos ( ) const

Returns the current position.

Returns:
Current position
PLMATH_API void PLMath::Sphere::SetPos ( float  fX = 0.0f,
float  fY = 0.0f,
float  fZ = 0.0f 
)

Set the current position.

Parameters:
[in]fXX component of the new position
[in]fYY component of the new position
[in]fZZ component of the new position
PLMATH_API void PLMath::Sphere::SetPos ( const Vector3 vPos)

Set the current position.

Parameters:
[in]vPosNew position

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


PixelLight PixelLight 0.9.10-R1
Copyright (C) 2002-2011 by The PixelLight Team
Last modified Fri Dec 23 2011 15:51:20
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported