Exports a scene into the Esri WebScene format.
@example:
# Settings class used to control parameters for exporting models to CityEngine Web Scene (WebGL)
exportSettings = CEWebSceneExportModelSettings()
exportSettings.setOutputPath(ce.toFSPath("/python/models/batchExportTests"))
exportSettings.setBaseName("3ws_batchexport")
exportSettings.setTerrainLayers(CEWebSceneExportModelSettings.TERRAIN_ALL)
ce.export(ce.selection()[0], exportSettings)
Methods defined here:
getBaseName
getBaseName(self):
Gets BaseName field. The WebScene name.
@return: Value of BaseName field. [str]getCompression
getCompression(self):
Gets Compression field. Compress exported files.
@return: Value of Compression field. [True/False]getExistingFiles
getExistingFiles(self):
Gets ExistingFiles field. Specifies how files should be written during the export run. The log file will be written anyways.
@return: Value of ExistingFiles field. ["OVERWRITE", "SKIP"] [str]getExportGeometry
getExportGeometry(self):
Gets ExportGeometry field. Choose what geometry is exported. 'Models with Shape Fallback' writes the Start Shape if the Model generation fails. 'Models' skips to the next export item if the Model generation fails. 'Shapes' always writes the Start Shape and disregards the Model generation.
@return: Value of ExportGeometry field. ["MODEL_GEOMETRY_FALLBACK", "MODEL_GEOMETRY", "SHAPE_GEOMETRY"] [str]getExportLog
getExportLog(self):
Returns a dictionary containing details of the export.
@return: A dictionary containing details about the finished export.getGeometryBase64
getGeometryBase64(self):
Gets GeometryBase64 field. Encode geometry data into Base64.
@return: Value of GeometryBase64 field. [True/False]getIncludeMaterials
getIncludeMaterials(self):
Gets IncludeMaterials field. Exports material definitions (e.g. color, textures, ...).
@return: Value of IncludeMaterials field. [True/False]getLayerTextureEncoding
getLayerTextureEncoding(self):
Gets LayerTextureEncoding field. Texture settings for whole scene.
@return: Value of LayerTextureEncoding field. ["ORIGINAL", "HIGH", "MEDIUM", "LOW", "HALFSIZE", "COMPACT", "NO_TEXTURES"] [str]getNormalPrecision
getNormalPrecision(self):
Gets NormalPrecision field. Specifies the minimal difference between normals.
@return: Value of NormalPrecision field. [float]getObjectInteraction
getObjectInteraction(self):
Gets ObjectInteraction field.
@return: Value of ObjectInteraction field. ["PICKABLE", "LOCKED"] [str]getObjectMetadata
getObjectMetadata(self):
Gets ObjectMetadata field.
@return: Value of ObjectMetadata field. ["NONE", "ATTRIBUTES", "REPORTS", "ALL"] [str]getOutputPath
getOutputPath(self):
Gets OutputPath field. Output directory for all exported files.
@return: Value of OutputPath field. [str]getScript
getScript(self):
Gets Script field. Python script to use for export callbacks.
@return: Value of Script field. [str]getShapeNameDelimiter
getShapeNameDelimiter(self):
Gets ShapeNameDelimiter field. Delimiting character for resolution of shape name clashes.
@return: Value of ShapeNameDelimiter field. [str]getSimplifyTerrainMeshes
getSimplifyTerrainMeshes(self):
Gets SimplifyTerrainMeshes field. Perform geometry simplification on terrains.
@return: Value of SimplifyTerrainMeshes field. [True/False]getTerrainLayers
getTerrainLayers(self):
Gets TerrainLayers field. Choose how terrain layers are exported.
@return: Value of TerrainLayers field. ["TERRAIN_ALL_VISIBLE", "TERRAIN_ALL_SELECTED", "TERRAIN_ALL", "TERRAIN_NONE"] [str]getTexcoordPrecision
getTexcoordPrecision(self):
Gets TexcoordPrecision field. Specifies the minimal distance between texels.
@return: Value of TexcoordPrecision field. [float]getVertexPrecision
getVertexPrecision(self):
Gets VertexPrecision field. Specifies the minimal distance between vertices.
@return: Value of VertexPrecision field. [float]getWKID
getWKID(self):
Gets WKID field. The WKID of the scene.
@return: Value of WKID field. [int]getWriteLog
getWriteLog(self):
Gets WriteLog field. Write log file with statistics about this export session.
@return: Value of WriteLog field. [True/False]load
load(self, name):
Load the named settings from the current scene file.
@param name: The name of the settings to load. [str]
@return: result. [CEWebSceneExportModelSettings]save
save(self, name):
Save the named settings to the current scene file.
@param name: The name of the settings to save. [str]setBaseName
setBaseName(self, stringValue):
Sets BaseName field. The WebScene name.
@param stringValue: the new value. [str]setCompression
setCompression(self, booleanValue):
Sets Compression field. Compress exported files.
@param booleanValue: the new value. [True/False]setExistingFiles
setExistingFiles(self, stringValue):
Sets ExistingFiles field. Specifies how files should be written during the export run. The log file will be written anyways.
@param stringValue: the new value ["OVERWRITE", "SKIP"]. [str]setExportGeometry
setExportGeometry(self, enumValue):
Sets ExportGeometry field. Choose what geometry is exported. 'Models with Shape Fallback' writes the Start Shape if the Model generation fails. 'Models' skips to the next export item if the Model generation fails. 'Shapes' always writes the Start Shape and disregards the Model generation.
@param enumValue: the new value ["MODEL_GEOMETRY_FALLBACK", "MODEL_GEOMETRY", "SHAPE_GEOMETRY"]. [str]setGeometryBase64
setGeometryBase64(self, booleanValue):
Sets GeometryBase64 field. Encode geometry data into Base64.
@param booleanValue: the new value. [True/False]setIncludeMaterials
setIncludeMaterials(self, booleanValue):
Sets IncludeMaterials field. Exports material definitions (e.g. color, textures, ...).
@param booleanValue: the new value. [True/False]setLayerTextureEncoding
setLayerTextureEncoding(self, enumValue):
Sets LayerTextureEncoding field. Texture settings for whole scene.
@param enumValue: the new value ["ORIGINAL", "HIGH", "MEDIUM", "LOW", "HALFSIZE", "COMPACT", "NO_TEXTURES"]. [str]setNormalPrecision
setNormalPrecision(self, floatValue):
Sets NormalPrecision field. Specifies the minimal difference between normals.
@param floatValue: the new value. [float]setObjectInteraction
setObjectInteraction(self, enumValue):
Sets ObjectInteraction field.
@param enumValue: the new value ["PICKABLE", "LOCKED"]. [str]setObjectMetadata
setObjectMetadata(self, enumValue):
Sets ObjectMetadata field.
@param enumValue: the new value ["NONE", "ATTRIBUTES", "REPORTS", "ALL"]. [str]setOutputPath
setOutputPath(self, stringValue):
Sets OutputPath field. Output directory for all exported files.
@param stringValue: the new value. [str]setScript
setScript(self, stringValue):
Sets Script field. Python script to use for export callbacks.
@param stringValue: the new value. [str]setShapeNameDelimiter
setShapeNameDelimiter(self, stringValue):
Sets ShapeNameDelimiter field. Delimiting character for resolution of shape name clashes.
@param stringValue: the new value. [str]setSimplifyTerrainMeshes
setSimplifyTerrainMeshes(self, booleanValue):
Sets SimplifyTerrainMeshes field. Perform geometry simplification on terrains.
@param booleanValue: the new value. [True/False]setTerrainLayers
setTerrainLayers(self, enumValue):
Sets TerrainLayers field. Choose how terrain layers are exported.
@param enumValue: the new value ["TERRAIN_ALL_VISIBLE", "TERRAIN_ALL_SELECTED", "TERRAIN_ALL", "TERRAIN_NONE"]. [str]setTexcoordPrecision
setTexcoordPrecision(self, floatValue):
Sets TexcoordPrecision field. Specifies the minimal distance between texels.
@param floatValue: the new value. [float]setVertexPrecision
setVertexPrecision(self, floatValue):
Sets VertexPrecision field. Specifies the minimal distance between vertices.
@param floatValue: the new value. [float]setWriteLog
setWriteLog(self, booleanValue):
Sets WriteLog field. Write log file with statistics about this export session.
@param booleanValue: the new value. [True/False]Constants
This class defines the following constants:
ALL = 'ALL'
ATTRIBUTES = 'ATTRIBUTES'
COMPACT = 'COMPACT'
HALFSIZE = 'HALFSIZE'
HIGH = 'HIGH'
LOCKED = 'LOCKED'
LOW = 'LOW'
MEDIUM = 'MEDIUM'
MODEL_GEOMETRY = 'MODEL_GEOMETRY'
MODEL_GEOMETRY_FALLBACK = 'MODEL_GEOMETRY_FALLBACK'
NONE = 'NONE'
NO_TEXTURES = 'NO_TEXTURES'
ORIGINAL = 'ORIGINAL'
OVERWRITE = 'OVERWRITE'
PICKABLE = 'PICKABLE'
REPORTS = 'REPORTS'
SHAPE_GEOMETRY = 'SHAPE_GEOMETRY'
SKIP = 'SKIP'
TERRAIN_ALL = 'TERRAIN_ALL'
TERRAIN_ALL_SELECTED = 'TERRAIN_ALL_SELECTED'
TERRAIN_ALL_VISIBLE = 'TERRAIN_ALL_VISIBLE'
TERRAIN_NONE = 'TERRAIN_NONE'