MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Mezzanine::SoftDebris Class Reference

A deformable debris. More...

#include <softdebris.h>

+ Inheritance diagram for Mezzanine::SoftDebris:
+ Collaboration diagram for Mezzanine::SoftDebris:

Public Member Functions

 SoftDebris (World *TheWorld)
 Blank constructor. More...
 
 SoftDebris (const String &Name, const Real Mass, World *TheWorld)
 Class constructor. More...
 
 SoftDebris (const XML::Node &SelfRoot, World *TheWorld)
 XML constructor. More...
 
virtual ~SoftDebris ()
 Class destructor.
 
virtual void _NotifyProxyDestroyed (WorldProxy *ToBeDestroyed)
 Notifies that a proxy belonging to this WorldObject is being forcibly destroyed, and it needs to update. More...
 
virtual void _Update ()
 Utility function for altering or checking the World Object every frame. More...
 
virtual void AddToWorld ()
 Adds the object to the World. More...
 
virtual String GetDerivedSerializableName () const
 Gets the most derived serializable name of this WorldObject. More...
 
virtual Graphics::EntityProxyGetEntityProxy () const
 Gets a pointer to the graphics portion of this debris. More...
 
virtual Vector3 GetLocation () const
 Gets this objects current location. More...
 
virtual Quaternion GetOrientation () const
 Gets this objects current orientation. More...
 
virtual void GetProxies (ProxyContainer &Proxies)
 Populates a container with all of the WorldProxies being used by this WorldObject. More...
 
virtual void GetProxies (const UInt32 Types, ProxyContainer &Proxies)
 Populates a container with all the WorldProxies being used by this WorldObject specified in a provided mask. More...
 
virtual Vector3 GetScale () const
 Gets the scaling currently being applied to this object. More...
 
virtual Physics::SoftProxyGetSoftProxy () const
 Gets a pointer to the physics portion of this debris. More...
 
virtual WorldObjectType GetType () const
 Gets the type of the object instance. More...
 
virtual Boolean IsInWorld () const
 Gets whether or not this object is currently in the world. More...
 
virtual Boolean IsKinematic () const
 Checks of the object is kinematic. More...
 
virtual Boolean IsStatic () const
 Checks of the object is static. More...
 
virtual void Pitch (const Real Angle)
 Rotate the object around the X axis. More...
 
virtual void ProtoDeSerializeProperties (const XML::Node &SelfRoot)
 Take the data stored in an XML Node and overwrite the properties of this object with it. More...
 
virtual void ProtoDeSerializeProxies (const XML::Node &SelfRoot)
 Take the data stored in an XML Node and overwrite the proxies of this object with it. More...
 
virtual void ProtoSerializeProperties (XML::Node &SelfRoot) const
 Convert the properties of this class to an XML::Node ready for serialization. More...
 
virtual void ProtoSerializeProxies (XML::Node &SelfRoot) const
 Convert the proxies of this class to an XML::Node ready for serialization. More...
 
virtual void RemoveFromWorld ()
 Removes the object from the World. More...
 
virtual void Roll (const Real Angle)
 Rotate the object around the Z axis. More...
 
virtual void Rotate (const Vector3 &Axis, const Real Angle)
 Rotates the object from it's existing rotation. More...
 
virtual void Rotate (const Quaternion &Rotation)
 Rotates the object from it's existing rotation. More...
 
virtual void Scale (const Vector3 &Scale)
 Scales the object from it's current size. More...
 
virtual void Scale (const Real X, const Real Y, const Real Z)
 Scales the object from it's current size. More...
 
virtual void SetLocation (const Vector3 &Loc)
 Sets the location of this object in parent space. More...
 
virtual void SetLocation (const Real X, const Real Y, const Real Z)
 Sets the location of this object in parent space via Reals. More...
 
virtual void SetOrientation (const Quaternion &Ori)
 Sets the orientation of this object in parent space. More...
 
virtual void SetOrientation (const Real X, const Real Y, const Real Z, const Real W)
 Sets the orientation of this object in parent space via Reals. More...
 
virtual void SetScale (const Vector3 &Sc)
 Sets the scaling to be applied to this object. More...
 
virtual void SetScale (const Real X, const Real Y, const Real Z)
 Sets the scaling to be applied to this object via Reals. More...
 
virtual void Translate (const Vector3 &Trans)
 Moves this object from it's current location. More...
 
