Rebel Fork Framework
Urho3D::RigidBody2D Class Reference

2D rigid body component. More...

#include <Urho3D/Physics2D/RigidBody2D.h>

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

Public Member Functions

 RigidBody2D (Context *context)
 ~RigidBody2D () override
void OnSetEnabled () override
 Handle enabled/disabled state change.
void SetBodyType (BodyType2D type)
void SetMass (float mass)
void SetInertia (float inertia)
void SetMassCenter (const Vector2 &center)
void SetUseFixtureMass (bool useFixtureMass)
void SetLinearDamping (float linearDamping)
void SetAngularDamping (float angularDamping)
void SetAllowSleep (bool allowSleep)
void SetFixedRotation (bool fixedRotation)
void SetBullet (bool bullet)
void SetGravityScale (float gravityScale)
void SetAwake (bool awake)
void SetLinearVelocity (const Vector2 &linearVelocity)
void SetAngularVelocity (float angularVelocity)
 Set angular velocity.
void ApplyForce (const Vector2 &force, const Vector2 &point, bool wake)
 Apply force.
void ApplyForceToCenter (const Vector2 &force, bool wake)
 Apply force to center.
void ApplyTorque (float torque, bool wake)
 Apply Torque.
void ApplyLinearImpulse (const Vector2 &impulse, const Vector2 &point, bool wake)
 Apply linear impulse.
void ApplyLinearImpulseToCenter (const Vector2 &impulse, bool wake)
 Apply linear impulse to center.
void ApplyAngularImpulse (float impulse, bool wake)
 Apply angular impulse.
void CreateBody ()
 Create body.
void ReleaseBody ()
 Release body.
void ApplyWorldTransform ()
 Apply world transform from the Box2D body. Called by PhysicsWorld2D.
void ApplyWorldTransform (const Vector3 &newWorldPosition, const Quaternion &newWorldRotation)
 Apply specified world position & rotation. Called by PhysicsWorld2D.
void AddCollisionShape2D (CollisionShape2D *collisionShape)
 Add collision shape.
void RemoveCollisionShape2D (CollisionShape2D *collisionShape)
 Remove collision shape.
void AddConstraint2D (Constraint2D *constraint)
 Add constraint.
void RemoveConstraint2D (Constraint2D *constraint)
 Remove constraint.
BodyType2D GetBodyType () const
float GetMass () const
float GetInertia () const
Vector2 GetMassCenter () const
bool GetUseFixtureMass () const
float GetLinearDamping () const
float GetAngularDamping () const
bool IsAllowSleep () const
bool IsFixedRotation () const
bool IsBullet () const
float GetGravityScale () const
bool IsAwake () const
Vector2 GetLinearVelocity () const
float GetAngularVelocity () const
 Return angular velocity.
b2Body * GetBody () const
 Return Box2D body.
- Public Member Functions inherited from Urho3D::Component
 Component (Context *context)
 ~Component () override
AttributeScopeHint GetEffectiveScopeHint () const
bool Save (Serializer &dest) const override
 Save as binary data. Return true if successful.
bool SaveXML (XMLElement &dest) const override
 Save as XML data. Return true if successful.
bool SaveJSON (JSONValue &dest) const override
 Save as JSON data. Return true if successful.
virtual void GetDependencyNodes (ea::vector< Node * > &dest)
 Return the depended on nodes to order network updates.
virtual void DrawDebugGeometry (DebugRenderer *debug, bool depthTest)
 Visualize the component as debug geometry.
virtual bool HasAuxiliaryData () const
virtual void SerializeAuxiliaryData (Archive &archive)
 Serialize auxiliary data from/to the current block of the archive. May throw ArchiveException.
void SetEnabled (bool enable)
void Remove ()
 Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
unsigned GetID () const
Node * GetNode () const
SceneGetScene () const
 Return the scene the node belongs to.
bool IsEnabled () const
bool IsEnabledEffective () const
ea::string GetFullNameDebug () const
 Return full component name for debugging. Unique for each component in the scene. Slow!
