Urho3D::PhysicsWorld2D Class Reference

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

#include <Urho3D/Physics2D/PhysicsWorld2D.h>

Inheritance diagram for Urho3D::PhysicsWorld2D:

Classes
struct	ContactInfo
	Contact info. More...

Public Member Functions
	PhysicsWorld2D (Context *context)
	Construct.
	~PhysicsWorld2D () override
	Destruct.
void	DrawDebugGeometry (DebugRenderer *debug, bool depthTest) override
	Visualize the component as debug geometry.
void	BeginContact (b2Contact *contact) override
	Called when two fixtures begin to touch.
void	EndContact (b2Contact *contact) override
	Called when two fixtures cease to touch.
void	PreSolve (b2Contact *contact, const b2Manifold *oldManifold) override
	Called when contact is updated.
void	DrawPolygon (const b2Vec2 *vertices, int32 vertexCount, const b2Color &color) override
	Draw a closed polygon provided in CCW order.
void	DrawSolidPolygon (const b2Vec2 *vertices, int32 vertexCount, const b2Color &color) override
	Draw a solid closed polygon provided in CCW order.
void	DrawCircle (const b2Vec2 &center, float32 radius, const b2Color &color) override
	Draw a circle.
void	DrawSolidCircle (const b2Vec2 &center, float32 radius, const b2Vec2 &axis, const b2Color &color) override
	Draw a solid circle.
void	DrawSegment (const b2Vec2 &p1, const b2Vec2 &p2, const b2Color &color) override
	Draw a line segment.
void	DrawTransform (const b2Transform &xf) override
	Draw a transform. Choose your own length scale.
void	DrawPoint (const b2Vec2 &p, float32 size, const b2Color &color) override
	Draw a point.
void	Update (float timeStep)
	Step the simulation forward.
void	DrawDebugGeometry ()
	Add debug geometry to the debug renderer.
void	SetUpdateEnabled (bool enable)
void	SetDrawShape (bool drawShape)
void	SetDrawJoint (bool drawJoint)
void	SetDrawAabb (bool drawAabb)
void	SetDrawPair (bool drawPair)
void	SetDrawCenterOfMass (bool drawCenterOfMass)
void	SetAllowSleeping (bool enable)
void	SetWarmStarting (bool enable)
void	SetContinuousPhysics (bool enable)
void	SetSubStepping (bool enable)
void	SetGravity (const Vector2 &gravity)
void	SetAutoClearForces (bool enable)
void	SetVelocityIterations (int velocityIterations)
void	SetPositionIterations (int positionIterations)
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 (ea::vector< 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.
RigidBody2D *	GetRigidBody (const Vector2 &point, unsigned collisionMask=M_MAX_UNSIGNED)
	Return rigid body at point.
RigidBody2D *	GetRigidBody (int screenX, int screenY, unsigned collisionMask=M_MAX_UNSIGNED)
	Return rigid body at screen point.
void	GetRigidBodies (ea::vector< RigidBody2D * > &results, const Rect &aabb, unsigned collisionMask=M_MAX_UNSIGNED)
	Return rigid bodies by a box query.
bool	IsUpdateEnabled () const
bool	GetDrawShape () const
bool	GetDrawJoint () const
bool	GetDrawAabb () const
bool	GetDrawPair () const
bool	GetDrawCenterOfMass () const
bool	GetAllowSleeping () const
bool	GetWarmStarting () const
bool	GetContinuousPhysics () const
bool	GetSubStepping () const
bool	GetAutoClearForces () const
const Vector2 &	GetGravity () const
int	GetVelocityIterations () const
int	GetPositionIterations () const
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.
	~Component () override
	Destruct.
virtual void	OnSetEnabled ()
	Handle enabled/disabled state change.
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 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
Scene *	GetScene () 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!
Component *	GetComponent (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)
	Construct.
	~Serializable () override
	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 ObjectReflection *	GetReflection () 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< Serializable >	Clone (bool resetToDefault=true) const
	Clone this serializable.
bool	IsTemporary () const
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
	~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 TypeInfo *	GetTypeInfo () 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.
VariantMap &	GetEventDataMap () 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.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
const VariantMap &	GetGlobalVars () const
void	SetGlobalVar (StringHash key, const Variant &value)
Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.
Object *	GetEventSender () const
	Return active event sender. Null outside event handling.
EventHandler *	GetEventHandler () 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.
RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.
int	AddRef ()
int	ReleaseRef ()
int	Refs () const
int	WeakRefs () const
RefCount *	RefCountPtr () 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 TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Protected Member Functions
void	OnSceneSet (Scene *scene) override
	Handle scene being assigned.
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.
Protected Member Functions inherited from Urho3D::Component
virtual void	OnNodeSet (Node *previousNode, Node *currentNode)
	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)
void	SetNode (Node *node)
	Set scene node. Called by Node when creating the component.
Component *	GetFixedUpdateSource ()
	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
ea::unique_ptr< b2World >	world_
	Box2D physics world.
Vector2	gravity_
	Gravity.
int	velocityIterations_ {}
	Velocity iterations.
int	positionIterations_ {}
	Position iterations.
WeakPtr< Scene >	scene_
	Extra weak pointer to scene to allow for cleanup in case the world is destroyed before other components.
DebugRenderer *	debugRenderer_ {}
	Debug renderer.
