Documentation

​
​

Development

User Acquisition

Monetization

Industry

Asset Transformer SDK

2026.1

Supported
​

User Manual

Python API

C# API

Changelog

Discussions

Asset Transformer SDK

2026.1

Supported
​

​
​
Get started
  • System requirements
  • Licensing
  • Setup
  • Migrate from Scenario Processor
Framework
  • Framework
  • Preferences
Input/output files
  • Supported formats
  • Import files
  • Export files
  • Export textures
  • CAD vs Mesh
Scene
  • Product structure
  • Occurrence
  • Component
  • Material
  • Image
Algorithms
  • CAD
  • Healing
  • Optimization
  • Combine and bake
  • Reconstruction
  • UVs
Viewer
  • Viewer
Pixyz UI
  • Setup
  • Overview
  • Create a custom UI
Guidelines
  • Data preparation
  • Process point clouds
Debug and diagnose
  • Log files
  • Debug best practices
Other
  • Samples
  • Glossary
  1. Asset Transformer SDK (ex Pixyz)

Changelog

List updates, new features, bug fixes, and changes in the Asset Transformer SDK.
Read time 23 minutes
Last updated 9 months ago

[2026.1.1] - 2025-12

Added

Types

  • material.ImageLayout
    : Describes the channel components of an image
  • material.ImageComponentType
    : Describes the data type of an image component
  • material.PixelInfo
    : Stores additional info about image pixels, like the pixel or component sizes, the component count, ...
  • material.BlurFilter
    : Describes the type of filter to use for image blurring
  • material.EdgeFilter
    : Describes how to manage pixels located out of an image
  • algo.VertexWeightStrategy
    : Describes how to calculate vertex weights

Functions

  • material.getImagePixelInfo
    Recovers pixel info from an image
  • material.getImagePixelInfoFromDefinition
    Same but from an image definition
  • material.getImagePixelInfoFromLayoutAndType
    Same but from a couple of image layout and component type
  • material.getImageColorBilinear
    Same as getImagePixelColor, except that it takes real coordinates as input and returns a bi-linearly interpolated color
  • material.convertImage
    Converts an image from one format to another
  • material.flipImageY
    Applies a vertical flip to an image
  • material.invertImageColor
    Inverts image pixel colors
  • material.blurImage
    Applies a blurring to an image
  • material.getImageLayout
    Gets the pixel layout (component definitions) of an image
  • material.getImageComponentType
    Gets the component type of an image
  • material.getImageComponentTypeName
    Gets a readable name from an image component type
  • material.fillImageWithColor
    Fills (a sub-part of) an image with a single color
  • material.getImageColorRange
    Gets the min and max bounds of each image color component
  • material.extractImageComponents
    Creates new images from individual components of an image
  • material.extractImageChannels
    Creates new images from individual channels of an image
  • material.getSubImage
    Extracts a sub-part of an image
  • material.setSubImage
    Replaces a sub-part of an image by another one
  • material.setImageRoI
    Defines the region of interest of an image
  • material.getImageRoI
    Gets the region of interest of an image
  • material.clearImageRoI
    Removes the region of interest from an image
  • material.transformImage
    Applies a transformation matrix to (the sub-part of) an image
  • material.translateImage
    Applies a translation to (the sub-part of) an image
  • material.rotateImage
    Applies a rotation to (the sub-part of) an image
  • material.stretchImage
    Applies a non-uniform scale to (the sub-part of) an image
  • material.createCheckerboardImage
    Creates a new image representing a checkerboard using two specified colors
  • material.overrideImageFormat
    Changes the way image channels are interpreted by assigning a new format without modifying the data
  • algo.deleteAttribute
    replaces the misspelt function
    algo.deleteAttibute

Changed

  • material.ImageDefinition
    : Component size and count have been replaced by the pixel layout and type
  • material.importImage
    Now able to manage new pixel data types, like uint16 or uint32 from TIFF, or half-float from EXR, for instance
  • material.exportImage
    Now applies an implicit conversion when trying to export to a format that doesn't support the current image data type
  • scene.deleteEmptyOccurrences
    : Now consider an occurrence with a Camera attached as not empty
  • PLY importer is now able to import point clouds
  • algo.createVertexWeightsFromVertexColors
    : Now accepts an additional optional parameter: strategy. If set to RedBlueDiff, vertex weights will be calculated based on the difference between the vertex's r and b color values. If set to Grayscale, vertex weights will be calculated based on their r color value. If set to InvertedGrayscale, vertex weights will be calculated based on the (1-r) color value.
  • PLY importer is now able to import point clouds.

Removed

  • algo.deleteAttibute
    was replaced by the correctly spelt function
    algo.deleteAttribute

Fixed

  • Fixed missing children in some USD files
  • New primary JT interface solving a huge number of import and performance problems
  • Fixed subpart materials handling in explode functions

[2025.7.3] - 2025-12

Fixed

  • Badly imported surfaces in Alias files

[2025.7.2] - 2025-11

Fixed

  • Badly imported obj file
  • Duplicated material at FBX export

[2025.7.1] - 2025-11

Added

  • scene.getPartOccurrencesGroupedBySimilarity
    Group all part occurrences following similarity criteria controlled by the function's parameters.

