light_effect.h

Go to the documentation of this file.

#pragma once
 
#include "esphome/core/component.h"
#include "esphome/core/string_ref.h"
 
namespace esphome::light {
 
inline constexpr StringRef EFFECT_NONE_REF = StringRef::from_lit("None");
 
class LightState;
 
class LightEffect {
 public:
  explicit LightEffect(const char *name) : name_(name) {}
 
  virtual void start() {}
 
  virtual void start_internal() { this->start(); }
 
  virtual void stop() {}
 
  virtual void apply() = 0;
 
  StringRef get_name() const { return StringRef(this->name_); }
 
  virtual void init() {}
 
  void init_internal(LightState *state) {
    this->state_ = state;
    this->init();
  }
 
  uint32_t get_index() const;
 
  bool is_active() const;
 
  LightState *get_light_state() const { return this->state_; }
 
 protected:
  LightState *state_{nullptr};
  const char *name_;
 
  uint32_t get_index_in_parent_() const;
};
 
}  // namespace esphome::light