Substance 3D Painter Python API 0.3.5 Documentation

Home

Writing plugins

• substance_painter_plugins module
• Examples of plugins

substance_painter package

• application module
• async_utils module
• baking module
• colormanagement module
• display module
• event module
• exception module
• export module
• js module
• layerstack module
• logging module
• project module
• properties module
• resource module
• source module
• textureset module
• ui module

Index

Module Index

• substance_painter.textureset

  * Update enumeration substance_painter.textureset.ChannelType to expose OpenPBR channel names by default and keep legacy/Adobe Standard Material channel names as aliases for backward compatibility.

• substance_painter.layerstack

  * Add substance_painter.layerstack.GeometryMaskMeshParams and substance_painter.layerstack.GeometryMaskUVTilesParams containing a list of Meshes/UVTiles and a boolean that explicitly controls if the list is included or excluded from the geometry mask.

• Add substance_painter.layerstack.LayerNode.get_geometry_mask() and substance_painter.layerstack.LayerNode.set_geometry_mask() to query and edit geometry mask settings through a unified and generic API for Meshes and UVTiles.
• Function substance_painter.layerstack.LayerNode.set_geometry_mask_type() is now deprecated, use substance_painter.layerstack.LayerNode.set_geometry_mask() instead.
• Function substance_painter.layerstack.LayerNode.set_geometry_mask_enabled_meshes() is now deprecated, use substance_painter.layerstack.LayerNode.set_geometry_mask() instead.
• Function substance_painter.layerstack.LayerNode.set_geometry_mask_enabled_uv_tiles() is now deprecated, use substance_painter.layerstack.LayerNode.set_geometry_mask() instead.

• substance_painter.project

  * Add substance_painter.project.AutoUnwrapUVTilesSettings class to control auto unwrap process during project creation and mesh reloading.

• Update substance_painter.project.create() to control auto unwrap process at project creation.

• Update substance_painter.project.reload_mesh() to control auto unwrap process when reloading mesh.

  note warning
  WARNING
  Auto unwrap settings must now be explicitly provided to substance_painter.project.create() and substance_painter.project.reload_mesh(), and don’t rely on user preferences or project saved settings anymore.

• substance_painter.layerstack

  * Add substance_painter.layerstack.export_as_smart_material() and substance_painter.layerstack.export_as_smart_mask() to create and save a smart material or a smart mask in the filesystem without adding it in the shelf.

• substance_painter.baking

  * The substance_painter.properties.Property named PerVertex (boolean type) has been removed from the Curvature From Map baker. The new behavior is now always forced to PerVertex = False (or in the UI, the Per Fragment mode).

• The two substance_painter.properties.Property named TonemappingMin and TonemappingMax (float type) have been removed in favor of a new substance_painter.properties.Property named TonemappingBounds (array of 2 float).

• substance_painter.layerstack

  * Add substance_painter.layerstack.is_3d_projection_mode() to query which projection mode is compatible with symmetry.

• Add substance_painter.layerstack.FillLayerNode.get_symmetry_parameters() to get symmetry parameters on Fill layers.
• Add substance_painter.layerstack.FillEffectNode.get_symmetry_parameters() to get symmetry parameters on Fill effects.
• Add substance_painter.layerstack.FillLayerNode.set_symmetry_parameters() to set symmetry parameters on Fill layers.
• Add substance_painter.layerstack.FillEffectNode.set_symmetry_parameters() to set symmetry parameters on Fill effects.

• substance_painter.source

  • * Add member log2_offset in substance_painter.source.ResolutionOverride to configure scaling in Auto mode.
  • * Add property substance_painter.source.SourceSubstance.resolution to edit resolution override of the substance.

• substance_painter.baking

  * Add support for automatic cage feature in the baking parameters. The substance_painter.properties.Property named UseCage (boolean type) has been removed in favor of a new substance_painter.properties.Property named CageMode (enum type).

• substance_painter.event

  * Add a new event substance_painter.event.ReloadResourcesStarted to be notified when resource reloading starts.

• Add a new event substance_painter.event.ReloadResourcesEnded to be notified when resource reloading ends.

• substance_painter.layerstack

  * Add substance_painter.layerstack.create_smart_material() to save a smart material.

• Add substance_painter.layerstack.create_smart_mask() to save a smart mask.

