Mezzanine::ActorBasePhysicsSettings Class Reference

This is a base helper class for configuring physics settings of an actor. More...

#include <actorphysicssettings.h>

Inheritance diagram for Mezzanine::ActorBasePhysicsSettings:

List of all members.

Public Member Functions
	ActorBasePhysicsSettings (ActorBase *Actor, btCollisionObject *PhysicsObject)
	Standard Constructor.
virtual	~ActorBasePhysicsSettings ()
	Class destructor.
ActorBasePhysicsSettings *	GetBasePointer ()
	Get a pointer to this class of type ActorBasePhysicsSettings.
virtual Real	GetCCDMotionThreshold () const
	Gets the amount of motion needed to enable CCD for this object.
virtual Real	GetCCDSphereRadius () const
	Gets the radius of the embedded sphere used for CCD.
virtual void	ProtoDeSerialize (const xml::Node &OneNode)
	Take the data stored in an XML and overwrite this instance of this object with it.
virtual void	ProtoSerialize (xml::Node &CurrentRoot) const
	Convert this class to an xml::Node ready for serialization.
virtual void	SetCCDParams (const Real &MotionThreshold, const Real &SweptSphereRadius=0)
	Sets the parameters used for Continuous Collision Detection.
virtual void	SetKinematic ()
	Sets the state of the object to Kinematic.
virtual void	SetStatic ()
	Sets the state of the object to Static.
Static Public Member Functions
static String	SerializableName ()
	Get the name of the the XML tag this class will leave behind as its instances are serialized.

---

Detailed Description

This is a base helper class for configuring physics settings of an actor.

This class contains functions for the configuring of physics specific settings of an actor. This class can only configure the actors physics. For configuring actor graphics, see ActorGraphicsSettings.

Definition at line 109 of file actorphysicssettings.h.

---

Constructor & Destructor Documentation

home sqeaky Mezzanine Mezzanine src actorphysicssettings cpp home sqeaky Mezzanine Mezzanine src actorphysicssettings cpp home sqeaky Mezzanine Mezzanine src actorphysicssettings cpp Mezzanine::ActorBasePhysicsSettings::ActorBasePhysicsSettings	(	ActorBase *	Actor,
		btCollisionObject *	PhysicsObject
	)

Standard Constructor.

Parameters:

Actor	The actor this settings class configures.
PhysicsObject	The physics object belonging to the actor this class configures.

Definition at line 67 of file actorphysicssettings.cpp.

---

Member Function Documentation

ActorBasePhysicsSettings * Mezzanine::ActorBasePhysicsSettings::GetBasePointer

(

)

Get a pointer to this class of type ActorBasePhysicsSettings.

Returns:

A pointer ActorBasePhysicsSettings

Definition at line 123 of file actorphysicssettings.cpp.

Real Mezzanine::ActorBasePhysicsSettings::GetCCDMotionThreshold

(

)

const [virtual]

Gets the amount of motion needed to enable CCD for this object.

Returns:

Returns a Real representing the required amount of motion to enable CCD, or zero if CCD is disabled.

Definition at line 103 of file actorphysicssettings.cpp.

Real Mezzanine::ActorBasePhysicsSettings::GetCCDSphereRadius

(

)

const [virtual]

Gets the radius of the embedded sphere used for CCD.

Returns:

Returns a Real representing the radius of the sphere embedded into the objects collision shape used for CCD.

Definition at line 108 of file actorphysicssettings.cpp.

void Mezzanine::ActorBasePhysicsSettings::ProtoDeSerialize

(

const xml::Node &

OneNode

)

[virtual]

Take the data stored in an XML and overwrite this instance of this object with it.

Parameters:

OneNode

and xml::Node containing the data.

Reimplemented from Mezzanine::NonTriggerPhysicsSettings.

Reimplemented in Mezzanine::ActorRigidPhysicsSettings.

Definition at line 153 of file actorphysicssettings.cpp.

void Mezzanine::ActorBasePhysicsSettings::ProtoSerialize

(

xml::Node &

CurrentRoot

)

const [virtual]

Convert this class to an xml::Node ready for serialization.

Parameters:

CurrentRoot

The point in the XML hierarchy that all this quaternion should be appended to.

Reimplemented from Mezzanine::NonTriggerPhysicsSettings.

Reimplemented in Mezzanine::ActorRigidPhysicsSettings.

Definition at line 128 of file actorphysicssettings.cpp.

String Mezzanine::ActorBasePhysicsSettings::SerializableName

(

)

[static]

Get the name of the the XML tag this class will leave behind as its instances are serialized.

Returns:

A string containing "ActorBasePhysicsSettings"

Reimplemented from Mezzanine::NonTriggerPhysicsSettings.

Reimplemented in Mezzanine::ActorRigidPhysicsSettings.

Definition at line 170 of file actorphysicssettings.cpp.

void Mezzanine::ActorBasePhysicsSettings::SetCCDParams	(	const Real &	MotionThreshold,
		const Real &	SweptSphereRadius = 0
	)		[virtual]

Sets the parameters used for Continuous Collision Detection.

If a Swept Sphere Radius is not provided, this function will attempt to find one for you using the currently set Collision Shape. If this fails for any reason or a shape is not set, it will set the radius to 1.

Parameters:

MotionThreshold	The speed at which the object has to be moving in order to enable CCD for the object. If set to zero CCD will be disabled.
SweptSphereRadius	The radius of the sphere to be used for CCD sweep tests. Essentially this should be the largest radius in which a sphere can fully fit inside your object.

Definition at line 76 of file actorphysicssettings.cpp.

void Mezzanine::ActorBasePhysicsSettings::SetKinematic

(

)

[virtual]

Sets the state of the object to Kinematic.

This function will set the object to a Kinematic Object.
Kinematic Objects are like Static Objects but are also able to be moved directly by character controllers.

Definition at line 113 of file actorphysicssettings.cpp.

void Mezzanine::ActorBasePhysicsSettings::SetStatic

(

)

[virtual]

Sets the state of the object to Static.

This function will set the object to a Static Object.
Static Objects don't move or have any force applied to them, but are cabable of exerting force on other objects.

Definition at line 118 of file actorphysicssettings.cpp.

---

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

• actorphysicssettings.h
• actorphysicssettings.cpp