Clone or download
Latest commit bc3a16b May 11, 2018

README.md

Esri CityEngine SDK Examples

Esri CityEngine is based on Esri Procedural Runtime, which is the underlying engine that supports two geoprocessing tools in ArcGIS and drives procedural symbology in ArcGIS Pro. The CityEngine SDK enables you as a 3rd party developer to extend CityEngine with additional import and export formats. Moreover, you can integrate the procedural runtime in your own client applications taking full advantage of the procedural core without running CityEngine or ArcGIS.

Preamble

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

  • This git repository with the example sources.
  • An archive with the SDK binaries and documentation (whitepaper and API reference).
  • 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/...
    license/...
    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.
  • prt4maya: wraps the SDK into a plugin for Autodesk Maya
  • 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.

General Software Requirements

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

All Platforms

  • To load custom encoders built with this SDK in CityEngine, CityEngine 2017.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
  • CMake 3.3.0 or later (http://www.cmake.org)

Windows

  • Windows 7, 8.1 or 10 (64bit)
  • Recommended C++ Compilers for client code (e.g. prt4cmd example): MSVC 14.11 C++ Compiler Toolset (Visual Studio 2017) or later
  • To compile SDK extensions (e.g. the stlenc example or a custom encoder) it is required to use this exact compiler:
    • Microsoft MSVC 14.11 C++ Compiler Toolset with cl.exe version 19.11, included in Visual Studio 2015 Update 3
    • Required flags: /bigobj /GR /EHsc /MD

macOS

  • Recommended build environment for client code (e.g. the prt4cmd example):
    • macOS Sierra (10.12) or later
    • Apple Clang 8.1 or later
  • To compile SDK extensions (e.g. the stlenc example or a custom encoder) it is required to use this exact compiler:
    • macOS Sierra (10.12)
    • Apple Clang 8.1 included in XCode 8.3
    • Required flags: -std=c++14 -stdlib=libc++ -fvisibility=hidden -fvisibility-inlines-hidden -Wl,--exclude-libs,ALL

Linux

  • RedHat Enterprise Linux 7.x or compatible (64bit only)
  • Recommended C++ Compilers for client code (e.g. the prt4cmd example):
    • GCC 6.3 or later
  • To compile SDK extensions (e.g. the stlenc example or a custom encoder) it is required to use this exact compiler:
    • RedHat Enterprise Linux 7.x or compatible
    • GCC 6.3.1 included in RedHat Enterprise Linux DevToolSet 6.1
    • Required flags: -std=c++14 -march=nocona -fvisibility=hidden -fvisibility-inlines-hidden -Wl,--exclude-libs,ALL

Further Resources

Issues

Find a bug or 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) 2018 Esri

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

  1. All content of all directories except "examples" is licensed under the CityEngine EULA, see license/EULA.pdf.
  2. 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. A copy of the license is also available in the repository at license/APACHE-LICENSE-2.0.txt.
  3. The example data is licensed by the "ESRI Attribution and Licensing Agreement".