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

Public Member Functions

 RaycastVehicle (Urho3D::Context *context)
 Construct.
 
 ~RaycastVehicle () override
 Destruct.
 
void OnSetEnabled () override
 Handle enabled/disabled state change.
 
void ApplyAttributes () override
 Perform post-load after deserialization. Acquire the components from the scene nodes.
 
void AddWheel (Node *wheelNode, Vector3 wheelDirection, Vector3 wheelAxle, float restLength, float wheelRadius, bool frontWheel)
 Add a wheel. All parameters are relative to RigidBody / node.
 
void ResetSuspension ()
 Reset all suspension.
 
void UpdateWheelTransform (int wheel, bool interpolated)
 Update transform for particular wheel.
 
void SetSteeringValue (int wheel, float steeringValue)
 Set steering value of particular wheel.
 
void SetWheelSuspensionStiffness (int wheel, float stiffness)
 Set suspension stiffness for particular wheel.
 
void SetWheelMaxSuspensionForce (int wheel, float force)
 Set wheel max suspension force. Good results are often obtained by a value that is about 3x to 4x the vehicle weight.
 
void SetWheelDampingRelaxation (int wheel, float damping)
 Set wheel damping relaxation.
 
void SetWheelDampingCompression (int wheel, float compression)
 Set wheel damping compression.
 
void SetWheelFrictionSlip (int wheel, float slip)
 Set wheel friction slip.
 
void SetWheelRollInfluence (int wheel, float rollInfluence)
 Set wheel roll influence.
 
void SetEngineForce (int wheel, float force)
 Set engine force for the wheel.
 
void SetBrake (int wheel, float force)
 Set hand brake (wheel rotation blocking force).
 
void SetWheelRadius (int wheel, float wheelRadius)
 Set wheel radius.
 
void ResetWheels ()
 Sets node initial positions.
 
void SetWheelSkidInfo (int wheel, float factor)
 Set sliding factor 0 <= x <= 1. The less the value, more sliding.
 
bool WheelIsGrounded (int wheel) const
 True if wheel touches ground (raycast hits something).
 
void SetMaxSuspensionTravel (int wheel, float maxSuspensionTravel)
 Set maximum suspension travel value.
 
void SetWheelDirection (int wheel, Vector3 direction)
 Set wheel direction vector.
 
void SetWheelAxle (int wheel, Vector3 axle)
 Set wheel axle vector.
 
void SetMaxSideSlipSpeed (float speed)
 
void SetWheelSkidInfoCumulative (int wheel, float skid)
 Set cumulative skid info.
 
void SetInAirRPM (float rpm)
 
void SetCoordinateSystem (const IntVector3 &coordinateSystem=RIGHT_FORWARD_UP)
 
void Init ()
 Init the vehicle component after creation.
 
void FixedUpdate (float timeStep) override
 Perform fixed step pre-update.
 
void FixedPostUpdate (float timeStep) override
 Perform fixed step post-update.
 
void PostUpdate (float timeStep) override
 Perform variable step post-update.
 
Vector3 GetWheelPosition (int wheel)
 Get wheel position relative to RigidBody.
 
Quaternion GetWheelRotation (int wheel)
 Get wheel rotation relative to RigidBody.
 
Vector3 GetWheelConnectionPoint (int wheel) const
 Get wheel connection point relative to RigidBody.
 
int GetNumWheels () const
 
NodeGetWheelNode (int wheel) const
 Get node of the wheel.
 
float GetSteeringValue (int wheel) const
 Get steering value of particular wheel.
 
float GetWheelSuspensionStiffness (int wheel) const
 Get suspension stiffness for particular wheel.
 
float GetWheelMaxSuspensionForce (int wheel) const
 Get wheel max suspension force.
 
float GetWheelDampingRelaxation (int wheel) const
 Get wheel damping relaxation.
 
float GetWheelDampingCompression (int wheel) const
 Get wheel damping compression.
 
float GetWheelFrictionSlip (int wheel) const
 Get wheel friction slip.
 
