Skip to content
This is the official site for the SDK of Esri CityEngine, a 3D city modeling software for urban design, visual effects, and VR/AR production.
Groovy
Branch: master
Clone or download

README.md

Esri CityEngine SDK

This is the official site for the SDK of Esri CityEngine, a 3D city modeling software for urban design, visual effects, and VR/AR production.

The CityEngine SDK can be used for the development of:

  1. Custom importers and exporters for CityEngine.

    This means the SDK enables you to develop CityEngine plugins to read or write additional 3D and image formats or your own proprietary 3D data format. A simple use case example is 3D printing where the STL geometry format is often needed. STL support is not provided out-of-the-box in CityEngine, but you can develop your own STL exporter as described below.

  2. 3D apps which need a procedural geometry engine.

    The core of CityEngine is its unique geometry generation engine, called Procedural Runtime (PRT). PRT takes as input an initial geometry and then applies a given rule package (= CGA rules authored in CityEngine) to generate more detailed 3D geometry as output. For example, PRT can generate - based on given rules - a 3D model of a building out of a parcel polygon. With the SDK you can integrate PRT in your own 3D applications taking full advantage of the procedural geometry generation without running CityEngine. An interesting use case example is Palladio, a plugin for SideFX’s Houdini software. Palladio includes PRT and therefore extends Houdini with the procedural geometry engine of CityEngine. Another use case example could be a specific cultural heritage 3D application which automatically generates detailed 3D models of temples based on input attributes.

The CityEngine SDK is free for non-commercial use. Commercial use requires at least one commercial license of the latest CityEngine version installed in the organization. Please refer to the licensing section below for more detailed licensing information.

Preamble

This document explains how to install the CityEngine SDK and how to work with the source-code examples contained in this repository. The CityEngine SDK is packaged into three parts:

  • This git repository with the example sources.
  • An archive per platform with the SDK binaries and documentation (whitepaper and API reference). The archives are attached to the repo release tags, see links below.
  • An archive with example data (e.g. rule packages and initial shapes).

The archives are available for download at the corresponding github release page. See installation instructions below for details.

CityEngine SDK Releases

Installation Instructions

  1. Clone or download this repository
  2. Download the SDK binary archive from the release page
  3. Download the SDK example data archive from the release page
  4. Unzip the archives into the cloned repository into a "prt" and "data" directory.

The final directory layout should look like this:

/esri-cityengine-sdk/
    examples/...
    data/...
    prt/
        bin/...
        cmake/...
        doc/...
        include/...
        lib/...

Examples

This repository contains a number of source code examples. Each example contains a README with detailed instructions how to build and use it.

A quick overview:

  • prt4cmd: a simple command line utility to apply rule packages onto initial shapes and generate models.
  • stlenc: demonstrates how to write a custom encoder, in this case for the STL geometry format.
  • stldec: demonstrates how to write a custom decoder for the STL geometry format.

Related external Apps and Examples:

  • Palladio: CityEngine plugin for SideFX Houdini
  • Serlio: CityEngine plugin for Autodesk Maya

General Software Requirements

Please note that the individual example READMEs may include further requirements.

All Platforms

  • To load custom encoders built with the latest SDK, CityEngine 2019.0 is required. For older versions of CityEngine an older version of the SDK might have to be used, see list above.
  • License for matching CityEngine, e.g. to author Rule Packages.
  • CMake 3.13 or later (http://www.cmake.org)

Windows

  • Windows 7, 8.1 or 10 (64bit)
  • Required C++ compiler: Visual Studio 2017 with Toolset MSVC 14.11 or later
  • Required flags for extension libraries release mode: /bigobj /GR /EHsc /MD (use /MDd to debug)

macOS

  • macOS Sierra (10.12) or later
  • Required C++ compiler: Apple Clang 8.1 or later (i.e. XCode 8.3 or later)
  • Required flags for extension libraries: -std=c++14 -stdlib=libc++ -fvisibility=hidden -fvisibility-inlines-hidden -Wl,--exclude-libs,ALL

Linux

  • RedHat Enterprise Linux 7.x or compatible
  • Required C++ compiler: GCC 6.3 or later (RedHat Enterprise Linux DevToolSet 6.1)
  • Required flags for extension libraries: -std=c++14 -D_GLIBCXX_USE_CXX11_ABI=0 -march=nocona -fvisibility=hidden -fvisibility-inlines-hidden -Wl,--exclude-libs,ALL

Further Resources

Issues

Did you find a bug or do you want to request a new feature? Please let us know by submitting an issue.

Contributing

Anyone and everyone is welcome to contribute and to extend and improve the examples by sending us pull requests.

Licensing

Copyright (c) 2019 Esri

You may not use the content of this repository except in compliance with the following Licenses:

  1. All content in the "examples" directory tree is licensed under the APACHE 2.0 license. You may obtain a copy of this license at http://www.apache.org/licenses/LICENSE-2.0.
  2. All other content is licensed under the Esri Terms of Use (also see Product-Specific Terms of Use).
You can’t perform that action at this time.