Urho3D::CollisionShape Class Reference

Physics collision shape component. More...

#include <Urho3D/Physics/CollisionShape.h>

Inheritance diagram for Urho3D::CollisionShape:

Public Member Functions
	CollisionShape (Context *context)
	Construct.
	~CollisionShape () override
	Destruct. Free the geometry data and clean up unused data from the geometry data cache.
void	ApplyAttributes () override
	Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
void	OnSetEnabled () override
	Handle enabled/disabled state change.
void	DrawDebugGeometry (DebugRenderer *debug, bool depthTest) override
	Visualize the component as debug geometry.
void	DrawDebugGeometry (DebugRenderer *debug, const Color &color, bool depthTest)
	Draw the shape as debug geometry.
void	SetBox (const Vector3 &size, const Vector3 &position=Vector3::ZERO, const Quaternion &rotation=Quaternion::IDENTITY)
	Set as a box.
void	SetSphere (float diameter, const Vector3 &position=Vector3::ZERO, const Quaternion &rotation=Quaternion::IDENTITY)
	Set as a sphere.
void	SetStaticPlane (const Vector3 &position=Vector3::ZERO, const Quaternion &rotation=Quaternion::IDENTITY)
	Set as a static plane.
void	SetCylinder (float diameter, float height, const Vector3 &position=Vector3::ZERO, const Quaternion &rotation=Quaternion::IDENTITY)
	Set as a cylinder.
void	SetCapsule (float diameter, float height, const Vector3 &position=Vector3::ZERO, const Quaternion &rotation=Quaternion::IDENTITY)
	Set as a capsule.
void	SetCone (float diameter, float height, const Vector3 &position=Vector3::ZERO, const Quaternion &rotation=Quaternion::IDENTITY)
	Set as a cone.
void	SetTriangleMesh (Model *model, unsigned lodLevel=0, const Vector3 &scale=Vector3::ONE, const Vector3 &position=Vector3::ZERO, const Quaternion &rotation=Quaternion::IDENTITY)
	Set as a triangle mesh from Model. If you update a model's geometry and want to reapply the shape, call physicsWorld->RemoveCachedGeometry(model) first.
void	SetCustomTriangleMesh (CustomGeometry *custom, const Vector3 &scale=Vector3::ONE, const Vector3 &position=Vector3::ZERO, const Quaternion &rotation=Quaternion::IDENTITY)
	Set as a triangle mesh from CustomGeometry.
void	SetConvexHull (Model *model, unsigned lodLevel=0, const Vector3 &scale=Vector3::ONE, const Vector3 &position=Vector3::ZERO, const Quaternion &rotation=Quaternion::IDENTITY)
	Set as a convex hull from Model.
void	SetCustomConvexHull (CustomGeometry *custom, const Vector3 &scale=Vector3::ONE, const Vector3 &position=Vector3::ZERO, const Quaternion &rotation=Quaternion::IDENTITY)
	Set as a convex hull from CustomGeometry.
void	SetGImpactMesh (Model *model, unsigned lodLevel=0, const Vector3 &scale=Vector3::ONE, const Vector3 &position=Vector3::ZERO, const Quaternion &rotation=Quaternion::IDENTITY)
	Set as a triangle mesh from Model. If you update a model's geometry and want to reapply the shape, call physicsWorld->RemoveCachedGeometry(model) first.
void	SetCustomGImpactMesh (CustomGeometry *custom, const Vector3 &scale=Vector3::ONE, const Vector3 &position=Vector3::ZERO, const Quaternion &rotation=Quaternion::IDENTITY)
	Set as a triangle mesh from CustomGeometry.
void	SetTerrain (unsigned lodLevel=0)
	Set as a terrain. Only works if the same scene node contains a Terrain component.
void	SetShapeType (ShapeType type)
void	SetSize (const Vector3 &size)
void	SetPosition (const Vector3 &position)
void	SetRotation (const Quaternion &rotation)
void	SetTransform (const Vector3 &position, const Quaternion &rotation)
	Set offset transform.
void	SetMargin (float margin)
void	SetModel (Model *model)
void	SetLodLevel (unsigned lodLevel)
btCollisionShape *	GetCollisionShape () const
	Return Bullet collision shape.
CollisionGeometryData *	GetGeometryData () const
	Return the shared geometry data.
PhysicsWorld *	GetPhysicsWorld () const
	Return physics world.
ShapeType	GetShapeType () const
const Vector3 &	GetSize () const
const Vector3 &	GetPosition () const
const Quaternion &	GetRotation () const
float	GetMargin () const
Model *	GetModel () const
unsigned	GetLodLevel () const
BoundingBox	GetWorldBoundingBox () const
void	NotifyRigidBody (bool updateMass=true)
	Update the new collision shape to the RigidBody.
void	SetModelAttr (const ResourceRef &value)
	Set model attribute.
ResourceRef	GetModelAttr () const
	Return model attribute.
void	ReleaseShape ()
	Release the collision shape.