• substance_painter.resource

  * Add substance_painter.resource.list_project_resources(), substance_painter.resource.list_project_outdated_resources() and substance_painter.resource.replace_project_resources() to list and replace resources in the project.

• Function substance_painter.resource.list_layer_stack_resources() is now deprecated, use substance_painter.resource.list_project_resources() instead.
• Function substance_painter.resource.update_layer_stack_resource() is now deprecated, use substance_painter.resource.replace_project_resources() instead.
• Add substance_painter.resource.is_reload_modified_resources_running() to check if the resource reloading process is currently running.
• Add substance_painter.resource.reload_modified_resources_async() to trigger the resource reloading process.
• Add substance_painter.resource.Shelf.refresh() to refresh a particulat shelf only.

• substance_painter.textureset

  * Add properties substance_painter.textureset.TextureSet.name and substance_painter.textureset.TextureSet.description to read/edit textureset’s name and description.

• Add properties substance_painter.textureset.UVTile.name and substance_painter.textureset.UVTile.description to read/edit uvtile’s name and description.
• Function substance_painter.textureset.TextureSet.name() is now deprecated, use property substance_painter.textureset.TextureSet.name instead.

• substance_painter.source

  * Add substance_painter.source.ResolutionOverride to configure resolution related parameters of a source vectorial or a source font.

• Members resolution_mode and resolution_value in substance_painter.source.SourceVectorialParams are now deprecated, use substance_painter.source.SourceVectorialParams.resolution instead.
• Members resolution_mode and resolution_value in substance_painter.source.SourceFontParams are now deprecated, use substance_painter.source.SourceFontParams.resolution instead.
• Rename substance_painter.source.VectorialResolutionMode to substance_painter.source.ResolutionMode.
• substance_painter.source.VectorialResolutionMode is now deprecated and an alias to substance_painter.source.ResolutionMode.

• substance_painter.resource

  * Fix members order of enumeration substance_painter.resource.Usage.

• Fix members order and add VECTORIAL to enumeration substance_painter.resource.Type.

• substance_painter.project

  * Add substance_painter.project.GltfSettings to pass gltf specific options.

• Add a member mesh_settings in substance_painter.project.Settings with type substance_painter.project.GltfSettings or substance_painter.project.UsdSettings.
• Member usd_settings in substance_painter.project.Settings is now deprecated, use mesh_settings instead.
• Add a member mesh_settings in substance_painter.project.MeshReloadingSettings with type substance_painter.project.UsdSettings.
• Member usd_settings in substance_painter.project.MeshReloadingSettings is now deprecated, use mesh_settings instead.

• substance_painter.layerstack

  * Fix substance_painter.layerstack.set_selection_type() to allow properties selection of an instance parent layer.

• Fix substance_painter.layerstack.FillLayerNode.set_source(),
  substance_painter.layerstack.FillLayerNode.set_material_source(),
  substance_painter.layerstack.FillEffectNode.set_source() and
  substance_painter.layerstack.FillEffectNode.set_material_source()
  to forbid creation of cycles with anchor points.
  It will now throw a ValueError.

• substance_painter.source

  * Fix substance_painter.source.SourceSubstance.set_source() to forbid creation of cycles with anchor points.
  It will now throw a ValueError.

• Add substance_painter.source.SourceBitmap.list_available_color_spaces() to query available colorspaces for a bitmap.

• substance_painter.layerstack

  * New module to manipulate the layer stack.

• substance_painter.source

  * New module to manipulate layer’s sources.

• substance_painter.colormanagement

  * New module with colormanagement facilities for layerstack edition.

• substance_painter.resource

  * Add ability to get substance presets details using substance_painter.resource.Resource.internal_properties() function.

• substance_painter.export

  * Add substance_painter.export.PredefinedExportPreset and substance_painter.export.list_predefined_export_presets()
  to retrieve predefined export presets and list their output maps.

• Add substance_painter.export.ResourceExportPreset and substance_painter.export.list_resource_export_presets()
  to retrieve resource export presets (editable presets from shelves) and list their output maps.

• substance_painter.project

  * Add substance_painter.project.get_uuid() to query the project UUID.

• substance_painter.application

  * Add ability to disable engine computations

• Add substance_painter.application.close() to close Substance 3D Painter.

