Breaking changes

2024.2 Update 2

💡 BEHAVIOR CHANGE

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 Update 1

❌ REMOVED FUNCTIONS

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

➕ ADDED FUNCTIONS

core.getLicenseError: Give the reason of license check failure

2024.2

💡 BEHAVIOR CHANGE

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

❌ REMOVED FUNCTIONS

algo.combineMeshes: Use algo.combineMaterials and scene.mergePartOccurrencesto 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
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

❌ REMOVED 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

➕ ADDED 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.createBoundedLinearExtrusionBody: Create a linear extrusion body
cad.createCurveExtrusionBody: Create a curve extrusion body
cad.createLinearExtrusionBody: Create a linear extrusion body
cad.createLoopFromCurve: Create a loop from a finite curve
cad.createMultiExtrusionBody: Create a linear extrusion body
cad.createRevolveExtrusionBody: 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

⚠️ 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`

⚠️ RENAMED TYPES

Previous	New
`polygonal.DressedPolyList`	`polygonal.SubmeshList`
`polygonal.DressedPoly`	`polygonal.Submesh`
`algo.SmartHiddenType`	`algo.InnerOuterOption`