Skip to content
Palladio enables the execution of Esri CityEngine CGA rules inside of SideFX Houdini.
C++ CMake Python Groovy C
Branch: master
Clone or download
mistafunk Merge pull request #128 from Esri/issue125-houdini-packages
#125: switch to "packages" installation mode, avoid OS PATH modification
Latest commit 4be8c4e Aug 12, 2019

README.md

Palladio - CityEngine Plugin for Houdini

Binaries and examples are available at https://esri.github.io/palladio

Palladio is a plugin for SideFX Houdini. It provides operator nodes which enable the execution of Esri CityEngine ‘rules’ within Houdini networks. Therefore, a 3D environment artist does not have to leave their familiar Houdini toolset anymore to make use of CityEngine’s procedural modeling power. Complicated export-import pipelines are no longer needed, which also means that the procedural building models do not need to be “baked” anymore. The buildings stay procedural during the entire modeling workflow (optionally even at render time). Consequently, the 3D environment artist can change the height, style and appearance of buildings easily with a parametric interface at any point during production.

Palladio requires so-called rule packages (RPK) as input, which are authored in CityEngine. An RPK includes assets and a CGA rule file which encodes an architectural style. Comprehensive RPK examples are available below and can be used “out-of-the-box” in Palladio.

Palladio is well suited for managing the procedural generation of architectural 3D content in digital sets. However, Palladio is restricted to the procedural generation of single buildings / objects. Palladio does not include the city layouting and street network editing tools of CityEngine i.e. the rich CityEngine toolset to design a city from scratch (or based on geographic data) is still needed.

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

Documentation

Palladio Documentation

External documentation:

Tips and Tricks

How to export an Alembic from CityEngine as input to Palladio

This short CityEngine guide explains how to include the random seed and start rule assignments when exporting input geometry to Alembic.

  1. Run the following Python script on your scene objects to assign the random seed as object attributes:
    from scripting import *
    
    ce = CE()
    
    shapes = ce.getObjectsFrom(ce.scene(), ce.isShape)
    for s in shapes:
        seed = ce.getAttribute(s, "/ce/rule/randomSeed")
        ce.setAttribute(s, "seed", seed)
  2. Assign this CGA script to the desired shapes to report out seed and rule (the start rule):
    version "2019.0"
    
    attr seed = 0
    
    Lot --> R	
    LotInner --> R
    Street --> R
    Sidewalk --> R
    Crossing --> R
    OpenSpace --> R
    Joint --> R
    R -->
        report("seed", seed)
        report("rule", initialShape.startRule)
    
    The seed rule attribute should have been connected to the previously assigned seed object attribute.
  3. Export the shapes to Alembic, the two report values are now attached as user properties to the meshes.

Keep CityEngine Rule Packages in the Houdini Project

It can be useful to put RPKs into an rpk sub-directory of your current Houdini project. If you use $HIP to refer to the RPK in the pldAssign node, your Houdini project will stay relocatable.

Environment Variables

  • CITYENGINE_LOG_LEVEL: controls the global (minimal) log level for all assign and generate nodes. Valid values are "debug", "info", "warning", "error", "fatal"
  • HOUDINI_DSO_ERROR: useful to debug loading issues, see http://www.sidefx.com/docs/houdini/ref/env

Community

Palladio is maintained as an open-source project by Matthias Buehler (vrbn studios) and Simon Haegler (Esri R&D Zurich). Matthias is focusing on UX/UI topics and use-cases, while Simon is focusing on the implementation and procedural modelling technology.

Our goal is to bring as many Houdini and CityEngine users and developers on board as possible. Anyone is invited to submit issues and/or to fork and contribute to this project.

Join us on slack!

Our thanks also go to the fine folks at Esri R&D Zurich and vrbn studios which provided valuable comments and feedback.

History

Palladio has been invented by Matthias Buehler and Simon Haegler in early 2015. It started out as a research project at Esri R&D Zurich to get to a tighter integration of CityEngine and Houdini than just via file-based import/export of assets. Early results were promising, so we slowly cooked the project to v1.0 in our spare time. In December 2017, we decided to open-source Palladio with an Apache 2.0 license.

Licensing

Palladio is under the same license as the included CityEngine SDK.

An exception is the Palladio source code (without CityEngine SDK, binaries, or object code), which is licensed under the Apache License, Version 2.0 (the “License”); you may not use this work except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

The "Favela" example data is copyrighted by vrbn studios. Please contact vrbn_studios for commercial licensing options.

You can’t perform that action at this time.