Skip to main content

ActiveViewportHandlesStateComponent Class Template

Stores the currently active viewport IDs based on game/match state. More...

Declaration​

template <typename THandle> class helios::engine::rendering::viewport::components::ActiveViewportHandlesStateComponent<THandle> { ... }

Public Member Functions Index​

template <typename THandle>
voidsetViewportHandles (std::span< const ViewportHandle > &viewportHandles)

Replaces the current viewport handles with the provided list. More...

template <typename THandle>
auto viewportHandles () const noexcept -> std::span< const ViewportHandle >

Returns a span over all active viewport IDs. More...

template <typename THandle>
boolhas (const ViewportHandle viewportHandle) const noexcept

Returns true if the ViewportId is contained in this component, otherwise false. More...

template <typename THandle>
voidclear () const noexcept

Clears all active viewport IDs. More...

Private Member Attributes Index​

template <typename THandle>
std::vector< ViewportHandle >viewportHandles_

Currently active viewport identifiers. More...

Description​

Stores the currently active viewport IDs based on game/match state.

This component maintains a list of ViewportIds that should be rendered for the current game and match state combination. It is updated by StateToViewportPolicyUpdateSystem each frame based on the configured StateToViewportPolicy.

Definition at line 27 of file ActiveViewportHandlesStateComponent.ixx.

Public Member Functions​

clear()​

template <typename THandle>
void helios::engine::rendering::viewport::components::ActiveViewportHandlesStateComponent< THandle >::clear ()
 inline noexcept

Clears all active viewport IDs.

Definition at line 74 of file ActiveViewportHandlesStateComponent.ixx.

74 void clear() const noexcept {
75 viewportHandles_.clear();
76 }

has()​

template <typename THandle>
bool helios::engine::rendering::viewport::components::ActiveViewportHandlesStateComponent< THandle >::has (const ViewportHandle viewportHandle)
 inline noexcept

Returns true if the ViewportId is contained in this component, otherwise false.

Parameters
viewportId
Returns

true if the ViewportId is currently active, false otherwise.

Definition at line 61 of file ActiveViewportHandlesStateComponent.ixx.

61 [[nodiscard]] bool has(const ViewportHandle viewportHandle) const noexcept {
62 for (const auto& handle : viewportHandles_) {
63 if (handle == viewportHandle) {
64 return true;
65 }
66 }
67
68 return false;
69 }

setViewportHandles()​

template <typename THandle>
void helios::engine::rendering::viewport::components::ActiveViewportHandlesStateComponent< THandle >::setViewportHandles (std::span< const ViewportHandle > & viewportHandles)
 inline

Replaces the current viewport handles with the provided list.

Parameters
viewportIds

The new list of active viewport handles.

Definition at line 42 of file ActiveViewportHandlesStateComponent.ixx.

42 void setViewportHandles(std::span<const ViewportHandle>& viewportHandles) {
43 viewportHandles_.assign(viewportHandles.begin(), viewportHandles.end());
44 }

Reference helios::engine::rendering::viewport::components::ActiveViewportHandlesStateComponent< THandle >::viewportHandles.

viewportHandles()​

template <typename THandle>
std::span< const ViewportHandle > helios::engine::rendering::viewport::components::ActiveViewportHandlesStateComponent< THandle >::viewportHandles ()
 inline noexcept

Returns a span over all active viewport IDs.

Returns

Read-only span of viewport handles.

Definition at line 51 of file ActiveViewportHandlesStateComponent.ixx.

51 [[nodiscard]] std::span<const ViewportHandle> viewportHandles() const noexcept {
52 return viewportHandles_;
53 }

Referenced by helios::engine::rendering::viewport::components::ActiveViewportHandlesStateComponent< THandle >::setViewportHandles.

Private Member Attributes​

viewportHandles_​

template <typename THandle>
std::vector<ViewportHandle> helios::engine::rendering::viewport::components::ActiveViewportHandlesStateComponent< THandle >::viewportHandles_
 mutable

Currently active viewport identifiers.

Definition at line 32 of file ActiveViewportHandlesStateComponent.ixx.

32 mutable std::vector<ViewportHandle> viewportHandles_;

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

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.