SceneMemberVisibilitySystem Class Template

Computes visibility for scene members and stores the frame snapshot. More...

Declaration

template <typename TOwnerHandle, typename TMemberHandle, typename TCullingStrategy, typename ... TRenderModes> class helios::engine::scene::systems::SceneMemberVisibilitySystem<TOwnerHandle, TMemberHandle, TCullingStrategy, TRenderModes> { ... }

Public Member Typedefs Index

template < ... >
using	EngineRoleTag = helios::engine::runtime::world::tags::TypedSystemRole
	Runtime role tag used for engine system registration. More...

Public Constructors Index

template < ... >
SceneMemberVisibilitySystem (TCullingStrategy cullingStrategy, SceneMemberVisibilityRegistry< TMemberHandle > &visibilityRegistry)
	Creates the visibility system with strategy and output registry. More...

Public Member Functions Index

template < ... >
void	update (UpdateContext &updateContext) noexcept
	Rebuilds the visibility registry for the current frame. More...

Private Member Functions Index

template <typename TSubmissionMode>
void	processMembers (UpdateContext &updateContext, CullingContext< TMemberHandle > &cullingContext, const SceneHandle sceneHandle, const RenderTargetBindingComponent< TOwnerHandle > &renderTargetBindingComponent, const ViewportEntity &viewportEntity)
	Evaluates all members for one submission mode and one viewport. More...

Private Member Attributes Index

template < ... >
TCullingStrategy	cullingStrategy_
	Culling strategy used to decide member visibility per viewport. More...
template < ... >
SceneMemberVisibilityRegistry< TMemberHandle > &	visibilityRegistry_
	Tracks visible and culled members per viewport for diagnostics/debugging. More...

Private Static Attributes Index

template < ... >
static auto &	logger_ = helios::engine::util::log::LogManager::loggerForScope(HELIOS_LOG_SCOPE)

Description

Computes visibility for scene members and stores the frame snapshot.

This system is responsible for filling SceneMemberVisibilityRegistry once per frame. The resulting visible/culled member lists are consumed by subsequent rendering steps (for example by scene render submission).

Template Parameters

TOwnerHandle	Viewport owner handle type.
TMemberHandle	Scene member handle type.
TCullingStrategy	Strategy used to decide member visibility.
TRenderModes	Reserved render mode parameter pack.

Definition at line 91 of file SceneMemberVisibilitySystem.ixx.

Public Member Typedefs

EngineRoleTag

template <typename TOwnerHandle, typename TMemberHandle, typename TCullingStrategy, typename ... TRenderModes>

using helios::engine::scene::systems::SceneMemberVisibilitySystem< TOwnerHandle, TMemberHandle, TCullingStrategy, TRenderModes >::EngineRoleTag = helios::engine::runtime::world::tags::TypedSystemRole

Runtime role tag used for engine system registration.

Definition at line 174 of file SceneMemberVisibilitySystem.ixx.

174 using EngineRoleTag = helios::engine::runtime::world::tags::TypedSystemRole;

Public Constructors

SceneMemberVisibilitySystem()

template <typename TOwnerHandle, typename TMemberHandle, typename TCullingStrategy, typename ... TRenderModes>

helios::engine::scene::systems::SceneMemberVisibilitySystem< TOwnerHandle, TMemberHandle, TCullingStrategy, TRenderModes >::SceneMemberVisibilitySystem (TCullingStrategy cullingStrategy, SceneMemberVisibilityRegistry< TMemberHandle > & visibilityRegistry)

inline explicit

Creates the visibility system with strategy and output registry.

Parameters

cullingStrategy	Culling strategy instance.
visibilityRegistry	Registry receiving per-frame visibility results.

Definition at line 182 of file SceneMemberVisibilitySystem.ixx.

182 explicit SceneMemberVisibilitySystem(TCullingStrategy cullingStrategy, SceneMemberVisibilityRegistry<TMemberHandle>& visibilityRegistry)