Changed

  • scene.separateSelection
    : Now takes an additional optional parameter: createSingleOccurrence, true by default. When true, it creates a new occurrences with an identity transform, placed under root, and containing every polygons selected. When false, it will create an occurrence per part containing a selection, positioned at the same place in the tree. Consequently, the function now returns a list of occurrences instead of a single occurrence.

Fixed

  • Missing animation in USD import
  • Crash with setMeshVertexColors
  • Execution stopped when baking with Lines/FreeVertices
  • CATDrawing format typo in format list

[2025.6.1] - 2025-11

Added

  • scene.getFinalPrototype
    Returns the final prototype of an occurrence

Deprecated

  • scene.findDuplicatedPartOccurrences
    will be removed in the next major release. Workaround is to use
    scene.getPartOccurrencesGroupedBySimilarity
    and remove each first element of a set of duplicates containing at least two occurrences.

Fixed

  • Crash in
    scene.removeSymmetryMatrices
    on Autodesk alias files
  • Material assignation on lines
  • Inconsistent imports of the same Revit file
  • Subpart material removal in the function
    scene.removeMaterials

[2025.5.4] - 2025-11

Fixed

  • Vulkan incompatibility on MacOs
  • Unity Licensing with channel names containing utf16 characters

[2025.5.3] - 2025-11

Added

  • IO module property "printMissingFiles" to print missing files during import

Fixed

  • Render capture on Linux
  • Crash with glTF import
  • Improve material compatibility in glTF import

[2025.5.2] - 2025-10

Fixed

  • Fixed DGN import of transparent colors
  • Fixed "invalid face" error during some Revit imports

[2025.5.1] - 2025-10

Added

  • algo.explodeByTopoDimension
    Separate polygons, lines and points into different occurrences
  • scene.createSelectionSnapshot
    Create a snapshot of the current selection to use it later. Most selection related functions now take an added optional selectionId as input allowing to handle a selection and change it without disturbing the displayed selection (the current selection)
  • scene.deleteSelectionSnapshot
    Delete a selection snapshot using its ID

Removed

  • scene.explodeSelection
    : this function was not implemented so it was useless and is being removed

Fixed

  • Supported format extensions (CREO)
  • Instabilities with undo/redo and unregistered entities
  • GLB issues with invalid/missing textures
  • Broken normals/tangents after
    scene.applyTransform()

[2025.4.3] - 2025-10

Changed

  • material.convertFloat32To8BitsImage
    : Now allows to perform in-place conversions instead of creating new images

Fixed

  • Bad categorization of closed surfaces
  • Issue with multiple level of prototypes in
    algo.convertSimilarPartOccurrencesToInstances
  • Linux corrupted files import
  • Offset 2d curves in Facebuilder when a closedSurface doesn't need to be split
  • Avoid importing curves in Alias that are just a point
  • USD Export (Occurrence Transform & Material Preservation, and Progress Bar)
  • USD Importer Visibility Handling and Variant Loading Behavior

[2025.4.2] - 2025-10

Added

  • scene.getPreviousSibling
    Get the previous occurrence in parent's children

Fixed

  • Missing occurrence material export logic. Only sub-part mesh materials were processed.
  • Switch back defaut JT export version value to 10.0 following hoop's memory fix
  • pixyzui crash related to gizmo and occurrence deletion
  • pixyzui redefine layout
  • pixyzui UserProperties issue with listProprerties
  • Feature DXF importer
  • tesselation rotation axis
  • Don't consider ODA surfaces a solid
  • Image convertion from hdr to png
  • Feature component not properly exported to gltf
  • .dwg missing occurence

[2025.4.2] - 2025-09

Added

  • algo.deletePolygonalWeightAttribute
    Delete polygonal weight attributes created from algo.transferVisibilityToPolygonalWeight

Fixed

  • Default color for opacity map baking (transparent)
  • JT export orientation issue
  • Sale problem in DWG import

[2025.4.1] - 2025-08

Added

  • algo.filterMeshVertexColors
    Smooth vertex colors on some meshes while preserving features
  • scene.isIsolated
    Get if the scene is in isolated state
  • scene.getIsolatedOccurrences
    Get currently isolated occurrences
  • scene.IsolateBegan
    Triggered when isolate mode starts
  • scene.IsolateEnded
    Triggered when isolate mode ends
  • CurveMaxSplit
    Maximum number of iteration in the algorithm discretizing a curve. Stop the algorithm and throw an error when the threshold is reached
  • SurfaceMaxSplit
    Maximum number of iteration in the algorithm discretizing a surface. Stop the algorithm and throw an error when the threshold is reached
  • AliasImportSymmetries
    Import symmetries in Alias file format

Changed

  • material.filterAO
    : Now accepts interleaved arrays of ambient occlusion and bent normals maps

Fixed

  • Retessellation of parts after singularization
  • Missing material at import in STEP format
  • USD visibility interpretation mismatch
  • Shininess of Standard materials incorrectly rendered in the viewer
  • Crash when using setPartMesh or setPartModel functions twice
  • Numerical precision issue in GPU Baking
  • Performances problem in algo.tessellatePointClouds() function
  • Baking API bug when baking feature component
  • Random crashes in algo.repairCAD() function
  • Crash in scene.mergePartOccurrencesByRegions()
  • Major Pixyz UI instability caused by the UV Viewer
  • Pixyz UI crash on exit when using customized UI
  • Improved STEP materials import
  • Improved export of submesh in glTF and 3dxml formats
  • Crash while importing USD files with malformed UVs
  • Undo/redo with deleted BRep materials