ComponentGetComponent (StringHash 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.
unsigned GetIndexInParent () const
 Return index of this component in the node.
- Public Member Functions inherited from Urho3D::Serializable
 Serializable (Context *context)
 ~Serializable () override
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 ObjectReflectionGetReflection () const
 Return reflection used for serialization.
virtual const ea::vector< AttributeInfo > * GetAttributes () const
 Return attribute descriptions, or null if none defined.
void SerializeInBlock (Archive &archive) override
 Serialize content from/to archive. May throw ArchiveException.
void SerializeInBlock (Archive &archive, bool serializeTemporary)
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.
virtual bool LoadJSON (const JSONValue &source)
 Load from JSON data. Return true if successful.
virtual bool Load (const ea::string &resourceName)
 Load from binary resource.
virtual bool LoadXML (const ea::string &resourceName)
 Load from XML resource.
virtual bool LoadJSON (const ea::string &resourceName)
 Load from JSON resource.
virtual bool LoadFile (const ea::string &resourceName)
 Load from resource of automatically detected type.
virtual void ApplyAttributes ()
 Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
virtual bool SaveDefaultAttributes (const AttributeInfo &attr) const
 Return whether should save default-valued attributes into XML. Default false.
bool SetAttribute (unsigned index, const Variant &value)
bool SetAttribute (const ea::string &name, const Variant &value)
 Set attribute by name. Return true if successfully set.
void SetInstanceDefault (bool enable)
 (Internal use) Set instance-level default flag.
void SetInstanceDefault (const ea::string &name, const Variant &defaultValue)
 (Internal use) Set instance-level default value. Allocate the internal data structure as necessary.
virtual Variant GetInstanceDefault (const ea::string &name) const
 (Internal use) Get instance-level default value.
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)
Variant GetAttribute (unsigned index) const
Variant GetAttribute (const ea::string &name) const
 Return attribute value by name. Return empty if not found.
Variant GetAttributeDefault (unsigned index) const
Variant GetAttributeDefault (const ea::string &name) const
 Return attribute default value by name. Return empty if not found.
unsigned GetNumAttributes () const
void CopyAttributes (const Serializable *source, bool resetToDefault=true)
 Copy all attributes from another serializable.
SharedPtr< SerializableClone (bool resetToDefault=true) const
 Clone this serializable.
bool IsTemporary () const
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 ~Object () override
 Destruct. Clean up self from event sender & receiver structures.
virtual StringHash GetType () const =0
virtual const ea::string & GetTypeName () const =0
virtual const TypeInfoGetTypeInfo () const =0
 Return type info.
virtual bool IsInstanceOf (StringHash type) const =0
 Check whether current instance implements specified type.
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
template<typename T >
bool IsInstanceOf () const
 Check current instance is type of specified class.
template<typename T >
T * Cast ()
 Cast the object to specified most derived class.
template<typename T >
const T * Cast () const
 Cast the object to specified most derived class.
