From c452e49e8e008b539cf9347d0435808c3d91b9cd Mon Sep 17 00:00:00 2001 From: Noah Dayan Date: Thu, 22 Feb 2018 17:52:14 +0000 Subject: [PATCH] Docs: Add block units description to Blocks module --- .../juce_blocks_basics/blocks/juce_TouchSurface.h | 2 +- .../juce_LittleFootFunctions.dox | 15 ++++++++++++--- .../littlefoot/LittleFoot Language README.txt | 6 +++--- 3 files changed, 16 insertions(+), 7 deletions(-) diff --git a/modules/juce_blocks_basics/blocks/juce_TouchSurface.h b/modules/juce_blocks_basics/blocks/juce_TouchSurface.h index c48869e7ab..e0f173cbe2 100644 --- a/modules/juce_blocks_basics/blocks/juce_TouchSurface.h +++ b/modules/juce_blocks_basics/blocks/juce_TouchSurface.h @@ -64,7 +64,7 @@ public: */ float yVelocity; - /** The current pressure of this touch, in the range 0.0 (no pressure) to 1.o (very hard). */ + /** The current pressure of this touch, in the range 0.0 (no pressure) to 1.0 (very hard). */ float z; /** The rate at which pressure is currently changing, measured in units/second. This is diff --git a/modules/juce_blocks_basics/juce_LittleFootFunctions.dox b/modules/juce_blocks_basics/juce_LittleFootFunctions.dox index bc61a2a737..eb6dd03680 100644 --- a/modules/juce_blocks_basics/juce_LittleFootFunctions.dox +++ b/modules/juce_blocks_basics/juce_LittleFootFunctions.dox @@ -226,9 +226,9 @@ void sendChannelPressure (int channel, int pressure); /** Sets the MIDI channel range. - @param useMPE - @param lowChannel - @param highChannel + @param useMPE whether to use MPE mode + @param lowChannel the lowest MIDI channel + @param highChannel the highest MIDI channel */ void setChannelRange (bool useMPE, int lowChannel, int highChannel); @@ -292,6 +292,9 @@ void onControlRelease (int buttonIndex); /** Called when a touch event starts. + Block units follow the number of DNA connectors on the side of the device. + For instance, a Lightpad Block is 2x2 and a Control Block is 2x1. + @param index the touch index, which will stay constant for each finger as it is tracked @param x the X position of this touch on the device, in block units starting from 0 (left) @param y the Y position of this touch on the device, in block units starting from 0 (top) @@ -302,6 +305,9 @@ void touchStart (int index, float x, float y, float z, float vz); /** Called when a touch event moves. + Block units follow the number of DNA connectors on the side of the device. + For instance, a Lightpad Block is 2x2 and a Control Block is 2x1. + @param index the touch index, which will stay constant for each finger as it is tracked @param x the X position of this touch on the device, in block units starting from 0 (left) @param y the Y position of this touch on the device, in block units starting from 0 (top) @@ -312,6 +318,9 @@ void touchMove (int index, float x, float y, float z, float vz); /** Called when a touch event ends. + Block units follow the number of DNA connectors on the side of the device. + For instance, a Lightpad Block is 2x2 and a Control Block is 2x1. + @param index the touch index, which will stay constant for each finger as it is tracked @param x the X position of this touch on the device, in block units starting from 0 (left) @param y the Y position of this touch on the device, in block units starting from 0 (top) diff --git a/modules/juce_blocks_basics/littlefoot/LittleFoot Language README.txt b/modules/juce_blocks_basics/littlefoot/LittleFoot Language README.txt index 4bf55970e8..ebc7918e2a 100644 --- a/modules/juce_blocks_basics/littlefoot/LittleFoot Language README.txt +++ b/modules/juce_blocks_basics/littlefoot/LittleFoot Language README.txt @@ -46,10 +46,10 @@ The usual control-flow operators are provided, all with C++ style syntax: Arithmetic ops are the usual suspects, (with the standard operator precedence): +, -, *, /, % - ||, &&, |, &, |, ~ - ++, --, +=, -=, *=, /=, %=, ^=, |=, &=, ^= + ||, &&, |, &, ~, ^ + ++, --, +=, -=, *=, /=, %=, |=, &=, ^= ==, !=, <, >, <=, >=, ! - <<, >>, <<=, >>= + <<, >>, <<=, >>=, >>> Ternary operator (x ? y : z) Local variables are declared in C++-style syntax: