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

#include <constraint.h>

+ Inheritance diagram for Mezzanine::Physics::UniversalConstraint:
+ Collaboration diagram for Mezzanine::Physics::UniversalConstraint:

Public Member Functions

 UniversalConstraint (RigidProxy *ProxyA, RigidProxy *ProxyB, const Vector3 &Anchor, const Vector3 &Axis1, const Vector3 &Axis2)
 Class constructor.
 
virtual ~UniversalConstraint ()
 Class destructor.
 
virtual void SetLowerLimit (Real Ang1Min, Real Ang2Min)
 
virtual void SetUpperLimit (Real Ang1Max, Real Ang2Max)
 
- Public Member Functions inherited from Mezzanine::Physics::Generic6DofConstraint
 Generic6DofConstraint (RigidProxy *ProxyA, RigidProxy *ProxyB, const Vector3 &VectorA, const Vector3 &VectorB, const Quaternion &QuaternionA, const Quaternion &QuaternionB, bool UseLinearReferenceA=false)
 Two proxy Verbose constructor. More...
 
 Generic6DofConstraint (RigidProxy *ProxyA, RigidProxy *ProxyB, const Transform &TransformA, const Transform &TransformB, bool UseLinearReferenceA=false)
 Two proxy Terse constructor. More...
 
 Generic6DofConstraint (RigidProxy *ProxyB, const Vector3 &VectorB, const Quaternion &QuaternionB, bool UseLinearReferenceB=true)
 Body and World Verbose constructor. More...
 
 Generic6DofConstraint (RigidProxy *ProxyB, const Transform &TransformB, bool UseLinearReferenceB=true)
 Body and World Terse constructor. More...
 
virtual ~Generic6DofConstraint ()
 Class destructor.
 
virtual int AxisToAngularAxis (int Axis) const
 Convert to internal Axis IDs from external or internal axis IDs. More...
 
virtual Vector3 GetAngularLimitLower () const
 Get the Upper limits on rotation. More...
 
Real GetAngularLimitLowerOnAxis (int RotationalAxis) const
 Get a specific lower rotational limit. More...
 
virtual Vector3 GetAngularLimitMaxForce () const
 Get the Maximimum amount of force applied to ensure limits are not surpassed. More...
 
virtual Real GetAngularLimitMaxForceOnAxis (int Axis) const
 Get the Maximimum amount of force applied to ensure a limit one axis is not surpassed. More...
 
virtual Vector3 GetAngularLimitUpper () const
 Get the Power limits on rotation. More...
 
Real GetAngularLimitUpperOnAxis (int RotationalAxis) const
 Get a specific upper rotational limit. More...
 
virtual Vector3 GetAngularMotorDamping () const
 Get the Damping for all Angular Axis. More...
 
virtual Real GetAngularMotorDampingOnAxis (int Axis) const
 Get the Damping for one given Axis. More...
 
virtual Vector3 GetAngularMotorEnabled () const
 Get a Vector3 with 3 zero or nonzero values that store whether or not a given rotational motor is enable. More...
 
virtual bool GetAngularMotorEnabledOnAxis (int Axis) const
 Is a specific rotational motor enabled. More...
 
virtual Vector3 GetAngularMotorMaxForce () const
 Get the Max Motor Force for each Axis. More...
 
virtual Real GetAngularMotorMaxForceOnAxis (int Axis) const
 Get the Max motor Force on a certain Axis. More...
 
virtual Vector3 GetAngularMotorRestitution () const
 Get the Restistution values for all three axis. More...
 
virtual Real GetAngularMotorRestitutionOnAxis (int Axis) const
 Get the Restistution/Bounciness for a single Axis. More...
 
virtual Vector3 GetAngularMotorTargetVelocity () const
 Get the target velocity for all angular Axis. More...
 
virtual Real GetAngularMotorTargetVelocityOnAxis (int Axis) const
 Get the Target Velocity for one axis. More...
 
virtual btTypedConstraint * GetConstraintBase () const
 Get the Bullet constraint that this class encapsulates. More...
 
virtual Real GetLinearLimitDamping () const
 Get the Damping of the linear Limits. More...
 
virtual Vector3 GetLinearLimitLower () const
 Get the Upper limits on translation. More...
 
virtual Real GetLinearLimitRestitution () const
 Get the Restitution of the linear Limits. More...
 
