Physics simulation world component. Should be added only to the root scene node.
More...
|
| PhysicsWorld (Context *context) |
| Construct.
|
|
| ~PhysicsWorld () override |
| Destruct.
|
|
bool | isVisible (const btVector3 &aabbMin, const btVector3 &aabbMax) override |
| Check if an AABB is visible for debug drawing.
|
|
void | drawLine (const btVector3 &from, const btVector3 &to, const btVector3 &color) override |
| Draw a physics debug line.
|
|
void | reportErrorWarning (const char *warningString) override |
| Log warning from the physics engine.
|
|
void | drawContactPoint (const btVector3 &pointOnB, const btVector3 &normalOnB, btScalar distance, int lifeTime, const btVector3 &color) override |
| Draw a physics debug contact point. Not implemented.
|
|
void | draw3dText (const btVector3 &location, const char *textString) override |
| Draw physics debug 3D text. Not implemented.
|
|
void | setDebugMode (int debugMode) override |
| Set debug draw flags.
|
|
int | getDebugMode () const override |
| Return debug draw flags.
|
|
void | DrawDebugGeometry (DebugRenderer *debug, bool depthTest) override |
| Visualize the component as debug geometry.
|
|
void | Update (float timeStep) |
| Step the simulation forward.
|
|
void | UpdateCollisions () |
| Refresh collisions only without updating dynamics.
|
|
void | SetFps (int fps) |
| Set simulation substeps per second.
|
|
void | SetGravity (const Vector3 &gravity) |
| Set gravity.
|
|
void | SetMaxSubSteps (int num) |
| Set maximum number of physics substeps per frame. 0 (default) is unlimited. Positive values cap the amount. Use a negative value to enable an adaptive timestep. This may cause inconsistent physics behavior.
|
|
void | SetNumIterations (int num) |
| Set number of constraint solver iterations.
|
|
void | SetUpdateEnabled (bool enable) |
| Enable or disable automatic physics simulation during scene update. Enabled by default.
|
|
void | SetInterpolation (bool enable) |
| Set whether to interpolate between simulation steps.
|
|
void | SetInternalEdge (bool enable) |
| Set whether to use Bullet's internal edge utility for trimesh collisions. Disabled by default.
|
|
void | SetSplitImpulse (bool enable) |
| Set split impulse collision mode. This is more accurate, but slower. Disabled by default.
|
|
void | SetMaxNetworkAngularVelocity (float velocity) |
| Set maximum angular velocity for network replication.
|
|
void | Raycast (PODVector< PhysicsRaycastResult > &result, const Ray &ray, float maxDistance, unsigned collisionMask=M_MAX_UNSIGNED) |
| Perform a physics world raycast and return all hits.
|
|
void | RaycastSingle (PhysicsRaycastResult &result, const Ray &ray, float maxDistance, unsigned collisionMask=M_MAX_UNSIGNED) |
| Perform a physics world raycast and return the closest hit.
|
|
void | RaycastSingleSegmented (PhysicsRaycastResult &result, const Ray &ray, float maxDistance, float segmentDistance, unsigned collisionMask=M_MAX_UNSIGNED, float overlapDistance=0.1f) |
|
void | SphereCast (PhysicsRaycastResult &result, const Ray &ray, float radius, float maxDistance, unsigned collisionMask=M_MAX_UNSIGNED) |
| Perform a physics world swept sphere test and return the closest hit.
|
|
void | ConvexCast (PhysicsRaycastResult &result, CollisionShape *shape, const Vector3 &startPos, const Quaternion &startRot, const Vector3 &endPos, const Quaternion &endRot, unsigned collisionMask=M_MAX_UNSIGNED) |
| Perform a physics world swept convex test using a user-supplied collision shape and return the first hit.
|
|
void | ConvexCast (PhysicsRaycastResult &result, btCollisionShape *shape, const Vector3 &startPos, const Quaternion &startRot, const Vector3 &endPos, const Quaternion &endRot, unsigned collisionMask=M_MAX_UNSIGNED) |
| Perform a physics world swept convex test using a user-supplied Bullet collision shape and return the first hit.
|
|
void | RemoveCachedGeometry (Model *model) |
| Invalidate cached collision geometry for a model.
|
|
void | GetRigidBodies (PODVector< RigidBody *> &result, const Sphere &sphere, unsigned collisionMask=M_MAX_UNSIGNED) |
| Return rigid bodies by a sphere query.
|
|
void | GetRigidBodies (PODVector< RigidBody *> &result, const BoundingBox &box, unsigned collisionMask=M_MAX_UNSIGNED) |
| Return rigid bodies by a box query.
|
|
void | GetRigidBodies (PODVector< RigidBody *> &result, const RigidBody *body) |
| Return rigid bodies by contact test with the specified body. It needs to be active to return all contacts reliably.
|
|
void | GetCollidingBodies (PODVector< RigidBody *> &result, const RigidBody *body) |
| Return rigid bodies that have been in collision with the specified body on the last simulation step. Only returns collisions that were sent as events (depends on collision event mode) and excludes e.g. static-static collisions.
|
|
Vector3 | GetGravity () const |
| Return gravity.
|
|
int | GetMaxSubSteps () const |
| Return maximum number of physics substeps per frame.
|
|
int | GetNumIterations () const |
| Return number of constraint solver iterations.
|
|
bool | IsUpdateEnabled () const |
| Return whether physics world will automatically simulate during scene update.
|
|
bool | GetInterpolation () const |
| Return whether interpolation between simulation steps is enabled.
|
|
bool | GetInternalEdge () const |
| Return whether Bullet's internal edge utility for trimesh collisions is enabled.
|
|
bool | GetSplitImpulse () const |
| Return whether split impulse collision mode is enabled.
|
|
int | GetFps () const |
| Return simulation steps per second.
|
|
float | GetMaxNetworkAngularVelocity () const |
| Return maximum angular velocity for network replication.
|
|
void | AddRigidBody (RigidBody *body) |
| Add a rigid body to keep track of. Called by RigidBody.
|
|
void | RemoveRigidBody (RigidBody *body) |
| Remove a rigid body. Called by RigidBody.
|
|
void | AddCollisionShape (CollisionShape *shape) |
| Add a collision shape to keep track of. Called by CollisionShape.
|
|
void | RemoveCollisionShape (CollisionShape *shape) |
| Remove a collision shape. Called by CollisionShape.
|
|
void | AddConstraint (Constraint *constraint) |
| Add a constraint to keep track of. Called by Constraint.
|
|
void | RemoveConstraint (Constraint *constraint) |
| Remove a constraint. Called by Constraint.
|
|
void | AddDelayedWorldTransform (const DelayedWorldTransform &transform) |
| Add a delayed world transform assignment. Called by RigidBody.
|
|
void | DrawDebugGeometry (bool depthTest) |
| Add debug geometry to the debug renderer.
|
|
void | SetDebugRenderer (DebugRenderer *debug) |
| Set debug renderer to use. Called both by PhysicsWorld itself and physics components.
|
|
void | SetDebugDepthTest (bool enable) |
| Set debug geometry depth test mode. Called both by PhysicsWorld itself and physics components.
|
|
btDiscreteDynamicsWorld * | GetWorld () |
| Return the Bullet physics world.
|
|
void | CleanupGeometryCache () |
| Clean up the geometry cache.
|
|
CollisionGeometryDataCache & | GetTriMeshCache () |
| Return trimesh collision geometry cache.
|
|
CollisionGeometryDataCache & | GetConvexCache () |
| Return convex collision geometry cache.
|
|
CollisionGeometryDataCache & | GetGImpactTrimeshCache () |
| Return GImpact trimesh collision geometry cache.
|
|
void | SetApplyingTransforms (bool enable) |
| Set node dirtying to be disregarded.
|
|
bool | IsApplyingTransforms () const |
| Return whether node dirtying should be disregarded.
|
|
bool | IsSimulating () const |
| Return whether is currently inside the Bullet substep loop.
|
|
| Component (Context *context) |
| Construct.
|
|
virtual void | OnSetEnabled () |
| Handle enabled/disabled state change.
|
|
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.
|
|
void | SetEnabled (bool enable) |
| Set enabled/disabled state.
|
|
void | Remove () |
| Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
|
|
unsigned | GetID () const |
| Return ID.
|
|
bool | IsReplicated () const |
| Return whether the component is replicated or local to a scene.
|
|
bool | IsEnabled () const |
| Return whether is enabled.
|
|
bool | IsEnabledEffective () const |
| Return whether is effectively enabled (node is also enabled).
|
|
Node * | GetNode () const |
| Return scene node.
|
|
Scene * | GetScene () const |
| Return the scene the node belongs to.
|
|
Component * | GetComponent (StringHash type) const |
| Return component in the same scene node by first of type.
|
|
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 component in the same scene node by first of 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.
|
|
| 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) |
| Set automatic update of animation, default true.
|
|
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) |
| Set object animation.
|
|
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 |
| Return animation enabled.
|
|
ObjectAnimation * | GetObjectAnimation () const |
| Return object animation.
|
|
ValueAnimation * | GetAttributeAnimation (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.
|
|
| 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 void | ApplyAttributes () |
| Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
|
|
virtual bool | SaveDefaultAttributes () const |
| Return whether should save default-valued attributes into XML. Default false.
|
|
bool | SetAttribute (unsigned index, const Variant &value) |
| Set attribute by index. Return true if successfully set.
|
|
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) |
| Set temporary flag. Temporary objects will not be saved.
|
|
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 |
| Return attribute value by index. Return empty if illegal index.
|
|
Variant | GetAttribute (const String &name) const |
| Return attribute value by name. Return empty if not found.
|
|
Variant | GetAttributeDefault (unsigned index) const |
| Return attribute default value by index. Return empty if illegal index.
|
|
Variant | GetAttributeDefault (const String &name) const |
| Return attribute default value by name. Return empty if not found.
|
|
unsigned | GetNumAttributes () const |
| Return number of attributes.
|
|
unsigned | GetNumNetworkAttributes () const |
| Return number of network replication attributes.
|
|
bool | IsTemporary () const |
| Return whether is temporary.
|
|
bool | GetInterceptNetworkUpdate (const String &attributeName) const |
| Return whether an attribute's network updates are being intercepted.
|
|
NetworkState * | GetNetworkState () const |
| Return the network attribute state, if allocated.
|
|
| Object (Context *context) |
| Construct.
|
|
| ~Object () override |
| Destruct. Clean up self from event sender & receiver structures.
|
|
virtual StringHash | GetType () const =0 |
| Return type hash.
|
|
virtual const String & | GetTypeName () const =0 |
| Return type name.
|
|
virtual const TypeInfo * | GetTypeInfo () 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.
|
|
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, 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.
|
|
Context * | GetContext () const |
| Return execution context.
|
|
const Variant & | GetGlobalVar (StringHash key) const |
| Return global variable based on key.
|
|
const VariantMap & | GetGlobalVars () const |
| Return all global variables.
|
|
void | SetGlobalVar (StringHash key, const Variant &value) |
| Set global variable with the respective key and 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 String & | GetCategory () const |
| Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
|
|
void | SetBlockEvents (bool block) |
| Block object from sending and receiving events.
|
|
bool | GetBlockEvents () const |
| Return sending and receiving events blocking status.
|
|
| 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.
|
|
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 |
| Return reference count.
|
|
int | WeakRefs () const |
| Return weak reference count.
|
|
RefCount * | RefCountPtr () |
| Return pointer to the reference count structure.
|
|