virtual void Translate (const Real X, const Real Y, const Real Z)
 Moves this object from it's current location. More...
 
virtual void Yaw (const Real Angle)
 Rotate the object around the Y axis. More...
 
- Public Member Functions inherited from Mezzanine::Debris
 Debris (World *TheWorld)
 Blank constructor. More...
 
 Debris (const String &Name, World *TheWorld)
 Class constructor. More...
 
virtual ~Debris ()
 Class destructor.
 
- Public Member Functions inherited from Mezzanine::WorldObject
 WorldObject (World *TheWorld)
 Blank constructor. More...
 
 WorldObject (const String &Name, World *TheWorld)
 Class constructor. More...
 
virtual ~WorldObject ()
 Class destructor.
 
virtual void _NotifyCollisionState (Physics::Collision *Col, const Physics::CollisionState State)
 Notifies this World Object of a collision that is occuring with it. More...
 
virtual const StringGetName () const
 Gets the name of this object. More...
 
virtual WorldGetWorld () const
 Gets the world this object currently belongs to. More...
 
virtual void ProtoDeSerialize (const XML::Node &SelfRoot)
 Take the data stored in an XML Node and overwrite this object with it. More...
 
virtual void ProtoSerialize (XML::Node &ParentNode) const
 Convert this class to an XML::Node ready for serialization. More...
 
- Public Member Functions inherited from Mezzanine::TransformableObject
virtual ~TransformableObject ()
 Class Destructor.
 
virtual Vector3 ConvertGlobalToLocal (const Vector3 &Location) const
 Converts a point in global space to the same point in local space. More...
 
virtual Quaternion ConvertGlobalToLocal (const Quaternion &Orientation) const
 Converts a rotation in global space to the same rotation in local space. More...
 
virtual Vector3 ConvertLocalToGlobal (const Vector3 &Location) const
 Converts a point in local space to the same point in global space. More...
 
virtual Quaternion ConvertLocalToGlobal (const Quaternion &Orientation) const
 Converts a rotation in local space to the same rotation in global space. More...
 

Static Public Member Functions

static String GetSerializableName ()
 Get the name of the the XML tag the proxy class will leave behind as its instances are serialized. More...
 
- Static Public Member Functions inherited from Mezzanine::Debris
static String GetSerializableName ()
 Get the name of the the XML tag the proxy class will leave behind as its instances are serialized. More...
 
- Static Public Member Functions inherited from Mezzanine::WorldObject
static String GetSerializableName ()
 Get the name of the the XML tag the proxy class will leave behind as its instances are serialized. More...
 

Protected Member Functions

virtual void CreateSoftDebris (const Real Mass)
 Common construction method for SoftDebris. More...
 
virtual void DestroySoftDebris ()
 Destruction method for RigidDebris. More...
 

Protected Attributes

Graphics::EntityProxyEntProx
 A pointer to the graphics representation of this debris. More...
 
Physics::SoftProxySofProx
 A pointer to the physics representation of this debris. More...
 

Additional Inherited Members

- Public Types inherited from Mezzanine::WorldObject
typedef std::set
< Physics::Collision * > 
CollisionContainer
 Basic container type for the current collisions applied to this object.
 
typedef
CollisionContainer::iterator 
CollisionIterator
 Iterator type for the current collisions applied to this object.
 
typedef
CollisionContainer::const_iterator 
ConstCollisionIterator
 Const Iterator type for the current collisions applied to this object.
 
typedef
ProxyContainer::const_iterator 
ConstProxyIterator
 Const Iterator type for WorldProxy instances stored by this class.
 
typedef std::vector< WorldProxy * > ProxyContainer
 Basic container type for WorldProxy storage by this class.
 
typedef ProxyContainer::iterator ProxyIterator
 Iterator type for WorldProxy instances stored by this class.
 

Detailed Description

A deformable debris.

Definition at line 62 of file softdebris.h.

Constructor & Destructor Documentation

Mezzanine::SoftDebris::SoftDebris ( World TheWorld)

Blank constructor.

Parameters
TheWorldA pointer to the world this object belongs to.

Definition at line 64 of file softdebris.cpp.

Mezzanine::SoftDebris::SoftDebris ( const String Name,
const Real  Mass,
World TheWorld 
)

Class constructor.

Parameters
NameThe name to be given to this object.
MassThe mass of the debris object.
TheWorldA pointer to the world this object belongs to.

