Core
Python API types
阅读时间26 分钟最后更新于 1 个月前
AliasTypeDesc
Fields
Type | Name | Default | Description |
|---|---|---|---|
| alias | String |
ArrayTypeDesc
Fields
Type | Name | Default | Description |
|---|---|---|---|
| arrayType | String | ||
| size | Int | 0 |
AutoValueReturn
Auto value function return.
Fields
Type | Name | Default | Description |
|---|---|---|---|
| values | StringPairList | [] | |
| message | String |
Bool
Derived class: Boolean
Functions accepting this type or a list of this type as a parameter:
- algo.bakeImpostor
- algo.createIndexMapFromOccurrences
- algo.createPointCloudKDTree
- algo.getVisualComparisonFootprint
- algo.createVisibilityInformation
- algo.findOccludedPartOccurrences
- algo.removeOccludedGeometries
- algo.retopologize
- algo.automaticUVMapping
- algo.mapUvOnAABB
- algo.mapUvOnMBB
- algo.createBillboard
- algo.repairMesh
- algo.requadify
- core.listTokens
- io.getExportFormats
- io.getFormatsDescriptions
- io.getImportFormats
- io.loadReferencedData
- material.findMaterialsByProperty
- material.applyFactorOnImage
- polygonal.getPolygonCount
- scene.deleteComponentByType
- scene.generateOctaViews
- scene.getComponent
- scene.getComponentByOccurrence
- scene.getComponents
- scene.getPolygonCount
- scene.getVertexCount
- scene.hasComponent
- scene.listComponents
- scene.resizeTextures
- scene.findOccurrencesByMetadata
- scene.findOccurrencesByMetadataValue
- scene.findOccurrencesByProperty
- scene.createSubTree
- scene.displayValueFromAnimChannelAtTime
- scene.alignPivotPointToWorld
- scene.movePivotPointToOccurrenceCenter
- scene.movePivotPointToOrigin
- scene.movePivotPointToTargetedOccurrenceCenter
- view.stopAllAnimation
- view.stopAnimation
- view.createGPUScene
- view.pickRectangle
- view.visibilityShoot
BoolList
List of core.Bool
Boolean
Base class: core.Bool
Derived class: Orientation
Functions accepting this type or a list of this type as a parameter:
- algo.assembleCAD
- algo.bakeImpostor
- algo.bakeVertexAttributes
- algo.configureFunctionLogger
- algo.crackEdges
- algo.crackMeshEdges
- algo.createNormals
- algo.createTangents
- algo.decimate
- algo.decimateEdgeCollapse
- algo.decimateTarget
- algo.deleteBRepShapes
- algo.deletePatches
- algo.evalDecimateErrorForTarget
- algo.extractNeutralAxis
- algo.filletMesh
- algo.identifyLinesOfInterest
- algo.identifyPatches
- algo.identifySharpEdges
- algo.invertTangents
- algo.listFeatures
- algo.removeHoles
- algo.repairCAD
- algo.segmentMesh
- algo.smoothMesh
- algo.sweep
- algo.tessellate
- algo.tessellatePointClouds
- algo.tessellateRelativelyToAABB
- algo.bakeAOMap
- algo.bakeDiffuseMap
- algo.bakeDisplacementMap
- algo.bakePositionMap
- algo.beginBakingSession
- algo.beginVertexBakingSession
- algo.combineMaterials
- algo.convexDecomposition
- algo.explodeBodies
- algo.explodeByVertexCount
- algo.explodeConnectedMeshes
- algo.createVisibilityInformation
- algo.createVisibilityInformationAdvanced
- algo.createVisibilityInformationFromViewPoints
- algo.findOccludedPartOccurrences
- algo.findOccludedPartOccurrencesAdvanced
- algo.removeOccludedGeometries
- algo.removeOccludedGeometriesAdvanced
- algo.removeOccludedGeometriesFromPoints
- algo.removeOccludedGeometriesFromViewPoints
- algo.dualContouring
- algo.marchingCubes
- algo.proxyMesh
- algo.voxelize
- algo.replaceByPrimitive
- algo.convertSimilarPartOccurrencesToInstances
- algo.convertSimilarPartOccurrencesToInstancesFast
- algo.findSimilarPartOccurrencesFast
- algo.mapUvOnAABB
- algo.mapUvOnBox
- algo.mapUvOnCubicAABB
- algo.mapUvOnCustomAABB
- algo.mapUvOnCylinder
- algo.mapUvOnFittingCylinder
- algo.mapUvOnFittingSphere
- algo.mapUvOnMBB
- algo.mapUvOnPlane
- algo.mapUvOnSphere
- algo.mergeUVIslandsAffine
- algo.mergeUVIslandsRelaxed
- algo.normalizeUV
- algo.repackUV
- algo.unwrapUV
- algo.getFittingCylinder
- algo.getFittingSphere
- algo.convertNormalMap
- algo.remeshSurfacicHoles
- algo.repairMesh
- algo.orientPolygonFaces
- algo.orientPolygonFacesAdvanced
- cad.configureFunctionLogger
- cad.createHelixCurve
- cad.createCoEdge
- cad.createFace
- cad.createLoop
- cad.invertFaces
- core.configureFunctionLogger
- core.getEntitiesByType
- core.installLicense
- core.parallelStart
- core.getModuleDescFromXML
- core.endUndoRedoStep
- core.configureInterfaceLogger
- core.setLogFile
- geom.configureFunctionLogger
- io.configureFunctionLogger
- io.exportSelection
- io.splitPointCloud
- material.configureFunctionLogger
- material.copyMaterial
- material.createMaterial
- material.filterAO
- material.convertFloat32To8BitsImage
- material.convertImage
- material.fillUnusedPixels
- material.rotateImage
- material.stretchImage
- material.transformImage
- material.translateImage
- polygonal.configureFunctionLogger
- scene.cleanUnusedMaterials
- scene.configureFunctionLogger
- scene.createOccurrenceFromSelection
- scene.createSceneFromMeshes
- scene.getAABB
- scene.getActivePropertyValue
- scene.getActivePropertyValues
- scene.mergeMaterials
- scene.createCapsule
- scene.createCone
- scene.createCube
- scene.createCylinder
- scene.createPlane
- scene.createSphere
- scene.createTorus
- scene.findPartOccurrencesByMaximumSize
- scene.findPartOccurrencesInBox
- scene.setParent
- scene.mergePartOccurrencesByFinalAssemblies
- scene.mergePartOccurrencesByMaterials
- scene.convertPMIToOccurrences
- scene.createOccurrenceFromAnnotation
- scene.cleanInstances
- scene.getSelectedOccurrences
- scene.separateSelection
- scene.makeInstanceUnique
- scene.rake
- scene.resetTransform
- unity.configureFunctionLogger
- view.configureFunctionLogger
- view.playAnimation
- view.setAnimationLoop
- view.createStreamedViewer
- algo.bakeImpostor
- algo.createIndexMapFromOccurrences
- algo.createPointCloudKDTree
- algo.getVisualComparisonFootprint
- algo.createVisibilityInformation
- algo.findOccludedPartOccurrences
- algo.removeOccludedGeometries
- algo.retopologize
- algo.automaticUVMapping
- algo.mapUvOnAABB
- algo.mapUvOnMBB
- algo.createBillboard
- algo.repairMesh
- algo.requadify
- core.listTokens
- io.getExportFormats
- io.getFormatsDescriptions
- io.getImportFormats
- io.loadReferencedData
- material.findMaterialsByProperty
- material.applyFactorOnImage
- polygonal.getPolygonCount
- scene.deleteComponentByType
- scene.generateOctaViews
- scene.getComponent
- scene.getComponentByOccurrence
- scene.getComponents
- scene.getPolygonCount
- scene.getVertexCount
- scene.hasComponent
- scene.listComponents
- scene.resizeTextures
- scene.findOccurrencesByMetadata
- scene.findOccurrencesByMetadataValue
- scene.findOccurrencesByProperty
- scene.createSubTree
- scene.displayValueFromAnimChannelAtTime
- scene.alignPivotPointToWorld
- scene.movePivotPointToOccurrenceCenter
- scene.movePivotPointToOrigin
- scene.movePivotPointToTargetedOccurrenceCenter
- view.stopAllAnimation
- view.stopAnimation
- view.createGPUScene
- view.pickRectangle
- view.visibilityShoot
BoundedInteger
Fields
Type | Name | Default | Description |
|---|---|---|---|
| value | Int | 0 | |
| min | Int | 0 | |
| max | Int | 0 |
Byte
Functions accepting this type or a list of this type as a parameter:
ByteList
List of core.Byte
Functions accepting this type or a list of this type as a parameter:
CaptchaCallback
Functions accepting this type or a list of this type as a parameter:
Coeff
Base class: core.Double
Functions accepting this type or a list of this type as a parameter:
- algo.beginBakingSession
- algo.beginVertexBakingSession
- algo.convertSimilarPartOccurrencesToInstancesFast
- algo.findSimilarPartOccurrencesFast
- scene.createHierarchicalClusters
- algo.decimateEdgeCollapse
- algo.evalDecimateErrorForTarget
- algo.filletMesh
- algo.filterMeshVertexColors
- algo.findBestPivotBetweenOccurrences
- algo.getOptimalTextureResolution
- algo.getVisualComparisonFootprint
- algo.optimizeTextureSize
- algo.tessellate
- algo.tessellateRelativelyToAABB
- algo.bakeDepthMap
- algo.bakeValidityMap
- algo.convexDecomposition
- algo.createVisibilityInformation
- algo.createVisibilityInformationFromViewPoints
- algo.findOccludedPartOccurrences
- algo.removeOccludedGeometries
- algo.removeOccludedGeometriesFromPoints
- algo.removeOccludedGeometriesFromViewPoints
- algo.dualContouring
- algo.sawWithOctree
- algo.sawWithPlane
- algo.alignUVIslands
- algo.automaticUVMapping
- algo.mergeUVIslandsAffine
- algo.mergeUVIslandsRelaxed
- algo.scaleUV
- algo.unwrapUV
- algo.orientPolygonFacesFromCamera
- algo.createVertexWeightsFromVertexColors
- algo.createVertexWeightsFromVisibilityAttributes
- cad.createHyperbolaCurve
- cad.createIntersectionCurve
- cad.createNURBSCurve
- cad.createParabolaCurve
- cad.createPolylineCurve
- cad.invertCurve
- cad.createLinearExtrusion
- cad.createRevolveExtrusion
- cad.createBRepCone
- cad.createBRepCube
- cad.createBRepCylinder
- cad.createBRepPlane
- cad.createBRepSphere
- cad.createBRepTorus
- cad.evalCurvatureOnCurve
- cad.evalOnCurve
- cad.getParametricPrecisionOnSurface
- cad.invertOnCurve
- cad.invertOnSurface
- cad.projectOnCurve
- cad.projectOnSurface
- cad.createConeSurface
- cad.createEllipticConeSurface
- cad.createNURBSSurface
- cad.createOffsetSurface
- cad.createRevolutionSurface
- geom.orthographicMatrix
- geom.perspectiveMatrix
- io.splitPointCloud
- material.convertHeightMapToNormalMap
- material.filterAO
- material.getPointsAndMaterialFromText
- material.convertFloat32To8BitsImage
- material.getImageColorBilinear
- material.rotateImage
- material.stretchImage
- material.translateImage
- polygonal.createMeshFromText
- scene.createOccurrenceFromText
- scene.generateOctaViews
- scene.generateOctree
- scene.createCapsule
- scene.createCone
- scene.createCube
- scene.createCylinder
- scene.createImmersion
- scene.createPlane
- scene.createSphere
- scene.createTorus
- scene.addLightComponent
- scene.createLight
- scene.addKeyframe
- scene.decimateAnimChannelBySegment
- scene.updateSphereProber
- view.playAnimation
- view.setAnimationSpeed
Color
A Color defines a color RGB.
Fields
Type | Name | Default | Description |
|---|---|---|---|
| r | Double | 1 | |
| g | Double | 1 | |
| b | Double | 1 |
Functions accepting this type or a list of this type as a parameter:
ColorAlpha
A Color defines a color RGBA.
Fields
Type | Name | Default | Description |
|---|---|---|---|
| r | Double | 1 | |
| g | Double | 1 | |
| b | Double | 1 | |
| a | Double | 1 |
Functions accepting this type or a list of this type as a parameter:
- algo.bakeAOMap
- algo.bakeDepthMap
- algo.bakeDiffuseMap
- algo.bakeDisplacementMap
- algo.bakeEmissiveMap
- algo.bakeFeatureMap
- algo.bakeMaterialAOMap
- algo.bakeMaterialIdMap
- algo.bakeMaterialPropertyMap
- algo.bakeMetallicMap
- algo.bakeNormalMap
- algo.bakeOccurrencePropertyMap
- algo.bakeOpacityMap
- algo.bakePartIdMap
- algo.bakePositionMap
- algo.bakeRoughnessMap
- algo.bakeSpecularMap
- algo.bakeUVMap
- algo.bakeVertexColorMap
- material.setColorAlphaProperty
- material.setMaterialMainColor
- material.applyFactorOnImage
- material.createCheckerboardImage
- material.fillImageWithColor
- material.fillUnusedPixels
- polygonal.createMeshFromText
- scene.createOccurrenceFromText
ColorAlphaList
List of core.ColorAlpha
Functions accepting this type or a list of this type as a parameter:
ColorAlphaListList
List of core.ColorAlphaList
Functions accepting this type or a list of this type as a parameter:
ColorList
List of core.Color
ConstantDesc
Fields
Type | Name | Default | Description |
|---|---|---|---|
| name | String | ||
| value | String | ||
| type | TypeDesc | ||
| description | String |
ConstantDescList
List of core.ConstantDesc
Date
Fields
Type | Name | Default | Description |
|---|---|---|---|
| year | Int | 2015 | |
| month | Int | 1 | |
| day | Int | 1 |
DirectoryPath
Base class: core.String
Derived class: OutputDirectoryPath
Functions accepting this type or a list of this type as a parameter:
- material.createMaterialsFromMaps
- algo.configureFunctionLogger
- algo.bakeMaterialPropertyMap
- algo.bakeOccurrencePropertyMap
- algo.sawWithAABB
- algo.sawWithOBB
- algo.sawWithPlane
- cad.configureFunctionLogger
- core.configureFunctionLogger
- core.getEvent
- core.getEvents
- core.getFunction
- core.getFunctions
- core.getGroup
- core.getGroups
- core.getModuleTypes
- core.getType
- core.getTypeAttributes
- core.addWantedToken
- core.checkWebLogin
- core.configureLicenseServer
- core.needToken
- core.ownToken
- core.releaseToken
- core.releaseWebLicense
- core.removeWantedToken
- core.requestWebLicense
- core.retrieveWebLicenses
- core.tokenValid
- core.parallelStart
- core.removeModule
- core.pushProgression
- core.addCustomProperties
- core.addCustomProperty
- core.getModuleProperty
- core.getModulePropertyInfo
- core.getProperties
- core.getProperty
- core.getPropertyInfo
- core.hasCustomProperty
- core.hasProperty
- core.listModuleProperties
- core.removeCustomProperty
- core.restoreModulePropertyDefaultValue
- core.setModuleProperty
- core.setProperties
- core.setProperty
- core.unsetProperty
- core.startUndoRedoStep
- core.log
- geom.configureFunctionLogger
- io.configureFunctionLogger
- io.addAssetPaths
- io.findInDirectories
- io.setAssetPaths
- io.importRemote3mxFile
- io.registerIOCallbacks
- io.getExtensionPriority
- material.addUniformProperty
- material.configureFunctionLogger
- material.createCustomMaterialPattern
- material.createMaterial
- material.findCustomMaterialPatternByName
- material.findMaterialsByPattern
- material.findMaterialsByProperty
- material.getPointsAndMaterialFromText
- material.getUniformPropertyType
- material.setCoeffOrTextureProperty
- material.setColorAlphaProperty
- material.setColorOrTextureProperty
- material.setFragmentShader
- material.setMaterialPattern
- material.setVertexShader
- material.createImageFromData
- polygonal.configureFunctionLogger
- polygonal.createMeshFromText
- scene.configureFunctionLogger
- scene.createOccurrence
- scene.createOccurrenceFromSelection
- scene.createOccurrenceFromText
- scene.createOccurrences
- scene.getActivePropertyValue
- scene.getActivePropertyValues
- scene.setOccurrenceName
- scene.findOccurrencesByMetadata
- scene.findOccurrencesByProperty
- scene.createLight
- scene.addMetadata
- scene.addMetadataBlock
- scene.getMetadata
- scene.removeMetadata
- scene.createAlternativeTree
- scene.createAnimation
- scene.getSubChannel
- scene.linkPropertyToAnimation
- scene.unlinkPropertyToAnimation
- scene.addFilterToLibrary
- scene.findFilterByName
- scene.setReferencedDataComponentPath
- scene.addAnnotationGroup
- scene.addVariant
- scene.duplicateVariant
- unity.configureFunctionLogger
- view.configureFunctionLogger
- view.getViewerProperty
- view.getViewerPropertyInfo
- view.setViewerProperty
- view.startRecording
Double
Derived classes:
Functions accepting this type or a list of this type as a parameter:
- algo.decimateEdgeCollapse
- algo.evalDecimateErrorForTarget
- algo.filletMesh
- algo.filterMeshVertexColors
- algo.findBestPivotBetweenOccurrences
- algo.getOptimalTextureResolution
- algo.getVisualComparisonFootprint
- algo.optimizeTextureSize
- algo.tessellate
- algo.tessellateRelativelyToAABB
- algo.bakeDepthMap
- algo.bakeValidityMap
- algo.convexDecomposition
- algo.createVisibilityInformation
- algo.createVisibilityInformationFromViewPoints
- algo.findOccludedPartOccurrences
- algo.removeOccludedGeometries
- algo.removeOccludedGeometriesFromPoints
- algo.removeOccludedGeometriesFromViewPoints
- algo.dualContouring
- algo.sawWithOctree
- algo.sawWithPlane
- algo.alignUVIslands
- algo.automaticUVMapping
- algo.mergeUVIslandsAffine
- algo.mergeUVIslandsRelaxed
- algo.scaleUV
- algo.unwrapUV
- algo.orientPolygonFacesFromCamera
- algo.createVertexWeightsFromVertexColors
- algo.createVertexWeightsFromVisibilityAttributes
- cad.createHyperbolaCurve
- cad.createIntersectionCurve
- cad.createNURBSCurve
- cad.createParabolaCurve
- cad.createPolylineCurve
- cad.invertCurve
- cad.createLinearExtrusion
- cad.createRevolveExtrusion
- cad.createBRepCone
- cad.createBRepCube
- cad.createBRepCylinder
- cad.createBRepPlane
- cad.createBRepSphere
- cad.createBRepTorus
- cad.evalCurvatureOnCurve
- cad.evalOnCurve
- cad.getParametricPrecisionOnSurface
- cad.invertOnCurve
- cad.invertOnSurface
- cad.projectOnCurve
- cad.projectOnSurface
- cad.createConeSurface
- cad.createEllipticConeSurface
- cad.createNURBSSurface
- cad.createOffsetSurface
- cad.createRevolutionSurface
- geom.orthographicMatrix
- geom.perspectiveMatrix
- io.splitPointCloud
- material.convertHeightMapToNormalMap
- material.filterAO
- material.getPointsAndMaterialFromText
- material.convertFloat32To8BitsImage
- material.getImageColorBilinear
- material.rotateImage
- material.stretchImage
- material.translateImage
- polygonal.createMeshFromText
- scene.createOccurrenceFromText
- scene.generateOctaViews
- scene.generateOctree
- scene.createCapsule
- scene.createCone
- scene.createCube
- scene.createCylinder
- scene.createImmersion
- scene.createPlane
- scene.createSphere
- scene.createTorus
- scene.addLightComponent
- scene.createLight
- scene.addKeyframe
- scene.decimateAnimChannelBySegment
- scene.updateSphereProber
- view.playAnimation
- view.setAnimationSpeed
DoubleList
List of core.Double
Functions accepting this type or a list of this type as a parameter:
DoubleListList
List of core.DoubleList
Entity
An entity is the Pixyz base object. All objects manipulated in Pixyz are derived from Entity.
Base class: core.Ident
Derived classes:
- GeomEntity
- CustomMaterialPattern
- Image
- Material
- Joint
- TessellationAttribute
- AlternativeTree
- AnimChannel
- Animation
- Annotation
- AnnotationGroup
- Component
- Keyframe
- LOD
- ProductView
- Variant
Functions accepting this type or a list of this type as a parameter:
- core.cloneEntity
- core.deleteEntities
- core.entityExists
- core.getEntityType
- core.getEntityTypeString
- core.addCustomProperties
- core.addCustomProperty
- core.getProperties
- core.getProperty
- core.getPropertyInfo
- core.hasCustomProperty
- core.hasProperty
- core.listProperties
- core.listPropertiesBatch
- core.removeCustomProperty
- core.setProperties
- core.setProperty
- core.supportCustomProperties
- core.unsetProperty
- scene.linkPropertyToAnimation
- scene.unlinkPropertyToAnimation
EntityList
List of core.Entity
Functions accepting this type or a list of this type as a parameter:
- core.deleteEntities
- core.addCustomProperties
- core.getProperties
- core.listPropertiesBatch
- core.setProperties
EntityListList
List of core.EntityList
EntityType
Base class: core.UInt
Functions accepting this type or a list of this type as a parameter:
- core.createEntity
- core.getEntitiesByType
- algo.fetchBakedMap
- algo.fetchBakedVertex
- algo.automaticUVMapping
- algo.getUVQualityMetrics
- algo.hasOverlappingUV
- algo.repackUV
- core.getRedoStepUserData
- core.getUndoStepUserData
- core.redo
- core.undo
- scene.getSubpartMaterial
- scene.setSubpartMaterial
- scene.setSubpartMaterials
- scene.setLocalMatrices
- view.getCameraFrontAxis
- view.getCameraPosition
- view.getCameraRightAxis
- view.getCameraUpAxis
EnumPropertyInfo
Fields
Type | Name | Default | Description |
|---|---|---|---|
| name | String | ||
| values | IntList | ||
| labels | StringList |
EnumTypeDesc
Fields
Type | Name | Default | Description |
|---|---|---|---|
| values | IntList | ||
| labels | StringList | ||
| valueType | String |
EventDesc
Fields
Type | Name | Default | Description |
|---|---|---|---|
| module | String | ||
| name | String | ||
| description | String | ||
| parameters | ParameterDescList |
EventDescList
List of core.EventDesc
Field
Fields
Type | Name | Default | Description |
|---|---|---|---|
| name | String | ||
| type | String | ||
| module | String | ||
| defaultValue | String | ||
| description | String | ||
| disableValue | String | ||
| predefinedValues | StringPairList |
FieldList
List of core.Field
FilePath
Base class: core.String
Derived classes:
Functions accepting this type or a list of this type as a parameter:
- core.load
- core.installLicense
- core.getModuleDescFromXML
- io.importPicture
- io.importScene
- io.listVariants
- io.splitPointCloud
- material.importImage
- scene.exportFilterLibrary
- scene.importFilterLibrary
- algo.configureFunctionLogger
- algo.bakeMaterialPropertyMap
- algo.bakeOccurrencePropertyMap
- algo.sawWithAABB
- algo.sawWithOBB
- algo.sawWithPlane
- cad.configureFunctionLogger
- core.configureFunctionLogger
- core.getEvent
- core.getEvents
- core.getFunction
- core.getFunctions
- core.getGroup
- core.getGroups
- core.getModuleTypes
- core.getType
- core.getTypeAttributes
- core.addWantedToken
- core.checkWebLogin
- core.configureLicenseServer
- core.needToken
- core.ownToken
- core.releaseToken
- core.releaseWebLicense
- core.removeWantedToken
- core.requestWebLicense
- core.retrieveWebLicenses
- core.tokenValid
- core.parallelStart
- core.removeModule
- core.pushProgression
- core.addCustomProperties
- core.addCustomProperty
- core.getModuleProperty
- core.getModulePropertyInfo
- core.getProperties
- core.getProperty
- core.getPropertyInfo
- core.hasCustomProperty
- core.hasProperty
- core.listModuleProperties
- core.removeCustomProperty
- core.restoreModulePropertyDefaultValue
- core.setModuleProperty
- core.setProperties
- core.setProperty
- core.unsetProperty
- core.startUndoRedoStep
- core.log
- geom.configureFunctionLogger
- io.configureFunctionLogger
- io.addAssetPaths
- io.findInDirectories
- io.setAssetPaths
- io.importRemote3mxFile
- io.registerIOCallbacks
- io.getExtensionPriority
- material.addUniformProperty
- material.configureFunctionLogger
- material.createCustomMaterialPattern
- material.createMaterial
- material.findCustomMaterialPatternByName
- material.findMaterialsByPattern
- material.findMaterialsByProperty
- material.getPointsAndMaterialFromText
- material.getUniformPropertyType
- material.setCoeffOrTextureProperty
- material.setColorAlphaProperty
- material.setColorOrTextureProperty
- material.setFragmentShader
- material.setMaterialPattern
- material.setVertexShader
- material.createImageFromData
- polygonal.configureFunctionLogger
- polygonal.createMeshFromText
- scene.configureFunctionLogger
- scene.createOccurrence
- scene.createOccurrenceFromSelection
- scene.createOccurrenceFromText
- scene.createOccurrences
- scene.getActivePropertyValue
- scene.getActivePropertyValues
- scene.setOccurrenceName
- scene.findOccurrencesByMetadata
- scene.findOccurrencesByProperty
- scene.createLight
- scene.addMetadata
- scene.addMetadataBlock
- scene.getMetadata
- scene.removeMetadata
- scene.createAlternativeTree
- scene.createAnimation
- scene.getSubChannel
- scene.linkPropertyToAnimation
- scene.unlinkPropertyToAnimation
- scene.addFilterToLibrary
- scene.findFilterByName
- scene.setReferencedDataComponentPath
- scene.addAnnotationGroup
- scene.addVariant
- scene.duplicateVariant
- unity.configureFunctionLogger
- view.configureFunctionLogger
- view.getViewerProperty
- view.getViewerPropertyInfo
- view.setViewerProperty
- view.startRecording
FilePathList
List of core.FilePath
Functions accepting this type or a list of this type as a parameter:
Format
Fields
Type | Name | Default | Description |
|---|---|---|---|
| name | String | ||
| extensions | StringList |
FormatList
List of core.Format
FunctionDesc
Fields
Type | Name | Default | Description |
|---|---|---|---|
| name | String | ||
| module | String | ||
| parameters | ParameterDescList | ||
| returns | ParameterDescList | ||
| description | String | ||
| stability | Stability | STABLE |
FunctionDescList
List of core.FunctionDesc
GroupDesc
Fields
Type | Name | Default | Description |
|---|---|---|---|
| name | String | ||
| description | String | ||
| functions | FunctionDescList |
GroupDescList
List of core.GroupDesc
Ident
Derived classes:
Functions accepting this type or a list of this type as a parameter:
- core.releaseWebLicense
- core.requestWebLicense
- scene.getFilterExpression
- scene.getFilterFromLibrary
- scene.removeFilterFromLibrary
- scene.clearSelection
- scene.deleteSelection
- scene.deleteSelectionSnapshot
- scene.getSelectedOccurrences
- scene.getSelectedPolygonCount
- scene.invertOrientationSelection
- scene.invertSelect
- scene.invertSelection
- scene.select
- scene.separateSelection
- scene.unselect
- scene.updateRayProber
- scene.updateSphereProber
IdentPair
Fields
Type | Name | Default | Description |
|---|---|---|---|
| key | Ident | 0 | |
| value | Ident | 0 |
IdentPairList
List of core.IdentPair
InheritableBool
Enum
Name | Value |
|---|---|
| False | 0 |
| True | 1 |
| Inherited | 2 |
InheritableBoolList
List of core.InheritableBool
Int
Derived classes:
Functions accepting this type or a list of this type as a parameter:
- algo.bakeImpostor
- algo.crackMeshEdges
- algo.createIndexMapFromOccurrences
- algo.createPointCloudKDTree
- algo.createTangents
- algo.decimateTarget
- algo.deleteTextureCoordinates
- algo.filletMesh
- algo.getVisualComparisonFootprint
- algo.identifyLinesOfInterest
- algo.lineToTexture
- algo.loopSubdivMesh
- algo.setFeatureComponentMaxIndex
- algo.smoothMesh
- algo.sweep
- algo.tessellate
- algo.tessellatePointClouds
- algo.tessellateRelativelyToAABB
- algo.transferUV
- algo.bakeAOMap
- algo.bakeMaterialPropertyMap
- algo.bakeOccurrencePropertyMap
- algo.bakeUVMap
- algo.beginBakingSession
- algo.setBakingSessionPadding
- algo.convexDecomposition
- algo.explodeByVertexCount
- algo.createVisibilityInformation
- algo.createVisibilityInformationAdvanced
- algo.createVisibilityInformationFromViewPoints
- algo.findOccludedPartOccurrences
- algo.findOccludedPartOccurrencesAdvanced
- algo.removeOccludedGeometries
- algo.removeOccludedGeometriesAdvanced
- algo.removeOccludedGeometriesFromPoints
- algo.removeOccludedGeometriesFromViewPoints
- algo.createOcclusionMesh
- algo.marchingCubes
- algo.proxyMesh
- algo.retopologize
- algo.voxelize
- algo.sawWithOctree
- algo.convertSimilarPartOccurrencesToInstances
- algo.alignUVIslands
- algo.applyUvTransform
- algo.automaticUVMapping
- algo.copyUV
- algo.getRatioUV3D
- algo.getUvAabr
- algo.mapUvOnAABB
- algo.mapUvOnBox
- algo.mapUvOnCubicAABB
- algo.mapUvOnCustomAABB
- algo.mapUvOnCylinder
- algo.mapUvOnFittingCylinder
- algo.mapUvOnFittingSphere
- algo.mapUvOnMBB
- algo.mapUvOnPlane
- algo.mapUvOnSphere
- algo.mergeUVIslandsAffine
- algo.mergeUVIslandsRelaxed
- algo.normalizeUV
- algo.removeUV
- algo.repackUV
- algo.resizeUVsToTextureSize
- algo.scaleUV
- algo.swapUvChannels
- algo.unwrapUV
- algo.convertNormalMap
- algo.createBillboard
- algo.barySmooth
- algo.crackMoebiusStrips
- algo.remeshSurfacicHoles
- algo.orientPolygonFacesAdvanced
- algo.orientPolygonFacesFromCamera
- algo.equilateralize
- cad.createNURBSCurve
- cad.evalOnCurve
- cad.evalOnSurface
- cad.createBezierSurface
- cad.createNURBSSurface
- core.parallelStart
- core.pushProgression
- core.stepProgression
- core.listEnumLabels
- material.filterAO
- material.generateColorFromIndex
- material.generateUniqueColors
- material.getPointsAndMaterialFromText
- material.remapIndexMap
- material.blurImage
- material.createCheckerboardImage
- material.extractImageChannels
- material.fillImageWithColor
- material.fillUnusedPixels
- material.getImagePixelColor
- material.getSubImage
- material.resizeImage
- material.setImageRoI
- material.setSubImage
- polygonal.computeMeshVertexPositionsChecksum
- polygonal.computeUVTopoChecksum
- polygonal.computeUVVertexPositionsChecksum
- polygonal.dracoDecode
- polygonal.dracoEncode
- polygonal.createMeshFromText
- polygonal.hasNormalizedUVs
- polygonal.hasUVs
- scene.createOccurrenceFromText
- scene.generateOctaViews
- scene.renameLongOccurrenceName
- scene.createHierarchicalClusters
- scene.generateOctree
- scene.createCapsule
- scene.createCone
- scene.createCube
- scene.createCylinder
- scene.createImmersion
- scene.createPlane
- scene.createSphere
- scene.createTorus
- scene.findPartOccurrencesByMinimumNumberOfInstances
- scene.getSubTree
- scene.mergeOccurrencesByTreeLevel
- scene.setPartsTransformsIndexed
- unity.asyncPick
- unity.asyncResize
- unity.createUnityViewSession
- view.createViewer
- view.invertSelectPrimitives
- view.pick
- view.pickRectangle
- view.resizeViewer
- view.selectPrimitives
- view.unselectPrimitives
- view.createStreamedViewer
- view.resizeStreamedViewer
IntList
List of core.Int
Functions accepting this type or a list of this type as a parameter:
IntListList
List of core.IntList
LicenseInfos
Fields
Type | Name | Default | Description |
|---|---|---|---|
| version | String | ||
| customerName | String | ||
| customerCompany | String | ||
| customerEmail | String | ||
| isFloating | Boolean | False | |
| isRevocable | Boolean | False | |
| startDate | Date | ||
| endDate | Date | ||
| invalidReasons | StringList |
LicenseServerType
Type of license server.
Enum of core.Int
Name | Value |
|---|---|
| PIXYZ | 0 |
| FLEXLM | 1 |
| UNITY | 2 |
Functions accepting this type or a list of this type as a parameter:
ListTypeDesc
Fields
Type | Name | Default | Description |
|---|---|---|---|
| listType | String |
Long
ModuleDesc
Fields
Type | Name | Default | Description |
|---|---|---|---|
| name | String | ||
| description | String | ||
| author | String | ||
| groups | GroupDescList | ||
| types | TypeDescList | ||
| constants | ConstantDescList | ||
| dependencies | StringList | ||
| stability | Stability | STABLE |
ModuleDescList
List of core.ModuleDesc
None
OutputDirectoryPath
Base class: core.DirectoryPath
Functions accepting this type or a list of this type as a parameter:
- io.splitPointCloud
- material.createMaterialsFromMaps
- algo.configureFunctionLogger
- algo.bakeMaterialPropertyMap
- algo.bakeOccurrencePropertyMap
- algo.sawWithAABB
- algo.sawWithOBB
- algo.sawWithPlane
- cad.configureFunctionLogger
- core.configureFunctionLogger
- core.getEvent
- core.getEvents
- core.getFunction
- core.getFunctions
- core.getGroup
- core.getGroups
- core.getModuleTypes
- core.getType
- core.getTypeAttributes
- core.addWantedToken
- core.checkWebLogin
- core.configureLicenseServer
- core.needToken
- core.ownToken
- core.releaseToken
- core.releaseWebLicense
- core.removeWantedToken
- core.requestWebLicense
- core.retrieveWebLicenses
- core.tokenValid
- core.parallelStart
- core.removeModule
- core.pushProgression
- core.addCustomProperties
- core.addCustomProperty
- core.getModuleProperty
- core.getModulePropertyInfo
- core.getProperties
- core.getProperty
- core.getPropertyInfo
- core.hasCustomProperty
- core.hasProperty
- core.listModuleProperties
- core.removeCustomProperty
- core.restoreModulePropertyDefaultValue
- core.setModuleProperty
- core.setProperties
- core.setProperty
- core.unsetProperty
- core.startUndoRedoStep
- core.log
- geom.configureFunctionLogger
- io.configureFunctionLogger
- io.addAssetPaths
- io.findInDirectories
- io.setAssetPaths
- io.importRemote3mxFile
- io.registerIOCallbacks
- io.getExtensionPriority
- material.addUniformProperty
- material.configureFunctionLogger
- material.createCustomMaterialPattern
- material.createMaterial
- material.findCustomMaterialPatternByName
- material.findMaterialsByPattern
- material.findMaterialsByProperty
- material.getPointsAndMaterialFromText
- material.getUniformPropertyType
- material.setCoeffOrTextureProperty
- material.setColorAlphaProperty
- material.setColorOrTextureProperty
- material.setFragmentShader
- material.setMaterialPattern
- material.setVertexShader
- material.createImageFromData
- polygonal.configureFunctionLogger
- polygonal.createMeshFromText
- scene.configureFunctionLogger
- scene.createOccurrence
- scene.createOccurrenceFromSelection
- scene.createOccurrenceFromText
- scene.createOccurrences
- scene.getActivePropertyValue
- scene.getActivePropertyValues
- scene.setOccurrenceName
- scene.findOccurrencesByMetadata
- scene.findOccurrencesByProperty
- scene.createLight
- scene.addMetadata
- scene.addMetadataBlock
- scene.getMetadata
- scene.removeMetadata
- scene.createAlternativeTree
- scene.createAnimation
- scene.getSubChannel
- scene.linkPropertyToAnimation
- scene.unlinkPropertyToAnimation
- scene.addFilterToLibrary
- scene.findFilterByName
- scene.setReferencedDataComponentPath
- scene.addAnnotationGroup
- scene.addVariant
- scene.duplicateVariant
- unity.configureFunctionLogger
- view.configureFunctionLogger
- view.getViewerProperty
- view.getViewerPropertyInfo
- view.setViewerProperty
- view.startRecording
OutputFilePath
Base class: core.FilePath
Derived class: ExportFilePath
Functions accepting this type or a list of this type as a parameter:
- core.save
- core.generateActivationCode
- core.generateDeactivationCode
- core.setCoreDumpFile
- core.setLogFile
- io.exportScene
- io.exportSelection
- material.exportImage
- view.takeScreenshot
- core.load
- core.installLicense
- core.getModuleDescFromXML
- io.importPicture
- io.importScene
- io.listVariants
- io.splitPointCloud
- material.importImage
- scene.exportFilterLibrary
- scene.importFilterLibrary
- algo.configureFunctionLogger
- algo.bakeMaterialPropertyMap
- algo.bakeOccurrencePropertyMap
- algo.sawWithAABB
- algo.sawWithOBB
- algo.sawWithPlane
- cad.configureFunctionLogger
- core.configureFunctionLogger
- core.getEvent
- core.getEvents
- core.getFunction
- core.getFunctions
- core.getGroup
- core.getGroups
- core.getModuleTypes
- core.getType
- core.getTypeAttributes
- core.addWantedToken
- core.checkWebLogin
- core.configureLicenseServer
- core.needToken
- core.ownToken
- core.releaseToken
- core.releaseWebLicense
- core.removeWantedToken
- core.requestWebLicense
- core.retrieveWebLicenses
- core.tokenValid
- core.parallelStart
- core.removeModule
- core.pushProgression
- core.addCustomProperties
- core.addCustomProperty
- core.getModuleProperty
- core.getModulePropertyInfo
- core.getProperties
- core.getProperty
- core.getPropertyInfo
- core.hasCustomProperty
- core.hasProperty
- core.listModuleProperties
- core.removeCustomProperty
- core.restoreModulePropertyDefaultValue
- core.setModuleProperty
- core.setProperties
- core.setProperty
- core.unsetProperty
- core.startUndoRedoStep
- core.log
- geom.configureFunctionLogger
- io.configureFunctionLogger
- io.addAssetPaths
- io.findInDirectories
- io.setAssetPaths
- io.importRemote3mxFile
- io.registerIOCallbacks
- io.getExtensionPriority
- material.addUniformProperty
- material.configureFunctionLogger
- material.createCustomMaterialPattern
- material.createMaterial
- material.findCustomMaterialPatternByName
- material.findMaterialsByPattern
- material.findMaterialsByProperty
- material.getPointsAndMaterialFromText
- material.getUniformPropertyType
- material.setCoeffOrTextureProperty
- material.setColorAlphaProperty
- material.setColorOrTextureProperty
- material.setFragmentShader
- material.setMaterialPattern
- material.setVertexShader
- material.createImageFromData
- polygonal.configureFunctionLogger
- polygonal.createMeshFromText
- scene.configureFunctionLogger
- scene.createOccurrence
- scene.createOccurrenceFromSelection
- scene.createOccurrenceFromText
- scene.createOccurrences
- scene.getActivePropertyValue
- scene.getActivePropertyValues
- scene.setOccurrenceName
- scene.findOccurrencesByMetadata
- scene.findOccurrencesByProperty
- scene.createLight
- scene.addMetadata
- scene.addMetadataBlock
- scene.getMetadata
- scene.removeMetadata
- scene.createAlternativeTree
- scene.createAnimation
- scene.getSubChannel
- scene.linkPropertyToAnimation
- scene.unlinkPropertyToAnimation
- scene.addFilterToLibrary
- scene.findFilterByName
- scene.setReferencedDataComponentPath
- scene.addAnnotationGroup
- scene.addVariant
- scene.duplicateVariant
- unity.configureFunctionLogger
- view.configureFunctionLogger
- view.getViewerProperty
- view.getViewerPropertyInfo
- view.setViewerProperty
- view.startRecording
ParallelCallback
Functions accepting this type or a list of this type as a parameter:
ParallelSession
Base class: core.Ptr
Functions accepting this type or a list of this type as a parameter:
- core.parallelAddJob
- core.parallelFinish
- core.parallelAddJob
- material.setMaterialUserData
- material.setMultipleMaterialUserData
- scene.setMultipleOccurrenceUserData
- scene.setOccurrenceUserData
- scene.setPartUserData
ParameterDesc
Fields
Type | Name | Default | Description |
|---|---|---|---|
| name | String | ||
| type | TypeDesc | ||
| description | String | ||
| optional | Bool | False | |
| defaultValue | String | ||
| disableValue | String | ||
| attributes | StringPairList | ||
| predefinedValues | StringPairList |
ParameterDescList
List of core.ParameterDesc
Password
Base class: core.String
Functions accepting this type or a list of this type as a parameter:
- core.checkWebLogin
- core.releaseWebLicense
- core.requestWebLicense
- core.retrieveWebLicenses
- algo.configureFunctionLogger
- algo.bakeMaterialPropertyMap
- algo.bakeOccurrencePropertyMap
- algo.sawWithAABB
- algo.sawWithOBB
- algo.sawWithPlane
- cad.configureFunctionLogger
- core.configureFunctionLogger
- core.getEvent
- core.getEvents
- core.getFunction
- core.getFunctions
- core.getGroup
- core.getGroups
- core.getModuleTypes
- core.getType
- core.getTypeAttributes
- core.addWantedToken
- core.checkWebLogin
- core.configureLicenseServer
- core.needToken
- core.ownToken
- core.releaseToken
- core.releaseWebLicense
- core.removeWantedToken
- core.requestWebLicense
- core.retrieveWebLicenses
- core.tokenValid
- core.parallelStart
- core.removeModule
- core.pushProgression
- core.addCustomProperties
- core.addCustomProperty
- core.getModuleProperty
- core.getModulePropertyInfo
- core.getProperties
- core.getProperty
- core.getPropertyInfo
- core.hasCustomProperty
- core.hasProperty
- core.listModuleProperties
- core.removeCustomProperty
- core.restoreModulePropertyDefaultValue
- core.setModuleProperty
- core.setProperties
- core.setProperty
- core.unsetProperty
- core.startUndoRedoStep
- core.log
- geom.configureFunctionLogger
- io.configureFunctionLogger
- io.addAssetPaths
- io.findInDirectories
- io.setAssetPaths
- io.importRemote3mxFile
- io.registerIOCallbacks
- io.getExtensionPriority
- material.addUniformProperty
- material.configureFunctionLogger
- material.createCustomMaterialPattern
- material.createMaterial
- material.findCustomMaterialPatternByName
- material.findMaterialsByPattern
- material.findMaterialsByProperty
- material.getPointsAndMaterialFromText
- material.getUniformPropertyType
- material.setCoeffOrTextureProperty
- material.setColorAlphaProperty
- material.setColorOrTextureProperty
- material.setFragmentShader
- material.setMaterialPattern
- material.setVertexShader
- material.createImageFromData
- polygonal.configureFunctionLogger
- polygonal.createMeshFromText
- scene.configureFunctionLogger
- scene.createOccurrence
- scene.createOccurrenceFromSelection
- scene.createOccurrenceFromText
- scene.createOccurrences
- scene.getActivePropertyValue
- scene.getActivePropertyValues
- scene.setOccurrenceName
- scene.findOccurrencesByMetadata
- scene.findOccurrencesByProperty
- scene.createLight
- scene.addMetadata
- scene.addMetadataBlock
- scene.getMetadata
- scene.removeMetadata
- scene.createAlternativeTree
- scene.createAnimation
- scene.getSubChannel
- scene.linkPropertyToAnimation
- scene.unlinkPropertyToAnimation
- scene.addFilterToLibrary
- scene.findFilterByName
- scene.setReferencedDataComponentPath
- scene.addAnnotationGroup
- scene.addVariant
- scene.duplicateVariant
- unity.configureFunctionLogger
- view.configureFunctionLogger
- view.getViewerProperty
- view.getViewerPropertyInfo
- view.setViewerProperty
- view.startRecording
Percent
Base class: core.Double
Functions accepting this type or a list of this type as a parameter:
- algo.decimateEdgeCollapse
- algo.evalDecimateErrorForTarget
- algo.filletMesh
- algo.filterMeshVertexColors
- algo.findBestPivotBetweenOccurrences
- algo.getOptimalTextureResolution
- algo.getVisualComparisonFootprint
- algo.optimizeTextureSize
- algo.tessellate
- algo.tessellateRelativelyToAABB
- algo.bakeDepthMap
- algo.bakeValidityMap
- algo.convexDecomposition
- algo.createVisibilityInformation
- algo.createVisibilityInformationFromViewPoints
- algo.findOccludedPartOccurrences
- algo.removeOccludedGeometries
- algo.removeOccludedGeometriesFromPoints
- algo.removeOccludedGeometriesFromViewPoints
- algo.dualContouring
- algo.sawWithOctree
- algo.sawWithPlane
- algo.alignUVIslands
- algo.automaticUVMapping
- algo.mergeUVIslandsAffine
- algo.mergeUVIslandsRelaxed
- algo.scaleUV
- algo.unwrapUV
- algo.orientPolygonFacesFromCamera
- algo.createVertexWeightsFromVertexColors
- algo.createVertexWeightsFromVisibilityAttributes
- cad.createHyperbolaCurve
- cad.createIntersectionCurve
- cad.createNURBSCurve
- cad.createParabolaCurve
- cad.createPolylineCurve
- cad.invertCurve
- cad.createLinearExtrusion
- cad.createRevolveExtrusion
- cad.createBRepCone
- cad.createBRepCube
- cad.createBRepCylinder
- cad.createBRepPlane
- cad.createBRepSphere
- cad.createBRepTorus
- cad.evalCurvatureOnCurve
- cad.evalOnCurve
- cad.getParametricPrecisionOnSurface
- cad.invertOnCurve
- cad.invertOnSurface
- cad.projectOnCurve
- cad.projectOnSurface
- cad.createConeSurface
- cad.createEllipticConeSurface
- cad.createNURBSSurface
- cad.createOffsetSurface
- cad.createRevolutionSurface
- geom.orthographicMatrix
- geom.perspectiveMatrix
- io.splitPointCloud
- material.convertHeightMapToNormalMap
- material.filterAO
- material.getPointsAndMaterialFromText
- material.convertFloat32To8BitsImage
- material.getImageColorBilinear
- material.rotateImage
- material.stretchImage
- material.translateImage
- polygonal.createMeshFromText
- scene.createOccurrenceFromText
- scene.generateOctaViews
- scene.generateOctree
- scene.createCapsule
- scene.createCone
- scene.createCube
- scene.createCylinder
- scene.createImmersion
- scene.createPlane
- scene.createSphere
- scene.createTorus
- scene.addLightComponent
- scene.createLight
- scene.addKeyframe
- scene.decimateAnimChannelBySegment
- scene.updateSphereProber
- view.playAnimation
- view.setAnimationSpeed
PropertyInfo
Fields
Type | Name | Default | Description |
|---|---|---|---|
| name | String | ||
| type | PropertyType | UNKNOWN | |
| subType | Int | 0 | The sub type in only filled when type is 'ENTITY' or 'ENUM'. |
| value | String | ||
| user | Boolean | False | |
| defaultValue | String | ||
| editable | Boolean | True | |
| isSet | Boolean | False | |
| delegated | Boolean | False | |
| delegatedOwnerEntity | Entity | False | |
| group | String | ||
| description | String |
PropertyInfoList
List of core.PropertyInfo
PropertyInfoListList
List of core.PropertyInfoList
PropertyType
Enumeration of all property types.
Enum of core.Long
Name | Value |
|---|---|
| STRING | 0 |
| STRINGLIST | 1 |
| INTEGER | 2 |
| BOUNDED_INTEGER | 3 |
| UNSIGNED_INTEGER | 4 |
| SHORT | 5 |
| UNSIGNED_SHORT | 6 |
| IDENTIFIER | 7 |
| IDENTIFIERLIST | 8 |
| BOOLEAN | 9 |
| INHERITABLEBOOL | 10 |
| REAL | 11 |
| REALLIST | 12 |
| COEFF | 13 |
| PERCENT | 14 |
| COLOR | 15 |
| COLOR_ALPHA | 16 |
| DATE | 17 |
| ANGLE | 18 |
| DISTANCE | 19 |
| MACHINEID | 20 |
| MACHINEIDLIST | 21 |
| SOCKET_PROTOCOL | 22 |
| POINT2 | 23 |
| POINT3 | 24 |
| AXIS3 | 25 |
| VECTOR3 | 26 |
| POINT3LIST | 27 |
| POINT4 | 28 |
| POINT4LIST | 29 |
| MATRIX4 | 30 |
| QUATERNION | 31 |
| BOUNDS1D | 32 |
| BOUNDS2D | 33 |
| TEXTUREDEF | 34 |
| COLORORTEXTURE | 35 |
| COEFFORTEXTURE | 36 |
| ENTITY | 37 |
| FILEPATH | 38 |
| AABB | 39 |
| ENUM | 40 |
| UNKNOWN | 41 |
Functions accepting this type or a list of this type as a parameter:
PropertyTypeList
List of core.PropertyType
Functions accepting this type or a list of this type as a parameter:
Ptr
Derived classes:
- ParallelSession
- ID3D11Device
- ID3D11RenderTargetView
- ID3D11Resource
- ID3D11ShaderResourceView
- UnityRenderBuffer
- UnityRenderingEvent
- UnityRenderingEventAndData
- VulkanDevice
- D3D11Texture
- VulkanTexture
Functions accepting this type or a list of this type as a parameter:
- core.parallelAddJob
- material.setMaterialUserData
- material.setMultipleMaterialUserData
- scene.setMultipleOccurrenceUserData
- scene.setOccurrenceUserData
- scene.setPartUserData
PtrList
List of core.Ptr
Functions accepting this type or a list of this type as a parameter:
Real
Base class: core.Double
Functions accepting this type or a list of this type as a parameter:
- scene.getPartOccurrencesGroupedBySimilarity
- scene.findDuplicatedPartOccurrences
- algo.decimateEdgeCollapse
- algo.evalDecimateErrorForTarget
- algo.filletMesh
- algo.filterMeshVertexColors
- algo.findBestPivotBetweenOccurrences
- algo.getOptimalTextureResolution
- algo.getVisualComparisonFootprint
- algo.optimizeTextureSize
- algo.tessellate
- algo.tessellateRelativelyToAABB
- algo.bakeDepthMap
- algo.bakeValidityMap
- algo.convexDecomposition
- algo.createVisibilityInformation
- algo.createVisibilityInformationFromViewPoints
- algo.findOccludedPartOccurrences
- algo.removeOccludedGeometries
- algo.removeOccludedGeometriesFromPoints
- algo.removeOccludedGeometriesFromViewPoints
- algo.dualContouring
- algo.sawWithOctree
- algo.sawWithPlane
- algo.alignUVIslands
- algo.automaticUVMapping
- algo.mergeUVIslandsAffine
- algo.mergeUVIslandsRelaxed
- algo.scaleUV
- algo.unwrapUV
- algo.orientPolygonFacesFromCamera
- algo.createVertexWeightsFromVertexColors
- algo.createVertexWeightsFromVisibilityAttributes
- cad.createHyperbolaCurve
- cad.createIntersectionCurve
- cad.createNURBSCurve
- cad.createParabolaCurve
- cad.createPolylineCurve
- cad.invertCurve
- cad.createLinearExtrusion
- cad.createRevolveExtrusion
- cad.createBRepCone
- cad.createBRepCube
- cad.createBRepCylinder
- cad.createBRepPlane
- cad.createBRepSphere
- cad.createBRepTorus
- cad.evalCurvatureOnCurve
- cad.evalOnCurve
- cad.getParametricPrecisionOnSurface
- cad.invertOnCurve
- cad.invertOnSurface
- cad.projectOnCurve
- cad.projectOnSurface
- cad.createConeSurface
- cad.createEllipticConeSurface
- cad.createNURBSSurface
- cad.createOffsetSurface
- cad.createRevolutionSurface
- geom.orthographicMatrix
- geom.perspectiveMatrix
- io.splitPointCloud
- material.convertHeightMapToNormalMap
- material.filterAO
- material.getPointsAndMaterialFromText
- material.convertFloat32To8BitsImage
- material.getImageColorBilinear
- material.rotateImage
- material.stretchImage
- material.translateImage
- polygonal.createMeshFromText
- scene.createOccurrenceFromText
- scene.generateOctaViews
- scene.generateOctree
- scene.createCapsule
- scene.createCone
- scene.createCube
- scene.createCylinder
- scene.createImmersion
- scene.createPlane
- scene.createSphere
- scene.createTorus
- scene.addLightComponent
- scene.createLight
- scene.addKeyframe
- scene.decimateAnimChannelBySegment
- scene.updateSphereProber
- view.playAnimation
- view.setAnimationSpeed
Regex
Regular expression using the ECMAScript syntax.
Base class: core.String
Functions accepting this type or a list of this type as a parameter:
- material.findMaterialsByProperty
- scene.findOccurrencesByMetadata
- scene.findOccurrencesByMetadataValue
- scene.findOccurrencesByProperty
- algo.configureFunctionLogger
- algo.bakeMaterialPropertyMap
- algo.bakeOccurrencePropertyMap
- algo.sawWithAABB
- algo.sawWithOBB
- algo.sawWithPlane
- cad.configureFunctionLogger
- core.configureFunctionLogger
- core.getEvent
- core.getEvents
- core.getFunction
- core.getFunctions
- core.getGroup
- core.getGroups
- core.getModuleTypes
- core.getType
- core.getTypeAttributes
- core.addWantedToken
- core.checkWebLogin
- core.configureLicenseServer
- core.needToken
- core.ownToken
- core.releaseToken
- core.releaseWebLicense
- core.removeWantedToken
- core.requestWebLicense
- core.retrieveWebLicenses
- core.tokenValid
- core.parallelStart
- core.removeModule
- core.pushProgression
- core.addCustomProperties
- core.addCustomProperty
- core.getModuleProperty
- core.getModulePropertyInfo
- core.getProperties
- core.getProperty
- core.getPropertyInfo
- core.hasCustomProperty
- core.hasProperty
- core.listModuleProperties
- core.removeCustomProperty
- core.restoreModulePropertyDefaultValue
- core.setModuleProperty
- core.setProperties
- core.setProperty
- core.unsetProperty
- core.startUndoRedoStep
- core.log
- geom.configureFunctionLogger
- io.configureFunctionLogger
- io.addAssetPaths
- io.findInDirectories
- io.setAssetPaths
- io.importRemote3mxFile
- io.registerIOCallbacks
- io.getExtensionPriority
- material.addUniformProperty
- material.configureFunctionLogger
- material.createCustomMaterialPattern
- material.createMaterial
- material.findCustomMaterialPatternByName
- material.findMaterialsByPattern
- material.findMaterialsByProperty
- material.getPointsAndMaterialFromText
- material.getUniformPropertyType
- material.setCoeffOrTextureProperty
- material.setColorAlphaProperty
- material.setColorOrTextureProperty
- material.setFragmentShader
- material.setMaterialPattern
- material.setVertexShader
- material.createImageFromData
- polygonal.configureFunctionLogger
- polygonal.createMeshFromText
- scene.configureFunctionLogger
- scene.createOccurrence
- scene.createOccurrenceFromSelection
- scene.createOccurrenceFromText
- scene.createOccurrences
- scene.getActivePropertyValue
- scene.getActivePropertyValues
- scene.setOccurrenceName
- scene.findOccurrencesByMetadata
- scene.findOccurrencesByProperty
- scene.createLight
- scene.addMetadata
- scene.addMetadataBlock
- scene.getMetadata
- scene.removeMetadata
- scene.createAlternativeTree
- scene.createAnimation
- scene.getSubChannel
- scene.linkPropertyToAnimation
- scene.unlinkPropertyToAnimation
- scene.addFilterToLibrary
- scene.findFilterByName
- scene.setReferencedDataComponentPath
- scene.addAnnotationGroup
- scene.addVariant
- scene.duplicateVariant
- unity.configureFunctionLogger
- view.configureFunctionLogger
- view.getViewerProperty
- view.getViewerPropertyInfo
- view.setViewerProperty
- view.startRecording
SelType
Fields
Type | Name | Default | Description |
|---|---|---|---|
| name | String | ||
| type | String | ||
| defaultValue | String | ||
| description | String |
SelTypeList
List of core.SelType
SelectTypeDesc
Fields
Type | Name | Default | Description |
|---|---|---|---|
| types | SelTypeList |
Short
Stability
Describes the level of maturity of a module/function.
Enum of core.Long
Name | Value |
|---|---|
| DEVELOPMENT | 0 |
| EXPERIMENTAL | 1 |
| BETA | 2 |
| STABLE | 3 |
| DEPRECATED | 4 |
| OBSOLETE | 5 |
String
Derived classes:
Functions accepting this type or a list of this type as a parameter:
- algo.configureFunctionLogger
- algo.bakeMaterialPropertyMap
- algo.bakeOccurrencePropertyMap
- algo.sawWithAABB
- algo.sawWithOBB
- algo.sawWithPlane
- cad.configureFunctionLogger
- core.configureFunctionLogger
- core.getEvent
- core.getEvents
- core.getFunction
- core.getFunctions
- core.getGroup
- core.getGroups
- core.getModuleTypes
- core.getType
- core.getTypeAttributes
- core.addWantedToken
- core.checkWebLogin
- core.configureLicenseServer
- core.needToken
- core.ownToken
- core.releaseToken
- core.releaseWebLicense
- core.removeWantedToken
- core.requestWebLicense
- core.retrieveWebLicenses
- core.tokenValid
- core.parallelStart
- core.removeModule
- core.pushProgression
- core.addCustomProperties
- core.addCustomProperty
- core.getModuleProperty
- core.getModulePropertyInfo
- core.getProperties
- core.getProperty
- core.getPropertyInfo
- core.hasCustomProperty
- core.hasProperty
- core.listModuleProperties
- core.removeCustomProperty
- core.restoreModulePropertyDefaultValue
- core.setModuleProperty
- core.setProperties
- core.setProperty
- core.unsetProperty
- core.startUndoRedoStep
- core.log
- geom.configureFunctionLogger
- io.configureFunctionLogger
- io.addAssetPaths
- io.findInDirectories
- io.setAssetPaths
- io.importRemote3mxFile
- io.registerIOCallbacks
- io.getExtensionPriority
- material.addUniformProperty
- material.configureFunctionLogger
- material.createCustomMaterialPattern
- material.createMaterial
- material.findCustomMaterialPatternByName
- material.findMaterialsByPattern
- material.findMaterialsByProperty
- material.getPointsAndMaterialFromText
- material.getUniformPropertyType
- material.setCoeffOrTextureProperty
- material.setColorAlphaProperty
- material.setColorOrTextureProperty
- material.setFragmentShader
- material.setMaterialPattern
- material.setVertexShader
- material.createImageFromData
- polygonal.configureFunctionLogger
- polygonal.createMeshFromText
- scene.configureFunctionLogger
- scene.createOccurrence
- scene.createOccurrenceFromSelection
- scene.createOccurrenceFromText
- scene.createOccurrences
- scene.getActivePropertyValue
- scene.getActivePropertyValues
- scene.setOccurrenceName
- scene.findOccurrencesByMetadata
- scene.findOccurrencesByProperty
- scene.createLight
- scene.addMetadata
- scene.addMetadataBlock
- scene.getMetadata
- scene.removeMetadata
- scene.createAlternativeTree
- scene.createAnimation
- scene.getSubChannel
- scene.linkPropertyToAnimation
- scene.unlinkPropertyToAnimation
- scene.addFilterToLibrary
- scene.findFilterByName
- scene.setReferencedDataComponentPath
- scene.addAnnotationGroup
- scene.addVariant
- scene.duplicateVariant
- unity.configureFunctionLogger
- view.configureFunctionLogger
- view.getViewerProperty
- view.getViewerPropertyInfo
- view.setViewerProperty
- view.startRecording
StringList
List of core.String
Functions accepting this type or a list of this type as a parameter:
- core.addCustomProperties
- core.setProperties
- io.addAssetPaths
- io.setAssetPaths
- scene.addMetadataBlock
StringPair
Fields
Type | Name | Default | Description |
|---|---|---|---|
| key | String | ||
| value | String |
StringPairList
List of core.StringPair
StringPairListList
List of core.StringPairList
StructTypeDesc
Fields
Type | Name | Default | Description |
|---|---|---|---|
| fields | FieldList |
TypeDesc
Fields
Type | Name | Default | Description |
|---|---|---|---|
| name | String | ||
| module | String | ||
| type | TypeDescType | UNKNOWN | |
| description | String | ||
| definition | TypeDescDef |
TypeDescDef
Select between:
- baseType: core.None
- aliasType: core.AliasTypeDesc
- enumType: core.EnumTypeDesc
- listType: core.ListTypeDesc
- arrayType: core.ArrayTypeDesc
- structType: core.StructTypeDesc
- selectType: core.SelectTypeDesc
TypeDescList
List of core.TypeDesc
TypeDescType
Enum of core.Long
Name | Value |
|---|---|
| UNKNOWN | 0 |
| BASE | 1 |
| ALIAS | 2 |
| ENUM | 3 |
| LIST | 4 |
| STRUCT | 5 |
| ARRAY | 6 |
| SELECT | 7 |
| FUNCPTR | 8 |
UInt
Derived classes:
Functions accepting this type or a list of this type as a parameter:
- algo.fetchBakedMap
- algo.fetchBakedVertex
- algo.automaticUVMapping
- algo.getUVQualityMetrics
- algo.hasOverlappingUV
- algo.repackUV
- core.getRedoStepUserData
- core.getUndoStepUserData
- core.redo
- core.undo
- scene.getSubpartMaterial
- scene.setSubpartMaterial
- scene.setSubpartMaterials
- scene.setLocalMatrices
- view.getCameraFrontAxis
- view.getCameraPosition
- view.getCameraRightAxis
- view.getCameraUpAxis
ULong
Derived class: AnimationTime
Functions accepting this type or a list of this type as a parameter:
ULongList
List of core.ULong
Functions accepting this type or a list of this type as a parameter:
UShort
Functions accepting this type or a list of this type as a parameter:
Verbose
The verbose level defines the amount of information shown in outputs.
Enum of core.Long
Name | Value |
|---|---|
| ERR | 0 |
| WARNING | 1 |
| INFO | 2 |
| SCRIPT | 5 |
Functions accepting this type or a list of this type as a parameter:
- core.addConsoleVerbose
- core.addLogFileVerbose
- core.addSessionLogFileVerbose
- core.hasConsoleVerbose
- core.log
- core.removeConsoleVerbose
- core.removeLogFileVerbose
- core.removeSessionLogFileVerbose
WebLicenseInfo
Fields
Type | Name | Default | Description |
|---|---|---|---|
| id | Ident | 0 | |
| product | String | ||
| validity | Date | ||
| count | Int | 0 | |
| inUse | Int | 0 | |
| revoke | Int | -1 | |
| description | String | ||
| onMachine | Bool | False | |
| current | Bool | False |
WebLicenseInfoList
List of core.WebLicenseInfo