JUCE  v5.4.1-191-g0ab5e696f
JUCE API
Looking for a senior C++ dev?
I'm looking for work. Hire me!
juce::Block Class Referenceabstract

Represents an individual BLOCKS device. More...

#include <juce_Block.h>

Inheritance diagram for juce::Block:
Collaboration diagram for juce::Block:

Classes

struct  BlockArea
 A simple struct representing the area of a block. More...
 
struct  ConfigMetaData
 Metadata for a given config item. More...
 
struct  ConnectionPort
 These are the edge-connectors that a device may have. More...
 
struct  DataInputPortListener
 Interface for objects listening to input data port. More...
 
struct  Program
 A program that can be loaded onto a block. More...
 
struct  ProgramEventListener
 Interface for objects listening to custom program events. More...
 
struct  ProgramEventMessage
 A message that can be sent to the currently loaded program. More...
 

Public Types

using Array = juce::ReferenceCountedArray< Block >
 The Block class is reference-counted, so Block::Array is useful when you are storing lists of them. More...
 
using Ptr = juce::ReferenceCountedObjectPtr< Block >
 The Block class is reference-counted, so always use a Block::Ptr when you are keeping references to them. More...
 
using Timestamp = uint32
 This type is used for timestamping events. More...
 
enum  Type {
  unknown = 0,
  lightPadBlock,
  liveBlock,
  loopBlock,
  developerControlBlock,
  touchBlock,
  seaboardBlock
}
 The different block types. More...
 
using UID = uint64
 This type is used for the unique block identifier. More...
 

Public Member Functions

virtual ~Block ()
 Destructor. More...
 
virtual void addDataInputPortListener (DataInputPortListener *)
 Adds a new listener for the data input port. More...
 
virtual void addProgramEventListener (ProgramEventListener *)
 Adds a new listener for custom program events from the block. More...
 
virtual void blockReset ()=0
 Reset this Block. More...
 
void decReferenceCount () noexcept
 Decreases the object's reference count. More...
 
bool decReferenceCountWithoutDeleting () noexcept
 Decreases the object's reference count. More...
 
virtual void factoryReset ()=0
 Perform factory reset on Block. More...
 
virtual float getBatteryLevel () const =0
 Returns the battery level in the range 0.0 to 1.0. More...
 
virtual BlockArea getBlockAreaWithinLayout () const =0
 Returns the area that this block covers within the layout of the group as a whole. More...
 
virtual juce::Array< ControlButton * > getButtons () const =0
 If this block has any control buttons, this will return an array of objects to control them. More...
 
virtual UID getConnectedMasterUID () const =0
 Returns the UID of the master block this block is connected to. More...
 
virtual uint8 getDataByte (size_t offset)=0
 Gets a byte from the littlefoot heap. More...
 
virtual juce::String getDeviceDescription () const =0
 Returns a human-readable description of this device type. More...
 
virtual uint32 getHeapMemorySize ()=0
 Returns the size of the data block that setDataByte and other functions can write to. More...
 
virtual int getHeight () const =0
 Returns the height of the device in logical device units. More...
 
virtual LEDGridgetLEDGrid () const =0
 If this block has a grid of LEDs, this will return an object to control it. More...
 
virtual LEDRowgetLEDRow ()=0
 If this block has a row of LEDs, this will return an object to control it. More...
 
virtual ConfigMetaData getLocalConfigMetaData (uint32 item)=0
 Get config item metadata. More...
 
virtual int32 getLocalConfigValue (uint32 item)=0
 Get local config item value. More...
 
virtual uint32 getMaxConfigIndex ()=0
 Returns the maximum number of config items available. More...
 
virtual uint32 getMemorySize ()=0
 Returns the overall memory of the block. More...
 
virtual float getMillimetersPerUnit () const =0
 Returns the length of one logical device unit as physical millimeters. More...
 
virtual juce::Array< ConnectionPortgetPorts () const =0
 Returns a list of the connectors that this device has. More...
 
