TinyMaterialDesign
Loading...
Searching...
No Matches
Public Member Functions | List of all members
CircularProgressIndicator< RGB_T > Class Template Reference

Circular "spinner" ring. Determinate (value in [0,1], drawn as a sweep starting at 12 o'clock) or indeterminate (a fixed-length arc rotates continuously, driven by update()). Both use TinyGPU's ISurface::drawArc. More...

#include <ProgressIndicator.h>

Inheritance diagram for CircularProgressIndicator< RGB_T >:
Inheritance graph
[legend]
Collaboration diagram for CircularProgressIndicator< RGB_T >:
Collaboration graph
[legend]

Public Member Functions

 CircularProgressIndicator ()=default
 
 CircularProgressIndicator (Bounds bounds, float value=0.0f, bool indeterminate=false)
 
float value () const
 
void setValue (float value)
 
void setIndeterminate (bool indeterminate)
 
void setThickness (uint8_t thickness)
 
void draw (tinygpu::ISurface< RGB_T > &target) override
 
bool update (uint32_t nowMs) override
 
- Public Member Functions inherited from Widget< RGB_T >
virtual ~Widget ()=default
 
virtual void setTheme (const MaterialTheme< RGB_T > &theme)
 
virtual void draw (tinygpu::ISurface< RGB_T > &target)=0
 
virtual bool onGesture (const tinygpu::GestureEvent &event)
 Handles one gesture event. Returns true if this widget consumed it.
 
virtual bool update (uint32_t nowMs)
 
virtual bool isDraggable () const
 
virtual bool isDraggableAt (int32_t x, int32_t y) const
 
virtual int childCount () const
 
virtual Widget< RGB_T > * child (int index)
 
virtual void drawBackground (tinygpu::ISurface< RGB_T > &target)
 
virtual void setThemeTint (RGB_T background, RGB_T foreground)
 
virtual bool isContainer () const
 Provides true if the widget is a container.
 

Additional Inherited Members

- Public Attributes inherited from Widget< RGB_T >
Bounds bounds
 
bool visible = true
 
bool enabled = true
 
- Protected Member Functions inherited from Widget< RGB_T >
const MaterialTheme< RGB_T > & theme () const
 Convenience accessor for draw() overrides - see theme_.
 
- Protected Attributes inherited from Widget< RGB_T >
const MaterialTheme< RGB_T > * theme_ = nullptr
 

Detailed Description

template<typename RGB_T = TINYMD_DEFAULT_RGB_T>
class tinymd::CircularProgressIndicator< RGB_T >

Circular "spinner" ring. Determinate (value in [0,1], drawn as a sweep starting at 12 o'clock) or indeterminate (a fixed-length arc rotates continuously, driven by update()). Both use TinyGPU's ISurface::drawArc.

Constructor & Destructor Documentation

◆ CircularProgressIndicator() [1/2]

◆ CircularProgressIndicator() [2/2]

CircularProgressIndicator ( Bounds  bounds,
float  value = 0.0f,
bool  indeterminate = false 
)
inlineexplicit

Member Function Documentation

◆ draw()

void draw ( tinygpu::ISurface< RGB_T > &  target)
inlineoverridevirtual

Renders the widget into target using colors/fonts/tokens from its own theme (see theme()/setTheme()).

Implements Widget< RGB_T >.

◆ setIndeterminate()

void setIndeterminate ( bool  indeterminate)
inline

◆ setThickness()

void setThickness ( uint8_t  thickness)
inline

◆ setValue()

void setValue ( float  value)
inline

◆ update()

bool update ( uint32_t  nowMs)
inlineoverridevirtual

Called once per frame, before draw(), to advance any time-based animation (ripple fade, indeterminate progress sweep, ...). Returns true if that advance changed anything this widget will draw differently, so Screen can decide whether a redraw is actually needed - see Screen::isDirty(). Default: no-op, not dirty, so widgets that don't animate cost nothing extra.

Reimplemented from Widget< RGB_T >.

◆ value()

float value ( ) const
inline

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