Urho3D
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Friends
Urho3D::Constraint Class Reference

Physics constraint component. Connects two rigid bodies together, or one rigid body to a static point. More...

#include <Constraint.h>

Inheritance diagram for Urho3D::Constraint:
Urho3D::Component Urho3D::Serializable Urho3D::Object Urho3D::RefCounted

List of all members.

Public Member Functions

 Constraint (Context *context)
 Construct.
 ~Constraint ()
 Destruct.
virtual void OnSetAttribute (const AttributeInfo &attr, const Variant &src)
 Handle attribute write access.
virtual void ApplyAttributes ()
 Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
virtual void GetDependencyNodes (PODVector< Node * > &dest)
 Return the depended on nodes to order network updates.
virtual void DrawDebugGeometry (DebugRenderer *debug, bool depthTest)
 Visualize the component as debug geometry.
void SetConstraintType (ConstraintType type)
 Set constraint type and recreate the constraint.
void SetOtherBody (RigidBody *body)
 Set other body to connect to. Set to null to connect to the static world.
void SetPosition (const Vector3 &position)
 Set constraint position relative to own body.
void SetRotation (const Quaternion &rotation)
 Set constraint rotation relative to own body.
void SetAxis (const Vector3 &axis)
 Set constraint rotation relative to own body by specifying the axis.
void SetOtherPosition (const Vector3 &position)
 Set constraint position relative to the other body. If connected to the static world, is a world-space position.
void SetOtherRotation (const Quaternion &rotation)
 Set constraint rotation relative to the other body. If connected to the static world, is a world-space rotation.
void SetOtherAxis (const Vector3 &axis)
 Set constraint rotation relative to the other body by specifying the axis.
void SetWorldPosition (const Vector3 &position)
 Set constraint world-space position. Resets both own and other body relative position, ie. zeroes the constraint error.
void SetHighLimit (const Vector2 &limit)
 Set high limit. Interpretation is constraint type specific.
void SetLowLimit (const Vector2 &limit)
 Set low limit. Interpretation is constraint type specific.
void SetDisableCollision (bool disable)
 Set whether to disable collisions between connected bodies.
PhysicsWorldGetPhysicsWorld () const
 Return physics world.
btTypedConstraint * GetConstraint () const
 Return Bullet constraint.
ConstraintType GetConstraintType () const
 Return constraint type.
RigidBodyGetOwnBody () const
 Return rigid body in own scene node.
RigidBodyGetOtherBody () const
 Return the other rigid body. May be null if connected to the static world.
const Vector3GetPosition () const
 Return constraint position relative to own body.
const QuaternionGetRotation () const
 Return constraint rotation relative to own body.
const Vector3GetOtherPosition () const
 Return constraint position relative to other body.
const QuaternionGetOtherRotation () const
 Return constraint rotation relative to other body.
Vector3 GetWorldPosition () const
 Return constraint world position, calculated from own body.
const Vector2GetHighLimit () const
 Return high limit.
const Vector2GetLowLimit () const
 Return low limit.
bool GetDisableCollision () const
 Return whether collisions between connected bodies are disabled.
void ReleaseConstraint ()
 Release the constraint.
- Public Member Functions inherited from Urho3D::Component
 Component (Context *context)
 Construct.
virtual ~Component ()
 Destruct.
virtual bool Save (Serializer &dest)
 Save as binary data. Return true if successful.
virtual bool SaveXML (XMLElement &dest)
 Save as XML data. Return true if successful.
void Remove ()
 Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
unsigned GetID () const
 Return ID.
NodeGetNode () const
 Return scene node.
SceneGetScene () const
 Return the scene the node belongs to.
void GetComponents (PODVector< Component * > &dest, ShortStringHash type) const
 Return components in the same scene node by type.
ComponentGetComponent (ShortStringHash type) const
 Return component in the same scene node by type. If there are several, returns the first.
template<class T >
T * GetComponent () const
 Template version of returning a component in the same scene node by type.
template<class T >
void GetComponents (PODVector< T * > &dest) const
 Template version of returning components in the same scene node by type.
void AddReplicationState (ComponentReplicationState *state)
 Add a replication state that is tracking this component.
void PrepareNetworkUpdate ()
 Prepare network update by comparing attributes and marking replication states dirty as necessary.
void CleanupConnection (Connection *connection)
 Clean up all references to a network connection that is about to be removed.
void MarkNetworkUpdate ()
 Mark for attribute check on the next network update.
- Public Member Functions inherited from Urho3D::Serializable
 Serializable (Context *context)
 Construct.
virtual ~Serializable ()
 Destruct.
virtual void OnGetAttribute (const AttributeInfo &attr, Variant &dest)
 Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor.
virtual bool Load (Deserializer &source)
 Load from binary data. Return true if successful.
virtual bool LoadXML (const XMLElement &source)
 Load from XML data. Return true if successful.
bool SetAttribute (unsigned index, const Variant &value)
 Set attribute by index. Return true if successfully set.
bool SetAttribute (const String &name, const Variant &value)
 Set attribute by name. Return true if successfully set.
void AllocateNetworkState ()
 Allocate network attribute state.
void WriteInitialDeltaUpdate (Serializer &dest)
 Write initial delta network update.
