Rebel Fork Framework
Urho3D::KinematicCharacterController Class Reference
Inheritance diagram for Urho3D::KinematicCharacterController:
Urho3D::Component Urho3D::Serializable Urho3D::Object Urho3D::RefCounted

Public Member Functions

 KinematicCharacterController (Context *context)
 ~KinematicCharacterController () override
void OnSetAttribute (const AttributeInfo &attr, const Variant &src) override
 Handle attribute write access. Default implementation writes to the variable at offset, or invokes the set accessor.
void ApplyAttributes () override
 Perform post-load after deserialization. Acquire the components from the scene nodes.
Vector3 GetRawPosition () const
 Return character position in world space without interpolation.
void AdjustRawPosition (const Vector3 &offset, float smoothConstant)
 Adjust position of kinematic body.
void SetCollisionLayer (unsigned layer)
 Set collision layer.
unsigned GetCollisionLayer () const
 Return collision layer.
void SetCollisionMask (unsigned mask)
 Set collision mask.
unsigned GetCollisionMask () const
 Return collision mask.
void SetCollisionLayerAndMask (unsigned layer, unsigned mask)
 Set collision group and mask.
void SetTrigger (bool enable)
 Set rigid body trigger mode. In trigger mode kinematic characters don't affect rigid bodies and don't collide with each other.
bool IsTrigger () const
 Return whether this RigidBody is acting as a trigger.
void SetGravity (const Vector3 &gravity)
 Set gravity.
const Vector3GetGravity () const
 Get gravity.
void SetLinearDamping (float linearDamping)
 Set linear velocity damping factor.
float GetLinearDamping () const
 Return linear velocity damping factor.
void SetAngularDamping (float angularDamping)
 Set angular velocity damping factor.
float GetAngularDamping () const
 Return linear velocity damping factor.
void SetHeight (float height)
 Set character height.
float GetHeight () const
 Return character height.
void SetDiameter (float diameter)
 Set character diameter.
float GetDiameter () const
 Return character diameter.
void SetActivateTriggers (bool activateTriggers)
 Set activate triggers flag.
bool GetActivateTriggers () const
 Get activate triggers flag.
void SetOffset (const Vector3 &offset)
 Set character collider offset.
const Vector3GetOffset () const
 Return character collider offset.
void SetStepHeight (float stepHeight)
 Set step height.
float GetStepHeight () const
 Return step height.
void SetMaxJumpHeight (float maxJumpHeight)
 Set max jump height.
float GetMaxJumpHeight () const
 Return max jump height.
void SetFallSpeed (float fallSpeed)
 Set fall speed (terminal velocity).
float GetFallSpeed () const
 Return fall speed (terminal velocity).
void SetJumpSpeed (float jumpSpeed)
 Set jump speed.
float GetJumpSpeed () const
 Return jump speed.
void SetMaxSlope (float maxSlope)
 Set max slope angle in degrees.
float GetMaxSlope () const
 Return max slope angle in degrees.
void SetWalkIncrement (const Vector3 &walkDir)
 Set walk increment. This is neither a direction nor a velocity, but the amount to increment the position each simulation iteration, regardless of dt.
bool OnGround () const
 Check if character in on the ground.
void Jump (const Vector3 &jump=Vector3::ZERO)
void ApplyImpulse (const Vector3 &impulse)
 ApplyImpulse is same as Jump.
bool CanJump () const
 Check if character can jump.
void SetAngularVelocity (const Vector3 &velocity)
 Set angular velocity.
const Vector3 GetAngularVelocity () const
 Return angular velocity.
void SetLinearVelocity (const Vector3 &velocity)
 Set linear velocity.
const Vector3 GetLinearVelocity () const
 Return linear velocity.
virtual void DrawDebugGeometry ()
 Draw debug geometry.
- Public Member Functions inherited from Urho3D::Component
 Component (Context *context)
 ~Component () override
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 void DrawDebugGeometry (DebugRenderer *debug, bool depthTest)
 Visualize the component as debug geometry.
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 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 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.
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 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.
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)
 Register object factory and attributes.
- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.

Protected Member Functions

btCapsuleShape * GetOrCreateShape ()
void ResetShape ()
void ReleaseKinematic ()
void ApplySettings (bool readdToWorld)
void OnNodeSet (Node *previousNode, Node *currentNode) override
 Handle scene node being assigned at creation.
void OnSceneSet (Scene *scene) override
 Handle scene being assigned. This may happen several times during the component's lifetime. Scene-wide subsystems and events are subscribed to here.
void AddKinematicToWorld ()
void RemoveKinematicFromWorld ()
void WarpKinematic (const Vector3 &position)
 Instantly reset character position to new value.
void HandlePhysicsPreUpdate (StringHash eventType, VariantMap &eventData)
void HandlePhysicsPostStep (StringHash eventType, VariantMap &eventData)
void HandlePhysicsPostUpdate (StringHash eventType, VariantMap &eventData)
void SendCollisionEvent (StringHash physicsEvent, StringHash nodeEvent, RigidBody *otherBody)
void ActivateTriggers ()
- Protected Member Functions inherited from Urho3D::Component
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.
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

unsigned colLayer_ { 1 }
unsigned colMask_ { 0xffff }
float height_ { 1.8f }
float diameter_ { 0.7f }
float stepHeight_ { 0.4f }
float maxJumpHeight_ { 2.0f }
float jumpSpeed_ { 9.0f }
float fallSpeed_ { 55.0f }
float maxSlope_ { 45.0f }
float linearDamping_ { 0.2f }
float angularDamping_ { 0.2f }
bool activateTriggers_ {true}
Vector3 gravity_ { Vector3(0.0f, -14.0f, 0.0f) }
WeakPtr< PhysicsWorldphysicsWorld_
ea::unique_ptr< btCapsuleShape > shape_
 Bullet collision shape.
ea::unique_ptr< btPairCachingGhostObject > pairCachingGhostObject_
ea::unique_ptr< btKinematicCharacterController > kinematicController_
ea::unordered_map< SharedPtr< RigidBody >, bool > activeTriggerContacts_
bool activeTriggerFlag_ {}
Vector3 colShapeOffset_ { 0.0f, 0.9f, 0.0f }
bool readdToWorld_ { false }
Vector3 positionOffset_
 Offset used for smooth Node position adjustment.
float smoothingConstant_ {}
 Constant used to fade out position offset.
VariantMap physicsCollisionData_
 Cached event data for physics collision.
VariantMap nodeCollisionData_
 Cached event data for node collision.
Vector3 previousPosition_
Vector3 nextPosition_
Vector3 latestPosition_
- 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.

Private Member Functions

 URHO3D_OBJECT (KinematicCharacterController, Component)

Member Data Documentation

◆ previousPosition_

Vector3 Urho3D::KinematicCharacterController::previousPosition_

Position used for interpolation and the final result.

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