|
|
| Line 5: |
Line 5: |
| Use of this API is limited to simulation only - when downloaded to the chip these calls will be omitted, so if need be they can be interleaved in downloadable code. | | Use of this API is limited to simulation only - when downloaded to the chip these calls will be omitted, so if need be they can be interleaved in downloadable code. |
|
| |
|
| Below is a reference to the classes available.
| | A reference to the classes and macros available can be found [[Simulation Functionality|here]]. |
| A complete list of [[Simulation Functionality|classes and macros]] is also available.
| |
| {| class="wikitable" width="85%"
| |
| |-
| |
| ! width="45%" | Class path
| |
| ! width="55%" | Description
| |
| |-
| |
| | [[API Component|Component]]
| |
| | Component traversal functions
| |
| |-
| |
| | [[API Component.Property|Component.Property]]
| |
| | Property manipulation functions
| |
| |-
| |
| | [[API Panel|Panel]]
| |
| | Panel object manipulations
| |
| |-
| |
| | [[API Panel.Position|Panel.Position]]
| |
| | Coordinate manipulation functions
| |
| |-
| |
| | [[API Panel.Position.Math|Panel.Position.Math]]
| |
| | Coordinate maths functions
| |
| |-
| |
| | [[API Panel.Position.Camera|Panel.Position.Camera]]
| |
| | Camera positioning
| |
| |-
| |
| | [[API Panel.PCloud|Panel.PCloud]]
| |
| | Point cloud manipulation
| |
| |-
| |
| | [[API Panel.LinkBar|Panel.LinkBar]]
| |
| | Position linkage management
| |
| |-
| |
| | [[API Panel.Collision|Panel.Collision]]
| |
| | Collision detection functions
| |
| |-
| |
| | [[API Panel.Graphics|Panel.Graphics]]
| |
| | Direct drawing routines for a single frame
| |
| |-
| |
| | [[API Panel.Graphics.Shape|Panel.Graphics.Shape]]
| |
| | Routines to change the last drawn shape
| |
| |-
| |
| | [[API Mouse|Mouse]]
| |
| | Mouse reading interface
| |
| |-
| |
| | [[API Keyboard|Keyboard]]
| |
| | Keyboard reading interface
| |
| |-
| |
| | [[API FCD|FCD]]
| |
| | Flowcode Chip Definition reading routines
| |
| |-
| |
| | [[API Sound|Sound]]
| |
| | Audio streaming interface
| |
| |-
| |
| | [[API Scope|DataRecorder]]
| |
| | Data scope additions
| |
| |-
| |
| | [[API Calculations|Calculations]]
| |
| | Miscellaneous calculations
| |
| |-
| |
| | [[API Console|Console]]
| |
| | Text console additions
| |
| |-
| |
| | [[API Connection|Connection]]
| |
| | Analog and digital connections
| |
| |-
| |
| | [[API Expand|Expand]]
| |
| | Various variable and code expansion routines
| |
| |-
| |
| | [[API Tree|Tree]]
| |
| | Data-tree traversal type routines
| |
| |-
| |
| | [[API File|File]]
| |
| | File reading and writing operations
| |
| |-
| |
| | [[API File.Buffer|File.Buffer]]
| |
| | Reads writes and monitors circular buffers
| |
| |-
| |
| | [[API File.NVM|File.NVM]]
| |
| | Reads from a file as though a block of NVM
| |
| |-
| |
| | [[API UI|UI]]
| |
| | Display message boxes and alerts
| |
| |-
| |
| | [[API Time|Time]]
| |
| | Helps read and manage clock counters
| |
| |-
| |
| | [[API System|System]]
| |
| | General system operations
| |
| |-
| |
| | [[API Debug|Debug]]
| |
| | Debug and diagnostic
| |
| |}
| |
Flowcode provides an application programming interface to help writing simulation and PC-side programs.
This API is a list of macros built in to Flowcode with each group, or class, of macros dealing with a specific area of the system.
Use of this API is limited to simulation only - when downloaded to the chip these calls will be omitted, so if need be they can be interleaved in downloadable code.
A reference to the classes and macros available can be found here.