PixelLightAPI  .
Public Member Functions | Protected Member Functions | Protected Attributes
PLPhysics::BodyCone Class Reference

Abstract PL physics cone body. More...

#include <BodyCone.h>

Inheritance diagram for PLPhysics::BodyCone:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual PLPHYSICS_API ~BodyCone ()
 Destructor.
PLPHYSICS_API float GetRadius () const
 Returns the cone radius at the base.
PLPHYSICS_API float GetHeight () const
 Returns the cone height along the x local axis from base to top.

Protected Member Functions

PLPHYSICS_API BodyCone (World &cWorld, BodyImpl &cBodyImpl, float fRadius, float fHeight)
 Constructor.

Protected Attributes

float m_fRadius
float m_fHeight

Detailed Description

Abstract PL physics cone body.

Note:
  • The cone height must equal of larger than the sum of the cap radius. If this is not the case the height will be clamped the 2 * radius.

Constructor & Destructor Documentation

virtual PLPHYSICS_API PLPhysics::BodyCone::~BodyCone ( ) [virtual]

Destructor.

PLPHYSICS_API PLPhysics::BodyCone::BodyCone ( World cWorld,
BodyImpl &  cBodyImpl,
float  fRadius,
float  fHeight 
) [protected]

Constructor.

Parameters:
[in]cWorldWorld this body is in
[in]cBodyImplReference to the physics API specific body implementation
[in]fRadiusCone radius at the base
[in]fHeightCone height along the x local axis from base to top

Member Function Documentation

PLPHYSICS_API float PLPhysics::BodyCone::GetRadius ( ) const

Returns the cone radius at the base.

Returns:
The cone radius at the base
PLPHYSICS_API float PLPhysics::BodyCone::GetHeight ( ) const

Returns the cone height along the x local axis from base to top.

Returns:
The cone height along the x local axis from base to top

Member Data Documentation

float PLPhysics::BodyCone::m_fRadius [protected]

Cone radius at the base

float PLPhysics::BodyCone::m_fHeight [protected]

Cone height along the x local axis from base to top


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:21
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported