Encodes geometry into the alembic format.
@example:
# Settings class used to control parameters for exporting models to ALEMBIC
exportSettings = ABCExportModelSettings()
exportSettings.setFilename(ce.toFSPath("/python/models/batchExportTests/") + "/abc_batchexport.abc")
exportSettings.setTerrainLayers(exportSettings.TERRAIN_NONE)
exportSettings.setTriangulateMeshes(True)
ce.export(ce.selection()[0], exportSettings)
Methods defined here:
getAtlasAddWrapBorder
getAtlasAddWrapBorder(self):
Gets AtlasAddWrapBorder field. Add a border of clamped pixels to protect against wrap mode bleeding.
@return: Value of AtlasAddWrapBorder field. [True/False]getCellSize
getCellSize(self):
Gets CellSize field. Cell size (meters) of top level grid of shapes (0 = single cell).
@return: Value of CellSize field. [int]getCreateTextureAtlases
getCreateTextureAtlases(self):
Gets CreateTextureAtlases field. Creates texture atlases which combine a set of textures into one, thus reducing the number of textures and materials. All textures except COLORMAPs are removed.
@return: Value of CreateTextureAtlases 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.getFacesWithHoles
getFacesWithHoles(self):
Gets FacesWithHoles field. Specifies how faces with holes should be handled during the export.
@return: Value of FacesWithHoles field. ["TRIANGULATE_FACES_WITH_HOLES", "DISCARD_HOLES", "CONVERT_HOLES_TO_FACES"] [str]getFilename
getFilename(self):
Gets Filename field. Alembic file name to export to.
@return: Value of Filename field. [str]getGlobalOffset
getGlobalOffset(self):
Gets GlobalOffset field. Global (= for all shapes/models) offset for exported geometry.
@return: Value of GlobalOffset field. [sequence of float]getLocalOffset
getLocalOffset(self):
Gets LocalOffset field. Local (= per shape or model) offset for exported geometry.
@return: Value of LocalOffset field. ["NONE", "MODEL_CENTROID", "MODEL_CENTROID_BOTTOM", "SHAPE_CENTROID", "SHAPE_CENTROID_BOTTOM"] [str]getMaxAtlasDim
getMaxAtlasDim(self):
Gets MaxAtlasDim field. Specifies the maximal dimension of the texture atlases in power-of-2 pixels, e.g. 11 gives a 2048x2048 Atlas.
@return: Value of MaxAtlasDim field. [int]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]getTerrainMeshResolution
getTerrainMeshResolution(self):
Gets TerrainMeshResolution field. Resolution of the generated terrain mesh. In the Python API this is an integer list [x-Resolution, y-Resolution]. A Python integer value of -1 will be replaced with the highest resolution of the selected terrains but limited at 1024.
@return: Value of TerrainMeshResolution field. [sequence of int]getTriangulateMeshes
getTriangulateMeshes(self):
Gets TriangulateMeshes field. Triangulate resulting meshes.
@return: Value of TriangulateMeshes field. [True/False]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. [ABCExportModelSettings]save
save(self, name):
Save the named settings to the current scene file.
@param name: The name of the settings to save. [str]setAtlasAddWrapBorder
setAtlasAddWrapBorder(self, booleanValue):
Sets AtlasAddWrapBorder field. Add a border of clamped pixels to protect against wrap mode bleeding.
@param booleanValue: the new value. [True/False]setCellSize
setCellSize(self, intValue):
Sets CellSize field. Cell size (meters) of top level grid of shapes (0 = single cell).
@param intValue: the new value. [int]setCreateTextureAtlases
setCreateTextureAtlases(self, booleanValue):
Sets CreateTextureAtlases field. Creates texture atlases which combine a set of textures into one, thus reducing the number of textures and materials. All textures except COLORMAPs are removed.
@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]setFacesWithHoles
setFacesWithHoles(self, stringValue):
Sets FacesWithHoles field. Specifies how faces with holes should be handled during the export.
@param stringValue: the new value ["TRIANGULATE_FACES_WITH_HOLES", "DISCARD_HOLES", "CONVERT_HOLES_TO_FACES"]. [str]setFilename
setFilename(self, stringValue):
Sets Filename field. Alembic file name to export to.
@param stringValue: the new value. [str]setGlobalOffset
setGlobalOffset(self, floatArrayValue):
Sets GlobalOffset field. Global (= for all shapes/models) offset for exported geometry.
@param floatArrayValue: the new value. [sequence of float]setLocalOffset
setLocalOffset(self, stringValue):
Sets LocalOffset field. Local (= per shape or model) offset for exported geometry.
@param stringValue: the new value ["NONE", "MODEL_CENTROID", "MODEL_CENTROID_BOTTOM", "SHAPE_CENTROID", "SHAPE_CENTROID_BOTTOM"]. [str]setMaxAtlasDim
setMaxAtlasDim(self, intValue):
Sets MaxAtlasDim field. Specifies the maximal dimension of the texture atlases in power-of-2 pixels, e.g. 11 gives a 2048x2048 Atlas.
@param intValue: the new value. [int]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]setTerrainMeshResolution
setTerrainMeshResolution(self, intArrayValue):
Sets TerrainMeshResolution field. Resolution of the generated terrain mesh. In the Python API this is an integer list [x-Resolution, y-Resolution]. A Python integer value of -1 will be replaced with the highest resolution of the selected terrains but limited at 1024.
@param intArrayValue: the new value. [sequence of int]setTriangulateMeshes
setTriangulateMeshes(self, booleanValue):
Sets TriangulateMeshes field. Triangulate resulting meshes.
@param booleanValue: the new value. [True/False]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:
CONVERT_HOLES_TO_FACES = 'CONVERT_HOLES_TO_FACES'
DISCARD_HOLES = 'DISCARD_HOLES'
MODEL_CENTROID = 'MODEL_CENTROID'
MODEL_CENTROID_BOTTOM = 'MODEL_CENTROID_BOTTOM'
MODEL_GEOMETRY = 'MODEL_GEOMETRY'
MODEL_GEOMETRY_FALLBACK = 'MODEL_GEOMETRY_FALLBACK'
NONE = 'NONE'
OVERWRITE = 'OVERWRITE'
SHAPE_CENTROID = 'SHAPE_CENTROID'
SHAPE_CENTROID_BOTTOM = 'SHAPE_CENTROID_BOTTOM'
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'
TRIANGULATE_FACES_WITH_HOLES = 'TRIANGULATE_FACES_WITH_HOLES'