Definition at line 70 of file softdebris.cpp.

Mezzanine::SoftDebris::SoftDebris ( const XML::Node SelfRoot,
World TheWorld 
)

XML constructor.

Parameters
SelfRootAn XML::Node containing the data to populate this class with.
TheWorldA pointer to the world this object belongs to.

Definition at line 76 of file softdebris.cpp.

Member Function Documentation

void Mezzanine::SoftDebris::_NotifyProxyDestroyed ( WorldProxy ToBeDestroyed)
virtual

Notifies that a proxy belonging to this WorldObject is being forcibly destroyed, and it needs to update.

Implements Mezzanine::WorldObject.

Definition at line 370 of file softdebris.cpp.

void Mezzanine::SoftDebris::_Update ( )
virtual

Utility function for altering or checking the World Object every frame.

Implements Mezzanine::WorldObject.

Definition at line 365 of file softdebris.cpp.

void Mezzanine::SoftDebris::AddToWorld ( )
virtual

Adds the object to the World.

Implements Mezzanine::WorldObject.

Definition at line 160 of file softdebris.cpp.

void Mezzanine::SoftDebris::CreateSoftDebris ( const Real  Mass)
protectedvirtual

Common construction method for SoftDebris.

Parameters
MassThe mass of the debris object.

Definition at line 85 of file softdebris.cpp.

void Mezzanine::SoftDebris::DestroySoftDebris ( )
protectedvirtual

Destruction method for RigidDebris.

Definition at line 100 of file softdebris.cpp.

String Mezzanine::SoftDebris::GetDerivedSerializableName ( ) const
virtual

Gets the most derived serializable name of this WorldObject.

Note
When creating a new WorldObject class verify this method has a valid return for it in order for serialization to work properly.
Returns
Returns the name of the XML tag from the most derived class of "this".

Reimplemented from Mezzanine::Debris.

Definition at line 356 of file softdebris.cpp.

Graphics::EntityProxy * Mezzanine::SoftDebris::GetEntityProxy ( ) const
virtual

Gets a pointer to the graphics portion of this debris.

Returns
Returns a pointer to the Entity proxy representing the graphics portion of this debris.

Definition at line 126 of file softdebris.cpp.

Vector3 Mezzanine::SoftDebris::GetLocation ( ) const
virtual

Gets this objects current location.

Returns
Returns Vector3 representing the current rotation of this object in parent space.

Implements Mezzanine::TransformableObject.

Definition at line 193 of file softdebris.cpp.

Quaternion Mezzanine::SoftDebris::GetOrientation ( ) const
virtual

Gets this objects current orientation.

Returns
Returns a Quaternion representing the current orientation of this object in parent space.

Implements Mezzanine::TransformableObject.

Definition at line 210 of file softdebris.cpp.

void Mezzanine::SoftDebris::GetProxies ( ProxyContainer Proxies)
virtual

Populates a container with all of the WorldProxies being used by this WorldObject.

Parameters
ProxiesThe container of proxies to be populated.

Implements Mezzanine::WorldObject.

Definition at line 141 of file softdebris.cpp.

void Mezzanine::SoftDebris::GetProxies ( const UInt32  Types,
ProxyContainer Proxies 
)
virtual

Populates a container with all the WorldProxies being used by this WorldObject specified in a provided mask.

Parameters
TypesThe bitmask specifing the types of world proxies to populate the container with.
ProxiesThe container of proxies to be populated.

Implements Mezzanine::WorldObject.

Definition at line 147 of file softdebris.cpp.

Vector3 Mezzanine::SoftDebris::GetScale ( ) const
virtual

Gets the scaling currently being applied to this object.

Returns
Returns a Vector3 representing the amount this object is being scaled.

Implements Mezzanine::TransformableObject.

Definition at line 227 of file softdebris.cpp.

String Mezzanine::SoftDebris::GetSerializableName ( )
static

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

Returns
A string containing the name of this class.

Definition at line 359 of file softdebris.cpp.

Physics::SoftProxy * Mezzanine::SoftDebris::GetSoftProxy ( ) const
virtual

Gets a pointer to the physics portion of this debris.

Returns
Returns a pointer to the Soft proxy representing the physics portion of this debris.

Definition at line 129 of file softdebris.cpp.

WorldObjectType Mezzanine::SoftDebris::GetType ( ) const
virtual

Gets the type of the object instance.