[2025.3.0] - 2025-07

Most of the following changes are related to an update of the baking API. See this script for an example of conversion from the old API to the new one.

Added

  • Added viewer informations at creation
  • Added, for Wire format, selection sets as comma separated list in metadata field
    InSets

Functions

  • algo.beginBakingSession
    Starts a new baking session
  • algo.beginVertexBakingSession
    Starts a new baking session intended to bake data at mesh vertices instead of to a texture map
  • algo.endBakingSession
    Ends and destroys an existing baking session
  • algo.fetchBakedMap
    Returns information about one texel of a baked map
  • algo.fetchBakedVertex
    Returns information about one baked vertex
  • algo.setBakingSessionPadding
    Sets the width of the dilation applied to baked maps
  • algo.bakeAOMap
    Ray tracing based ambient occlusion computation
  • algo.bakeDepthMap
    Depth map baking
  • algo.bakeDiffuseMap
    Diffuse map baking
  • algo.bakeDisplacementMap
    Displacement map baking
  • algo.bakeEmissiveMap
    Emissive map baking
  • algo.bakeFeatureMap
    Index map baking for features component
  • algo.bakeMaterialAOMap
    AO baking from the source material
  • algo.bakeMaterialIdMap
    Color map baking based on source material IDs
  • algo.bakeMaterialPropertyMap
    Baking of custom material properties
  • algo.bakeMetallicMap
    Metallic map baking
  • algo.bakeNormalMap
    Normal map baking
  • algo.bakeOccurrencePropertyMap
    Occurrence property map baking
  • algo.bakeOpacityMap
    Opacity map baking
  • algo.bakePartIdMap
    Color map baking based on the source part IDs
  • algo.bakePositionMap
    Position map baking
  • algo.bakeRoughnessMap
    Roughness map baking
  • algo.bakeSpecularMap
    Specular map baking
  • algo.bakeUVMap
    Baking of source UV coordinates
  • algo.bakeValidityMap
    Baking of a map distinguishing baked pixels from non baked ones
  • algo.bakeVertexColorMap
    Vertex color map baking
  • algo.getMeshVertexColors Recovers the vertex colors from a set of meshes as arrays
  • algo.setMeshVertexColors Specifies the vertex colors for a set of meshes
  • scene.getClusters
    : Get groups of occurrences based on spatial proximity

Types

  • algo.BakingSession
  • algo.BakedValue
  • algo.Space

IO Properties

  • CreoViewModelGeometrySolids
    Toggle import of solid geometry
  • CreoViewModelGeometrySurfaces
    Toggle import of surfaces geometry
  • CreoViewModelGeometryCosmetics
    Toggle import of cosmetics geometry
  • CreoViewModelConstructionGeometrySurfaces
    Toggle import of cad construction surfaces
  • CreoViewModelConstructionGeometryCosmetics
    Toggle import of cad construction cosmetics
  • CreoViewModelConstructionGeometryDatum
    Toggle import of cad datum planes, curves, axes, points
  • CreoViewModelConstructionGeometryCoordinateSystems
    Toggle import of cad datum coordinate systems
  • CreoViewLayer/importLayerMode
    Select how layers will be imported ( default , layers as occurrences or layers as variants )

Changed

  • algo.convertNormalMap
    : Now allows to convert from / to world space too
  • material.filterAO
    : Now accepts image lists as input. Moreover, default values for all
    sigma
    parameters have been updated
  • material.fillUnusedPixels
    : Now accepts three more parameters:
    size
    to limit the dilation to a finite band around the valid texels,
    validityMask
    as an alternative to
    unusedColor
    to define valid texels, and
    inPlace
    to avoid image duplication. Moreover, running speed has been greatly improved
  • algo.convertSimilarPartOccurrencesToInstancesFast
    : createNewOccurrencesForPrototypes parameter has been removed, it will always create a new occurrence for the prototype. keepExistingPrototypes has been removed to, we always keep the existing prototypes.
  • algo.convertSimilarOccurrences
    : keepExistingPrototypes has been removed to, we always keep the existing prototypes.

Fixed

  • Fixed error importing components with flexibility from Creo Parametric
  • Fixed metadata preservation executing convertSmilarOccurrencesToInstances functions
  • Fixed undo/redo of instance singularization
  • Fixed LoadVariant IO property not working for GLTF files
  • Fixed isolation behavior
  • Fixed metadata export in JT format
  • Fixed DWG import with cjk characters
  • Fixed crash in
    mergePartOccurrences
    with visibility information
  • Fixed remove occluded geometries
  • Fixed Revit Over-importing "Mass Floor" geometry
  • Fixed Step loading style
  • Fixed and Updated JtExportVersion IO parameter to reflect actual supported export versions
  • Fixed infinite loop in Revit
  • Fixed crash in STEP importer

Removed

Algo Properties

  • UseGPUBaking

