2D physics simulation world component. Should be added only to the root scene node. More...

#include <Urho3D/Urho2D/PhysicsWorld2D.h>

Inheritance diagram for Urho3D::PhysicsWorld2D:
[legend]
Collaboration diagram for Urho3D::PhysicsWorld2D:
[legend]

Classes

struct  ContactInfo
 Contact info. More...
 

Public Member Functions

 PhysicsWorld2D (Context *context)
 Construct.
 
virtual ~PhysicsWorld2D ()
 Destruct.
 
virtual void DrawDebugGeometry (DebugRenderer *debug, bool depthTest)
 Visualize the component as debug geometry.
 
virtual void BeginContact (b2Contact *contact)
 Called when two fixtures begin to touch.
 
virtual void EndContact (b2Contact *contact)
 Called when two fixtures cease to touch.
 
virtual void DrawPolygon (const b2Vec2 *vertices, int32 vertexCount, const b2Color &color)
 Draw a closed polygon provided in CCW order.
 
virtual void DrawSolidPolygon (const b2Vec2 *vertices, int32 vertexCount, const b2Color &color)
 Draw a solid closed polygon provided in CCW order.
 
virtual void DrawCircle (const b2Vec2 &center, float32 radius, const b2Color &color)
 Draw a circle.
 
virtual void DrawSolidCircle (const b2Vec2 &center, float32 radius, const b2Vec2 &axis, const b2Color &color)
 Draw a solid circle.
 
virtual void DrawSegment (const b2Vec2 &p1, const b2Vec2 &p2, const b2Color &color)
 Draw a line segment.
 
virtual void DrawTransform (const b2Transform &xf)
 Draw a transform. Choose your own length scale.
 
void Update (float timeStep)
 Step the simulation forward.
 
void DrawDebugGeometry ()
 Add debug geometry to the debug renderer.
 
void SetUpdateEnabled (bool enable)
 Enable or disable automatic physics simulation during scene update. Enabled by default.
 
void SetDrawShape (bool drawShape)
 Set draw shape.
 
void SetDrawJoint (bool drawJoint)
 Set draw joint.
 
void SetDrawAabb (bool drawAabb)
 Set draw aabb.
 
void SetDrawPair (bool drawPair)
 Set draw pair.
 
void SetDrawCenterOfMass (bool drawCenterOfMass)
 Set draw center of mass.
 
void SetAllowSleeping (bool enable)
 Set allow sleeping.
 
void SetWarmStarting (bool enable)
 Set warm starting.
 
void SetContinuousPhysics (bool enable)
 Set continuous physics.
 
void SetSubStepping (bool enable)
 Set sub stepping.
 
void SetGravity (const Vector2 &gravity)
 Set gravity.
 
void SetAutoClearForces (bool enable)
 Set auto clear forces.
 
void SetVelocityIterations (int velocityIterations)
 Set velocity iterations.
 
void SetPositionIterations (int positionIterations)
 Set position iterations.
 
void AddRigidBody (RigidBody2D *rigidBody)
 Add rigid body.
 
void RemoveRigidBody (RigidBody2D *rigidBody)
 Remove rigid body.
 
void AddDelayedWorldTransform (const DelayedWorldTransform2D &transform)
 Add a delayed world transform assignment. Called by RigidBody2D.
 
void Raycast (PODVector< PhysicsRaycastResult2D > &results, const Vector2 &startPoint, const Vector2 &endPoint, unsigned collisionMask=M_MAX_UNSIGNED)
 Perform a physics world raycast and return all hits.
 
void RaycastSingle (PhysicsRaycastResult2D &result, const Vector2 &startPoint, const Vector2 &endPoint, unsigned collisionMask=M_MAX_UNSIGNED)
 Perform a physics world raycast and return the closest hit.
 
RigidBody2DGetRigidBody (const Vector2 &point, unsigned collisionMask=M_MAX_UNSIGNED)
 Return rigid body at point.
 
RigidBody2DGetRigidBody (int screenX, int screenY, unsigned collisionMask=M_MAX_UNSIGNED)
 Return rigid body at screen point.
 
void GetRigidBodies (PODVector< RigidBody2D * > &result, const Rect &aabb, unsigned collisionMask=M_MAX_UNSIGNED)
 Return rigid bodies by a box query.
 