Returns
Returns the type of the object instance

Implements Mezzanine::WorldObject.

Definition at line 123 of file softdebris.cpp.

Boolean Mezzanine::SoftDebris::IsInWorld ( ) const
virtual

Gets whether or not this object is currently in the world.

Returns
Returns a bool indicating if this object has been added to the world.

Implements Mezzanine::WorldObject.

Definition at line 132 of file softdebris.cpp.

Boolean Mezzanine::SoftDebris::IsKinematic ( ) const
virtual

Checks of the object is kinematic.

Returns
Returns true if the object is kinematic, false otherwise.

Implements Mezzanine::WorldObject.

Definition at line 138 of file softdebris.cpp.

Boolean Mezzanine::SoftDebris::IsStatic ( ) const
virtual

Checks of the object is static.

Returns
Returns true if the object is static, false otherwise.

Implements Mezzanine::WorldObject.

Definition at line 135 of file softdebris.cpp.

void Mezzanine::SoftDebris::Pitch ( const Real  Angle)
virtual

Rotate the object around the X axis.

Parameters
AngleThe angle to rotate this object in radians.

Implements Mezzanine::TransformableObject.

Definition at line 250 of file softdebris.cpp.

void Mezzanine::SoftDebris::ProtoDeSerializeProperties ( const XML::Node SelfRoot)
virtual

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

Parameters
SelfRootAn XML::Node containing the data to populate this class with.

Reimplemented from Mezzanine::Debris.

Definition at line 313 of file softdebris.cpp.

void Mezzanine::SoftDebris::ProtoDeSerializeProxies ( const XML::Node SelfRoot)
virtual

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

Parameters
SelfRootAn XML::Node containing the data to populate this class with.
Todo:
I don't think an exception is appropriate for the failure of the worldmanager validity checks, however a warning should be written to the log if that happens. This should be updated to do that once logging refactors are done.

Implements Mezzanine::WorldObject.

Definition at line 318 of file softdebris.cpp.

void Mezzanine::SoftDebris::ProtoSerializeProperties ( XML::Node SelfRoot) const
virtual

Convert the properties of this class to an XML::Node ready for serialization.

Parameters
SelfRootThe root node containing all the serialized data for this instance.

Reimplemented from Mezzanine::Debris.

Definition at line 290 of file softdebris.cpp.

void Mezzanine::SoftDebris::ProtoSerializeProxies ( XML::Node SelfRoot) const
virtual

Convert the proxies of this class to an XML::Node ready for serialization.

Parameters
SelfRootThe root node containing all the serialized data for this instance.

Implements Mezzanine::WorldObject.

Definition at line 295 of file softdebris.cpp.

void Mezzanine::SoftDebris::RemoveFromWorld ( )
virtual

Removes the object from the World.

Implements Mezzanine::WorldObject.

Definition at line 169 of file softdebris.cpp.

void Mezzanine::SoftDebris::Roll ( const Real  Angle)
virtual

Rotate the object around the Z axis.

Parameters
AngleThe angle to rotate this object in radians.

Implements Mezzanine::TransformableObject.

Definition at line 256 of file softdebris.cpp.

void Mezzanine::SoftDebris::Rotate ( const Vector3 Axis,
const Real  Angle 
)
virtual

Rotates the object from it's existing rotation.

Note
This method has an additive effect with the objects current rotation. Unlike "SetOrientation" this method does not replace the existing orientation with what you provide.
Parameters
AxisThe axis on which this object will be rotated.
AngleThe angle to rotate this object in radians.

Implements Mezzanine::TransformableObject.

Definition at line 262 of file softdebris.cpp.

void Mezzanine::SoftDebris::Rotate ( const Quaternion Rotation)
virtual

Rotates the object from it's existing rotation.

Note
This method has an additive effect with the objects current rotation. Unlike "SetOrientation" this method does not replace the existing orientation with what you provide.
Parameters
RotationThe rotation to apply to this object.

Implements Mezzanine::TransformableObject.

Definition at line 268 of file softdebris.cpp.

void Mezzanine::SoftDebris::Scale ( const Vector3 Scale)
virtual

Scales the object from it's current size.

Note
This method has an additive effect with the objects' current scaling. Unlike "SetScale" this method does not replace the existing scale with what you provide.
Parameters
ScaleA Vector3 representing the scaling to apply to this object.

Implements Mezzanine::TransformableObject.

