View
Python API types
Read time 9 minutesLast updated a day ago
AnimationPlayerInfo
FieldsType | Name | Default | Description |
|---|---|---|---|
| isPlaying | Bool | False | |
| isLooping | Bool | False | |
| currentFrame | Scene.AnimationTime | 0 | |
| speed | Double | 0. |
CameraType
Enum of core.LongName | Value |
|---|---|
| Perspective | 0 |
| Orthographic | 1 |
D3D11Texture
Base class: core.Ptr- core.parallelAddJob
- material.setMaterialUserData
- material.setMultipleMaterialUserData
- scene.setMultipleOccurrenceUserData
- scene.setOccurrenceUserData
EncoderSettings
FieldsType | Name | Default | Description |
|---|---|---|---|
| frameRate | UInt | 30 | Specifies the frame rate used for encoding in frames per second. |
| averageBitRate | UInt | 2500000 | Specifies the average bitrate(in bits/sec) used for encoding. |
| maxBitRate | UInt | 2500000 | Specifies the maximum bitrate for the encoded output. This is used for VBR and ignored for CBR mode. |
| rateControl | RateControl | CONSTQP | Specifies the rate control mode. (Constant QP Mode, Constant bitrate mode, Variable bitrate mode. |
| qp | QP | Specifies the initial QP to be used for encoding, these values would be used for all frames if in Constant QP mode. | |
| targetQuality | UInt | 0 | Target CQ (Constant Quality) level for VBR mode (range 0-51 with 0-automatic). |
GLTextureHandle
Base class: core.Int- 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.fillUnusedPixels
- material.filterAO
- material.generateColorFromIndex
- material.generateUniqueColors
- material.getImagePixelColor
- material.getPointsAndMaterialFromText
- material.remapIndexMap
- material.resizeImage
- 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
GPUScene
Base class: core.Int- view.destroyGPUScene
- view.getLastAABB
- view.getOccurrenceIndex
- view.getSceneIndex
- view.lockGPUSceneUpdate
- view.lockGPUScenesUpdate
- view.tryLockGPUSceneUpdate
- view.tryLockGPUScenesUpdate
- view.unlockGPUSceneUpdate
- view.unlockGPUScenesUpdate
- view.addGPUScene
- view.identifySelectedEdges
- view.removeGPUScene
- 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.fillUnusedPixels
- material.filterAO
- material.generateColorFromIndex
- material.generateUniqueColors
- material.getImagePixelColor
- material.getPointsAndMaterialFromText
- material.remapIndexMap
- material.resizeImage
- 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
GPUSceneList
List of view.GPUScene Functions accepting this type or a list of this type as a parameter:GraphicAPI
Enum of core.LongName | Value |
|---|---|
| None | 0 |
| OpenGL | 1 |
| D3D11 | 2 |
| Vulkan | 3 |
| OpenGL_GLX | 4 |
| OpenGL_EGL | 5 |
GraphicsContext
FieldsType | Name | Default | Description |
|---|---|---|---|
| api | GraphicAPI | None | |
| context | Ptr | nullptr |
PrimitiveSelectionType
Enum of core.LongName | Value |
|---|---|
| Polygon | 0 |
| Patch | 1 |
| ConnectedMesh | 2 |
| Edge | 3 |
QP
FieldsType | Name | Default | Description |
|---|---|---|---|
| qpInterP | UInt | 28 | Specifies QP value for P-frame. |
| qpInterB | UInt | 31 | Specifies QP value for B-frame. |
| qpIntra | UInt | 25 | Specifies QP value Intra Frame. |
RateControl
Enum of core.LongName | Value |
|---|---|
| CONSTQP | 0 |
| CBR | 1 |
| VBR | 2 |
RenderMap
Enum of core.LongName | Value |
|---|---|
| Composited | 0 |
| AlbedoOpacity | 1 |
| Normal | 2 |
| Depth | 3 |
| MetallicRoughnessAOMisc | 4 |
| Emissive | 5 |
| ObjectIdPrimitiveId | 6 |
| UVs | 7 |
| SSAO | 8 |
| IndirectLighting | 9 |
StreamedViewerInfo
FieldsType | Name | Default | Description |
|---|---|---|---|
| host | String | ||
| port | Short | 0 | |
| viewer | Viewer | -1 |
Viewer
Base class: core.Int- view.getD3D11Texture
- view.getGLTextureHandle
- view.getVulkanTexture
- view.getLastAABB
- view.getSceneIndex
- view.addGPUScene
- view.destroyViewer
- view.getAutoClipping
- view.getCameraFrontAxis
- view.getCameraPosition
- view.getCameraRightAxis
- view.getCameraUpAxis
- view.getViewerProperty
- view.getViewerPropertyInfo
- view.getViewerSize
- view.getViewerStats
- view.invertSelectPrimitives
- view.listViewerProperties
- view.pick
- view.pickRectangle
- view.refreshViewer
- view.removeGPUScene
- view.resizeViewer
- view.selectPrimitives
- view.setDefaultViewerId
- view.setViewerProperty
- view.unselectPrimitives
- view.getCompositedImage
- view.getRenderMapImage
- view.takeScreenshot
- view.resizeStreamedViewer
- view.startRecording
- view.stopRecording
- view.fitCamera
- view.getViewerMatrices
- view.setViewerMatrices
- view.visibilityShoot
- 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.fillUnusedPixels
- material.filterAO
- material.generateColorFromIndex
- material.generateUniqueColors
- material.getImagePixelColor
- material.getPointsAndMaterialFromText
- material.remapIndexMap
- material.resizeImage
- 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
VulkanTexture
Base class: core.Ptr- core.parallelAddJob
- material.setMaterialUserData
- material.setMultipleMaterialUserData
- scene.setMultipleOccurrenceUserData
- scene.setOccurrenceUserData
WebRTCInfo
FieldsType | Name | Default | Description |
|---|---|---|---|
| signalingUrl | String | 127.0.0.1:8090 | |
| stunServer | String | stun:stun.l.google.com:19302 | |
| udpPortRangeBegin | UShort | 1024 | |
| udpPortRangeEnd | UShort | 65535 |