183 : cullingStrategy_(std::move(cullingStrategy)), visibilityRegistry_(visibilityRegistry) {

184 }

Public Member Functions

update()

template <typename TOwnerHandle, typename TMemberHandle, typename TCullingStrategy, typename ... TRenderModes>

void helios::engine::scene::systems::SceneMemberVisibilitySystem< TOwnerHandle, TMemberHandle, TCullingStrategy, TRenderModes >::update (UpdateContext & updateContext)

inline noexcept

Rebuilds the visibility registry for the current frame.

The registry is cleared first, then all active viewport bindings are traversed. For each viewport, members are tested and classified into visible/culled buckets per submission mode.

Parameters

updateContext

ECS/world update context.

Definition at line 196 of file SceneMemberVisibilitySystem.ixx.

196 void update(UpdateContext& updateContext) noexcept {

197

198 visibilityRegistry_.clear();

199

200 for (auto [viewportEntity, renderTargetBindingComponent, sbc, cbc, viewportActive] : updateContext.view<

201 TOwnerHandle,

202 RenderTargetBindingComponent<TOwnerHandle>,

203 SceneBindingComponent<TOwnerHandle>,

204 CameraBindingComponent<TOwnerHandle>,

205 Active<TOwnerHandle>

206 >().whereEnabled()) {

207

208 const auto sceneHandle = sbc->targetHandle();

209 const auto cameraHandle = cbc->targetHandle();

210

211 const auto camera = updateContext.find<TMemberHandle>(cameraHandle);

212 if (!camera) {

213 assert(false && "Camera not found");

214 logger_.error("Camera not found");

215 continue;

216 }

217 auto* pmc = camera->template get<ProjectionMatrixComponent<TMemberHandle>>();

218 if (!pmc) {

219 assert(pmc && "Camera had no ProjectionMatrixComponent");

220 logger_.error("Camera had no ProjectionMatrixComponent");

221 continue;

222 }

223 auto* lac = camera->template get<ViewMatrixComponent<TMemberHandle>>();

224 if (!lac) {

225 assert(lac && "Camera had no ViewMatrixComponent");

226 logger_.error("Camera had no ViewMatrixComponent");

227 continue;

228 }

229

230 auto* pcc = camera->template get<PerspectiveCameraComponent<TMemberHandle>>();

231 auto frustumPlanes = helios::math::frustumPlanes(

232 pcc->fovY(), pcc->aspectRatio(), pcc->zNear(), pcc->zFar(), lac->value()

233 );

234

235 auto cullingContext = CullingContext<TMemberHandle>{frustumPlanes, pmc->value(), lac->value()};

236

237 processMembers<Instanced>(

238 updateContext, cullingContext, sceneHandle, *renderTargetBindingComponent, viewportEntity);

239 processMembers<NonInstanced>(

240 updateContext, cullingContext, sceneHandle, *renderTargetBindingComponent, viewportEntity);

241 }

242

243 }

References helios::engine::scene::SceneMemberVisibilityRegistry< TMemberHandle >::clear and helios::engine::scene::registerComponents.

Private Member Functions

processMembers()

template <typename TSubmissionMode>

void helios::engine::scene::systems::SceneMemberVisibilitySystem< TOwnerHandle, TMemberHandle, TCullingStrategy, TRenderModes >::processMembers (UpdateContext & updateContext, CullingContext< TMemberHandle > & cullingContext, const SceneHandle sceneHandle, const RenderTargetBindingComponent< TOwnerHandle > & renderTargetBindingComponent, const ViewportEntity & viewportEntity)

inline

Evaluates all members for one submission mode and one viewport.

Appends each member to the visibility registry as either visible or culled.

Template Parameters

TSubmissionMode

Submission mode (Instanced or NonInstanced).

Parameters