Definition at line 274 of file softdebris.cpp.

void Mezzanine::SoftDebris::Scale ( const Real  X,
const Real  Y,
const Real  Z 
)
virtual

Scales the object from it's current size.

Note
This method has an additive effect with the objects' current scaling. Unlike "SetScale" this method does not replace the existing scale with what you provide.
Parameters
XThe scaling factor to apply on the X axis.
YThe scaling factor to apply on the Y axis.
ZThe scaling factor to apply on the Z axis.

Implements Mezzanine::TransformableObject.

Definition at line 280 of file softdebris.cpp.

void Mezzanine::SoftDebris::SetLocation ( const Vector3 Loc)
virtual

Sets the location of this object in parent space.

Parameters
LocationA Vector3 representing the location this object is to be set to.

Implements Mezzanine::TransformableObject.

Definition at line 181 of file softdebris.cpp.

void Mezzanine::SoftDebris::SetLocation ( const Real  X,
const Real  Y,
const Real  Z 
)
virtual

Sets the location of this object in parent space via Reals.

Parameters
XThe position on the X axis where this object is to be set.
YThe position on the Y axis where this object is to be set.
ZThe position on the Z axis where this object is to be set.

Implements Mezzanine::TransformableObject.

Definition at line 187 of file softdebris.cpp.

void Mezzanine::SoftDebris::SetOrientation ( const Quaternion Ori)
virtual

Sets the orientation of this object in parent space.

Parameters
OrientationA Quaternion representing the rotation this object is to be set to.

Implements Mezzanine::TransformableObject.

Definition at line 198 of file softdebris.cpp.

void Mezzanine::SoftDebris::SetOrientation ( const Real  X,
const Real  Y,
const Real  Z,
const Real  W 
)
virtual

Sets the orientation of this object in parent space via Reals.

Parameters
XThe X component of the Axis.
YThe Y component of the Axis.
ZThe Z component of the Axis.
WRotation on the Axis X, Y and Z defined.

Implements Mezzanine::TransformableObject.

Definition at line 204 of file softdebris.cpp.

void Mezzanine::SoftDebris::SetScale ( const Vector3 Sc)
virtual

Sets the scaling to be applied to this object.

Parameters
ScaleA Vector3 representing the amount of scaling to apply to this object.

Implements Mezzanine::TransformableObject.

Definition at line 215 of file softdebris.cpp.

void Mezzanine::SoftDebris::SetScale ( const Real  X,
const Real  Y,
const Real  Z 
)
virtual

Sets the scaling to be applied to this object via Reals.

Parameters
XThe scaling factor to apply on the X axis.
YThe scaling factor to apply on the Y axis.
ZThe scaling factor to apply on the Z axis.

Implements Mezzanine::TransformableObject.

Definition at line 221 of file softdebris.cpp.

void Mezzanine::SoftDebris::Translate ( const Vector3 Trans)
virtual

Moves this object from it's current location.

Note
This method has an additive effect with the objects current location. Unlike "SetLocation" this method does not replace the existing location with what you provide.
Parameters
TransA Vector3 representing the amount of movement to apply to this object.

Implements Mezzanine::TransformableObject.

Definition at line 232 of file softdebris.cpp.

void Mezzanine::SoftDebris::Translate ( const Real  X,
const Real  Y,
const Real  Z 
)
virtual

Moves this object from it's current location.

Note
This method has an additive effect with the objects current location. Unlike "SetLocation" this method does not replace the existing location with what you provide.
Parameters
XThe amount of movement to apply on the X axis.
YThe amount of movement to apply on the Y axis.
ZThe amount of movement to apply on the Z axis.

Implements Mezzanine::TransformableObject.

Definition at line 238 of file softdebris.cpp.

void Mezzanine::SoftDebris::Yaw ( const Real  Angle)
virtual

Rotate the object around the Y axis.

Parameters
AngleThe angle to rotate this object in radians.

Implements Mezzanine::TransformableObject.

Definition at line 244 of file softdebris.cpp.

Member Data Documentation

Graphics::EntityProxy* Mezzanine::SoftDebris::EntProx
protected

A pointer to the graphics representation of this debris.

Definition at line 67 of file softdebris.h.

Physics::SoftProxy* Mezzanine::SoftDebris::SofProx
protected

A pointer to the physics representation of this debris.

Definition at line 70 of file softdebris.h.


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