JUCE
Enumerations | Functions
juce_LittleFootFunctions.dox File Reference

Enumerations

enum  ControlType { internalConfig = 0 , midiCC , sysex }
 Control type for use with initControl. More...
 
enum  ControlMode {
  toggle = 0 , togglePulse , gate , trigger ,
  cycle , incDec , triState
}
 Control mode for use with initControl. More...
 

Functions

int getHeapByte (int byteIndex)
 Reads and returns the value of a single byte from the heap. More...
 
int getHeapInt (int byteIndex)
 Reads 4 bytes from the heap and returns the value as an integer. More...
 
int getHeapBits (int startBitIndex, int numBits)
 Reads a sequence of bits from the heap and returns the value as an integer. More...
 
void setHeapByte (int byteIndex, int newValue)
 Writes a single byte to the heap. More...
 
void setHeapInt (int byteIndex, int newValue)
 Writes 4 bytes to the heap. More...
 
int min (int a, int b)
 Returns the smaller of two integer values. More...
 
float min (float a, float b)
 Returns the smaller of two floating point values. More...
 
int max (int a, int b)
 Returns the larger of two integer values. More...
 
float max (float a, float b)
 Returns the larger of two floating point values. More...
 
int clamp (int lowerLimit, int upperLimit, int valueToConstrain)
 Constrains an integer value to keep it within a given range. More...
 
float clamp (float lowerLimit, float upperLimit, float valueToConstrain)
 Constrains a floating point value to keep it within a given range. More...
 
int abs (int arg)
 Returns the absolute value of an integer value. More...
 
float abs (float arg)
 Returns the absolute value of a floating point value. More...
 
float map (float value, float sourceMin, float sourceMax, float destMin, float destMax)
 Remaps a value from a source range to a target range. More...
 
float map (float value, float sourceMin, float sourceMax)
 Remaps a value from a source range to the range 0 - 1.0. More...
 
int mod (int dividend, int divisor)
 Performs a modulo operation (can cope with the dividend being negative). More...
 
float getRandomFloat ()
 Returns a random floating-point number. More...
 
int getRandomInt (int maxValue)
 Returns a random integer, limited to a given range. More...
 
int getMillisecondCounter ()
 Returns the number of milliseconds since a fixed event (usually system startup). More...
 
int getTimeInCurrentFunctionCall ()
 Returns the length of time spent in the current function call in milliseconds. More...
 
void log (int data)
 Logs an integer value to the console. More...
 
void logHex (int data)
 Logs a hexadecimal value to the console. More...
 
void sendMIDI (int byte0)
 Sends a 1-byte short midi message. More...
 
void sendMIDI (int byte0, int byte1)
 Sends a 2-byte short midi message. More...
 
void sendMIDI (int byte0, int byte1, int byte2)
 Sends a 3-byte short midi message. More...
 
void sendNoteOn (int channel, int noteNumber, int velocity)
 Sends a key-down message. More...
 
void sendNoteOff (int channel, int noteNumber, int velocity)
 Sends a key-up message. More...
 
void sendAftertouch (int channel, int noteNumber, int level)
 Sends an aftertouch message. More...
 
void sendCC (int channel, int controller, int value)
 Sends a controller message. More...
 
void sendPitchBend (int channel, int position)
 Sends a pitch bend message. More...
 
void sendChannelPressure (int channel, int pressure)
 Sends a channel-pressure change event. More...
 
void setChannelRange (bool useMPE, int lowChannel, int highChannel)
 Sets the MIDI channel range. More...
 
int assignChannel (int noteNumber)
 Assigns a MIDI channel to a note number. More...
 
void deassignChannel (int noteNumber, int channel)
 Deassigns a channel from a note number. More...
 
int getControlChannel ()
 Returns the channel that is being used for control messages. More...
 
void useMPEDuplicateFilter (bool active)
 Sets whether duplicate notes should be filtered out when MPE is enabled. More...
 
void repaint ()
 Use this method to draw the display. More...
 
void handleButtonDown (int index)
 Called when a button is pushed. More...
 
void handleButtonUp (int index)
 Called when a button is released. More...
 
void onControlPress (int buttonIndex)
 Call this when a control block button is pressed to trigger the buttons default behaviour. More...
 
void onControlRelease (int buttonIndex)
 Call this when a control block button is released to trigger the buttons default behaviour. More...
 
void touchStart (int index, float x, float y, float z, float vz)
 Called when a touch event starts. More...
 
void touchMove (int index, float x, float y, float z, float vz)
 Called when a touch event moves. More...
 
void touchEnd (int index, float x, float y, float z, float vz)
 Called when a touch event ends. More...
 
void initialise ()
 Called when a program is loaded onto the block and is about to start. More...
 
void handleMIDI (int byte0, int byte1, int byte2)
 Called when a block receives a MIDI message. More...
 
void handleMessage (int param1, int param2, int param3)
 Called when a block receives a message. More...
 
int makeARGB (int alpha, int red, int green, int blue)
 Combines a set of 8-bit ARGB values into a 32-bit colour and returns the result. More...
 
int blendARGB (int baseColour, int overlaidColour)
 Blends the overlaid ARGB colour onto the base one and returns the new colour. More...
 
