ViewportComponent Class Template

Component that groups viewport, scene, and camera bindings. More...

Declaration

template <typename THandle> class helios::engine::scene::components::ViewportComponent<THandle> { ... }

Public Constructors Index

template <typename THandle>
ViewportComponent (const ViewportHandle viewportHandle, const SceneHandle sceneHandle, const THandle cameraEntityHandle)
	Constructs the component from viewport, scene, and camera handles. More...

Public Member Functions Index

template <typename THandle>
SceneHandle	sceneHandle () const noexcept
	Returns the bound scene handle. More...
template <typename THandle>
ViewportHandle	viewportHandle () const noexcept
	Returns the bound viewport handle. More...
template <typename THandle>
THandle	cameraEntityHandle () const noexcept
	Returns the bound camera entity handle. More...

Private Member Attributes Index

template <typename THandle>
SceneHandle	sceneHandle_ {}
template <typename THandle>
ViewportHandle	viewportHandle_ {}
template <typename THandle>
THandle	cameraEntityHandle_ {}

Description

Component that groups viewport, scene, and camera bindings.

Template Parameters

THandle

Camera entity handle type.

Definition at line 25 of file ViewportComponent.ixx.

Public Constructors

ViewportComponent()

template <typename THandle>

helios::engine::scene::components::ViewportComponent< THandle >::ViewportComponent (const ViewportHandle viewportHandle, const SceneHandle sceneHandle, const THandle cameraEntityHandle)

inline explicit

Constructs the component from viewport, scene, and camera handles.

Parameters

viewportHandle	Bound viewport handle.
sceneHandle	Bound scene handle.
cameraEntityHandle	Bound camera entity handle.

Definition at line 42 of file ViewportComponent.ixx.

42 explicit ViewportComponent(

43 const ViewportHandle viewportHandle, const SceneHandle sceneHandle, const THandle cameraEntityHandle)

44 : viewportHandle_(viewportHandle), sceneHandle_(sceneHandle), cameraEntityHandle_(cameraEntityHandle) {};

Public Member Functions

cameraEntityHandle()

template <typename THandle>

THandle helios::engine::scene::components::ViewportComponent< THandle >::cameraEntityHandle ()

inline noexcept

Returns the bound camera entity handle.

Definition at line 57 of file ViewportComponent.ixx.

57 [[nodiscard]] THandle cameraEntityHandle() const noexcept {

58 return cameraEntityHandle_;

59 }

sceneHandle()

template <typename THandle>

SceneHandle helios::engine::scene::components::ViewportComponent< THandle >::sceneHandle ()

inline noexcept

Returns the bound scene handle.

Definition at line 47 of file ViewportComponent.ixx.

47 [[nodiscard]] SceneHandle sceneHandle() const noexcept {

48 return sceneHandle_;

49 }

viewportHandle()

template <typename THandle>

ViewportHandle helios::engine::scene::components::ViewportComponent< THandle >::viewportHandle ()

inline noexcept

Returns the bound viewport handle.

Definition at line 52 of file ViewportComponent.ixx.

52 [[nodiscard]] ViewportHandle viewportHandle() const noexcept {

53 return viewportHandle_;

54 }

Private Member Attributes

cameraEntityHandle_

template <typename THandle>

THandle helios::engine::scene::components::ViewportComponent< THandle >::cameraEntityHandle_ {}

Definition at line 31 of file ViewportComponent.ixx.

31 THandle cameraEntityHandle_{};

sceneHandle_

template <typename THandle>

SceneHandle helios::engine::scene::components::ViewportComponent< THandle >::sceneHandle_ {}

Definition at line 27 of file ViewportComponent.ixx.

27 SceneHandle sceneHandle_{};

viewportHandle_

template <typename THandle>

ViewportHandle helios::engine::scene::components::ViewportComponent< THandle >::viewportHandle_ {}

Definition at line 29 of file ViewportComponent.ixx.

29 ViewportHandle viewportHandle_{};

---

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

• ViewportComponent.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.