void WriteDeltaUpdate (Serializer &dest, const DirtyBits &attributeBits)
 Write a delta network update according to dirty attribute bits.
void WriteLatestDataUpdate (Serializer &dest)
 Write a latest data network update.
void ReadDeltaUpdate (Deserializer &source)
 Read and apply a network delta update.
void ReadLatestDataUpdate (Deserializer &source)
 Read and apply a network latest data update.
Variant GetAttribute (unsigned index)
 Return attribute value by index. Return empty if illegal index.
Variant GetAttribute (const String &name)
 Return attribute value by name. Return empty if not found.
unsigned GetNumAttributes () const
 Return number of attributes.
unsigned GetNumNetworkAttributes () const
 Return number of network replication attributes.
const Vector< AttributeInfo > * GetAttributes () const
 Return attribute descriptions, or null if none defined.
const Vector< AttributeInfo > * GetNetworkAttributes () const
 Return network replication attribute descriptions, or null if none defined.
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
virtual ~Object ()
 Destruct. Clean up self from event sender & receiver structures.
virtual ShortStringHash GetType () const =0
 Return type hash.
virtual const StringGetTypeName () const =0
 Return type name.
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
void SubscribeToEvent (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
void SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
void UnsubscribeFromEvent (StringHash eventType)
 Unsubscribe from an event.
void UnsubscribeFromEvent (Object *sender, StringHash eventType)
 Unsubscribe from a specific sender's event.
void UnsubscribeFromEvents (Object *sender)
 Unsubscribe from a specific sender's events.
void UnsubscribeFromAllEvents ()
 Unsubscribe from all events.
void UnsubscribeFromAllEventsExcept (const PODVector< StringHash > &exceptions, bool onlyUserData)
 Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events.)
void SendEvent (StringHash eventType)
 Send event to all subscribers.
void SendEvent (StringHash eventType, VariantMap &eventData)
 Send event with parameters to all subscribers.
ContextGetContext () const
 Return execution context.
ObjectGetSubsystem (ShortStringHash type) const
 Return subsystem by type.
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
EventHandlerGetEventHandler () const
 Return active event handler. Null outside event handling.
bool HasSubscribedToEvent (StringHash eventType) const
 Return whether has subscribed to an event without specific sender.
bool HasSubscribedToEvent (Object *sender, StringHash eventType) const
 Return whether has subscribed to a specific sender's event.
template<class T >
T * GetSubsystem () const
 Template version of returning a subsystem.
- Public Member Functions inherited from Urho3D::RefCounted
 RefCounted ()
 Construct. Allocate the reference count structure and set an initial self weak reference.
virtual ~RefCounted ()
 Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
void AddRef ()
 Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
void ReleaseRef ()
 Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
int Refs () const
 Return reference count.
int WeakRefs () const
 Return weak reference count.
RefCountRefCountPtr ()
 Return pointer to the reference count structure.

Static Public Member Functions

static void RegisterObject (Context *context)
 Register object factory.

Protected Member Functions

virtual void OnNodeSet (Node *node)
 Handle node being assigned.
virtual void OnMarkedDirty (Node *node)
 Handle node transform being dirtied.
- Protected Member Functions inherited from Urho3D::Component
void SetID (unsigned id)
 Set ID. Called by Scene.
void SetNode (Node *node)
 Set scene node. Called by Node when creating the component.

Private Member Functions

 OBJECT (Constraint)
void CreateConstraint ()
 Create the constraint.
void ApplyFrames ()
 Apply constraint frames.
void ApplyLimits ()
 Apply high and low constraint limits.

Private Attributes

WeakPtr< PhysicsWorldphysicsWorld_
 Physics world.
WeakPtr< RigidBodyownBody_
 Own rigid body.
WeakPtr< RigidBodyotherBody_
 Other rigid body.
btTypedConstraint * constraint_
 Bullet constraint.
ConstraintType constraintType_
 Constraint type.
Vector3 position_
 Constraint position.
Quaternion rotation_
 Constraint rotation.
Vector3 otherPosition_
 Constraint other body position.
Quaternion otherRotation_
 Constraint other body axis.
Vector3 cachedWorldScale_
 Cached world scale for determining if the constraint position needs update.
Vector2 highLimit_
 High limit.
Vector2 lowLimit_
 Low limit.
int otherBodyNodeID_
 Other body node ID for pending constraint recreation.
bool disableCollision_
 Disable collision between connected bodies flag.
bool recreateConstraint_
 Recreate constraint flag.
bool framesDirty_
 Coordinate frames dirty flag.

Friends

class RigidBody

Additional Inherited Members

- Protected Attributes inherited from Urho3D::Component
Nodenode_
 Scene node.
unsigned id_
 Unique ID within the scene.
bool networkUpdate_
 Network update queued flag.
- Protected Attributes inherited from Urho3D::Serializable
NetworkStatenetworkState_
 Network attribute state.
- Protected Attributes inherited from Urho3D::Object
Contextcontext_
 Execution context.

Detailed Description

Physics constraint component. Connects two rigid bodies together, or one rigid body to a static point.


Member Function Documentation

void Urho3D::Constraint::OnMarkedDirty ( Node node)
protectedvirtual

Handle node transform being dirtied.

Todo:
This does not catch the connected body node's scale changing

Reimplemented from Urho3D::Component.


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