Types

  • algo.BakingMethod
  • algo.MapType
  • algo.MapTypeList
  • algo.BakeMap
  • algo.BakeMapList
  • algo.CustomBakeMap
  • algo.CustomBakeMapList

Functions

  • algo.bakeMaps

[2025.2.0] - 2025-05

Added

  • Added import of instances and Metadata in NWD file format
  • Added an evend raised when an entity is detroyed

Events

  • core.addEntityDetroyedCallback
    : Add callback for new entity destroyed callback
  • core.removeEntityDetroyedCallback
    : Add callback for new entity destroyed callback

Fixed

  • Fixed redo after unsetting some properties
  • Fixed CGR missing texture
  • Fixed missing referenced files in FBX files (textures)
  • Fixed badly imported Cones in some CAD file formats
  • Fixed Pixyz UI scaling with multiple monitors
  • Fixed Pixyz UI default values with function using structured parameters
  • Fixed random behavior occurring during algo.meshComparison
  • Fixed crash when exporting a mesh with no normal
  • Fixed missing Geometries and Materials during USD export
  • Fixed crash when Importing USD with instances containing variants
  • Fixed conversion of PMI to occurrence duplicated material
  • Fixed crash in function createVertexWeightsFromVisibilityAttributes
  • Fixed wrong animation export in glTF export

Renamed

Previous

New

scene.getComponentByOccurrence
scene.getComponents

[2025.1.1] - 2025-04

Added

  • Added support for subpart materials export in glTF, USD, FBX and JT
  • OSX Packages

Functions

  • algo.hasOverlappingUV
    New function
  • core.getRemainingSecondsBeforeLicenseTimeout
    : After the connection to a floating license server is lost, get the seconds remanining until the program quits
  • polygonal.hasUVs
    : Function to check if a given mesh has some valid UV channels
  • core.hasConsoleVerbose
    : Function to check whether a given Verbose level is present in the console's current mask
  • cad.areCurvesEquals
    : New function that check if two curves are equal by comparing each attributes, one by one
  • cad.getUnitLength
    : Shortcut to the module property UnitLength of PiXYZCAD (avoid casting the float value to string)

Events

  • core.LicenseClientDisconnected
    : Callback for when the connection to the license server is lost for a floating license
  • core.LicenseClientReconnected
    : Callback for when the connection to the license server is restored for a floating license

Viewer properties

  • UseSSGI
    Enables or disables the Screen-Space Global Illumination for improved rendering. Its activation will impact performance. Default is false
  • SSGIQuality
    When UseSSGI is used, choose a quality preset for Screen-Space Global Illumination. Possibilities are:
    VeryHigh
    ,
    High
    ,
    Medium
    and
    Low
    . Default is
    Low
    to not impact performance too much, but
    Medium
    should be prefered for quality
  • SSGIThickness
    Floating number for virtual thickness to consider behind object: meaning thickness of the light barrier behind objects. Default value is 4000.0
  • SSGICoeff
    Floating number to multiply the indirect lighting computed before adding it to the composited image. Default value is 0.5. Increasing/decreasing it will respectively amplify/reduce the effect
  • SSGIFilteringPasses
    Number of filtering passes to perform on the indirect lighting map. Default is 2. Increasing it will smooth the indirect lighting, whereas decreasing it (minimum 0) will likely make noise more visible
  • RenderIndirectLighting
    Render the texture for the indirect lighting computed by the SSGI. Default value is false

Changed

  • algo.mergeUVIslandsAffine
    : Now has one new parameter
    rotationStep
    that only allows UV to rotate by multiples of this angle in degrees. -1 is used when no restriction is in place, and 0 or a value superior or equal to 360 for no rotation
  • scene.getBRepInfos
    Now return the number of nan-manifold edges in the scene tree
  • scene.hide
    Now accept a list of occurrences instead of a single occurrence
  • view.createGPUScene
    : Added the parameters
    useIsolate
    to indicate if the scene visibility should be impacted by the isolate function

Viewer properties

Previous

New

BlurSSAO
SSAOBlur
BlurSize
SSAOBlurSize

Fixed

  • Fixed a crash in
    repackUV
  • Fixed material assignment lost with the
    cleanInstances
    function
  • Fixed missing open shells at Rhino import
  • Fixed
    mergePartOccurrencesByMaterials
    ignoring subpart materials
  • Fixed
    computeAABB
    to include lines
  • Revit: fixed misoriented faces at import
  • Fixed Utf-8 material name encoding issue
  • GLTF: Fixed PBR channels exception
  • GLTF: Fixed variants not imported
  • DGN: Fixed missong colors in some files
  • USD: Fixes incorrect occurrences naming at export
  • PARASOLID: Fixed surfaces created twice and overlapping leading to visual artifacts
  • Fixed viewer's auto-clipping planes issue with 2D objects
  • Fixed a crash when calling undo on empty stack
  • Fixed offset parts with
    convertSimilarPartOccurrencesToInstancesFast
  • Fixed
    explodeByMaterials
    unsetting subpart materials
  • Improved VRAM consumption for GPU baking with opacity threshold
  • Fixed
    repairCAD
    modifying with faces orientation with
    orient
    parameter disabled
  • Fixed crash with
    bakeMaps
    when executed on parts without meshes
  • Fixed
    convertVisibility
    not working in
    convertPMIToOccurrences
  • Fixed baking failing when a material uses a UV channel that doesn't exist in the mesh