virtual ProgramgetProgram () const =0
 Returns a pointer to the currently loaded program. More...
 
int getReferenceCount () const noexcept
 Returns the object's current reference count. More...
 
virtual int getRotation () const =0
 Returns the rotation of this block relative to the master block in 90 degree steps clockwise. More...
 
virtual juce::Array< StatusLight * > getStatusLights () const =0
 If this block has any status LEDs, this will return an array of objects to control them. More...
 
virtual TouchSurfacegetTouchSurface () const =0
 If this block has a pressure-sensitive surface, this will return an object to access its data. More...
 
virtual Type getType () const =0
 Returns the type of this device. More...
 
virtual int getWidth () const =0
 Returns the width of the device in logical device units. More...
 
void incReferenceCount () noexcept
 Increments the object's reference count. More...
 
virtual bool isBatteryCharging () const =0
 Returns true if the battery is charging. More...
 
virtual bool isConnected () const =0
 Returns true if this block is connected and active. More...
 
bool isControlBlock () const
 Returns true if this a control block. More...
 
virtual bool isHardwareBlock () const =0
 Returns true if the device is a physical hardware block (i.e. More...
 
virtual bool isLocalConfigItemActive (uint32 item)=0
 Determine if config item is active or not. More...
 
virtual bool isMasterBlock () const =0
 Returns true if this block is directly connected to the application, as opposed to only being connected to a different block via a connection port. More...
 
virtual bool isValidUserConfigIndex (uint32 item)=0
 Determine if this is a valid config item index. More...
 
bool operator!= (const Block &other) const noexcept
 Two blocks are considered equal if they have the same UID. More...
 
bool operator== (const Block &other) const noexcept
 Two blocks are considered equal if they have the same UID. More...
 
virtual void removeDataInputPortListener (DataInputPortListener *)
 Removes a listener for the data input port. More...
 
virtual void removeProgramEventListener (ProgramEventListener *)
 Removes a listener for custom program events from the block. More...
 
virtual void requestFactoryConfigSync ()=0
 Request sync of factory config with block. More...
 
virtual void resetConfigListActiveStatus ()=0
 Reset all items active status. More...
 
virtual void saveProgramAsDefault ()=0
 Sets the current program as the block's default state. More...
 
virtual bool sendFirmwareUpdatePacket (const uint8 *data, uint8 size, std::function< void(uint8, uint32)> packetAckCallback)=0
 Sends a firmware update packet to a block, and waits for a reply. More...
 
virtual void sendMessage (const void *messageData, size_t messageSize)=0
 Sends a message to the block. More...
 
virtual void sendProgramEvent (const ProgramEventMessage &)=0
 Sends a message to the currently loaded program. More...
 
virtual void setConfigChangedCallback (std::function< void(Block &, const ConfigMetaData &, uint32)>)=0
 Provides a callback that will be called when a config changes. More...
 
virtual void setDataBits (uint32 startBit, uint32 numBits, uint32 value)=0
 Sets multiple bits on the littlefoot heap. More...
 
virtual void setDataByte (size_t offset, uint8 value)=0
 Sets a single byte on the littlefoot heap. More...
 
virtual void setDataBytes (size_t offset, const void *data, size_t num)=0
 Sets multiple bytes on the littlefoot heap. More...
 
virtual void setLocalConfigItemActive (uint32 item, bool isActive)=0
 Set if config item is active or not. More...
 
virtual void setLocalConfigRange (uint32 item, int32 min, int32 max)=0
 Set local config item range. More...
 
virtual void setLocalConfigValue (uint32 item, int32 value)=0
 Set local config item value. More...
 
virtual void setLogger (std::function< void(const String &)> loggingCallback)=0
 Allows the user to provide a function that will receive log messages from the block. More...
 
virtual bool setName (const juce::String &name)=0
 Set Block name. More...
 
virtual juce::Result setProgram (Program *)=0
 Sets the Program to run on this block. More...
 
virtual void setProgramLoadedCallback (std::function< void(Block &)> programLoaded)=0
 Provides a callback that will be called when a prgoram has been loaded. More...
 
virtual bool supportsGraphics () const =0
 This returns true if the block supports generating graphics by drawing into a JUCE Graphics context. More...
 

Static Public Member Functions

static bool isControlBlock (Block::Type)
 Returns true if Block::Type is a control block. More...
 

Public Attributes

juce::String name
 The Block's name. More...
 
const juce::String serialNumber
 The Block's serial number. More...
 
const UID uid
 This Block's UID. More...
 
juce::String versionNumber
 The Block's version number. More...
 

Protected Member Functions

 Block (const juce::String &serialNumberToUse)
 
 Block (const juce::String &serial, const juce::String &version, const juce::String &name)
 
void resetReferenceCount () noexcept
 Resets the reference count to zero without deleting the object. More...
 

Protected Attributes

juce::ListenerList< DataInputPortListenerdataInputPortListeners
 
juce::ListenerList< ProgramEventListenerprogramEventListeners
 

Detailed Description

Represents an individual BLOCKS device.

{Blocks}

Member Typedef Documentation

◆ Array

The Block class is reference-counted, so Block::Array is useful when you are storing lists of them.

◆ Ptr

The Block class is reference-counted, so always use a Block::Ptr when you are keeping references to them.

◆ Timestamp

This type is used for timestamping events.

It represents a number of milliseconds since the block device was booted.

◆ UID

This type is used for the unique block identifier.

Member Enumeration Documentation

◆ Type

The different block types.

See also
Block::getType()
Enumerator
unknown 

Unknown block type.

lightPadBlock 

Lightpad block type.

liveBlock 

Live control block type.

loopBlock 

Loop control block type.

developerControlBlock 

Developer control block type.

touchBlock 

Touch control block type.

seaboardBlock 

Seaboard block type.

Constructor & Destructor Documentation

◆ ~Block()

virtual juce::Block::~Block ( )
virtual

Destructor.

◆ Block() [1/2]

juce::Block::Block ( const juce::String serialNumberToUse)
protected

◆ Block() [2/2]

juce::Block::Block ( const juce::String serial,
const juce::String version,
const juce::String name 
)
protected

Member Function Documentation

◆ addDataInputPortListener()

virtual void juce::Block::addDataInputPortListener ( DataInputPortListener )
virtual

Adds a new listener for the data input port.

Referenced by juce::Block::DataInputPortListener::~DataInputPortListener().

◆ addProgramEventListener()

virtual void juce::Block::addProgramEventListener ( ProgramEventListener )
virtual

Adds a new listener for custom program events from the block.

Referenced by juce::Block::ProgramEventListener::~ProgramEventListener().

◆ blockReset()

virtual void juce::Block::blockReset ( )
pure virtual

Reset this Block.

◆ decReferenceCount()

void juce::ReferenceCountedObject::decReferenceCount ( )
inlinenoexceptinherited

Decreases the object's reference count.

If the count gets to zero, the object will be deleted.

References jassert.

◆ decReferenceCountWithoutDeleting()

bool juce::ReferenceCountedObject::decReferenceCountWithoutDeleting ( )
inlinenoexceptinherited

Decreases the object's reference count.

If the count gets to zero, the object will not be deleted, but this method will return true, allowing the caller to take care of deletion.

References jassert.

◆ factoryReset()

virtual void juce::Block::factoryReset ( )
pure virtual

Perform factory reset on Block.

◆ getBatteryLevel()

virtual float juce::Block::getBatteryLevel ( ) const
pure virtual

Returns the battery level in the range 0.0 to 1.0.

Referenced by operator!=().

◆ getBlockAreaWithinLayout()

virtual BlockArea juce::Block::getBlockAreaWithinLayout ( ) const
pure virtual

Returns the area that this block covers within the layout of the group as a whole.

The coordinates are in logical block units, and are relative to the origin, which is the master block's top-left corner.

◆ getButtons()

virtual juce::Array<ControlButton*> juce::Block::getButtons ( ) const
pure virtual

If this block has any control buttons, this will return an array of objects to control them.

Note that the objects in the array belong to this Block object, and the caller must neither delete them or use them after the lifetime of this Block object has finished.

◆ getConnectedMasterUID()

virtual UID juce::Block::getConnectedMasterUID ( ) const
pure virtual

Returns the UID of the master block this block is connected to.

Referenced by operator!=().

◆ getDataByte()

virtual uint8 juce::Block::getDataByte ( size_t  offset)
pure virtual

Gets a byte from the littlefoot heap.

Referenced by juce::Block::ProgramEventListener::~ProgramEventListener().

◆ getDeviceDescription()

virtual juce::String juce::Block::getDeviceDescription ( ) const
pure virtual

Returns a human-readable description of this device type.

Referenced by operator!=().

◆ getHeapMemorySize()

virtual uint32 juce::Block::getHeapMemorySize ( )
pure virtual

Returns the size of the data block that setDataByte and other functions can write to.

Referenced by juce::Block::ProgramEventListener::~ProgramEventListener().

◆ getHeight()

virtual int juce::Block::getHeight ( ) const
pure virtual

Returns the height of the device in logical device units.

Referenced by operator!=().

◆ getLEDGrid()

virtual LEDGrid* juce::Block::getLEDGrid ( ) const
pure virtual

If this block has a grid of LEDs, this will return an object to control it.

Note that the pointer that is returned belongs to this object, and the caller must neither delete it or use it after the lifetime of this Block object has finished. If there are no LEDs, then this method will return nullptr.

◆ getLEDRow()

virtual LEDRow* juce::Block::getLEDRow ( )
pure virtual

If this block has a row of LEDs, this will return an object to control it.

Note that the pointer that is returned belongs to this object, and the caller must neither delete it or use it after the lifetime of this Block object has finished. If there are no LEDs, then this method will return nullptr.

◆ getLocalConfigMetaData()

virtual ConfigMetaData juce::Block::getLocalConfigMetaData ( uint32  item)
pure virtual

Get config item metadata.

◆ getLocalConfigValue()

virtual int32 juce::Block::getLocalConfigValue ( uint32  item)
pure virtual

Get local config item value.

◆ getMaxConfigIndex()

virtual uint32 juce::Block::getMaxConfigIndex ( )
pure virtual

Returns the maximum number of config items available.

◆ getMemorySize()

virtual uint32 juce::Block::getMemorySize ( )
pure virtual

Returns the overall memory of the block.

Referenced by juce::Block::ProgramEventListener::~ProgramEventListener().

◆ getMillimetersPerUnit()

virtual float juce::Block::getMillimetersPerUnit ( ) const
pure virtual

Returns the length of one logical device unit as physical millimeters.

Referenced by operator!=().

◆ getPorts()

virtual juce::Array<ConnectionPort> juce::Block::getPorts ( ) const
pure virtual

Returns a list of the connectors that this device has.

◆ getProgram()

virtual Program* juce::Block::getProgram ( ) const
pure virtual

Returns a pointer to the currently loaded program.

◆ getReferenceCount()

int juce::ReferenceCountedObject::getReferenceCount ( ) const
inlinenoexceptinherited

Returns the object's current reference count.

◆ getRotation()

virtual int juce::Block::getRotation ( ) const
pure virtual

Returns the rotation of this block relative to the master block in 90 degree steps clockwise.

◆ getStatusLights()

virtual juce::Array<StatusLight*> juce::Block::getStatusLights ( ) const
pure virtual

If this block has any status LEDs, this will return an array of objects to control them.

Note that the objects in the array belong to this Block object, and the caller must neither delete them or use them after the lifetime of this Block object has finished.

◆ getTouchSurface()

virtual TouchSurface* juce::Block::getTouchSurface ( ) const
pure virtual

If this block has a pressure-sensitive surface, this will return an object to access its data.

Note that the pointer returned does is owned by this object, and the caller must neither delete it or use it after the lifetime of this Block object has finished. If the device is not touch-sensitive, then this method will return nullptr.

◆ getType()

virtual Type juce::Block::getType ( ) const
pure virtual

Returns the type of this device.

See also
Block::Type

Referenced by operator!=().

◆ getWidth()

virtual int juce::Block::getWidth ( ) const
pure virtual

Returns the width of the device in logical device units.

Referenced by operator!=().

◆ incReferenceCount()

void juce::ReferenceCountedObject::incReferenceCount ( )
inlinenoexceptinherited

Increments the object's reference count.

This is done automatically by the smart pointer, but is public just in case it's needed for nefarious purposes.

◆ isBatteryCharging()

virtual bool juce::Block::isBatteryCharging ( ) const
pure virtual

Returns true if the battery is charging.

Referenced by operator!=().

◆ isConnected()

virtual bool juce::Block::isConnected ( ) const
pure virtual

Returns true if this block is connected and active.

Referenced by operator!=().

◆ isControlBlock() [1/2]

bool juce::Block::isControlBlock ( ) const

Returns true if this a control block.

Referenced by operator!=().

◆ isControlBlock() [2/2]

static bool juce::Block::isControlBlock ( Block::Type  )
static

Returns true if Block::Type is a control block.

◆ isHardwareBlock()

virtual bool juce::Block::isHardwareBlock ( ) const
pure virtual

Returns true if the device is a physical hardware block (i.e.

not a virtual block).

Referenced by operator!=().

◆ isLocalConfigItemActive()

virtual bool juce::Block::isLocalConfigItemActive ( uint32  item)
pure virtual

Determine if config item is active or not.

◆ isMasterBlock()

virtual bool juce::Block::isMasterBlock ( ) const
pure virtual

Returns true if this block is directly connected to the application, as opposed to only being connected to a different block via a connection port.

See also
ConnectionPort

Referenced by operator!=().

◆ isValidUserConfigIndex()

virtual bool juce::Block::isValidUserConfigIndex ( uint32  item)
pure virtual

Determine if this is a valid config item index.

◆ operator!=()

bool juce::Block::operator!= ( const Block other) const
inlinenoexcept

◆ operator==()

bool juce::Block::operator== ( const Block other) const
inlinenoexcept

Two blocks are considered equal if they have the same UID.

◆ removeDataInputPortListener()

virtual void juce::Block::removeDataInputPortListener ( DataInputPortListener )
virtual

Removes a listener for the data input port.

Referenced by juce::Block::DataInputPortListener::~DataInputPortListener().

◆ removeProgramEventListener()

virtual void juce::Block::removeProgramEventListener ( ProgramEventListener )
virtual

Removes a listener for custom program events from the block.

Referenced by juce::Block::ProgramEventListener::~ProgramEventListener().

◆ requestFactoryConfigSync()

virtual void juce::Block::requestFactoryConfigSync ( )
pure virtual

Request sync of factory config with block.

◆ resetConfigListActiveStatus()

virtual void juce::Block::resetConfigListActiveStatus ( )
pure virtual

Reset all items active status.

◆ resetReferenceCount()

void juce::ReferenceCountedObject::resetReferenceCount ( )
inlineprotectednoexceptinherited

Resets the reference count to zero without deleting the object.

You should probably never need to use this!

◆ saveProgramAsDefault()

virtual void juce::Block::saveProgramAsDefault ( )
pure virtual

Sets the current program as the block's default state.

Referenced by juce::Block::ProgramEventListener::~ProgramEventListener().

◆ sendFirmwareUpdatePacket()

virtual bool juce::Block::sendFirmwareUpdatePacket ( const uint8 data,
uint8  size,
std::function< void(uint8, uint32)>  packetAckCallback 
)
pure virtual

Sends a firmware update packet to a block, and waits for a reply.

Returns an error code.

◆ sendMessage()

virtual void juce::Block::sendMessage ( const void *  messageData,
size_t  messageSize 
)
pure virtual

Sends a message to the block.

Referenced by juce::Block::DataInputPortListener::~DataInputPortListener().

◆ sendProgramEvent()

virtual void juce::Block::sendProgramEvent ( const ProgramEventMessage )
pure virtual

Sends a message to the currently loaded program.

To receive the message the program must provide a littlefoot function called handleMessage with the following form:

void handleMessage (int param1, int param2, int param3)
{
// Do something with the two integer parameters that the app has sent...
}

◆ setConfigChangedCallback()

virtual void juce::Block::setConfigChangedCallback ( std::function< void(Block &, const ConfigMetaData &, uint32)>  )
pure virtual

Provides a callback that will be called when a config changes.

◆ setDataBits()

virtual void juce::Block::setDataBits ( uint32  startBit,
uint32  numBits,
uint32  value 
)
pure virtual

Sets multiple bits on the littlefoot heap.

Referenced by juce::Block::ProgramEventListener::~ProgramEventListener().

◆ setDataByte()

virtual void juce::Block::setDataByte ( size_t  offset,
uint8  value 
)
pure virtual

Sets a single byte on the littlefoot heap.

Referenced by juce::Block::ProgramEventListener::~ProgramEventListener().

◆ setDataBytes()

virtual void juce::Block::setDataBytes ( size_t  offset,
const void *  data,
size_t  num 
)
pure virtual

Sets multiple bytes on the littlefoot heap.

Referenced by juce::Block::ProgramEventListener::~ProgramEventListener().

◆ setLocalConfigItemActive()

virtual void juce::Block::setLocalConfigItemActive ( uint32  item,
bool  isActive 
)
pure virtual

Set if config item is active or not.

◆ setLocalConfigRange()

virtual void juce::Block::setLocalConfigRange ( uint32  item,
int32  min,
int32  max 
)
pure virtual

Set local config item range.

◆ setLocalConfigValue()

virtual void juce::Block::setLocalConfigValue ( uint32  item,
int32  value 
)
pure virtual

Set local config item value.

◆ setLogger()

virtual void juce::Block::setLogger ( std::function< void(const String &)>  loggingCallback)
pure virtual

Allows the user to provide a function that will receive log messages from the block.

◆ setName()

virtual bool juce::Block::setName ( const juce::String name)
pure virtual

Set Block name.

◆ setProgram()

virtual juce::Result juce::Block::setProgram ( Program )
pure virtual

Sets the Program to run on this block.

The supplied Program's lifetime will be managed by this class, so do not use the Program in other places in your code.

◆ setProgramLoadedCallback()

virtual void juce::Block::setProgramLoadedCallback ( std::function< void(Block &)>  programLoaded)
pure virtual

Provides a callback that will be called when a prgoram has been loaded.

◆ supportsGraphics()

virtual bool juce::Block::supportsGraphics ( ) const
pure virtual

This returns true if the block supports generating graphics by drawing into a JUCE Graphics context.

This should only be true for virtual on-screen blocks; hardware blocks will instead use the LED Grid for visuals.

Member Data Documentation

◆ dataInputPortListeners

juce::ListenerList<DataInputPortListener> juce::Block::dataInputPortListeners
protected

◆ name

juce::String juce::Block::name

The Block's name.

◆ programEventListeners

juce::ListenerList<ProgramEventListener> juce::Block::programEventListeners
protected

◆ serialNumber

const juce::String juce::Block::serialNumber

The Block's serial number.

◆ uid

const UID juce::Block::uid

This Block's UID.

This will be globally unique, and remains constant for a particular device.

◆ versionNumber

juce::String juce::Block::versionNumber

The Block's version number.


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