bool	debugDepthTest_ {}
	Debug draw depth test mode.
bool	updateEnabled_ {true}
	Automatic simulation update enabled flag.
bool	physicsStepping_ {}
	Whether is currently stepping the world. Used internally.
bool	applyingTransforms_ {}
	Applying transforms.
ea::vector< WeakPtr< RigidBody2D > >	rigidBodies_
	Rigid bodies.
ea::unordered_map< RigidBody2D *, DelayedWorldTransform2D >	delayedWorldTransforms_
	Delayed (parented) world transform assignments.
ea::vector< ContactInfo >	beginContactInfos_
	Begin contact infos.
ea::vector< ContactInfo >	endContactInfos_
	End contact infos.
VectorBuffer	contacts_
	Temporary buffer with contact data.
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< VariantMap >	instanceDefaultValues_
	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< Context >	context_
	Execution context.

Private Member Functions
	URHO3D_OBJECT (PhysicsWorld2D, Component)

Additional Inherited Members
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}

Detailed Description

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

Member Function Documentation

GetAllowSleeping()

bool Urho3D::PhysicsWorld2D::GetAllowSleeping

(

)

const

Return allow sleeping.

GetAutoClearForces()

bool Urho3D::PhysicsWorld2D::GetAutoClearForces

(

)

const

Return auto clear forces.

GetContinuousPhysics()

bool Urho3D::PhysicsWorld2D::GetContinuousPhysics

(

)

const

Return continuous physics.

GetDrawAabb()

bool Urho3D::PhysicsWorld2D::GetDrawAabb ( ) const

inline

Return draw aabb.

GetDrawCenterOfMass()

bool Urho3D::PhysicsWorld2D::GetDrawCenterOfMass ( ) const

inline

Return draw center of mass.

GetDrawJoint()

bool Urho3D::PhysicsWorld2D::GetDrawJoint ( ) const

inline

Return draw joint.

GetDrawPair()

bool Urho3D::PhysicsWorld2D::GetDrawPair ( ) const

inline

Return draw pair.

GetDrawShape()

bool Urho3D::PhysicsWorld2D::GetDrawShape ( ) const

inline

Return draw shape.

GetGravity()

const Vector2& Urho3D::PhysicsWorld2D::GetGravity ( ) const

inline

Return gravity.

GetPositionIterations()

int Urho3D::PhysicsWorld2D::GetPositionIterations ( ) const

inline

Return position iterations.

GetSubStepping()

bool Urho3D::PhysicsWorld2D::GetSubStepping

(

)

const

Return sub stepping.

GetVelocityIterations()

int Urho3D::PhysicsWorld2D::GetVelocityIterations ( ) const

inline

Return velocity iterations.

GetWarmStarting()

bool Urho3D::PhysicsWorld2D::GetWarmStarting

(

)

const

Return warm starting.

IsUpdateEnabled()

bool Urho3D::PhysicsWorld2D::IsUpdateEnabled ( ) const

inline

Return whether physics world will automatically simulate during scene update.

RegisterObject()

void Urho3D::PhysicsWorld2D::RegisterObject ( Context *  context )

static

Register object factory.

SetAllowSleeping()

void Urho3D::PhysicsWorld2D::SetAllowSleeping

(

bool

enable

)

Set allow sleeping.

SetAutoClearForces()

void Urho3D::PhysicsWorld2D::SetAutoClearForces

(

bool

enable

)

Set auto clear forces.

SetContinuousPhysics()

void Urho3D::PhysicsWorld2D::SetContinuousPhysics

(

bool

enable

)

Set continuous physics.

SetDrawAabb()

void Urho3D::PhysicsWorld2D::SetDrawAabb

(

bool

drawAabb

)

Set draw aabb.

SetDrawCenterOfMass()

void Urho3D::PhysicsWorld2D::SetDrawCenterOfMass

(

bool

drawCenterOfMass

)

Set draw center of mass.

SetDrawJoint()

void Urho3D::PhysicsWorld2D::SetDrawJoint

(

bool

drawJoint

)

Set draw joint.

SetDrawPair()

void Urho3D::PhysicsWorld2D::SetDrawPair

(

bool

drawPair

)

Set draw pair.

SetDrawShape()

void Urho3D::PhysicsWorld2D::SetDrawShape

(

bool

drawShape

)

Set draw shape.

SetGravity()

void Urho3D::PhysicsWorld2D::SetGravity

(

const Vector2 &

gravity

)

Set gravity.

SetPositionIterations()

void Urho3D::PhysicsWorld2D::SetPositionIterations

(

int

positionIterations

)

Set position iterations.

SetSubStepping()

void Urho3D::PhysicsWorld2D::SetSubStepping

(

bool

enable

)

Set sub stepping.

SetUpdateEnabled()

void Urho3D::PhysicsWorld2D::SetUpdateEnabled

(

bool

enable

)

Enable or disable automatic physics simulation during scene update. Enabled by default.

SetVelocityIterations()

void Urho3D::PhysicsWorld2D::SetVelocityIterations

(

int

velocityIterations

)

Set velocity iterations.

SetWarmStarting()

void Urho3D::PhysicsWorld2D::SetWarmStarting

(

bool

enable

)

Set warm starting.

---

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

• Urho3D/Physics2D/PhysicsWorld2D.h
• Urho3D/Physics2D/PhysicsWorld2D.cpp