Python 脚本注释和更改日志

CityEngine 脚本界面

CityEngine 脚本界面基于 Jython（Python 的 Java 实现方式）。 当前版本为 2.7.0。

CityEngine 带有专门的 Jython 模块脚本，其中包含特定于 CityEngine 的命令（请参阅类列表）

Jython 支持标准 Python 库的几乎所有模块。 另外，Jython 可以包括任意 Java 类以扩展其功能。 有关详细信息，请查看 Jython 网站。

2023.1 更改日志

状态	命令
新建	新增了 CE.get/setTerrainWireframe 来控制地形上的线框渲染。
新建	在 GrowStreetSettings 中新增了 get/setStreetWidthSettingsBlockSubdivision 以控制块中的动态形状创建。
已更改	RPKExportSettings 经过调整，可以通过处理 CGA 文件的方式处理 VCGA 文件。

2023.0 更改日志

状态	命令
新建	已添加 CE.invertSegment。
新建	已添加 ImageExportTerrainSettings.get/setResolution。
新建	向以下导出模型设置添加了 get/setTerrainMeshResolution： ABCExportModelSettings DAEExportModelSettings DWGExportModelSettings FBXExportModelSettings FGDBExportModelSettings GLTFExportModelSettings IFCExportModelSettings KMLExportModelSettings OBJExportModelSettings USDExportModelSettings VOBExportModelSettings
已移除	从 CE 中移除了选项 get/setTerrainTessellationResolution。
已移除	CEWebSceneExportModelSettings，以反映 CityEngine Webscene Exporter 的移除。

2022.1 更改日志

状态	命令
新建	USDExportModelSettings：添加了 get/setMeshMerging

2022.0 更改日志

状态	命令
新建	添加了 VRExportSettings 以导出 3VR 包。
新建	添加了 CE.get/CE.setTerrainApplyAlignment、CE.get/CE.setTerrainSamplingMethod 和 CE.get/CE.setTerrainTessellationResolution
新建	UnrealExportModelSettings：添加了 get/setTwinmotionCompatible 和 get/setUseUnrealBaseMaterials

2021.1 更改日志

状态	命令
新建	添加了 IFCExportModelSettings 和 IFCImportSettings 以导出和导入 BuildingSMART IFC 文件。
新建	添加了 CGAMATExportModelSettings 以将材料导出为 CityEngine 材料格式。
新建	USDExportModelSettings：添加了 get/setTriangulateMeshes。
新建	AlignTerrainSettings：添加了 get/setBorderEasing、get/setBorderGradient、get/setBorderRange 和 get/setSmoothBorders。
新增和已弃用	AlignTerrainSettings 和 ResetTerrainSettings：添加了 get/setTerrainLayer 并弃用了 get/setTerrain。
新增和已弃用	AlignGraphSettings、AlignShapesSettings 和 AlignStaticModelSettings：添加了 get/setHeightmapLayer 并弃用了 get/setHeightmap。
新增和已弃用	GrowStreetsSettings：添加了 get/setEnvironmentSettingsHeightmapLayer 和 get/setEnvironmentSettingsObstaclemapLayer 并弃用了 get/setEnvironmentSettingsHeightmap 和 get/setEnvironmentSettingsObstaclemap。

2021.0 更改日志

状态	命令
新建	添加了 DWGImportSettings 和 DWGExportModelSettings，用于导入和导出 Autodesk DWG 文件。
新建	添加了 GenericPRTImportSettings，以通过自定义 PRT 解码器导入文件。
新建	已添加函数 CE.isSynchronized 和 CE.unsynchronize，以便与 ArcGIS 门户上的要素服务搭配使用。
新建	USDExportModelSettings 获得了两个新函数 get/setFileType，用以获取/设置 USD 文件格式（.usdc 或 .usdz）。
新建	CleanupShapesSettings 类获得了两个新函数 get/setSplitSelfintersectingPolygons，用于控制是否应该分割自相交面。
新建	RenderSettings 类获得了两个新函数 get/setTerrainMasking，用于控制渲染重叠地形的方式。
已更改	函数 "makeDefaultObject"、"makeScenarioObject" 和 "removeFromScenario" 已被重命名为 CE.makeLayerDefaultObject、CE.makeLayerScenarioObject 和 CE.removeLayerFromScenario，以反映方案系统的变化。
已移除	已移除 RIBExportModelSettings，以反映 Renderman RIB 导出器的移除。

2020.1 更改日志

状态	命令
新建	添加了 USDImportSettings 以导入通用场景描述文件。
新建	添加了方法 CE.publishPortalItem 和已连接设置 PortalPublishSettings，以便在门户上发布已上传的项目。
新建	RPKExportSettings.get/setCompatibility 控件与 ArcGIS Pro 的兼容性。
新建	引入了方法 UnrealExportModelSettings.get/setExportLod、get/setLODAttribute 和 get/setLODOrder，以控制已创作细节层次的创建。
已更改	已在 FBXExportModelSettings 上将 PASS 添加为 get/setFacesWithHoles 的值，以保留 FBX 文件上的孔洞。
已更改	已将 ComputeEdgeAttributesSettings 上的方法 get/setCommaSeparatedListOfStreetClasses 和 get/setStreetClassAttribute 重命名为 get/setCommaSeparatedListOfStreetCategories 和 get/setStreetCategoryAttribute。

2020.0 更改日志

状态	命令
新建	添加了 MSPKExportSettings 以导出移动场景包。
新建	添加了 USDExportModelSettings 以导出通用场景描述文件。
已更改	引入了方法 UnrealExportModelSettings.get/setUseTextureAtlas 以控制纹理地图集的创建，并与单个纹理文件进行对比。
已更改	为了保持一致性，已将方法 ImageExportTerrainSettings.setFilename 由 setFileName 进行了重命名。
已更改	为了保持一致性，已将方法 TPKExportSettings.get/setOutputPath 由 get/setPath 进行了重命名。

2019.1 更改日志

状态	命令
已更改	已将数组的 getAttribute 返回类型由字典更改为列表。
新建	可以通过已弃用函数 CE.getAttributeArrayAsDict 获得返回字典的数组的 getAttribute 旧行为。
新建	SPKMeshExportModelSettings 可通过选项 get/setFileSize 来影响文件大小。 或者，熟悉 i3s 规范的用户可以使用 get/setMaxDepth 直接设置最大树深。
已移除	从上面的大小函数开始，已从 SPKMeshExportModelSettings 中移除了选项 get/setLayerTextureEncoding。

2019.0 更改日志

状态	命令
新建	可以使用 ce.importFile 中的 GLTFImportSettings 导入 glTF 模型，并可使用 ce.export 中的 GLTFExportModelSettings 导出 glTF 模型。
新建	可以使用带有 ce.get/setLighting 的 LightSettings、带有 ce.get/setPanorama 的 PanoramaSettings 和带有 view3d.get/setRenderSettings 的 RenderSettings 来控制场景渲染。
新建	可以使用 ce.computeEdgeAttributes 来计算形状的边属性，并使用 ComputeEdgeAttributesSettings 来控制这些属性。
新建	可以使用 ce.get/ce.setElevationOffset 来控制图层的高程偏移。
新建	可以使用 ce.get/ce.setTerrainMinHeight 和 ce.get/ce.setTerrainMaxHeight 来控制地形高程限制。
新建	可以使用 ce.subtractShapes 对形状相互进行布尔差运算。
新建	现在可以使用以下函数来控制方案： CE.getScenarioColor CE.addScenario CE.getScenarioIds CE.getScenarioName CE.getScenarios CE.getSceneScenario CE.getViewportScenario CE.isDefaultObject CE.isDefaultObjectsVisible CE.makeDefaultObject CE.makeScenarioObject CE.removeFromScenario CE.removeScenario CE.setScenarioColor CE.setScenarioId CE.setScenarioName CE.setScenarioOrder CE.setSceneScenario CE.setViewportScenario CE.withScenario
新建	TPKExportSettings 现在具有 get/setVerticalOffset 函数。
新建	UnrealExportModelSettings 现在具有 get/setMetadata 函数。
新建	RPKExportSettings 具有新函数 get/setIncludeSourceFiles 和 getAddFilesAutomatically。
已更改	RPKExportSettings 函数 addFilesAutomatically 已重命名为 setAddFilesAutomatically，而且该函数带有一个允许停用自动文件添加功能的可选参数。
已更改	方法 CE.get3DViews 仅会返回视窗。
已更改	CE.isInspector 和 CE.isViewport 方法已被弃用，原因是 CE.get3DViews 仅会返回视窗。
已移除	函数 get/setWriteDDSTextures 已从 SPKMeshExportModelSettings 中移除。