Data API Changelog

Version 2026.0.0

New APIs

• Database:

  • Add Database.find_texture() method

• Product:

  • Add Product.export_fbx() method.

• Model:

  • Add Model.import_obj() method.

• Texture:

  • Add Texture.xref

Corrections

• Fixed AspectLayer.group now return None if layer has no parent, in place of raising exception.

• Fixed AspectLayerGroup.parent_group now return None if group has no parent, in place of freezing UI.

• Fixed AspectLayerGroup.parent_group now set the parent group.

• Fixed AspectLayerGroup.visible did nothing.

• Fixed MultiLayerMaterialSpecularLayer.specular_map_keep_aspect did nothing.

• Fixed saved selections are now correctly saved when using P3DFile.open api.

Version 2025.0.0

New APIs

• Database:

  • Add Database.find_material()

• SceneObject:

  • Add constraints management:

    • Add SceneObject.list_constraints

    • Add SceneObject.add_constraint

    • Add SceneObject.remove_constraint

• Light:

  • Add SkyLight.lighting_hdr_environment

  • Add SkyLight.enable_lighting_hdr_environment

• Material:

  • Add EnvMaterial.mode

  • Add xxxxMapResolutionOffset for each map of StandardMaterial, MirrorMaterial and MultiLayerMaterial

• AspectLayer:

  • Add AspectLayer.sticker_assignments_per_surface()

Corrections

• Fixed Model.create_configuration_preset() and Product.create_configuration_preset() to have the same behavior.

• Fixed ConfigurationTarget.id now give acces to the target layer id.

• Fixed a memory leak when removing GeometryLayer.

Version 2024.0.0

New APIs

• Model:

  • Add Model.find_saved_selection(), Model.list_saved_selections() and Model.create_saved_selection()

• AspectLayer:

  • Add AspectLayer.assign_sticker()

  • Add AspectLayer.sticker_count()

  • Add AspectLayer.sticker_assignment_offset_u()

  • Add AspectLayer.set_sticker_assignment_offset_u()

  • Add AspectLayer.sticker_assignment_offset_v()

  • Add AspectLayer.set_sticker_assignment_offset_v()

  • Add AspectLayer.sticker_assignment_rotation()

  • Add AspectLayer.set_sticker_assignment_rotation()

  • Add AspectLayer.remove_sticker_assignment()

  • Add AspectLayer.remove_all_sticker_assignments()

  • Add AspectLayer.sticker_assignment()

  • Add AspectLayer.all_sticker_assignments()

• Material:

  • Add StandardMaterial.diffuse_gradient_ramp and StandardMaterial.velvet_gradient_ramp properties

  • Add MultiLayerMaterialDiffuseLayer.gradient_ramp and MultiLayerMaterialIlluminationLayer.gradient_ramp properties.

  • Add MirrorMaterial new methods and attributes.

• Texture:

  • Add Texture.export_to_file()

• PostProcess groups:

  • Add PostprocessGroup.import_kfx()

Version 2023.0.0

New APIs

• Camera:

  • Add Camera.exposed_in_configuration, Camera.lens_shift_x and Camera.lens_shift_y attribute.

Corrections

• Fixed SceneObject.list_child_objects() when recursive=True also returning the current object when it shouldn't.

Version 2022.0.1

New APIs

• Add Kinematics

  • Add Axis

  • Add Null

  • Add Vector

• Add Bezier Path

• Add SceneObject which groups Surface, Kinematics and Bezier Path

• Add PositionLayer

• Add Timeline

  • Add Timeline

  • Add TimelineTrack

• Add Animation

  • Add CameraBezierPathAnimation

  • Add CameraBookmarkAnimation and CameraBookmark

  • Add ConfigurationKeyAnimation

  • Add ChannelsAnimation, ChannelsSimpleAnimation, ChannelsCurveAnimation, AnimationCurve, AnimationKeyFrame, SurfaceBakedAnimation

  • Add ProductKeyAnimation

  • Add TextureAnimation

• PostprocessingEffect:

  • Add PostprocessingEffectBloom

  • Add PostprocessingEffectSharpen

  • Add PostprocessingEffectAddMultiply

• Surface:

  • Add Surface.is_merged

  • Add tags management :

    • Add Surface.has_tag

    • Add Surface.list_tags

    • Add Surface.add_tag

    • Add Surface.remove_tag