Public Member Functions inherited from Urho3D::Component
	Component (Context *context)
	Construct.
	~Component () override
	Destruct.
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 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	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.
virtual btCollisionShape *	UpdateDerivedShape (int shapeType, const Vector3 &newWorldScale)
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.
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.

Private Member Functions
	URHO3D_OBJECT (CollisionShape, Component)
btCompoundShape *	GetParentCompoundShape ()
	Find the parent rigid body component and return its compound collision shape.
void	UpdateShape ()
	Update the collision shape after attribute changes.
void	UpdateCachedGeometryShape (CollisionGeometryDataCache &cache)
	Update cached geometry collision shape.
void	SetModelShape (ShapeType shapeType, Model *model, unsigned lodLevel, const Vector3 &scale, const Vector3 &position, const Quaternion &rotation)
	Set as specified shape type using model and LOD.
void	SetCustomShape (ShapeType shapeType, CustomGeometry *custom, const Vector3 &scale, const Vector3 &position, const Quaternion &rotation)
	Set as specified shape type using CustomGeometry.
void	HandleTerrainCreated (StringHash eventType, VariantMap &eventData)
	Update terrain collision shape from the terrain component.
void	HandleModelReloadFinished (StringHash eventType, VariantMap &eventData)
	Update trimesh or convex shape after a model has reloaded itself.
void	MarkShapeDirty ()
	Mark shape dirty.

Private Attributes
WeakPtr< PhysicsWorld >	physicsWorld_
	Physics world.
WeakPtr< RigidBody >	rigidBody_
	Rigid body.
SharedPtr< Model >	model_
	Model.
SharedPtr< CollisionGeometryData >	geometry_
	Shared geometry data.
ea::unique_ptr< btCollisionShape >	shape_
	Bullet collision shape.
ShapeType	shapeType_
	Collision shape type.
Vector3	position_
	Offset position.
Quaternion	rotation_
	Offset rotation.
Vector3	size_
	Shape size.
Vector3	cachedWorldScale_
	Cached world scale for determining if the collision shape needs update.
unsigned	lodLevel_
	Model LOD level.
unsigned	customGeometryID_
	CustomGeometry component ID. 0 if not creating the convex hull / triangle mesh from a CustomGeometry.
float	margin_
	Collision margin.
bool	recreateShape_
	Recreate collision shape flag.
bool	retryCreation_
	Shape creation retry flag if attributes initially set without scene.

Additional Inherited Members
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}
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.

Detailed Description

Physics collision shape component.

Member Function Documentation

GetLodLevel()

unsigned Urho3D::CollisionShape::GetLodLevel ( ) const

inline

Return model LOD level.

GetMargin()

float Urho3D::CollisionShape::GetMargin ( ) const

inline

Return collision margin.

GetModel()

Model* Urho3D::CollisionShape::GetModel ( ) const

inline

Return triangle mesh / convex hull model.

GetPosition()

const Vector3& Urho3D::CollisionShape::GetPosition ( ) const

inline

Return offset position.

GetRotation()

const Quaternion& Urho3D::CollisionShape::GetRotation ( ) const

inline

Return offset rotation.

GetShapeType()

ShapeType Urho3D::CollisionShape::GetShapeType ( ) const

inline

Return shape type.

GetSize()

const Vector3& Urho3D::CollisionShape::GetSize ( ) const

inline

Return shape size.

GetWorldBoundingBox()

BoundingBox Urho3D::CollisionShape::GetWorldBoundingBox

(

)

const

Return world-space bounding box.

RegisterObject()

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

static

Register object factory.

SetLodLevel()

void Urho3D::CollisionShape::SetLodLevel

(

unsigned

lodLevel

)

Set model LOD level.

SetMargin()

void Urho3D::CollisionShape::SetMargin

(

float

margin

)

Set collision margin.

SetModel()

void Urho3D::CollisionShape::SetModel

(

Model *

model

)

Set triangle mesh / convex hull model.

SetPosition()

void Urho3D::CollisionShape::SetPosition

(

const Vector3 &

position

)

Set offset position.

SetRotation()

void Urho3D::CollisionShape::SetRotation

(

const Quaternion &

rotation

)

Set offset rotation.

SetShapeType()

void Urho3D::CollisionShape::SetShapeType

(

ShapeType

type

)

Set shape type.

SetSize()

void Urho3D::CollisionShape::SetSize

(

const Vector3 &

size

)

Set shape size.

UpdateDerivedShape()

btCollisionShape * Urho3D::CollisionShape::UpdateDerivedShape ( int  shapeType, const Vector3 &  newWorldScale  )

protectedvirtual

Called when instantiating a collision shape that is not one of ShapeType (default no-op).

Useful for custom shape types that subclass CollisionShape and use a non-standard underlying btCollisionShape. UpdateDerivedShape can then be overridden to create the required btCollisionShape subclass.

---

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

• Urho3D/Physics/CollisionShape.h
• Urho3D/Physics/CollisionShape.cpp