bool IsUpdateEnabled () const
 Return whether physics world will automatically simulate during scene update.
 
bool GetDrawShape () const
 Return draw shape.
 
bool GetDrawJoint () const
 Return draw joint.
 
bool GetDrawAabb () const
 Return draw aabb.
 
bool GetDrawPair () const
 Return draw pair.
 
bool GetDrawCenterOfMass () const
 Return draw center of mass.
 
bool GetAllowSleeping () const
 Return allow sleeping.
 
bool GetWarmStarting () const
 Return warm starting.
 
bool GetContinuousPhysics () const
 Return continuous physics.
 
bool GetSubStepping () const
 Return sub stepping.
 
bool GetAutoClearForces () const
 Return auto clear forces.
 
const Vector2GetGravity () const
 Return gravity.
 
int GetVelocityIterations () const
 Return velocity iterations.
 
int GetPositionIterations () const
 Return position iterations.
 
b2World * GetWorld ()
 Return the Box2D physics world.
 
void SetApplyingTransforms (bool enable)
 Set node dirtying to be disregarded.
 
bool IsApplyingTransforms () const
 Return whether node dirtying should be disregarded.
 
- Public Member Functions inherited from Urho3D::Component
 Component (Context *context)
 Construct.
 
virtual ~Component ()
 Destruct.
 
virtual void OnSetEnabled ()
 Handle enabled/disabled state change.
 
virtual bool Save (Serializer &dest) const
 Save as binary data. Return true if successful.
 
virtual bool SaveXML (XMLElement &dest) const
 Save as XML data. Return true if successful.
 
virtual bool SaveJSON (JSONValue &dest) const
 Save as JSON data. Return true if successful.
 
virtual void MarkNetworkUpdate ()
 Mark for attribute check on the next network update.
 
virtual void GetDependencyNodes (PODVector< Node * > &dest)
 Return the depended on nodes to order network updates.
 
void SetEnabled (bool enable)
 Set enabled/disabled state.
 
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.
 
bool IsEnabled () const
 Return whether is enabled.
 
bool IsEnabledEffective () const
 Return whether is effectively enabled (node is also enabled.)
 
ComponentGetComponent (StringHash type) const
 Return component in the same scene node by type. If there are several, returns the first.
 
void GetComponents (PODVector< Component * > &dest, StringHash type) const
 Return components in the same scene node by type.
 
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.
 
- Public Member Functions inherited from Urho3D::Animatable
 Animatable (Context *context)
 Construct.
 
virtual ~Animatable ()
 Destruct.
 
virtual bool LoadXML (const XMLElement &source, bool setInstanceDefault=false)
 Load from XML data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful.
 
virtual bool LoadJSON (const JSONValue &source, bool setInstanceDefault=false)
 Load from JSON data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful.
 
void SetAnimationEnabled (bool enable)
 Set automatic update of animation, default true.
 
void SetAnimationTime (float time)
 Set time position of all attribute animations or an object animation manually. Automatic update should be disabled in this case.
 
void SetObjectAnimation (ObjectAnimation *objectAnimation)
 Set object animation.
 
void SetAttributeAnimation (const String &name, ValueAnimation *attributeAnimation, WrapMode wrapMode=WM_LOOP, float speed=1.0f)
 Set attribute animation.
 
void SetAttributeAnimationWrapMode (const String &name, WrapMode wrapMode)
 Set attribute animation wrap mode.
 
void SetAttributeAnimationSpeed (const String &name, float speed)
 Set attribute animation speed.
 
void SetAttributeAnimationTime (const String &name, float time)
 Set attribute animation time position manually. Automatic update should be disabled in this case.
 
void RemoveObjectAnimation ()
 Remove object animation. Same as calling SetObjectAnimation with a null pointer.
 
void RemoveAttributeAnimation (const String &name)
 Remove attribute animation. Same as calling SetAttributeAnimation with a null pointer.
 
bool GetAnimationEnabled () const
 Return animation enabled.
 
ObjectAnimationGetObjectAnimation () const
 Return object animation.
 
ValueAnimationGetAttributeAnimation (const String &name) const
 Return attribute animation.
 
WrapMode GetAttributeAnimationWrapMode (const String &name) const
 Return attribute animation wrap mode.
 
