Antkeeper  0.0.1
point-light.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2023 Christopher J. Howard
3  *
4  * This file is part of Antkeeper source code.
5  *
6  * Antkeeper source code is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * Antkeeper source code is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Antkeeper source code. If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #ifndef ANTKEEPER_SCENE_POINT_LIGHT_HPP
21 #define ANTKEEPER_SCENE_POINT_LIGHT_HPP
22 
23 #include <engine/scene/light.hpp>
24 #include <engine/math/vector.hpp>
25 
26 namespace scene {
27 
31 class point_light: public light
32 {
33 public:
35  [[nodiscard]] inline light_type get_light_type() const noexcept override
36  {
37  return light_type::point;
38  }
39 
45  inline void set_luminous_flux(float luminous_flux) noexcept
46  {
47  m_luminous_flux = luminous_flux;
48  luminous_flux_updated();
49  }
50 
52  [[nodiscard]] inline constexpr float get_luminous_flux() const noexcept
53  {
54  return m_luminous_flux;
55  }
56 
58  [[nodiscard]] inline constexpr const math::fvec3& get_colored_luminous_flux() const noexcept
59  {
60  return m_colored_luminous_flux;
61  }
62 
63 private:
64  void color_updated() override;
65  void luminous_flux_updated() noexcept;
66 
67  float m_luminous_flux{};
68  math::fvec3 m_colored_luminous_flux{};
69 };
70 
71 } // namespace scene
72 
73 #endif // ANTKEEPER_SCENE_POINT_LIGHT_HPP
Abstract base class for light objects.
Definition: scene/light.hpp:32
Light source that radiates outward from a point.
Definition: point-light.hpp:32
light_type get_light_type() const noexcept override
Returns light_type::point.
Definition: point-light.hpp:35
void set_luminous_flux(float luminous_flux) noexcept
Sets the luminous flux of the light.
Definition: point-light.hpp:45
constexpr float get_luminous_flux() const noexcept
Returns the luminous flux of the light.
Definition: point-light.hpp:52
constexpr const math::fvec3 & get_colored_luminous_flux() const noexcept
Returns the color-modulated luminous flux of the light.
Definition: point-light.hpp:58
3D scene.
Definition: context.hpp:28
light_type
Light types.
Definition: light-type.hpp:29
@ point
Point light.
n-dimensional vector.
Definition: vector.hpp:44