[2024.3.0] - 11-26-2024

Added

  • Install Python SDK through pip install

[2024.2.2]

Changed

  • scene.hide
    Now accept a list of occurrences instead of a single occurrence
  • scene.show
    Now accept a list of occurrences instead of a single occurrence
  • scene.inverseVisibility
    Now accept a list of occurrences instead of a single occurrence
  • scene.showOnly
    Now accept a list of occurrences instead of a single occurrence

[2024.2.1] - 09-13-2024

Added

  • core.getLicenseError
    : Give the reason of license check failure

Removed

  • core.pushAnalytic
  • core.isInteractiveMode
  • core.setInteractiveMode
  • core.message
  • core.askYesNo
  • core.choose
  • core.askString

[2024.2.0] - 07-24-2024

Added

  • 2024.2 comes with an API revamp for a more consitent development experience.
  • New viewer API to render scenes, generating screenshots or create interactive viewers.
  • The following list of formats and versions is now officially supported:

Format

Version

ACIS2024
Autodesk Revit2024
Autodesk Navisworks2025
CATIAV5_6R2024
Creo11.0
DGN7
Inventor2025
NX-UnigraphicsNX 2312 (2023 Dec. version)
Parasolid36.0
Rhino8
Solid Edge2024
SolidWorks2024