float GetAttributeAnimationSpeed (const String &name) const
 Return attribute animation speed.
 
float GetAttributeAnimationTime (const String &name) const
 Return attribute animation time position.
 
void SetObjectAnimationAttr (const ResourceRef &value)
 Set object animation attribute.
 
ResourceRef GetObjectAnimationAttr () const
 Return object animation attribute.
 
- Public Member Functions inherited from Urho3D::Serializable
 Serializable (Context *context)
 Construct.
 
virtual ~Serializable ()
 Destruct.
 
virtual void OnSetAttribute (const AttributeInfo &attr, const Variant &src)
 Handle attribute write access. Default implementation writes to the variable at offset, or invokes the set accessor.
 
virtual void OnGetAttribute (const AttributeInfo &attr, Variant &dest) const
 Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor.
 
virtual const Vector
< AttributeInfo > * 
GetAttributes () const
 Return attribute descriptions, or null if none defined.
 
virtual const Vector
< AttributeInfo > * 
GetNetworkAttributes () const
 Return network replication attribute descriptions, or null if none defined.
 
virtual bool Load (Deserializer &source, bool setInstanceDefault=false)
 Load from binary data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful.
 
virtual void ApplyAttributes ()
 Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
 
virtual bool SaveDefaultAttributes () const
 Return whether should save default-valued attributes into XML. Default false.
 
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 ResetToDefault ()
 Reset all editable attributes to their default values.
 
void RemoveInstanceDefault ()
 Remove instance's default values if they are set previously.
 
void SetTemporary (bool enable)
 Set temporary flag. Temporary objects will not be saved.
 
void SetInterceptNetworkUpdate (const String &attributeName, bool enable)
 Enable interception of an attribute from network updates. Intercepted attributes are sent as events instead of applying directly. This can be used to implement client side prediction.
 
void AllocateNetworkState ()
 Allocate network attribute state.
 
void WriteInitialDeltaUpdate (Serializer &dest, unsigned char timeStamp)
 Write initial delta network update.
 
void WriteDeltaUpdate (Serializer &dest, const DirtyBits &attributeBits, unsigned char timeStamp)
 Write a delta network update according to dirty attribute bits.
 
void WriteLatestDataUpdate (Serializer &dest, unsigned char timeStamp)
 Write a latest data network update.
 
bool ReadDeltaUpdate (Deserializer &source)
 Read and apply a network delta update. Return true if attributes were changed.
 
bool ReadLatestDataUpdate (Deserializer &source)
 Read and apply a network latest data update. Return true if attributes were changed.
 
Variant GetAttribute (unsigned index) const
 Return attribute value by index. Return empty if illegal index.
 
Variant GetAttribute (const String &name) const
 Return attribute value by name. Return empty if not found.
 
Variant GetAttributeDefault (unsigned index) const
 Return attribute default value by index. Return empty if illegal index.
 
Variant GetAttributeDefault (const String &name) const
 Return attribute default value by name. Return empty if not found.
 
unsigned GetNumAttributes () const
 Return number of attributes.
 
unsigned GetNumNetworkAttributes () const
 Return number of network replication attributes.
 
bool IsTemporary () const
 Return whether is temporary.
 
bool GetInterceptNetworkUpdate (const String &attributeName) const
 Return whether an attribute's network updates are being intercepted.
 
NetworkStateGetNetworkState () const
 Return the network attribute state, if allocated.
 
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
 
virtual ~Object ()
 Destruct. Clean up self from event sender & receiver structures.
 
virtual StringHash GetType () const =0
 Return type hash.
 
virtual const StringGetTypeName () const =0
 Return type name.
 
virtual const TypeInfoGetTypeInfo () const =0
 Return type info.
 
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
 
bool IsInstanceOf (StringHash type) const
 Check current instance is type of specified type.
 
bool IsInstanceOf (const TypeInfo *typeInfo) const
 Check current instance is type of specified type.
 
template<typename T >
bool IsInstanceOf () const
 Check current instance is type of specified class.
 
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. More...
 
VariantMapGetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
 
ContextGetContext () const
 Return execution context.
 
const VariantGetGlobalVar (StringHash key) const
 Return global variable based on key.
 
const VariantMapGetGlobalVars () const
 Return all global variables.
 
void SetGlobalVar (StringHash key, const Variant &value)
 Set global variable with the respective key and value.
 
