API Overview

From Flowcode Help
Jump to navigationJump to search

<sidebar>API Contents</sidebar> 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.

Below is a reference to the classes available. A complete list of classes and macros is also available.

Class path Description
Component Component traversal functions
Component.Property Property manipulation functions
Panel Panel object manipulations
Panel.Position Coordinate manipulation functions
Panel.Position.Math Coordinate maths functions
Panel.Position.Camera Camera positioning
Panel.PCloud Point cloud manipulation
Panel.LinkBar Position linkage management
Panel.Collision Collision detection functions
Panel.Graphics Direct drawing routines for a single frame
Panel.Graphics.Shape Routines to change the last drawn shape
Mouse Mouse reading interface
FCD Flowcode Chip Definition reading routines
Sound Audio streaming interface
Scope Data scope additions
Console Text console additions
Connection Analog and digital connections
Expand Various variable and code expansion routines
Tree Data-tree traversal type routines
File File reading and writing operations
File.Buffer Reads writes and monitors circular buffers
File.NVM Reads from a file as though a block of NVM
Time Helps read and manage clock counters
Language Foreign language support
System General system operations
Debug Debug and diangostic