Functions

  • algo.crackMeshEdges
    : Crack polygonal edges according to given criteria
  • algo.dualContouring
    : Replace the tessellations of the selected parts by a retopology based on a dual-contouring
  • algo.filletMesh
    : Fillet a mesh according to its Lines of Interest
  • algo.getAllAxisFromCADModel
    : Return all the main axis contained in the CAD models given
  • algo.getUVQualityMetrics
    : Compute UV mapping qualitative metrics.
  • algo.getVisualComparisonFootprint
    : Compute the visual footprint of the difference between two sets of occurrences
  • algo.identifySharpEdges
    : Mark as Lines Of Interest the sharp edges
  • algo.mergeUVIslandsRelaxed
    : Minimizes the number of seams in the UV mapping by merging UV islands
  • algo.meshBooleanOperation
    : Computes the boolean operation between the meshes of two occurrence lists
  • algo.segmentMesh
    : Segment Mesh into clusters guided by edge sharpnesses
  • cad.addBodyToModel
    : Add a body to the model
  • cad.addEdgeToModel
    : Add an edge to the model
  • cad.addOpenShellToModel
    : Add an open shell to the model
  • cad.addPrecisionArea
    : Define a working area on the 2D projection of the surface to define a parametric precision
  • cad.addVertexToModel
    : Add a vertex to the model
  • cad.createBoundedLinearExtrusion
    : Create a linear extrusion body
  • cad.createCurveExtrusion
    : Create a curve extrusion body
  • cad.createLinearExtrusion
    : Create a linear extrusion body
  • cad.createLoopFromCurve
    : Create a loop from a finite curve
  • cad.createMultiExtrusion
    : Create a linear extrusion body
  • cad.createRevolveExtrusion
    : Create a revolved extrusion body
  • cad.endThreadBrepSession
    : Ends BrepSession on current thread
  • cad.getClosedShellOrientedFaces
    : Get all orienteFaces contain in the closedShell
  • cad.getCurveLength
    : Returns the length of the curve
  • cad.getEdgeLength
    : Returns the length of the edge
  • cad.getEdgeMaterial
    : Get the material of the edge, if any
  • cad.getModelOpenShells
    : Get the list of open shells contained in a model
  • cad.getModelPrecision
    : Get the precision used in a model
  • cad.getOpenShellOrientedFaces
    : Get all orienteFaces contain in the openShell
  • cad.getParametricPrecisionOnSurface
    : Returns the parametric precision of a surface from the input precision
  • cad.getPrecision
    : Get the CAD precision
  • cad.invertCoEdge
    : Invert a coedge
  • cad.invertFaces
    : Invert faces
  • cad.invertLoop
    : Invert a loop
  • cad.isCurveFinite
    : If the curve is finite return true, return false otherwise
  • cad.isSurfaceFinite
    : Return if the surface is finite
  • cad.needPrecisionArea
    : Tells if it needs a working area on the surface
  • cad.needTorusShapeCheck
    : Returns true if the torus has a shape (lemon or apple) corresponding to the provided points
  • cad.setCoEdgeCurve2D
    : Set the curve 2D value of a coEdge
  • cad.setCoEdgeSurface
    : Set the surface value of a coEdge
  • cad.setCurveLimits
    : set the parametric space limits of a curve
  • cad.setEdgeMaterial
    : Define an edge's material
  • cad.setUnitLength
    : Set the CAD unity length property
  • cad.startThreadBrepSession
    : Create a new BrepSession on current thread
  • core.getLogFile
    : Get the path of the log file
  • core.hasCustomProperty
    : Return true if the custom property was found on the occurrence
  • core.lockEntityRegistration
    : Lock Entity registration, use with Caution. All entities created after this call will not be saved on .pxz file and will not be listed as existing entities on the Database. Be careful to not references these entities with other registered entities
  • core.log
    : Log a message to Pixyz output
  • core.parallelAddJob
    : Add a job to a parallel session
  • core.parallelFinish
    : Ends a parallel session after waiting for all jobs to finish
  • core.parallelStart
    : Starts a new parallel session
  • core.removeModule
    : Remove a module added via getModuleDescFromXML
  • core.unlockEntityRegistration
    : Unlock Entity registration
  • geom.fromAffine
    : Create a Matrix from an Affine
  • geom.getMaxScale
    : Get maximum matrix scale
  • io.addAssetPaths
    : add directory paths to search assets in
  • io.applyAutoTessellate
    : Handle auto tessellate options on given part, need to be complete
  • io.clearAssetPaths
    : clear all asset paths
  • io.findInDirectories
    : find the final path. This will search for the file in asset paths
  • io.getAssetPaths
    : get user defined paths to find assets
  • io.getExtensionPriority
    : get the priority of an extension from the pixyz importer
  • io.importRemote3mxFile
    : Import a remote 3mx file
  • io.listVariants
    : List all variants if file
  • io.registerIOCallbacks
    : Register import and export callbacks
  • io.setAssetPaths
    : replace paths to find assets
  • material.convertFloat32To8BitsImage
    : Returns a new image from the given converter from 32bits float to a 8Bits (e.g. depth render map)
  • material.createImageFromData
    : Import an Image from only its data
  • material.fillUnusedPixels
    : Fill unused pixels by propagating and averaging used pixels
  • material.filterAO
    : Filter an AO map using ATrous method
  • material.getImagePixelColor
    : Returns the color of a given pixel in an image
  • material.getImagesSizes
    : Returns the sizes of multiple images
  • material.getMaterialPattern
    : Gets the MaterialPattern name of the material
  • material.getPointsAndMaterialFromText
    : Returns list of 3D Points and a material from a string and fontname
  • material.setCoeffOrTextureProperty
    : Set a CoeffOrTexture property
  • material.setColorAlphaProperty
    : Set a ColorAlpha property
  • material.setColorOrTextureProperty
    : Set a ColorOrTexture property
  • polygonal.createMeshFromDefinitions
    : Create a new mesh from multiple MeshDefinition
  • polygonal.createMeshFromText
    : Creates an occurrence from string
  • polygonal.usePointGapFillerNormal
    : This triangulates a set of points and normals
  • scene.addAnnotationGroup
    : Add a Annotation Group to the pmi component
  • scene.addInParentInstances
    : Add an instance of prototype's child as child in current occurrence recursively
  • scene.addMeshToAnnotation
    : Add a mesh and its material to a annotation
  • scene.createAnnotationFromDefinition
    : Create Annotation from definition
  • scene.createCapsule
    : Create a new capsule
  • scene.createOccurrenceFromAnnotation
    : Convert a single annotation on an occurrence into an occurrence with mesh geometry
  • scene.endModifyAllVariants
    : Call this function to disable the modifications of all variants at the same time
  • scene.getBrepShape
    : Returns the Brep shape of a part
  • scene.getHiddenPartOccurrences
    : Get hidden part occurrences
  • scene.getPartialLoadingStatus
    : Get the current status of a partial loading component
  • scene.getTessellationParameters
    : Get tessellation parameters
  • scene.getVolume
    : Return the volume of the occurrence
  • scene.getVolumes
    : Return the volume of a set of root occurrences
  • scene.invertSelect
    : Invert occurrences to selection
  • scene.setAnnotationToGroup
    : set Annotation to a Annotation Group
  • scene.setReferencedDataComponentParent
    : Defines which referenced data is parent to the given component
  • scene.setReferencedDataComponentPath
    : Defines which path the referenced data is at
  • scene.startModifyAllVariants
    : Call this function to to enable the modifications of all variants at the same time
  • scene.updateChildrenPrototypes
    : Update children prototypes of the given occurrence
  • view.drawCappingPlane
    : Create an occurrence that holds the mesh of the surfaces that have been cut by the cutting plane
  • view.getCameraFrontAxis
    : Get the front axis of the nth view matrix of a given viewer
  • view.getCameraPosition
    : Get the position of the nth view matrix of a given viewer
  • view.getCameraRightAxis
    : Get the right axis of the nth view matrix of a given viewer
  • view.getCameraUpAxis
    : Get the up axis of the nth view matrix of a given viewer
  • view.selectPrimitives
    : Select the primitives (polygons, surfaces) contained in the given rectangle
  • view.setDefaultViewerId
    : Set default viewer id. This viewer will be used in other functions taking a Viewer as a parameter. Useful if a viewer needs to be shared across different contexts.
  • view.startRecording
    : Record viewer in a file
  • view.stopRecording
    : Stop recording video

Removed

