light.hpp

Go to the documentation of this file.

 
#pragma once
#include "node_3d.hpp"
 
#include <toast/export.hpp>
 
namespace toast {

enum class LightType : uint8_t {
  none,
  point,
  directional,
  spot,
  ambient,
};
 
class [[ToastNode, Hidden, Icon("PointLight")]] TOAST_API Light : public Node3D {
public:
  Light() = default;
 
  [[nodiscard]]
  auto lightType() const -> LightType {
    return m_light_type;
  }
 
  [[nodiscard]]
  auto color() const -> const glm::vec3& {
    return m_light_color;
  }
 
  [[nodiscard]]
  auto intensity() const -> float {
    return m_intensity;
  }

  [[nodiscard]]
  auto castsShadows() const -> bool {
    return m_cast_shadows;
  }

  [[nodiscard]]
  auto shadowResolutionScale() const -> float {
    return m_shadow_resolution_scale;
  }

  [[nodiscard]]
  auto shadowDistance() const -> float {
    return m_shadow_distance;
  }

  [[nodiscard]]
  auto cullDistance() const -> float {
    return m_cull_distance;
  }
 
protected:
  void setLightType(LightType type) { m_light_type = type; }
 
private:
  void init();
  void end();
  void destroy();
 
  [[Reflect, Color]]
  glm::vec3 m_light_color = glm::vec3(1.0f, 1.0f, 1.0f);
 
  [[Reflect, Unit("lm")]]
  float m_intensity = 1.0f;
 
  [[Reflect, Name("Cast Shadows"), Group("Optimization")]]
  bool m_cast_shadows = true;

  [[Reflect, Name("Shadow Resolution Scale"), Range(0.1, 1.0), Group("Optimization")]]
  float m_shadow_resolution_scale = 1.0f;

  [[Reflect, Name("Shadow Distance"), Unit("m"), Group("Optimization")]]
  float m_shadow_distance = 60.0f;

  [[Reflect, Name("Cull Distance"), Unit("m"), Group("Optimization")]]
  float m_cull_distance = 0.0f;
 
  // Deliberately not [[Reflect]] - applyFields() only ever touches reflected fields during prefab
  // deserialization, so this constructor-set value can never be clobbered
  LightType m_light_type = LightType::none;
 
  bool m_registered_proxy = false;
};
}