ESPHome  2022.9.1
Public Member Functions | Protected Attributes
esphome::light::LightFlashTransformer Class Reference

#include <transformers.h>

Inheritance diagram for esphome::light::LightFlashTransformer:
esphome::light::LightTransformer

Public Member Functions

 LightFlashTransformer (LightState &state)
 
void start () override
 
optional< LightColorValuesapply () override
 
void stop () override
 
bool is_finished () override
 
- Public Member Functions inherited from esphome::light::LightTransformer
virtual ~LightTransformer ()=default
 
void setup (const LightColorValues &start_values, const LightColorValues &target_values, uint32_t length)
 
const LightColorValuesget_start_values () const
 
const LightColorValuesget_target_values () const
 

Protected Attributes

LightStatestate_
 
uint32_t transition_length_
 
std::unique_ptr< LightTransformertransformer_ {nullptr}
 
bool begun_lightstate_restore_
 
- Protected Attributes inherited from esphome::light::LightTransformer
uint32_t start_time_
 
uint32_t length_
 
LightColorValues start_values_
 
LightColorValues target_values_
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::light::LightTransformer
float get_progress_ ()
 The progress of this transition, on a scale of 0 to 1. More...
 

Detailed Description

Definition at line 67 of file transformers.h.

Constructor & Destructor Documentation

◆ LightFlashTransformer()

esphome::light::LightFlashTransformer::LightFlashTransformer ( LightState state)
inline

Definition at line 69 of file transformers.h.

Member Function Documentation

◆ apply()

optional<LightColorValues> esphome::light::LightFlashTransformer::apply ( )
inlineoverridevirtual

Implements esphome::light::LightTransformer.

Definition at line 83 of file transformers.h.

◆ is_finished()

bool esphome::light::LightFlashTransformer::is_finished ( )
inlineoverridevirtual

Reimplemented from esphome::light::LightTransformer.

Definition at line 116 of file transformers.h.

◆ start()

void esphome::light::LightFlashTransformer::start ( )
inlineoverridevirtual

Reimplemented from esphome::light::LightTransformer.

Definition at line 71 of file transformers.h.

◆ stop()

void esphome::light::LightFlashTransformer::stop ( )
inlineoverridevirtual

Reimplemented from esphome::light::LightTransformer.

Definition at line 106 of file transformers.h.

Field Documentation

◆ begun_lightstate_restore_

bool esphome::light::LightFlashTransformer::begun_lightstate_restore_
protected

Definition at line 122 of file transformers.h.

◆ state_

LightState& esphome::light::LightFlashTransformer::state_
protected

Definition at line 119 of file transformers.h.

◆ transformer_

std::unique_ptr<LightTransformer> esphome::light::LightFlashTransformer::transformer_ {nullptr}
protected

Definition at line 121 of file transformers.h.

◆ transition_length_

uint32_t esphome::light::LightFlashTransformer::transition_length_
protected

Definition at line 120 of file transformers.h.


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