API Reference

This package provides a viewer for COMPAS.

Viewer

The Viewer class is the main entry of COMPAS Viewer`. It organizes the scene and create the GUI application.

viewer

• compas_viewer.viewer

Scene and Objects

Classes for all scene objects.

Scene and Objects

• compas_viewer.scene

Controller and Actions

The Controller class is the main entry of all the key and mouse events. Actions are functions that are called when a certain event happens, such as mouse and keyboard click.

Controller and Actions

• compas_viewer.controller
• compas_viewer.actions

Components and Configurations

Components and the corresponding configurations of them.

Components and Configurations

• compas_viewer.components
• compas_viewer.configurations

Layout and UI

The layout and UI of the viewer.

Layout and UI

• compas_viewer.layout

Utilities

Useful functions and other helper classes.

Utilities

• compas_viewer.utilities