Breaking Changes

• Changed Surface transform properties, contrary to the previous version setting transformations do not keep the surface global position:

  • Surface.translation, Surface.rotation are now the transform from local to world

  • Removed Surface.pivot_global_position and Surface.pivot_global_orientation

  • Added Surface.pivot_to_world_translation by Surface.pivot_to_world_rotation

  • Removed Surface.pivot_local_position and Surface.pivot_local_orientation

  • Added Surface.local_to_pivot_translation, Surface.local_to_pivot_rotation

  • Added Surface.pivot_to_parent_translation, Surface.pivot_to_parent_rotation

• Removed prefix get_ for scripting methods:

  • Modified in AspectLayer: AspectLayer.materialAssignmentOffsetU(), AspectLayer.materialAssignmentOffsetV(), AspectLayer.materialAssignmentRotation(), AspectLayer.materialAssignment()

  • Modified in ConfigurationParameter: ConfigurationParameter.symbol()

  • Modified in Database: Database.objectMetadataValue(), Database.objectMetadataStore()

  • Modified in EnvironmentLayer: EnvironmentLayer.environmentAssignment(), EnvironmentLayer.globalEnvironment()

  • Modified in Surface shadow methods: Surface.shadow_cast(), Surface.receive_shadow()

  • Modified in Surface dressing methods: Surface.dressingMappingMode(), Surface.dressingScaleUV(), Surface.dressingLocalTranslation(), Surface.dressingLocalOrientation(), Surface.dressingSize(), Surface.dressingTile()

Version 2022.0.0

New APIs

• Database:

  • Add Database.create_configuration_rule(), Database.find_configuration_rule() and Database.list_configuration_rules() methods.

  • Add Database.export_kdr() and Database.export_kdc() methods.

  • Add Database.active_model attribute.

• Model:

  • Add Model.list_configuration_parameters(), Model.list_configuration_presets(), and Model.create_configuration_preset() methods.

  • Add Model.selected_surfaces and Model.leader_surface properties.

• Product:

  • Add Product.list_configuration_parameters(), Product.list_configuration_presets(), and Product.create_configuration_preset() methods.

  • Add Product.find_aspect_layer(), Product.find_aspect_layer_group() and Product.create_aspect_layer_group() methods.

• Configuration:

  • Add ConfigurationParameter class.

  • Add ConfigurationPreset class.

  • Add ConfigurationRule class.

  • Add ConfigurationTarget class.

• Surface:

  • Add Surface.selected property.

  • Add Surface.get_shadow_cast(), Surface.set_shadow_cast(), Surface.get_shadow_receive() and Surface.set_shadow_receive() methods.

• Aspect Layer:

  • Add AspectLayer.locked property.

  • Add AspectLayer.get_material_assignment_offset_u(), AspectLayer.set_material_assignment_offset_u(), AspectLayer.get_material_assignment_offset_v(), AspectLayer.set_material_assignment_offset_v(), AspectLayer.get_material_assignment_rotation() and AspectLayer.set_material_assignment_rotation(), methods.

• LightingColor: Add LightingColor.active property.

• Environment Group: Add EnvironmentGroup.import_kev() method to import an environment from .kev file.

• Environment: Add Environment.export_kev() method to export an environment to .kev file.

Changed APIs

• The VisibilityLayer class is now called GeometryLayer to be consistent with Patchwork 3D concepts. All properties and methods referencing geometry layers have been renamed accordingly.

• AspectLayer.visibility has been renamed to AspectLayer.visible.

• AspectLayerGroup.visibility has been renamed to AspectLayerGroup.visible.

Corrections

• Fix crash when creating a Camera without specifying a CameraGroup.

Version 2021.1.3

Corrections

• Fix LightGroup.list_lights() not returning the right light type.

• Fix enums returning wrong values in some cases when using the direct .p3d access API.

• Fix crash when creating a Camera while in Matter with no product open.

• Fix exception when duplicating a MaterialGroup.

Version 2021.1.0

New APIs

• AxfCPA2Material: Add properties to change the material color.

• Product: Add properties for SSAO.

• Visibility Layer: Add VisibilityLayer.import_triangle_mesh() and VisibilityLayer.import_indexed_triangle_mesh() to create surfaces from meshes.

Corrections

• Fix some methods not using their arguments properly.

Version 2020.2.4

Corrections