Functions

  • algo.combineMeshes
    : Use
    algo.combineMaterials
    and
    scene.mergePartOccurrences
    to achieve the same result
  • algo.deletePolygonalWeightAttribute
  • algo.destroyElements
  • algo.flattenUV
  • algo.getEdgePolygons
  • algo.getEdgeVertices
  • algo.getEdges
  • algo.getFreeEdges
  • algo.getFreeVertices
  • algo.getNormal
  • algo.getPatches
  • algo.getPolygonEdges
  • algo.getPolygonVertices
  • algo.getPolygons
  • algo.getTessellationBoundaries
  • algo.getTextureCoordinates
  • algo.getVertexCoordinates
  • algo.getVertexEdges
  • algo.getVertexPolygons
  • algo.getVertices
  • algo.getVisiblePolygons
  • algo.invertElements
  • algo.relaxUV
  • algo.retessellate
    : Use
    algo.tessellate
    instead
  • algo.smoothUV
  • algo.stitchUV
  • algo.toEditableMesh
  • algo.toStaticMesh
  • algo.combineMeshesByMaterials
    : Use
    scene.mergePartOccurrencesByMaterials
    instead with the additional 'combineMeshes' parameter
  • cad.addToModel
  • cad.createBoundedCurve
  • cad.getBoundedCurveDefinition
  • cad.getClosedShellOrientedDomains
  • cad.getModelDomains
  • cad.getOpenShellOrientedDomains
  • cad.setPrecision
  • core.addPreset
  • core.executeCommand
  • core.exportFunctionDialogScreen
  • core.exportPresets
  • core.generateHTMLDocumentation
  • core.getEntityTypeFromString
  • core.importPresets
  • core.isFloatingLicense
  • core.removeAllPresets
  • core.removePreset
  • core.savePreset
  • core.updateDocumentation
  • core.askYesNo
  • core.choose
  • core.askString
  • core.updateDocumentation
  • core.message
  • io.exportSceneToDTPlatform
  • io.exportSceneToReflect
  • io.importSceneFromDTPlatform
  • scene.selectPartsFromNoShow

Types

  • algo.EdgeListList
  • algo.EdgeList
  • algo.ElementList
  • algo.PatchList
  • algo.Patch
  • algo.PolygonListList
  • algo.PolygonList
  • algo.UVCoordList
  • algo.UVCoord
  • algo.VertexListList
  • algo.VertexList
  • core.Regex
    : Changed from struct to
    core.String

Changed

  • algo.automaticUVMapping
    : Now have two new optional parameters allowing to set up the resolution and the padding
  • algo.createVisibilityInformationAdvanced
    : Now has a
    level
    parameter, like
    algo.createVisibilityInformation
  • algo.decimateTarget
    : Now takes an optional experimental parameter for hybrid memoryless approach
  • algo.explodeConnectedMeshes
    : Now has an optional parameter allowing to split connected components along non-manifold edges
  • algo.getFittingCylinder
    ,
    algo.mapUvOnFittingCylinder
    : Theses function now take an optional forced direction vector
  • algo.remeshSurfacicHoles
    : Algorithm was improved, new parameters were added
  • algo.removeOccludedGeometries
    ,
    algo.findOccludedPartOccurrences
    and
    algo.createVisibilityInformation
    : Now can create viewpoints on an hemisphere
  • algo.removeOccludedGeometries
    ,
    algo.findOccludedPartOccurrences
    and
    algo.removeOccludedGeometriesFromPoints
    : Viewpoints generation no longer creates a uv mapping of a grid of
    sphereCount
    ×
    sphereCount
    on a sphere (density is higher on the poles than on the hemisphere) but creates a uniform distribution of
    sphereCount
    viewpoints on a sphere.
  • algo.removeOccludedGeometries
    ,
    algo.removeOccludedGeometriesAdvanced
    ,
    algo.removeOccludedGeometriesFromPoints
    and
    algo.removeOccludedGeometriesFromViewPoints
    : These functions now take an optional list of occluders
  • algo.unwrapUV
    : Now has two new parameters to control solver's behavior
  • cad.createLoop
    : Now has a parameter allowing to merge isolated vertices in the loop
  • cad.createRevolutionSurface
    : Now parameters defining the starting and ending angles are renamed and used as if they were in radians
  • cad.invertFaces
    : Now has a parameter to invert loop orientation
  • core.endUndoRedoStep
    : Now has an optional
    deleteIfEmpty
    parameter
  • geom.fromTRS
    : Rotation vector should be passed in degrees instead of radians
  • geom.toTRS
    : Rotation vector values are now returned in degrees
  • material.createMaterialsFromMaps
    : Now returns info on the created material
  • scene.createTorus
    : Now has a
    generateUV
    parameter like other
    scene.create___
    functions
  • scene.getAABB
    : Now takes an optional parameter allowing to compute more precise AABB
  • scene.mergePartOccurrencesByFinalAssemblies
    :
    MergeHiddenPartsMode
    default value is now
    Destroy
  • view.refreshViewer
    : Removed the parameters
    frameCount
    and
    forceUpdate
    that were unused

Renamed

Functions

Previous

New

