PixelLightAPI  .
Public Member Functions | Protected Member Functions
PLPhysics::Element Class Reference

Abstract PL physics element base class. More...

#include <Element.h>

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

List of all members.

Public Member Functions

PLPHYSICS_API WorldGetWorld () const
 Returns the world this element is in.
virtual PLPHYSICS_API ~Element ()
 Destructor.
virtual PLPHYSICS_API bool IsBody () const =0
 Returns whether or not this is a body.
virtual PLPHYSICS_API bool IsJoint () const =0
 Returns whether or not this is a joint.
virtual PLPHYSICS_API bool IsSensor () const =0
 Returns whether or not this is a sensor.

Protected Member Functions

PLPHYSICS_API Element (World &cWorld)
 Constructor.

Detailed Description

Abstract PL physics element base class.


Constructor & Destructor Documentation

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

Destructor.

Reimplemented from PLCore::Element< Element >.

PLPHYSICS_API PLPhysics::Element::Element ( World cWorld) [protected]

Constructor.

Parameters:
[in]cWorldWorld this element is in

Member Function Documentation

PLPHYSICS_API World& PLPhysics::Element::GetWorld ( ) const

Returns the world this element is in.

Returns:
The world this element is in
virtual PLPHYSICS_API bool PLPhysics::Element::IsBody ( ) const [pure virtual]

Returns whether or not this is a body.

Returns:
'true' if this is a body, else 'false'

Implemented in PLPhysics::Body, PLPhysics::Joint, and PLPhysics::Sensor.

virtual PLPHYSICS_API bool PLPhysics::Element::IsJoint ( ) const [pure virtual]

Returns whether or not this is a joint.

Returns:
'true' if this is a joint, else 'false'

Implemented in PLPhysics::Body, PLPhysics::Joint, and PLPhysics::Sensor.

virtual PLPHYSICS_API bool PLPhysics::Element::IsSensor ( ) const [pure virtual]

Returns whether or not this is a sensor.

Returns:
'true' if this is a sensor, else 'false'

Implemented in PLPhysics::Body, PLPhysics::Joint, and PLPhysics::Sensor.


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