• Fix AspectLayer.get_material_assignment not returning the right material type.

Version 2020.2.2

New APIs

• Aspect Layer Group: Add AspectLayerGroup class.

• Aspect Layer: Add AspectLayer class. This allows you to assign materials to surfaces or query the material of a surface.

• Environment Layer: Add EnvironmentLayer class. This allows you to assign environments to surfaces or change the global environment of the product.

• Product: Add Product class.

• Model: Add Model.create_product(), Model.find_product() and Model.list_products() methods.

Corrections

• Fix Database.active_material not returning the right material type.

• Fix crash when setting Database.active_material.

• Fix no default model, visibility layer and lighting created when creating a database using P3DFile.create().

Version 2020.2.1

New APIs

• Database:

  • Add Database.active_material, Database.active_background, Database.active_environment, Database.active_overlay, Database.active_postprocess and Database.active_sensor attributes.

  • Add Database.active_texture_group, Database.active_background_group, Database.active_environment_group, Database.active_overlay_group, Database.active_postprocess_group and Database.active_sensor_group attributes.

  • Add Database.create_texture_group(), Database.find_texture_group() and Database.list_texture_groups() methods.

  • Add Database.create_background_group(), Database.find_background_group() and Database.list_background_groups() methods.

  • Add Database.create_environment_group(), Database.find_environment_group() and Database.list_environment_groups() methods.

  • Add Database.create_overlay_group(), Database.find_overlay_group() and Database.list_overlay_groups() methods.

  • Add Database.create_postprocess_group(), Database.find_postprocess_group() and Database.list_postprocess_groups() methods.

  • Add Database.create_sensor_group(), Database.find_sensor_group() and Database.list_sensor_groups() methods.

• Background Group: Add BackgroundGroup class.

• Background: Add Background class.

• Camera: Add Camera.sensor attribute.

• Material: Add StandardMaterial.diffuse_gradient_ramp_enabled, StandardMaterial.velvet_gradient_ramp_enabled, MultiLayerMaterialDiffuseLayer.gradient_ramp_enabled and MultiLayerMaterialIlluminationLayer.gradient_ramp_enabled properties.

• Environment Group: Add EnvironmentGroup class.

• Environment: Add Environment class.

• Overlay Group: Add OverlayGroup class.

• Overlay: Add Overlay and OverlayLayer classes.

• Postprocess Group: Add PostprocessGroup class.

• Postprocess:

  • Add Postprocess class.

  • Add PostprocessingEffect base class with some subclasses (more to come): PostprocessingEffectBloom and PostprocessingEffectBlur.

• Sensor Group: Add SensorGroup class.

• Sensor: Add Sensor class.

Corrections

• Fix crash when setting Database.active_material_group to None.

Version 2020.2.0

New APIs

• Material Group:

  • Add MaterialGroup.import_kmt() method to import a material from .kmt file.

  • Add material creation methods: MaterialGroup.create_standard_material(), MaterialGroup.create_multi_layer_material(), MaterialGroup.create_mirror_material(), MaterialGroup.create_matte_material() and MaterialGroup.create_env_material().

• Material:

  • Add Material.duplicate() and Material.remove() methods.

  • Add Material.export_kmt() method to export a material to .kmt file.

  • Add FlakesDistribution, LabelMode, RepetitionMode and StandardMaterialType enums.

  • Add MultiLayerMaterialLayer base class with its subclasses: MultiLayerMaterialDiffuseLayer, MultiLayerMaterialFlakesLayer, MultiLayerMaterialIlluminationLayer and MultiLayerMaterialSpecularLayer.

  • Add material-specific methods to get/set 1 their properties. Currently it is not possible to get/set material gradients, this will come in a future release.

• Texture Group:

  • Add TextureGroup class.

  • Textures can be imported using TextureGroup.import_from_encoded_data().

• Texture:

  • Add Texture class.

  • The texture data can be retrieved (in encoded format only currently) using the Texture.encoded_data() method.

Corrections

• Fix crash when creating a visibility layer

• Fix creating a visibility layer not working properly when using P3DFile API.

• Fix wrong database version after saving a file opened with P3DFile API.

• Fix no default groups created in Matter library when creating a database using P3DFile.create().

Version 2020.1.0

Initial release

Footnotes

1

Except SeamMaterial where it is not possible to set the properties as it is a deprecated material.