void displayBatteryLevel ()
 Displays an animation indicating the current battery level of this block. More...
 
void clearDisplay ()
 Clears the display and sets all the LEDs to black. More...
 
void clearDisplay (int rgb)
 Clears the display and sets all the LEDs to a specified colour. More...
 
void fillPixel (int rgb, int x, int y)
 Sets a pixel to a specified colour with full alpha. More...
 
void blendPixel (int argb, int x, int y)
 Blends the current pixel colour with a specified colour. More...
 
void fillRect (int rgb, int x, int y, int width, int height)
 Fills a rectangle on the display with a specified colour. More...
 
void blendRect (int argb, int x, int y, int width, int height)
 Blends a rectangle on the display with a specified colour. More...
 
void blendGradientRect (int colourNW, int colourNE, int colourSE, int colourSW, int x, int y, int width, int height)
 Fills a rectangle on the display with four corner colours blended together. More...
 
void blendCircle (int argb, float xCentre, float yCentre, float radius, bool fill)
 Blends a circle on the display with a specified colour. More...
 
void drawNumber (int value, int colour, int x, int y)
 Draws a number on the display. More...
 
int getFirmwareVersion ()
 Returns the current firmware version of this block. More...
 
float getBatteryLevel ()
 Returns the battery level of this block, between 0 and 1.0. More...
 
bool isBatteryCharging ()
 Returns true if this block's battery is charging. More...
 
void setStatusOverlayActive (bool active)
 Sets whether status overlays should be displayed on this block. More...
 
void setPowerSavingEnabled (bool enabled)
 Sets whether power saving mode should be enabled on this block. More...
 
int getBlockTypeForID (int blockID)
 Returns the type of the block with a given ID. More...
 
void sendMessageToBlock (int blockID, int param1, int param2, int param3)
 Sends a message to the block with the specified ID. More...
 
void sendMessageToHost (int param1, int param2, int param3)
 Sends a message to the host. More...
 
void addPressurePoint (int argb, float touchX, float touchY, float touchZ)
 Draws a pressure point with a specified colour and pressure. More...
 
void drawPressureMap ()
 Draws the pressure map on the display. More...
 
void fadePressureMap ()
 Fades the pressure map on the display. More...
 
void linkBlockIDtoController (int blockID)
 Links a another block to this control block. More...
 
void repaintControl ()
 Repaints the control block display. More...
 
void initControl (int buttonIndex, int modeToUse, int outputType, int val, int min, int max, int index, int onColourToUse, int offColourToUse)
 Initialises one of the control block buttons. More...
 
void handleTouchAsSeaboard (int touchIndex)
 Forces a touch event to be handled as seaboard playing. More...
 
int getNumBlocksInTopology ()
 Returns the number of blocks in the current topology. More...
 
int getBlockIDForIndex (int index)
 Returns the ID of a block at a given index in the topology. More...
 
bool isMasterBlock ()
 Returns true if this block is directly connected to the host, as opposed to only being connected to a different block via a connection port. More...
 
bool isConnectedToHost ()
 Returns true if this block is connected to the host computer, this can be directly or through connections to other blocks. More...
 
int getBlockIDOnPort (int port)
 Returns the ID of a block connected to a specified port on this block. More...
 
int getPortToMaster ()
 Returns the port number that is connected to the master block. More...
 
int getHorizontalDistFromMaster ()
 Returns the horizontal distance between this block and the master block in block units. More...
 
int getVerticalDistFromMaster ()
 Returns the vertical distance between this block and the master block in block units. More...
 
int getAngleFromMaster ()
 Returns the angle of this block relative to the master block in degrees. More...
 
void setAutoRotate (bool enabled)
 Sets whether this block should auto-rotate when its angle relative to the master block changes. More...
 
int getClusterIndex ()
 Returns the index of this block in the current cluster. More...
 
int getClusterWidth ()
 Returns how many blocks wide the current cluster is. More...
 
int getClusterHeight ()
 Returns how many blocks high the current cluster is. More...
 
int getClusterXpos ()
 Returns the x index of this block in the current cluster. More...
 
int getClusterYpos ()
 Returns the y index of this block in the current cluster. More...
 
int getNumBlocksInCurrentCluster ()
 Returns the number of blocks in the current cluster. More...
 
int getBlockIdForBlockInCluster (int index)
 Returns the block ID for a block in the current cluster. More...
 
bool isMasterInCurrentCluster ()
 Returns true if the master block is in the current cluster. More...
 
int getLocalConfig (int item)
 Returns current value of one of the local config items. More...
 
void setLocalConfig (int item, int value)
 Sets the current value of one of the local config items. More...
 
void requestRemoteConfig (int longAddress, int item)
 Sets the local config of a block to the config item of a remote block. More...
 
void setRemoteConfig (int longAddress, int item, int value)
 Sets the config of a remote block. More...
 
void setLocalConfigItemRange (int item, int min, int max)
 Sets the range of one of the local config items. More...
 
void setLocalConfigActiveState (int item, bool isActive, bool saveToFlash)
 Sets whether a local config item should be active. More...