pixled-lib  1.0
Public Member Functions | List of all members
pixled::Mapping Struct Reference

#include <mapping.h>

Inheritance diagram for pixled::Mapping:
Inheritance graph
[legend]

Public Member Functions

const std::vector< led > & leds () const
 
void push (const led &led)
 
box boundingBox () const
 

Detailed Description

The Mapping is an essential pixled component.

It is used to described all the leds contained in the current system, so that the Runtime can apply an Animation on each led.

A Mapping can be used to define any 2D led shape, without any restriction.

See the mapping namespace for predefined mappings.

Member Function Documentation

◆ leds()

const std::vector<led>& pixled::Mapping::leds ( ) const
inline

Returns all the leds contained in this mapping.

◆ push()

void pixled::Mapping::push ( const led led)

Push a new led in the mapping. It is the responsability of the user to ensure that the led indexes are consistent.

Parameters
ledled to add to the mapping

◆ boundingBox()

box pixled::Mapping::boundingBox ( ) const
inline

Minimalist box around all the leds currently contained in the mapping.

The bounding box is updated each time push() is called.

Returns
mapping bounding box

The documentation for this struct was generated from the following files: