Design API Overview

Creating Trusses

Projects are the top-level containers for layouts and trusses, which means you need to create a project before you can start creating layouts or trusses.

Once you create a project there are three ways to start designing trusses:

• Layout

  • Define a 3D layout (roof and/or floor) and place trusses within the layout

  • Tutorials

    • "Create layout" tutorial

  • Samples

    • LayoutConsoleApp (.NET)

    • create-gable-roof (Node.js)

    • create-cross-gable-roof (Node.js)

  • Reference

    • Layouts

• Single component insertion

  • Generate a truss based its 2D profile (for pitched chord roof trusses) or its features (for parallel chord trusses)

  • Tutorials

    • Getting Started with .NET

    • Getting Started with REST

  • Samples

    • create-profile-trusses (Node.js)

  • Reference

    • POST /projects/{guid}/createProfileTruss

• File upload

  • Accepts common truss industry files

  • Reference

    • POST /proejcts/{guid}/uploadFiles

Analyzing Trusses

Once you've created a truss using one of the methods above, you're ready to analyze it. There are two options when analyzing trusses:

• Analyze

  • This will analyze the truss without making any modifications to the truss. This will not succeed on a newly created truss from layout or single component insertion, since plates are not added during creation of the truss. You will need to Upgrade and Analyze the truss in order to add plates.

  • Reference

    • POST /trusses/{guid}/analyze

• Upgrade and Analyze

  • This will analyze the truss and make changes to the lumber material and plates in order to get the truss to pass.

  • Reference

    • POST /trusses/{guid}/upgradeAndAnalyze

If successful, these routes will return an AnalysisSet which contains information about the analysis of the truss.