FCDPASPlane Class Reference
[COLLADA Document Object Model.]

A COLLADA physics plane. More...

#include <FCDPhysicsAnalyticalGeometry.h>

Inheritance diagram for FCDPASPlane:

FCDPhysicsAnalyticalGeometry FCDEntity FCDObjectWithId FCDObject FUParameterizable FUTrackable FUObject List of all members.

Public Member Functions

 FCDPASPlane (FCDocument *document)
 Constructor: do not use directly.
virtual ~FCDPASPlane ()
 Destructor.
virtual GeomType GetGeomType () const
 Retrieves the analytical geometry type for this class.
virtual float CalculateVolume () const
 Calculates the volume of this analytical geometry.
virtual FCDEntityClone (FCDEntity *clone=NULL, bool cloneChildren=false) const
 Copies the physics plane into a clone.

Public Attributes

FMVector3 normal
 The normal for the plane.
float d
 The value that positions the plane.

Detailed Description

A COLLADA physics plane.


Constructor & Destructor Documentation

FCDPASPlane::FCDPASPlane FCDocument document  ) 
 

Constructor: do not use directly.

Create new analytical geometries by using FCDPhysicsShape::CreateAnalyticalGeometry function.

Parameters:
document The COLLADA document that contains this physics plane.


Member Function Documentation

virtual float FCDPASPlane::CalculateVolume  )  const [virtual]
 

Calculates the volume of this analytical geometry.

Returns:
The volume.

Implements FCDPhysicsAnalyticalGeometry.

virtual FCDEntity* FCDPASPlane::Clone FCDEntity clone = NULL,
bool  cloneChildren = false
const [virtual]
 

Copies the physics plane into a clone.

Parameters:
clone The empty clone. If this pointer is NULL, a analytical geometry will be created and you will need to release the returned pointer manually.
cloneChildren Whether to recursively clone this entity's children.
Returns:
The clone.

Reimplemented from FCDPhysicsAnalyticalGeometry.

virtual GeomType FCDPASPlane::GetGeomType  )  const [inline, virtual]
 

Retrieves the analytical geometry type for this class.

Returns:
The analytical geometry type: PLANE.

Implements FCDPhysicsAnalyticalGeometry.


Member Data Documentation

float FCDPASPlane::d
 

The value that positions the plane.

If the normal of the plane is at (A, B, C), the equation of the plane is Ax + By + Cz + d = 0.


The documentation for this class was generated from the following file:
Generated on Thu Feb 14 16:58:39 2008 for FCollada by  doxygen 1.4.6-NO