Getting Started with FormIt

Table of Contents

• Getting Started
  • Download
    • Supported Platforms
  • Building Applications
    • Include FormIt
    • Link with FormIt
  • API Overview
  • Sample Code

Getting Started

Download

The FormIt Core C++ API can be obtained from the FormIt git repository.

Path to the FormIt Core public headers:

    <FORMIT_PATH>/formItCore/Public/

See the FormIt README for build instructions.

After building FormIt Windows ("Pyramid"), the FormIt Core library files will be found here:

    <FORMIT_PATH>/formItDesktopQt/<arch>/formItCore/[Debug|Release]/FormItCore.lib

    <FORMIT_PATH>/formItDesktopQt/<arch>/[Debug|Release]/FormItCore.dll

Supported Platforms

Platform	Architecture	Build	FormItCore Library
Windows	32bit and 64bit	Release and Debug	Shared (.lib/.dll)

FormIt is also compiled to JavaScript for Web.

Building Applications

Include FormIt

Add the FormIt include directory to the include search path of the application build settings:

    <FORMIT_PATH>/formItCore/Public/

Link with FormIt

Add the appropriate platform-dependent SDK lib directory to the library search path of the application linker settings:

    <FORMIT_PATH>/formItDesktopQt/<arch>/formItCore/[Debug|Release]/FormItCore.lib

    <FORMIT_PATH>/formItDesktopQt/<arch>/[Debug|Release]/FormItCore.dll

and specify the appropriate platform-dependent input library file 'FormItCore.<libext>' for linking.

API Overview

The main header file is FormItCoreAPI.h. The FormIt Core API is grouped by functionality into nested namespaces.

See the FormIt API File List, FormIt Core API Reference List, and the FormIt Namespace Reference.

Sample Code

To demonstrate FormIt API usage, sample code is available in the Sample Code page.

To generate a build project for each sample:

cd <FORMIT_PATH>/Build/Tools/Doxygen/config/FORMIT_API/samples
python3 Generate_Project.py    # [-h,--help] to display options