nc::NcPhysics Struct Reference

Physics module interface. More...

#include <NcPhysics.h>

Inheritance diagram for nc::NcPhysics:

Public Member Functions
virtual auto	IsUpdateEnabled () const -> bool
	Check if the physics update step is enabled.
virtual void	EnableUpdate (bool)
	Toggle physics update step on or off.
Network Rollback Operations
Network rollback functions require Config::PhysicsSettings::enableNetworkRollback to be true on initialization. This prevents NcPhysics from scheduling any tasks, so the client application is responsible for ticking the simulation. This should be done from the update graph with a task using id nc::update_task_id::PhysicsPipeline. A Typical simulation tick looks like: Tick(1); // step the simulation once SyncTransforms(); // write RigidBody updates back to Transforms DispatchAccumulatedEvents(); // send CollisionListener events
virtual auto	GetTick () const -> PhysicsTick=0
virtual void	ResetTick (PhysicsTick tick=PhysicsTick{0})=0
virtual void	Tick (uint32_t steps=1)=0
virtual void	SyncTransforms ()=0
virtual void	SyncTransformsInterpolated (float factor)=0
virtual void	DispatchAccumulatedEvents ()=0
virtual void	SaveSnapshot (PhysicsSnapshot &snapshot)=0
virtual auto	RestoreSnapshot (PhysicsSnapshot &snapshot) -> bool=0
RigidBody Batching Operations
A RigidBody batch enables more efficient bulk initialization of RigidBody and Constraint instances. Batching is automatically performed during scene fragment deserialization. The Begin/End batch functions can be used to wrap other scopes where many objects are created, e.g. a Scene::Load() function that hard codes object creation. An optional count hint can be provided to also reserve space in the RigidBody pool upfront. While a batch is in progress, RigidBody and Constraint objects cannot be deleted, and new instances should be considered read-only. Only one batch may be in progress at a time.
virtual void	BeginRigidBodyBatch (size_t bodyCountHint=0ull)=0
virtual void	EndRigidBodyBatch ()=0
Runtime Asset Operations
In order to reference a dynamically constructed CompoundShape in a Shape, RigidBody, or CollisionQuery, it must be made known to internal asset storage. Once cooked, call AddRuntimeCompoundShape() with a unique AssetId to make it available.
virtual void	AddRuntimeCompoundShape (const CookedShape &cookedShape, asset::AssetId id)=0
virtual void	RemoveRuntimeCompoundShape (asset::AssetId id)=0
virtual void	RemoveAllRuntimeCompoundShapes ()=0
Public Member Functions inherited from nc::Module
	Module (size_t id=0) noexcept
	Constructor for the Module interface. More...
auto	Id () const noexcept
	Get the module's unique id.
virtual void	OnBuildTaskGraph (task::UpdateTasks &, task::RenderTasks &)
	Called on registered modules when the task graphs are constructed.
virtual void	OnBeforeSceneLoad ()
	Called on registered modules prior to loading a new scene.
virtual void	OnBeforeSceneFragmentLoad ()
	Called on registered modules immediately before loading a SceneFragment file.
virtual void	OnAfterSceneFragmentLoad ()
	Called on registered modules immediately after loading a SceneFragment file.
virtual void	Clear () noexcept
	Called on registered modules prior to clearing the Registry. This includes Scene::Unload() and NcEngine::Shutdown().

Detailed Description

Physics module interface.

Tasks PhysicsPipeline Depends On: FrameLogicUpdate Component Access: Write: RigidBody, Transform

---

The documentation for this struct was generated from the following file:

• include/ncengine/physics/NcPhysics.h