virtual Real GetLinearLimitSoftness () const
 Get the Softness of the linear Limits. More...
 
virtual Vector3 GetLinearLimitUpper () const
 Get the lower limits on translation. More...
 
virtual Vector3 GetLinearMotorEnabled () const
 Get a Vector3 with 3 zero or nonzero values that store whether or not a given rotational motor is enable. More...
 
virtual bool GetLinearMotorEnabledOnAxis (int Axis) const
 Is a specific Linear motor enabled. More...
 
virtual Vector3 GetLinearMotorMaxForce () const
 Get the Max Motor Force for each Axis. More...
 
virtual Real GetLinearMotorMaxForceOnAxis (int Axis) const
 Get the Max motor Force on a certain Axis. More...
 
virtual Vector3 GetLinearMotorTargetVelocity () const
 Get the target velocity for all Linear Axis. More...
 
virtual Real GetLinearMotorTargetVelocityOnAxis (int Axis) const
 Get the Target Velocity for one axis. More...
 
virtual Vector3 GetPivotALocation () const
 Get the location of the pivot relative to ActorA's Center of gravity. More...
 
virtual Quaternion GetPivotARotation () const
 Get the relative rotation for ActorA. More...
 
virtual Transform GetPivotATransform () const
 Get the current Rotation and Location of Actor A. More...
 
virtual Vector3 GetPivotBLocation () const
 Get the location of the pivot relative to ActorB's Center of gravity. More...
 
virtual Quaternion GetPivotBRotation () const
 Get the relative rotation for ActorB. More...
 
virtual Transform GetPivotBTransform () const
 Get the current Rotation and Location of Actor B. More...
 
virtual bool GetUseFrameOffset () const
 Retrieve the stored value from the physics subsystem(bullet) More...
 
virtual bool HasParamBeenSet (ConstraintParam Param, int Axis) const
 
virtual void ProtoDeSerialize (const XML::Node &OneNode)
 Take the data stored in an XML and overwrite this instance of this object with it. More...
 
virtual void ProtoSerialize (XML::Node &CurrentRoot) const
 Convert this class to an XML::Node ready for serialization. More...
 
virtual void SetAngularLimitLower (const Vector3 &Limit)
 Set the Lower limits on rotation. More...
 
virtual void SetAngularLimitMaxForce (const Vector3 &MaxLimitForces)
 Set the Maximimum amount of force applied to ensure limits are not surpassed. More...
 
virtual void SetAngularLimitMaxForceOnAxis (Real MaxLimitForce, int Axis)
 Set the Maximimum amount of force applied to ensure a limit on one axis is not surpassed. More...
 
virtual void SetAngularLimitUpper (const Vector3 &Limit)
 Set the Upper limits on rotation. More...
 
virtual void SetAngularMotorDamping (const Vector3 &Dampings)
 Set the Angular Motor Damping for each Angular Axis. More...
 
virtual void SetAngularMotorDampingOnAxis (Real Damping, int Axis)
 For one Axis, set the Damping. More...
 
virtual void SetAngularMotorEnabled (const Vector3 &Enableds)
 Set whether or not the motor is enabled for all Axis Simultaneously. More...
 
virtual void SetAngularMotorEnabledOnAxis (bool Enabled, int Axis)
 For one Axis, set whether or not the motor is enabled. More...
 
virtual void SetAngularMotorMaxForce (const Vector3 &Forces)
 Set the Angular Motor Maximum force on all 3 rotational axis. More...
 
virtual void SetAngularMotorMaxForceOnAxis (Real Force, int Axis)
 For one Axis, set the Maximimum Motor Force. More...
 
virtual void SetAngularMotorRestitution (const Vector3 &Restistutions)
 Set the Bounciness/Restition for rotation on all three Axis. More...
 
virtual void SetAngularMotorRestitutionOnAxis (Real Restistution, int Axis)
 For one Axis, set the Restistution/Bounciness/. More...
 
virtual void SetAngularMotorTargetVelocity (const Vector3 &Velocities)
 Set the Target velocity of the motor on each anuglar axis. More...
 
virtual void SetAngularMotorTargetVelocityOnAxis (Real Velocity, int Axis)
 For one Axis, set the target velocity of the angular motor. More...
 
