LCDGFX LCD display driver  1.2.0
Lightweight graphics library for SSD1306, SSD1325, SSD1327, SSD1331, SSD1351, SH1106, SH1107, IL9163, ST7735, ST7789, ILI9341, PCD8544 displays over I2C/SPI
NanoSprite< T > Class Template Reference

This is template class for user sprites implementations. More...

#include <sprite.h>

Inheritance diagram for NanoSprite< T >:
Collaboration diagram for NanoSprite< T >:

Public Member Functions

 NanoSprite (const NanoPoint &pos, const NanoPoint &size, const uint8_t *bitmap)
 Creates sprite object of variable size. More...
 
void draw () override
 Draws nano object Engine canvas.
 
void setBitmap (const uint8_t *bitmap)
 Replaces sprite bitmap with new one.
 
const uint8_t * getBitmap ()
 Returns pointer to sprite bitmap data. More...
 
- Public Member Functions inherited from NanoObject< T >
 NanoObject (const NanoPoint &pos)
 Creates basic object with the size [1,1]. More...
 
 NanoObject (const NanoPoint &pos, const NanoPoint &size)
 Creates basic object with arbitrary size. More...
 
void refresh () override
 Marks nano object location for refreshing on the new frame.
 
void update () override
 Updates NanoObject.
 
lcdint_t width () const
 Returns width of NanoObject.
 
lcdint_t height () const
 Returns height of NanoObject.
 
void moveTo (const NanoPoint &p)
 Moves sprite to new position and marks screen area for refresh.
 
void moveBy (const NanoPoint &p)
 Moves sprite to new position by specified offset.
 
void resize (const NanoPoint &size)
 Resizes NanoObject and marks screen area for refresh. More...
 
void setSize (const NanoPoint &size)
 Sets new size of NanoObject. More...
 
void setPos (const NanoPoint &p)
 Sets position of NanoObject, doesn't mark for update content on the screen.
 
const NanoPoint bottom () const
 Returns bottom-center point of the sprite.
 
const NanoPoint top () const
 Returns top-center point of the sprite.
 
const NanoPoint left () const
 Returns left-center point of the sprite.
 
const NanoPoint right () const
 Returns right-center point of the sprite.
 
const NanoPoint center () const
 Returns center point of the sprite.
 
lcdint_t x () const
 Returns sprite x position.
 
lcdint_t y () const
 Returns sprite y position.
 
const NanoPointgetPosition () const
 Returns current sprite position (top-left corner)
 
const NanoRectgetRect () const
 Returns rectangle area, occupied by the NanoObject.
 
- Public Member Functions inherited from NanoEngineObject< T >
void focus ()
 Sets logic focus on NanoEngineObject.
 
void defocus ()
 Clears logic focus from NanoEngineObject.
 
bool isFocused ()
 Returns true if logic focus points to the object. More...
 
bool hasTiler ()
 Returns true if NanoEngineObject is bound to NanoEngine instance.
 
T & getTiler ()
 Returns reference to NanoEngine. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NanoEngineObject< T >
void setTiler (T *tiler)
 Bind NanoEngineObject to specific NanoEngine. More...
 
- Protected Attributes inherited from NanoObject< T >
NanoRect m_rect
 Rectangle area occupied by the object.
 
- Protected Attributes inherited from NanoEngineObject< T >
T * m_tiler = nullptr
 Active tiler, assigned to the NanoEngineObject.
 
NanoEngineObject< T > * m_next = nullptr
 Next NanoEngineObject in the list.
 

Detailed Description

template<class T>
class NanoSprite< T >

This is template class for user sprites implementations.

NanoSprite can work only as part of NanoEngine.

Definition at line 45 of file sprite.h.

Constructor & Destructor Documentation

◆ NanoSprite()

template<class T>
NanoSprite< T >::NanoSprite ( const NanoPoint pos,
const NanoPoint size,
const uint8_t *  bitmap 
)
inline

Creates sprite object of variable size.

Such sprites can change their size and bitmap content.

Parameters
posposition of the sprite in global coordinates
sizesize of sprite
bitmapsprite content (in flash memory)

Definition at line 55 of file sprite.h.

Member Function Documentation

◆ getBitmap()

template<class T>
const uint8_t* NanoSprite< T >::getBitmap ( )
inline

Returns pointer to sprite bitmap data.

The data are located in the Flash memory.

Definition at line 79 of file sprite.h.


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