ObjectGetSubsystem (StringHash 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.
 
bool HasEventHandlers () const
 Return whether has subscribed to any event.
 
template<class T >
T * GetSubsystem () const
 Template version of returning a subsystem.
 
const StringGetCategory () const
 Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
 
- 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 OnSceneSet (Scene *scene)
 Handle scene being assigned.
 
- Protected Member Functions inherited from Urho3D::Component
virtual void OnAttributeAnimationAdded ()
 Handle attribute animation added.
 
virtual void OnAttributeAnimationRemoved ()
 Handle attribute animation removed.
 
virtual void OnNodeSet (Node *node)
 Handle scene node being assigned at creation.
 
virtual void OnMarkedDirty (Node *node)
 Handle scene node transform dirtied.
 
virtual void OnNodeSetEnabled (Node *node)
 Handle scene node enabled status changing.
 
void SetID (unsigned id)
 Set ID. Called by Scene.
 
void SetNode (Node *node)
 Set scene node. Called by Node when creating the component.
 
void HandleAttributeAnimationUpdate (StringHash eventType, VariantMap &eventData)
 Handle scene attribute animation update event.
 
ComponentGetFixedUpdateSource ()
 Return a component from the scene root that sends out fixed update events (either PhysicsWorld or PhysicsWorld2D). Return null if neither exists.
 
- Protected Member Functions inherited from Urho3D::Animatable
virtual AnimatableFindAttributeAnimationTarget (const String &name, String &outName)
 Find target of an attribute animation from object hierarchy by name.
 
void SetObjectAttributeAnimation (const String &name, ValueAnimation *attributeAnimation, WrapMode wrapMode, float speed)
 Set object attribute animation internal.
 
void OnObjectAnimationAdded (ObjectAnimation *objectAnimation)
 Handle object animation added.
 
void OnObjectAnimationRemoved (ObjectAnimation *objectAnimation)
 Handle object animation removed.
 
void UpdateAttributeAnimations (float timeStep)
 Update attribute animations.
 
bool IsAnimatedNetworkAttribute (const AttributeInfo &attrInfo) const
 Is animated network attribute.
 
AttributeAnimationInfoGetAttributeAnimationInfo (const String &name) const
 Return attribute animation info.
 
void HandleAttributeAnimationAdded (StringHash eventType, VariantMap &eventData)
 Handle attribute animation added.
 
void HandleAttributeAnimationRemoved (StringHash eventType, VariantMap &eventData)
 Handle attribute animation removed.
 

Private Member Functions

 URHO3D_OBJECT (PhysicsWorld2D, Component)
 
void HandleSceneSubsystemUpdate (StringHash eventType, VariantMap &eventData)
 Handle the scene subsystem update event, step simulation here.
 
void SendBeginContactEvents ()
 Send begin contact events.
 
void SendEndContactEvents ()
 Send end contact events.
 

Private Attributes

b2World * world_
 Box2D physics world.
 
Vector2 gravity_
 Gravity.
 
int velocityIterations_
 Velocity iterations.
 
int positionIterations_
 Position iterations.
 
WeakPtr< Scenescene_
 Extra weak pointer to scene to allow for cleanup in case the world is destroyed before other components.
 
DebugRendererdebugRenderer_
 Debug renderer.
 
bool debugDepthTest_
 Debug draw depth test mode.
 
bool updateEnabled_
 Automatic simulation update enabled flag.
 
bool physicsStepping_
 Whether is currently stepping the world. Used internally.
 
bool applyingTransforms_
 Applying transforms.
 
Vector< WeakPtr< RigidBody2D > > rigidBodies_
 Rigid bodies.
 
HashMap< RigidBody2D
*, DelayedWorldTransform2D
delayedWorldTransforms_
 Delayed (parented) world transform assignments.
 
Vector< ContactInfobeginContactInfos_
 Begin contact infos.
 
Vector< ContactInfoendContactInfos_
 End contact infos.
 

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.
 
bool enabled_
 Enabled flag.
 

Detailed Description

2D physics simulation world component. Should be added only to the root scene node.


The documentation for this class was generated from the following files:
  • Source/Urho3D/Urho2D/PhysicsWorld2D.h
  • Source/Urho3D/Urho2D/PhysicsWorld2D.cpp