float GetWheelRollInfluence (int wheel) const
 Get wheel roll influence.
 
float GetEngineForce (int wheel) const
 Get engine force for the wheel.
 
float GetBrake (int wheel) const
 Get hand brake value.
 
float GetWheelRadius (int wheel) const
 Get wheel radius.
 
void SetWheelRestLength (int wheel, float length)
 Get wheel rest length.
 
float GetWheelRestLength (int wheel) const
 Get wheel rest length.
 
float GetMaxSuspensionTravel (int wheel)
 Get maximum suspension travel value.
 
Vector3 GetWheelAxle (int wheel) const
 Get wheel axle vector.
 
float GetWheelSideSlipSpeed (int wheel) const
 Get wheel slide speed.
 
float GetMaxSideSlipSpeed () const
 
float GetWheelSkidInfo (int wheel) const
 Sliding factor 0 <= x <= 1.
 
Vector3 GetWheelDirection (int wheel) const
 Get wheel direction vector.
 
float GetWheelSkidInfoCumulative (int wheel) const
 Get cumulative skid info.
 
bool IsFrontWheel (int wheel) const
 True if front wheel, otherwise false.
 
Vector3 GetContactPosition (int wheel) const
 Get wheel contact position.
 
Vector3 GetContactNormal (int wheel) const
 Get contact normal.
 
float GetInAirRPM () const
 
IntVector3 GetCoordinateSystem () const
 
VariantVector GetWheelDataAttr () const
 Get wheel data attribute for serialization.
 
void SetWheelDataAttr (const VariantVector &value)
 Set wheel data attribute during loading.
 
- Public Member Functions inherited from Urho3D::Component
 Component (Context *context)
 Construct.
 
 ~Component () override
 Destruct.
 
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.
 
void MarkNetworkUpdate () override
 Mark for attribute check on the next network update.
 
virtual void GetDependencyNodes (PODVector< 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
 
bool IsReplicated () const
 
NodeGetNode () const
 
SceneGetScene () const
 Return the scene the node belongs to.
 
bool IsEnabled () const
 
bool IsEnabledEffective () const
 
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.
 
 ~Animatable () override
 Destruct.
 
bool LoadXML (const XMLElement &source) override
 Load from XML data. Return true if successful.
 
bool LoadJSON (const JSONValue &source) override
 Load from JSON data. Return true if successful.
 
void SetAnimationEnabled (bool enable)
 
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)
 
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
 
ObjectAnimationGetObjectAnimation () const
 
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.
 
 ~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 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)
 Load from binary data. Return true if successful.
 
virtual bool SaveDefaultAttributes () const
 Return whether should save default-valued attributes into XML. Default false.
 
bool SetAttribute (unsigned index, const Variant &value)
 
bool SetAttribute (const String &name, const Variant &value)
 Set attribute by name. Return true if successfully set.
 
void SetInstanceDefault (bool enable)
 Set instance-level default flag.
 
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)
 
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
 
Variant GetAttribute (const String &name) const
 Return attribute value by name. Return empty if not found.
 
Variant GetAttributeDefault (unsigned index) const
 
Variant GetAttributeDefault (const String &name) const
 Return attribute default value by name. Return empty if not found.
 
unsigned GetNumAttributes () const
 
unsigned GetNumNetworkAttributes () const
 Return number of network replication attributes.
 
bool IsTemporary () const
 
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.
 
 ~Object () override
 Destruct. Clean up self from event sender & receiver structures.
 
virtual StringHash GetType () const =0
 
virtual const StringGetTypeName () 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 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 SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
 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.
 
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, Args... args)
 Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another.
 
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 StringGetCategory () const
 
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.
 
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
 
int WeakRefs () const
 
RefCountRefCountPtr ()
 Return pointer to the reference count structure.
 

Static Public Member Functions

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

Static Public Attributes

static const IntVector3 RIGHT_UP_FORWARD
 (0, 1, 2) coordinate system (default).
 
static const IntVector3 RIGHT_FORWARD_UP
 (0, 2, 1) coordinate system.
 
