EntropyCanvas::SceneService

SceneService manages scene graph operations via ISceneGraph interface. More…

#include <SceneService.h>

Inherits from EntropyEngine::Core::EntropyService, EntropyEngine::Core::EntropyObject

Public Functions

	Name
	~SceneService() override
flecs::world &	world() Get the Flecs world from the scene graph.
const flecs::world &	world() const
virtual const char *	version() const override
void	updateCameraAspectRatio(float aspectRatio) Update the active camera’s aspect ratio (call on window resize).
virtual void	unload() override
virtual EntropyEngine::Core::TypeSystem::TypeID	typeId() const override
void	tick(float deltaTime) Tick the scene - runs ECS systems and updates entities.
virtual void	stop() override
virtual void	start() override
void	setSchemaService(ComponentSchemaService * service) Set the schema service for hash-based component lookup.
void	setDataProvider(IDataProvider * provider) Set the data provider for receiving scene data.
void	setActiveCamera(flecs::entity camera) Set the active camera.
ComponentSchemaService *	schemaService() const Get the schema service.
void	scheduleAsyncTick(EntropyEngine::Core::Concurrency::WorkContractGroup & group, float deltaTime) Schedule tick as async work contract (fire-and-forget).
ISceneGraph *	sceneGraph() const Get the underlying ISceneGraph.
void	prepareForShutdown() Prepare for shutdown - prevents new ticks from being scheduled.
SceneService &	operator=(const SceneService & ) =delete
virtual const char *	name() const override
uint64_t	makeLocalEntityId(uint32_t serverId, uint64_t serverEntityId) Create a local entity ID from server ID and server entity ID.
virtual void	load() override
bool	isValid(flecs::entity entity) const Check if an entity is valid.
bool	isTickInProgress() const Check if a tick is currently in progress.
virtual const char *	id() const override
glm::mat4	getActiveCameraViewProjection() const Get the view-projection matrix from the active camera.
glm::mat4	getActiveCameraView() const Get just the view matrix from the active camera.
glm::mat4	getActiveCameraProjection() const Get just the projection matrix from the active camera.
glm::vec3	getActiveCameraPosition() const Get the world position of the active camera.
std::optional< flecs::entity >	getActiveCamera() const Get the active camera entity.
template <typename Func > void	forEachRenderable(Func && func) Iterate all entities with Transform and MeshComponent.
template <typename Func > void	forEachLight(Func && func) Iterate all entities with Transform and Light.
template <typename Func > void	forEachCamera(Func && func) Iterate all entities with Transform and CameraComponent.
ExternalTransformRegistry &	externalTransformRegistry() Get the external transform registry for low-latency transform sources.
const ExternalTransformRegistry &	externalTransformRegistry() const
size_t	entityCount() const Get entity count.
void	destroyEntity(flecs::entity entity) Destroy an entity.
IDataProvider *	dataProvider() const Get the current data provider.
flecs::entity	createEntity(const char * name =nullptr) Create a new entity with an optional name.
flecs::entity	createEntity(const Transform & transform, const char * name =nullptr) Create an entity with Transform component.
flecs::entity	createCamera(const Transform & transform, const CameraComponent & camera, const char * name =nullptr) Create a camera entity with Transform and CameraComponent.
SimulationCommandQueue &	commandQueue() Get the command queue for external systems to submit flecs mutations.
void	applySnapshot(const SceneSnapshot & snapshot) Apply a scene snapshot (full scene replacement).
void	applyDelta(const PropertyDelta & delta) Apply a property delta (single property change).
	SceneService() Construct with default SceneGraph (created on load).
	SceneService(std::unique_ptr< ISceneGraph > sceneGraph) Construct with injected ISceneGraph implementation.
	SceneService(const SceneService & ) =delete

Additional inherited members

Public Functions inherited from EntropyEngine::Core::EntropyService

	Name
	~EntropyService() override =default
ServiceState	state() const
virtual std::vector< TypeSystem::TypeID >	dependsOnTypes() const
virtual std::vector< std::string >	dependsOn() const
virtual const char *	className() const override Runtime class name for diagnostics and reflection.

Protected Functions inherited from EntropyEngine::Core::EntropyService

	Name
void	setState(ServiceState s)

Friends inherited from EntropyEngine::Core::EntropyService

	Name