• substance_painter.display

  * Add substance_painter.display.Camera to manipulate camera settings.

• substance_painter.event

  * Add a new event substance_painter.event.EngineComputationsStatusChanged to be notified when engine computations status changes.

• Add a new event substance_painter.event.CameraPropertiesChanged to be notified when the properties of a camera change.

• substance_painter.export

  * Add ability to export the mesh of the current project.

• Add ability to get the default export path used for exporting textures.

• substance_painter.project

  * Add substance_painter.project.BoundingBox and substance_painter.project.get_scene_bounding_box() to query dimensions of the scene.

• substance_painter.export

  * Fix textures exported in EXR with 32f bit depth were incorrectly saved in 16f.

• substance_painter.project

  * Add substance_painter.project.UsdSettings in substance_painter.project.Settings to support USD parameters for project creation.

• Add substance_painter.project.UsdSettings in substance_painter.project.MeshReloadingSettings to support USD parameters for mesh reloading.

• substance_painter.async_utils

  * New module to expose primitives used in async computations.

• substance_painter.event

  * Add a new event substance_painter.event.BakingProcessProgress to be notified about baking process progress.

• Add a new event substance_painter.event.BakingProcessAboutToStart to be notified of the start of a baking process.
• Allow to configure throttling period for substance_painter.event.TextureStateEvent.

• substance_painter.baking

  * Add substance_painter.baking.bake_selected_textures_async() to bake all selected texture set.

• Fix substance_painter.baking.bake_async() to take UV Tiles selection into account.
• Now async functions return a substance_painter.async_utils.StopSource to allow for cancellation.

• substance_painter.application

  * New module to expose functionnalities on the application level.

• Add substance_painter.application.version_info() to query Substance 3D Painter version as a tuple.
• Add substance_painter.application.version() to query Substance 3D Painter version as a string.

• substance_painter.event

  * Add a new event substance_painter.event.BakingProcessEnded to be notified of the end of the baking process.

• substance_painter.project

  * Add substance_painter.project.last_saved_substance_painter_version() to query wich Substance 3D
  Painter version was used to last save the project.

• substance_painter.textureset

  * Add substance_painter.textureset.TextureSet.uv_tile() to get a specific UV Tile.

• substance_painter.ui

  * Add Baking to substance_painter.ui.UIMode.

• Add substance_painter.ui.get_current_mode() to query the current UI mode.
• Add substance_painter.ui.switch_to_mode() to switch to some UI mode.

• substance_painter.resource

  * Add new values to substance_painter.resource.Type enumeration.

• Add substance_painter.resource.Resource.children() to query child resources of a resource.
• Add substance_painter.resource.Resource.parent() to query parent resource of a resource.

• substance_painter.textureset

  * Add substance_painter.textureset.MeshMapUsage to enumerate possible Mesh map usages.

• Add substance_painter.textureset.TextureSet.get_mesh_map_resource() to query the resource set as some Mesh map usage.
• Add substance_painter.textureset.TextureSet.set_mesh_map_resource() to replace the resource for some Mesh map usage.

• substance_painter.ui

  * Add substance_painter.ui.get_layout() to save UI layout state.

• Add substance_painter.ui.get_layout_mode() to query the UI mode of a saved state.
• Add substance_painter.ui.set_layout() to restore a saved UI state.
• Add substance_painter.ui.reset_layout() to reset UI state to default.

• substance_painter.event

  * Add a new event substance_painter.event.TextureStateEvent to be notified of document textures edition.

• substance_painter.project

  * substance_painter.project.create() and substance_painter.project.Settings
  now supports using a custom unit scale for mesh size.

• substance_painter.textureset

  * Add substance_painter.textureset.TextureSet.all_mesh_names() to query the list of mesh names used in a Texture Set.

• Add substance_painter.textureset.UVTile.all_mesh_names() to query the list of mesh names used in a UV Tile.

• substance_painter.resource

  * Add substance_painter.resource.Usage enumeration to describe resource usages.

• Add substance_painter.resource.Type enumeration to describe resource types.
• Add substance_painter.resource.Resource.category() to query the category of a resource.
• Add substance_painter.resource.Resource.usages() to query the usages of a resource.
• Add substance_painter.resource.Resource.gui_name() to query the name of a resource.
• Add substance_painter.resource.Resource.type() to query the type of a resource.
• Add substance_painter.resource.Resource.tags() to query the tags of a resource.
• Add substance_painter.resource.Resource.internal_properties() to query a dictionnary of a resource internal properties.