void SubscribeToEventManual (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
void SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
template<class T >
void SubscribeToEvent (StringHash eventType, T handler)
 Subscribe to an event that can be sent by any sender.
template<class T >
void SubscribeToEvent (Object *sender, StringHash eventType, T 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 ea::vector< StringHash > &exceptions)
 Unsubscribe from all events except those listed.
void UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
 Unsubscribe from all events except those with listed senders.
void SendEvent (StringHash eventType)
 Send event to all subscribers.
void SendEvent (StringHash eventType, VariantMap &eventData)
 Send event with parameters to all subscribers.
VariantMapGetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void SendEvent (StringHash eventType, const Args &... args)
 Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
ContextGetContext () const
 Return execution context.
const VariantGetGlobalVar (StringHash key) const
const VariantMapGetGlobalVars () const
void SetGlobalVar (StringHash key, const Variant &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 ea::string & GetCategory () const
void SendEvent (StringHash eventType, const VariantMap &eventData)
 Send event with parameters to all subscribers.
void SetBlockEvents (bool block)
 Block object from sending and receiving events.
bool GetBlockEvents () const
 Return sending and receiving events blocking status.
- 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.
 RefCounted (const RefCounted &rhs)=delete
 Prevent copy construction.
RefCountedoperator= (const RefCounted &rhs)=delete
 Prevent assignment.
int AddRef ()
int ReleaseRef ()
int Refs () const
int WeakRefs () const
RefCountRefCountPtr () const
 Return pointer to the reference count structure.
bool HasScriptObject () const
 Return true if script runtime object wrapping this native object exists.
bool IsScriptStrongRef () const
 Return true if script reference is strong.

Static Public Member Functions

static void RegisterObject (Context *context)
- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.

Private Member Functions

 URHO3D_OBJECT (RigidBody2D, Component)
void OnNodeSet (Node *previousNode, Node *currentNode) override
 Handle node being assigned.
void OnSceneSet (Scene *scene) override
 Handle scene being assigned.
void OnMarkedDirty (Node *node) override
 Handle node transform being dirtied.

Private Attributes

WeakPtr< PhysicsWorld2DphysicsWorld_
 Physics world.
b2BodyDef bodyDef_
 Box2D body define.
b2MassData massData_
 Box2D mass data.
bool useFixtureMass_
 Use fixture mass (calculate mass & inertia from collision shapes automatically).
b2Body * body_
 Box2D body.
ea::vector< WeakPtr< CollisionShape2D > > collisionShapes_
 Collision shapes.
ea::vector< WeakPtr< Constraint2D > > constraints_

Additional Inherited Members

- Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 > TypeHierarchy {}
- Protected Member Functions inherited from Urho3D::Component
virtual void OnNodeSetEnabled (Node *node)
 Handle scene node enabled status changing.
void SetID (unsigned id)
void SetNode (Node *node)
 Set scene node. Called by Node when creating the component.
ComponentGetFixedUpdateSource ()
 Return a component from the scene root that sends out fixed update events (either PhysicsWorld or PhysicsWorld2D). Return null if neither exists.
void DoAutoRemove (AutoRemoveMode mode)
 Perform autoremove. Called by subclasses. Caller should keep a weak pointer to itself to check whether was actually removed, and return immediately without further member operations in that case.
- Protected Attributes inherited from Urho3D::Component
Node * node_
 Scene node.
unsigned id_
 Unique ID within the scene.
bool networkUpdate_
 Network update queued flag.
bool enabled_
 Enabled flag.
- Protected Attributes inherited from Urho3D::Serializable
ea::unique_ptr< VariantMapinstanceDefaultValues_
 Attribute default value at each instance level.
bool setInstanceDefault_
 When true, store the attribute value as instance's default value (internal use only).
bool temporary_
 Temporary flag.
- Protected Attributes inherited from Urho3D::Object
WeakPtr< Contextcontext_
 Execution context.

Detailed Description

2D rigid body component.

Member Function Documentation

◆ GetAngularDamping()

float Urho3D::RigidBody2D::GetAngularDamping ( ) const

Return angular damping.

◆ GetBodyType()

BodyType2D Urho3D::RigidBody2D::GetBodyType ( ) const

Return body type.

◆ GetGravityScale()

float Urho3D::RigidBody2D::GetGravityScale ( ) const

Return gravity scale.

◆ GetInertia()

float Urho3D::RigidBody2D::GetInertia ( ) const

Return inertia.

◆ GetLinearDamping()

float Urho3D::RigidBody2D::GetLinearDamping ( ) const

Return linear damping.

◆ GetLinearVelocity()

Vector2 Urho3D::RigidBody2D::GetLinearVelocity ( ) const

Return linear velocity.

◆ GetMass()

float Urho3D::RigidBody2D::GetMass ( ) const

Return mass.

◆ GetMassCenter()

Vector2 Urho3D::RigidBody2D::GetMassCenter ( ) const

Return mass center.

◆ GetUseFixtureMass()

bool Urho3D::RigidBody2D::GetUseFixtureMass ( ) const

Return whether to calculate mass and inertia from collision shapes automatically.

◆ IsAllowSleep()

bool Urho3D::RigidBody2D::IsAllowSleep ( ) const

Return allow sleep.

◆ IsAwake()

bool Urho3D::RigidBody2D::IsAwake ( ) const

Return awake.

◆ IsBullet()

bool Urho3D::RigidBody2D::IsBullet ( ) const

Return bullet mode.

◆ IsFixedRotation()

bool Urho3D::RigidBody2D::IsFixedRotation ( ) const

Return fixed rotation.

◆ RegisterObject()

void Urho3D::RigidBody2D::RegisterObject ( Context context)

Register object factory.

◆ SetAllowSleep()

void Urho3D::RigidBody2D::SetAllowSleep ( bool  allowSleep)

Set allow sleep.

◆ SetAngularDamping()

void Urho3D::RigidBody2D::SetAngularDamping ( float  angularDamping)

Set angular damping.

◆ SetAwake()

void Urho3D::RigidBody2D::SetAwake ( bool  awake)

Set awake.

◆ SetBodyType()

void Urho3D::RigidBody2D::SetBodyType ( BodyType2D  type)

Set body type.

◆ SetBullet()

void Urho3D::RigidBody2D::SetBullet ( bool  bullet)

Set bullet mode.

◆ SetFixedRotation()

void Urho3D::RigidBody2D::SetFixedRotation ( bool  fixedRotation)

Set fixed rotation.

◆ SetGravityScale()

void Urho3D::RigidBody2D::SetGravityScale ( float  gravityScale)

Set gravity scale.

◆ SetInertia()

void Urho3D::RigidBody2D::SetInertia ( float  inertia)

Set inertia.

◆ SetLinearDamping()

void Urho3D::RigidBody2D::SetLinearDamping ( float  linearDamping)

Set linear damping.

◆ SetLinearVelocity()

void Urho3D::RigidBody2D::SetLinearVelocity ( const Vector2 linearVelocity)

Set linear velocity.

◆ SetMass()

void Urho3D::RigidBody2D::SetMass ( float  mass)

Set mass.

◆ SetMassCenter()

void Urho3D::RigidBody2D::SetMassCenter ( const Vector2 center)

Set mass center.

◆ SetUseFixtureMass()

void Urho3D::RigidBody2D::SetUseFixtureMass ( bool  useFixtureMass)

Set whether to automatically calculate mass and inertia from collision shapes. Default true.

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