virtual void SetLimit (int Axis, Real Lower, Real Upper)
 Change the upper and lower limit for one axis of translation or rotation limit. More...
 
virtual void SetLinearLimitDamping (Real Damping)
 Set the Damping of the linear Limits. More...
 
virtual void SetLinearLimitLower (const Vector3 &Limit)
 Set the Upper limits on translation. More...
 
virtual void SetLinearLimitRestitution (Real Restitution)
 Set the Restitution of the linear Limits. More...
 
virtual void SetLinearLimitSoftness (Real Softness)
 Set the Softness of the linear Limits. More...
 
virtual void SetLinearLimitUpper (const Vector3 &Limit)
 Set the lower limits on translation. More...
 
virtual void SetLinearMotorEnabled (const Vector3 &Enableds)
 Set whether or not the motor is enabled for all Linear Axis Simultaneously. More...
 
virtual void SetLinearMotorEnabledOnAxis (bool Enabled, int Axis)
 For one Axis, set whether or not the motor is enabled. More...
 
virtual void SetLinearMotorMaxForce (const Vector3 &Forces)
 Set the Linear Motor Maximum force on all 3 translation axis. More...
 
virtual void SetLinearMotorMaxForceOnAxis (Real Force, int Axis)
 For one Axis, set the Maximimum Motor Force. More...
 
virtual void SetLinearMotorTargetVelocity (const Vector3 &Velocities)
 Set the Target velocity of the motor on each anuglar axis. More...
 
virtual void SetLinearMotorTargetVelocityOnAxis (Real Velocity, int Axis)
 For one Axis, set the target velocity of the Linear motor. More...
 
virtual void SetPivotALocation (const Vector3 &Location)
 Set The relative location of the pivot from ActorA's Center of gravity. More...
 
virtual void SetPivotARotation (const Quaternion &Rotation)
 Set The relative rotation of ActorA. More...
 
virtual void SetPivotATransform (const Transform &TranA)
 Set the Position and Rotation using a Transform. More...
 
virtual void SetPivotBLocation (const Vector3 &Location)
 Set The relative location of the pivot from ActorB's Center of gravity. More...
 
virtual void SetPivotBRotation (const Quaternion &Rotation)
 Set The relative rotation of ActorB. More...
 
virtual void SetPivotBTransform (const Transform &TranB)
 Set the Position and Rotation using a Transform. More...
 
virtual void SetUseFrameOffset (bool FrameOffset)
 Set the stored value for UseFrameOffset on this hinge in the physics subsystem(bullet) More...
 
virtual Constraint::AxisList ValidAngularAxis () const
 Get A list sorted (low to high) of all axis that operate Angularly (that lock sliding/translation) More...
 
virtual Constraint::AxisList ValidLinearAxis () const
 Get a sorted (low to high) list of all axis that operate linearly (that lock sliding/translation) More...
 
virtual Constraint::ParamList ValidParamOnAxis (int Axis) const
 Get a sorted (low to high) list of Parameters that are valid on this Axis. More...
 

Protected Attributes

btUniversalConstraint * Universal
 Bullet constraint that this class encapsulates.
 
- Protected Attributes inherited from Mezzanine::Physics::Generic6DofConstraint
btGeneric6DofConstraint * Generic6dof
 Bullet constraint that this class encapsulates.
 

Additional Inherited Members

- Public Types inherited from Mezzanine::Physics::Generic6DofConstraint
enum  UsableAxis {
  LinearX = 0, LinearY = 1, LinearZ = 2, AngularX = 3,
  AngularY = 4, AngularZ = 5, AngularXAsRotationalAxis = 0, AngularYAsRotationalAxis = 1,
  AngularZAsRotationalAxis = 2
}
 Identify the Axis a bit easier when iterating over them is less convienent than typing an Identifier. More...
 
- Static Public Member Functions inherited from Mezzanine::Physics::Generic6DofConstraint
static String SerializableName ()
 Get the name of the the XML tag this class will leave behind as its instances are serialized. More...
 
- Protected Member Functions inherited from Mezzanine::Physics::Generic6DofConstraint
 Generic6DofConstraint ()
 Inheritance Constructor. More...
 

Detailed Description

This class is currently incomplete and is marked as internal until its completion

Definition at line 57 of file universalconstraint.h.


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