![]() |
MD_Cubo LED Cube Arduino Library
1.1
Library to control LED Cubes
|
Public Member Functions | |
void | begin () |
void | update () |
void | animate (uint32_t wait=0) |
void | setVoxel (boolean p, uint8_t x, uint8_t y, uint8_t z) |
boolean | getVoxel (uint8_t x, uint8_t y, uint8_t z) |
void | clear (boolean p=false) |
uint8_t | size (axis_t axis) |
![]() | |
MD_Cubo (uint8_t sizeCube) | |
~MD_Cubo () | |
virtual void | setIntensity (uint8_t intensity) |
virtual void | fillPlane (boolean p, plane_t plane, uint8_t coord) |
virtual void | copyPlane (plane_t plane, uint8_t cordFrom, uint8_t cordTo) |
virtual void | drawLine (boolean p, uint8_t x1, uint8_t y1, uint8_t z1, uint8_t x2, uint8_t y2, uint8_t z2) |
virtual void | drawRPrism (boolean p, uint8_t x, uint8_t y, uint8_t z, int8_t dx, uint8_t dy, uint8_t dz) |
void | drawCube (boolean p, uint8_t x, uint8_t y, uint8_t z, int8_t size) |
Additional Inherited Members | |
![]() | |
enum | axis_t { XAXIS, YAXIS, ZAXIS } |
enum | plane_t { XYPLANE, XZPLANE, YZPLANE } |
![]() | |
uint8_t | _sizeXaxis |
the number of LEDs on x axis of the cube. Total number of pixels is x*y*z. | |
uint8_t | _sizeYaxis |
the number of LEDs on y axis of the cube. Total number of pixels is x*y*z. | |
uint8_t | _sizeZaxis |
the number of LEDs on z axis of the cube. Total number of pixels is x*y*z. | |
|
virtual |
Animate the cube display.
Cubes that need to be refreshed/multiplexed in order to show the display should have the multiplexing code inserted here. The code should be written as a non-blocking state machine that should be executing for wait milliseconds. If wait is zero then one step in the refresh should be executed and the method needs to be invoke often enough to ensure animations are seen to be smooth. This is only implementable in the user derived object, as it is heavily reliant on the hardware configuration.
wait | optional period for this animation to execute before returning. |
Reimplemented from MD_Cubo.
|
virtual |
Initialize the object.
Initialise the object data. This needs to be called during setup() to initialise new data for the class that cannot be done during the object creation.
Hardware interfaces implemented in virtual functions should be initialized here.
Reimplemented from MD_Cubo.
|
virtual |
Clear the cube.
Set every pixel in the cube to the specificed value (default off). The generic method iterates through all the pixels. A more efficient implementation may be possible by exploiting access to hardware.
p | set ON if true, off if false (default). |
Reimplemented from MD_Cubo.
|
virtual |
Get the status of specified pixel in the cube.
This is the most basic graphic function and is necessarily only implementable in the user derived object, as it is heavily related to the hardware configuration. The (x,y,z) coordinate for the pixel needs to be mapped to a device address and on/off value of the pixel returned to the calling program..
x | x coordinate for the pixel. |
y | y coordinate for the pixel. |
z | z coordinate for the pixel. |
Reimplemented from MD_Cubo.
|
virtual |
Set the specified point in the cube.
This is the most basic graphic function and is necessarily only implementable in the user derived object, as it is heavily related to the hardware configuration. The (x,y,z) coordinate for the pixel needs to be mapped to a device action to turn the pixel on or off.
p | pixel value - if false, set the pixel off. If true, set the pixel on. |
x | x coordinate for the pixel. |
y | y coordinate for the pixel. |
z | z coordinate for the pixel. |
Reimplemented from MD_Cubo.
|
virtual |
Return the size of the cube.
Return the number of LED on one side of the cube. Allows high level code to be independent of any size definitions, which are known in in the user derived object, as it is reliant on the hardware configuration.
axis | specifies the axis required, one of the axis_t enumerations |
Reimplemented from MD_Cubo.
|
virtual |
Update the cube display.
All cube changes are buffered internally until this method is called, at which time the cube is updated. This is only implementable in the user derived object, as it is heavily reliant on the hardware configuration.
Reimplemented from MD_Cubo.