class	EntropyServiceRegistry

Protected Classes inherited from EntropyEngine::Core::EntropyObject

	Name
struct	HandleCore Optional handle identity stamped by an owner/registry.

Public Functions inherited from EntropyEngine::Core::EntropyObject

	Name
virtual	~EntropyObject() =default
virtual const TypeSystem::TypeInfo *	typeInfo() const Optional richer type information; may be null.
bool	tryRetain() const Attempts to retain only if the object is still alive.
virtual std::string	toString() const Human-readable short string (class@ptr by default).
void	retain() const Increments the reference count.
void	release() const Decrements the reference count and deletes when it reaches zero.
uint32_t	refCount() const Current reference count (approximate under contention).
bool	hasHandle() const
template <class OwnerT > OwnerT *	handleOwnerAs() const Returns the stamped owner pointer cast to the requested type.
const void *	handleOwner() const
uint32_t	handleIndex() const
uint64_t	handleId() const
uint32_t	handleGeneration() const
WeakControlBlock *	getWeakControlBlock() const Lazily retrieves or creates the weak control block.
virtual std::string	description() const Long-form description; defaults to toString().
virtual std::string	debugString() const Debug-oriented string including refcount and handle when present.
virtual const char *	className() const Runtime class name for diagnostics and reflection.
virtual uint64_t	classHash() const Stable type hash for cross-language identification.
	EntropyObject() =default
	EntropyObject(EntropyObject && ) =delete
	EntropyObject(const EntropyObject & ) =delete

Protected Functions inherited from EntropyEngine::Core::EntropyObject

	Name
void	_setHandleIdentity(void * owner, uint32_t index, uint32_t generation)
void	_clearHandleIdentity()

Protected Attributes inherited from EntropyEngine::Core::EntropyObject

	Name
std::atomic< WeakControlBlock * >	_weakBlock Lazily allocated control block for weak refs.
std::atomic< uint32_t >	_refCount Thread-safe retain/release counter.
struct EntropyEngine::Core::EntropyObject::HandleCore	_handle

Friends inherited from EntropyEngine::Core::EntropyObject

	Name
struct	HandleAccess

Detailed Description

class EntropyCanvas::SceneService;

SceneService manages scene graph operations via ISceneGraph interface.

This service works with any ISceneGraph implementation:

SceneGraph: Base implementation for clients
PersistentSceneGraph: Server-side with USD persistence, DeltaTracker, etc.

Responsibilities:

Wraps ISceneGraph for service lifecycle management
Receives scene snapshots and deltas via IDataProvider
Provides entity creation/destruction API
Supports querying entities by component
Manages the active camera

Public Functions Documentation

function ~SceneService

~SceneService() override

function world

inline flecs::world & world()

Get the Flecs world from the scene graph.

Use for advanced queries or direct Flecs API access.

function world

inline const flecs::world & world() const

function version

inline virtual const char * version() const override

Reimplements: EntropyEngine::Core::EntropyService::version

function updateCameraAspectRatio

void updateCameraAspectRatio(
    float aspectRatio
)

Update the active camera’s aspect ratio (call on window resize).

function unload

virtual void unload() override

Reimplements: EntropyEngine::Core::EntropyService::unload

function typeId

inline virtual EntropyEngine::Core::TypeSystem::TypeID typeId() const override

Reimplements: EntropyEngine::Core::EntropyService::typeId

function tick

void tick(
    float deltaTime
)

Tick the scene - runs ECS systems and updates entities.

Parameters:

deltaTime Time since last tick in seconds

Call once per frame from simulation thread/main loop.

function stop

virtual void stop() override

Reimplements: EntropyEngine::Core::EntropyService::stop

function start

virtual void start() override

Reimplements: EntropyEngine::Core::EntropyService::start

function setSchemaService

void setSchemaService(
    ComponentSchemaService * service
)

Set the schema service for hash-based component lookup.

function setDataProvider

void setDataProvider(
    IDataProvider * provider
)

Set the data provider for receiving scene data.

This registers for delta callbacks automatically.

function setActiveCamera

void setActiveCamera(
    flecs::entity camera
)

Set the active camera.

function schemaService

inline ComponentSchemaService * schemaService() const

Get the schema service.

function scheduleAsyncTick

void scheduleAsyncTick(
    EntropyEngine::Core::Concurrency::WorkContractGroup & group,
    float deltaTime
)

Schedule tick as async work contract (fire-and-forget).

Parameters:

group WorkContractGroup to schedule on
deltaTime Time since last tick in seconds

If a tick is already in progress, this is a no-op.

function sceneGraph

inline ISceneGraph * sceneGraph() const

Get the underlying ISceneGraph.

Return: Pointer to ISceneGraph (nullptr if not loaded)

function prepareForShutdown

void prepareForShutdown()

Prepare for shutdown - prevents new ticks from being scheduled.

Call before waiting for in-flight tick to complete.

function operator=

SceneService & operator=(
    const SceneService &
) =delete

function name

inline virtual const char * name() const override

Reimplements: EntropyEngine::Core::EntropyService::name

function makeLocalEntityId

static uint64_t makeLocalEntityId(
    uint32_t serverId,
    uint64_t serverEntityId
)

Create a local entity ID from server ID and server entity ID.

This allows entities from multiple servers to coexist.

function load

virtual void load() override

Reimplements: EntropyEngine::Core::EntropyService::load

function isValid

bool isValid(
    flecs::entity entity
) const

Check if an entity is valid.

function isTickInProgress

bool isTickInProgress() const

Check if a tick is currently in progress.

Used to prevent overlapping ticks.

function id

inline virtual const char * id() const override

Reimplements: EntropyEngine::Core::EntropyService::id

function getActiveCameraViewProjection

glm::mat4 getActiveCameraViewProjection() const

Get the view-projection matrix from the active camera.

Returns identity matrix if no active camera.

function getActiveCameraView

glm::mat4 getActiveCameraView() const

Get just the view matrix from the active camera.

function getActiveCameraProjection

glm::mat4 getActiveCameraProjection() const

Get just the projection matrix from the active camera.

function getActiveCameraPosition

glm::vec3 getActiveCameraPosition() const

Get the world position of the active camera.

function getActiveCamera

std::optional< flecs::entity > getActiveCamera() const

Get the active camera entity.

function forEachRenderable

template <typename Func >
inline void forEachRenderable(
    Func && func
)

Iterate all entities with Transform and MeshComponent.

function forEachLight

template <typename Func >
inline void forEachLight(
    Func && func
)

Iterate all entities with Transform and Light.

function forEachCamera

template <typename Func >
inline void forEachCamera(
    Func && func
)

Iterate all entities with Transform and CameraComponent.

function externalTransformRegistry

inline ExternalTransformRegistry & externalTransformRegistry()

Get the external transform registry for low-latency transform sources.

function externalTransformRegistry

inline const ExternalTransformRegistry & externalTransformRegistry() const

function entityCount

size_t entityCount() const

Get entity count.

function destroyEntity

void destroyEntity(
    flecs::entity entity
)

Destroy an entity.

function dataProvider

inline IDataProvider * dataProvider() const

Get the current data provider.

function createEntity

flecs::entity createEntity(
    const char * name =nullptr
)

Create a new entity with an optional name.

function createEntity

flecs::entity createEntity(
    const Transform & transform,
    const char * name =nullptr
)

Create an entity with Transform component.

function createCamera

flecs::entity createCamera(
    const Transform & transform,
    const CameraComponent & camera,
    const char * name =nullptr
)

Create a camera entity with Transform and CameraComponent.

function commandQueue

inline SimulationCommandQueue & commandQueue()

Get the command queue for external systems to submit flecs mutations.

Thread-safe: can be called from any thread.

function applySnapshot

void applySnapshot(
    const SceneSnapshot & snapshot
)

Apply a scene snapshot (full scene replacement).

function applyDelta

void applyDelta(
    const PropertyDelta & delta
)

Apply a property delta (single property change).

function SceneService

SceneService()

Construct with default SceneGraph (created on load).

function SceneService

explicit SceneService(
    std::unique_ptr< ISceneGraph > sceneGraph
)

Construct with injected ISceneGraph implementation.

Parameters:

sceneGraph ISceneGraph implementation (e.g., PersistentSceneGraph)

Takes ownership of the scene graph.

function SceneService

SceneService(
    const SceneService &
) =delete

Updated on 2026-01-26 at 17:14:35 -0500