algo.bakeUV
algo.transferUV
algo.convertSimilarOccurrencesToInstances
algo.convertSimilarPartOccurrencesToInstances
algo.createInstancesBySimilarity
algo.convertSimilarPartOccurrencesToInstancesFast
algo.explodePartByMaterials
algo.explodeByMaterials
algo.explodeVertexCount
algo.explodeByVertexCount
algo.explodeVoxel
algo.explodeByVoxel
algo.hiddenRemovalCamera
algo.removeOccludedGeometriesFromPoints
algo.hiddenRemovalViewPoints
algo.removeOccludedGeometriesFromViewPoints
algo.hiddenRemoval
algo.removeOccludedGeometries
algo.hiddenSelection
algo.findOccludedPartOccurrences
algo.mergeUVIslands
algo.mergeUVIslandsAffine
algo.orientFromCamera
algo.orientPolygonFacesFromCamera
algo.orient
algo.orientPolygonFaces
algo.selectSimilar
algo.findSimilarPartOccurrencesFast
algo.smartHiddenCreateVisibilityInformation
algo.createVisibilityInformationAdvanced
algo.smartHiddenRemoval
algo.removeOccludedGeometriesAdvanced
algo.smartHiddenSelection
algo.findOccludedPartOccurrencesAdvanced
algo.smartOrient
algo.orientPolygonFacesAdvanced
algo.uvUnwrap
algo.unwrapUV
scene.findByActiveMaterial
scene.findPartOccurrencesByActiveMaterial
scene.findByMetadataValue
scene.findOccurrencesByMetadataValue
scene.findByMetadata
scene.findOccurrencesByMetadata
scene.findByProperty
scene.findOccurrencesByProperty
scene.getDuplicatedParts
scene.findDuplicatedPartOccurrences
scene.getNodeName
scene.getOccurrenceName
scene.getReferencers
scene.getDirectInstances
scene.getUnstitchedFacesOccurrences
scene.findPartOccurrencesWithUnstitchedOpenShells
scene.identifyInstances
scene.findPartOccurrencesByMinimumNumberOfInstances
scene.mergeByRegions
scene.mergePartOccurrencesByRegions
scene.mergeByTreeLevel
scene.mergeOccurrencesByTreeLevel
scene.mergeFinalLevel
scene.mergePartOccurrencesByFinalAssemblies
scene.mergeOpenShells
scene.mergePartOccurrencesWithSingleOpenShellByAssemblies
scene.mergePartsByAssemblies
scene.mergePartOccurrencesByAssemblies
scene.mergePartsByMaterials
scene.mergePartOccurrencesByMaterials
scene.mergePartsByName
scene.mergePartOccurrencesByName
scene.mergeParts
scene.mergePartOccurrences
scene.selectByMaterial
scene.findOccurrencesByMaterial
scene.selectByMaximumSize
scene.findPartOccurrencesByMaximumSize
scene.selectByVisibleMaterial
scene.findPartOccurrencesByVisibleMaterial
scene.selectDuplicated
scene.findDuplicatedPartOccurrences
scene.selectInstances
scene.getInstances
scene.selectPartOccurrencesInAABB
scene.findPartOccurrencesInAABB
scene.selectPartOccurrencesInBox
scene.findPartOccurrencesInBox
scene.selectVisibleParts
scene.getVisiblePartOccurrences

Types

Previous

New

polygonal.DressedPolyList
polygonal.SubmeshList
polygonal.DressedPoly
polygonal.Submesh
algo.SmartHiddenType
algo.InnerOuterOption

Copyright © 2026 Unity Technologies
LegalPrivacy PolicyCookiesDocumentation Terms of UseDo Not Sell or Share My Personal InformationYour Privacy Choices (Cookie Settings)

"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S and elsewhere (more info here). Other names or brands are trademarks of their respective owners.

Some pages are machine-translated for convenience, and may contain inaccuracies. In the event of conflicting information, the English version is authoritative.

  • On this page
    • [2026.1.1] - 2025-12

      • Added

        • Types

        • Functions

      • Changed

      • Removed

      • Fixed

    • [2025.7.3] - 2025-12

      • Fixed

    • [2025.7.2] - 2025-11

      • Fixed

    • [2025.7.1] - 2025-11

      • Added

      • Changed

      • Fixed

    • [2025.6.1] - 2025-11

      • Added

      • Deprecated

      • Fixed

    • [2025.5.4] - 2025-11

      • Fixed

    • [2025.5.3] - 2025-11

      • Added

      • Fixed

    • [2025.5.2] - 2025-10

      • Fixed

    • [2025.5.1] - 2025-10

      • Added

      • Removed

      • Fixed

    • [2025.4.3] - 2025-10

      • Changed

      • Fixed

    • [2025.4.2] - 2025-10

      • Added

      • Fixed

    • [2025.4.2] - 2025-09

      • Added

      • Fixed

    • [2025.4.1] - 2025-08

      • Added

      • Changed

      • Fixed

    • [2025.3.0] - 2025-07

      • Added

        • Functions

        • Types

        • IO Properties

      • Changed

      • Fixed

      • Removed

        • Algo Properties

        • Types

        • Functions

    • [2025.2.0] - 2025-05

      • Added

        • Events

      • Fixed

      • Renamed

    • [2025.1.1] - 2025-04

      • Added

        • Functions

        • Events

        • Viewer properties

      • Changed

        • Viewer properties

      • Fixed

    • [2024.3.0] - 11-26-2024

      • Added

    • [2024.2.2]

      • Changed

    • [2024.2.1] - 09-13-2024

      • Added

      • Removed

    • [2024.2.0] - 07-24-2024

      • Added

        • Functions

      • Removed

        • Functions

        • Types

      • Changed

      • Renamed

        • Functions

        • Types


Report a problem with this page