updateContext	ECS/world update context.
cullingContext	Reusable culling context used per member.
sceneHandle	Scene currently bound to the viewport.
renderTargetBindingComponent	Render target bound to the viewport.
viewportEntity	Viewport entity being processed.

Definition at line 119 of file SceneMemberVisibilitySystem.ixx.

119 void processMembers(

120 UpdateContext& updateContext,

121 CullingContext<TMemberHandle>& cullingContext,

122 const SceneHandle sceneHandle,

123 const RenderTargetBindingComponent<TOwnerHandle>& renderTargetBindingComponent,

124 const ViewportEntity &viewportEntity

125 ) {

126

127 for (auto [

128 memberEntity,

129 smc,

130 rpc,

131 transformWorld,

132 boundsWorld,

133 memberActive

134 ] : updateContext.view<

135 TMemberHandle,

136 SceneMemberComponent<TMemberHandle>,

137 RenderPrototypeComponent<TMemberHandle, TSubmissionMode>,

138 TransformComponent<TMemberHandle, World>,

139 BoundsComponent<TMemberHandle, World>,

140 Active<TMemberHandle>

141 >().whereEnabled()) {

142

143 cullingContext.bounds = boundsWorld->value();

144 cullingContext.handle = memberEntity.handle();

145

146 auto memberContext = SceneMemberVisibilityContext<TMemberHandle, TSubmissionMode>{

147 memberEntity.handle(),

148 renderTargetBindingComponent.targetHandle(),

149 viewportEntity.handle(),

150 sceneHandle,

151 transformWorld->value()

152 };

153

154 visibilityRegistry_.addSceneRenderContext({

155 renderTargetBindingComponent.targetHandle(), viewportEntity.handle(), sceneHandle

156 });

157

158

159 if (smc->targetHandle() == sceneHandle && cullingStrategy_.shouldRender(cullingContext)) {

160 visibilityRegistry_.template addVisibleMember<TSubmissionMode>(viewportEntity.handle(), std::move(memberContext));

161 } else {

162 visibilityRegistry_.template addCulledMember<TSubmissionMode>(viewportEntity.handle(), std::move(memberContext));

163 }

164 }

165 }

Private Member Attributes

cullingStrategy_

template <typename TOwnerHandle, typename TMemberHandle, typename TCullingStrategy, typename ... TRenderModes>

TCullingStrategy helios::engine::scene::systems::SceneMemberVisibilitySystem< TOwnerHandle, TMemberHandle, TCullingStrategy, TRenderModes >::cullingStrategy_

Culling strategy used to decide member visibility per viewport.

Definition at line 96 of file SceneMemberVisibilitySystem.ixx.

96 TCullingStrategy cullingStrategy_;

visibilityRegistry_

template <typename TOwnerHandle, typename TMemberHandle, typename TCullingStrategy, typename ... TRenderModes>

SceneMemberVisibilityRegistry<TMemberHandle>& helios::engine::scene::systems::SceneMemberVisibilitySystem< TOwnerHandle, TMemberHandle, TCullingStrategy, TRenderModes >::visibilityRegistry_

Tracks visible and culled members per viewport for diagnostics/debugging.

Definition at line 103 of file SceneMemberVisibilitySystem.ixx.

103 SceneMemberVisibilityRegistry<TMemberHandle>& visibilityRegistry_;

Private Static Attributes

logger_

template <typename TOwnerHandle, typename TMemberHandle, typename TCullingStrategy, typename ... TRenderModes>

auto& helios::engine::scene::systems::SceneMemberVisibilitySystem< TOwnerHandle, TMemberHandle, TCullingStrategy, TRenderModes >::logger_ = helios::engine::util::log::LogManager::loggerForScope(HELIOS_LOG_SCOPE)

static

Definition at line 98 of file SceneMemberVisibilitySystem.ixx.

98 static inline auto& logger_ = helios::engine::util::log::LogManager::loggerForScope(HELIOS_LOG_SCOPE);

---

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

• SceneMemberVisibilitySystem.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.