static const IntVector3 UP_FORWARD_RIGHT
 (1, 2, 0) coordinate system.
 
static const IntVector3 UP_RIGHT_FORWARD
 (1, 0, 2) coordinate system.
 
static const IntVector3 FORWARD_RIGHT_UP
 (2, 0, 1) coordinate system.
 
static const IntVector3 FORWARD_UP_RIGHT
 (2, 1, 0) coordinate system.
 

Private Member Functions

 URHO3D_OBJECT (RaycastVehicle, LogicComponent)
 

Private Attributes

bool activate_
 If the RigidBody should be activated.
 
WeakPtr< RigidBodyhullBody_
 Hull RigidBody.
 
RaycastVehicleData * vehicleData_
 Opaque Bullet data hidden from public.
 
IntVector3 coordinateSystem_
 Coordinate system.
 
Vector< Node * > wheelNodes_
 Nodes of all wheels.
 
Vector< QuaternionorigRotation_
 All wheels original rotations. These are applied in addition to wheel rotations by btRaycastVehicle.
 
float inAirRPM_
 Revolutions per minute value for in-air motor wheels. FIXME: set this one per wheel.
 
Vector< float > skidInfoCumulative_
 Per-wheel extra settings.
 
Vector< float > wheelSideSlipSpeed_
 Wheel side movement speed.
 
float maxSideSlipSpeed_
 Side slip speed threshold.
 
VariantVector loadedWheelData_
 Loaded data temporarily wait here for ApplyAttributes to come pick them up.
 

Additional Inherited Members

- Protected Member Functions inherited from Urho3D::LogicComponent
void OnNodeSet (Node *node) override
 Handle scene node being assigned at creation.
 
void OnSceneSet (Scene *scene) override
 Handle scene being assigned.
 
- Protected Member Functions inherited from Urho3D::Component
void OnAttributeAnimationAdded () override
 Handle attribute animation added.
 
void OnAttributeAnimationRemoved () override
 Handle attribute animation removed.
 
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.
 
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.
 
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 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.
 
- 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.
 
- Protected Attributes inherited from Urho3D::Animatable
bool animationEnabled_
 Animation enabled.
 
SharedPtr< ObjectAnimationobjectAnimation_
 Animation.
 
HashSet< const AttributeInfo * > animatedNetworkAttributes_
 Animated network attribute set.
 
HashMap< String, SharedPtr< AttributeAnimationInfo > > attributeAnimationInfos_
 Attribute animation infos.
 
- Protected Attributes inherited from Urho3D::Serializable
UniquePtr< NetworkStatenetworkState_
 Network attribute state.
 
- Protected Attributes inherited from Urho3D::Object
Contextcontext_
 Execution context.
 

Member Function Documentation

◆ GetCoordinateSystem()

IntVector3 Urho3D::RaycastVehicle::GetCoordinateSystem ( ) const
inline

Get the coordinate system.

◆ GetInAirRPM()

float Urho3D::RaycastVehicle::GetInAirRPM ( ) const

Get revolution per minute value for when wheel doesn't touch ground.

◆ GetMaxSideSlipSpeed()

float Urho3D::RaycastVehicle::GetMaxSideSlipSpeed ( ) const

Get side speed which is considered sliding.

◆ GetNumWheels()

int Urho3D::RaycastVehicle::GetNumWheels ( ) const

Get number of attached wheels.

Here is the caller graph for this function:

◆ SetCoordinateSystem()

void Urho3D::RaycastVehicle::SetCoordinateSystem ( const IntVector3 coordinateSystem = RIGHT_FORWARD_UP)

Set the coordinate system. The default is (0, 1, 2).

◆ SetInAirRPM()

void Urho3D::RaycastVehicle::SetInAirRPM ( float  rpm)

Set revolution per minute value for when wheel doesn't touch ground. If set to 0 (or not set), calculated from engine force (probably not what you want).

◆ SetMaxSideSlipSpeed()

void Urho3D::RaycastVehicle::SetMaxSideSlipSpeed ( float  speed)

Set side speed which is considered sliding.


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