• substance_painter.project

  * substance_painter.project.create() supports PAINTER_ACE_CONFIG
  environment variable, to setup the project color management mode.

• substance_painter.project.create() now raise an error if OCIO
  or PAINTER_ACE_CONFIG environment variable is set to an invalid
  configuration.

• substance_painter.display

  * Add substance_painter.display.get_tone_mapping() to query the
  project tone mapping.

• Add substance_painter.display.set_tone_mapping() to set the
  project tone mapping.

• substance_painter.project

  * Add substance_painter.project.execute_when_not_busy() to execute
  code when Substance 3D Painter is no longer busy.

• substance_painter.js

  * Add substance_painter.js.evaluate() to evaluate some JavaScript code.

• substance_painter.project

  * substance_painter.project.create() supports OCIO environment variable,
  to setup the project color management mode.

• substance_painter.display

  * substance_painter.display.set_color_lut_resource() and
  substance_painter.display.set_environment_resource() throw a
  TypeError instead of a ValueError when an argument has a type different
  from expected.

• substance_painter.event

  * Add substance_painter.event.Dispatcher.connect_strong() to connect
  strong reference callbacks to the event dispatcher.

• substance_painter.project

  * Add substance_painter.project.is_busy() to query whether Substance
  3D Painter is busy.

• Project saving functions are disabled when Substance 3D Painter is
  busy.
• Add substance_painter.project.last_imported_mesh_path() to query the
  path to the last imported mesh.
• Add substance_painter.project.reload_mesh() to load a new mesh in the
  current opened project.
• substance_painter.project.create() throws a TypeError instead
  of a ValueError when its settings argument has a type different from
  expected.

• substance_painter.resource

  * Add substance_painter.resource.show_resources_in_ui() to highlight a
  list of resources in the aplication UI.

• substance_painter.resource.update_layer_stack_resource() throws
  a TypeError when an argument has a type different from expected.

• substance_painter.textureset

  * Add substance_painter.textureset.UVTile to interact with UV Tiles.
  Add ability to manipulate UV Tiles resolutions.

• substance_painter.textureset.TextureSet.from_name() throws a
  TypeError instead of a ValueError when its argument has a type different
  from expected.

• substance_painter.resource

  * Add substance_painter.resource.list_layer_stack_resources() to
  list resources used by the layer stack and mesh maps.

• Add substance_painter.resource.update_layer_stack_resource() to
  update resources used by the layer stack and mesh maps.

• substance_painter.resource

  * Add substance_painter.resource.Resource.show_in_ui() to highlight
  a resource in the UI.

• Modify substance_painter.resource.Shelves.user_shelf() to take
  user settings into account.

• substance_painter.textureset

  * Modify substance_painter.textureset.ChannelType to include
  the new available texture channels.

• substance_painter.ui

  * Add substance_painter.ui.add_plugins_toolbar_widget() to add
  a widget to the plugins toolbar.

• substance_painter.event

  * Add substance_painter.event.ProjectEditionEntered event.

• Add substance_painter.event.ProjectEditionLeft event.
• Add substance_painter.event.ShelfCrawlingStarted event.
• Add substance_painter.event.ShelfCrawlingEnded event.

• substance_painter.project

  * Add substance_painter.project.is_in_edition_state().

• substance_painter.resource

  * Add substance_painter.resource.Resource to manipulate substance
  painter resources.

• Add substance_painter.resource.search() to search for available
  resources.
• Add substance_painter.resource.Shelf.
• Add substance_painter.resource.Shelves for shelves manipulation
  facilities.

• substance_painter.textureset

  * Add substance_painter.textureset.TextureSet.all_uv_tiles().

• Add substance_painter.textureset.TextureSet.has_uv_tiles().
• Add substance_painter.textureset.UVTile.

• substance_painter.export

  * Document the use of existing export presets.

• Add a module overview example.

• substance_painter.textureset

  * Add substance_painter.textureset.Channel.type().

• Add substance_painter.textureset.Stack.all_channels().

• substance_painter.project

  * Add substance_painter.project.ProjectWorkflow.

• Change the constructor of substance_painter.project.Settings.