Scene
Python API types
Read time 28 minutesLast updated 9 months ago
AlternativeTree
An AlternativeTree is an alternative product structure tree.
Base class: core.Entity
Functions accepting this type or a list of this type as a parameter:
- scene.getAlternativeTreeRoot
- scene.setVariantTree
- 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
AlternativeTreeList
List of scene.AlternativeTree
AnimChannel
A container of AnimCurves.
Base class: core.Entity
Functions accepting this type or a list of this type as a parameter:
- scene.addKeyframe
- scene.addKeyframeFromCurrentPosition
- scene.decimateAnimChannelBySegment
- scene.displayAllKeyframesFromAnimChannel
- scene.displayValueFromAnimChannelAtTime
- scene.getAnimChannelInfo
- scene.getAnimChannelOccurrence
- scene.getKeyframes
- scene.getMainChannel
- scene.getParentChannel
- scene.getSubChannel
- scene.getSubChannels
- scene.makeDefaultKeyframe
- scene.removeKeyframe
- 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
AnimChannelInfo
Fields
Type | Name | Default | Description |
|---|---|---|---|
| name | String | ||
| type | AnimChannelType | SIMPLE | |
| mainPropertyBinder | Ident | 0 | |
| hasKeyFrames | Bool | False |
AnimChannelList
List of scene.AnimChannel
AnimChannelType
Enum of core.Long
Name | Value |
|---|---|
| SIMPLE | 0 |
| VECTOR3 | 1 |
| QUATERNION | 2 |
| MATRIX4 | 3 |
AnimPropertyBinder
Fields
Type | Name | Default | Description |
|---|---|---|---|
| occurrence | Occurrence | 0 | |
| animation | Animation | 0 | |
| mainChannel | AnimChannel | 0 |
AnimPropertyBinderList
List of scene.AnimPropertyBinder
Animation
An Animation allows to animate several properties through several AnimPropertyBinder.
Base class: core.Entity
Functions accepting this type or a list of this type as a parameter:
- scene.addAnimation
- scene.animatesThisOccurrence
- scene.bakeAnimation
- scene.deleteAnimation
- scene.displayAllKeyframesFromAnimation
- scene.getAnimChannelIfExists
- scene.getAnimationInfo
- scene.getAnimationPropertyBinderLists
- scene.linkPropertyToAnimation
- scene.listMainChannels
- scene.moveAnimation
- scene.unlinkPropertyToAnimation
- view.getAnimationPlayerInfo
- view.isAnimationPlaying
- view.pauseAnimation
- view.playAnimation
- view.resumeAnimation
- view.setAnimationFrame
- view.setAnimationLoop
- view.setAnimationSpeed
- view.stopAnimation
- 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
AnimationComponent
An Animation component.
Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:
- scene.getAnimationComponentPropertyBinderLists
- scene.getComponentOccurrence
- scene.getComponentType
- scene.setComponentOccurrence
- scene.getAnnotationGroups
- view.drawCappingPlane
- 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
AnimationInfo
Fields
Type | Name | Default | Description |
|---|---|---|---|
| name | String | ||
| group | String | ||
| length | AnimationTime | 0 |
AnimationList
List of scene.Animation
AnimationTime
Base class: core.ULong
Functions accepting this type or a list of this type as a parameter:
- scene.addKeyframe
- scene.addKeyframeFromCurrentPosition
- scene.bakeAnimation
- scene.displayValueFromAnimChannelAtTime
- scene.moveAnimation
- scene.removeKeyframe
- view.applyPlayingAnimations
- view.setAnimationFrame
- algo.decimateTarget
- polygonal.createJointPlaceholders
Annotation
An annotation.
Base class: core.Entity
Functions accepting this type or a list of this type as a parameter:
- scene.addMeshToAnnotation
- scene.createOccurrenceFromAnnotation
- scene.getAnnotationDefinition
- scene.getAnnotationListAABB
- scene.setAnnotationToGroup
- 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
AnnotationDefinition
Annotation definition.
Fields
Type | Name | Default | Description |
|---|---|---|---|
| id | Annotation | 0 | The annotation we get the definition. |
| name | String | Name of the annotation. | |
| visible | Boolean | False | Visibility of the annotation. |
| group | AnnotationGroup | 0 | Group of the annotation. |
| shapes | TessellatedShapeList | Shapes of the annotation. |
Functions accepting this type or a list of this type as a parameter:
AnnotationDefinitionList
List of scene.AnnotationDefinition
AnnotationGroup
A group of annotation.
Base class: core.Entity
Functions accepting this type or a list of this type as a parameter:
- scene.getAnnotations
- scene.setAnnotationToGroup
- 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
AnnotationGroupList
List of scene.AnnotationGroup
AnnotationList
List of scene.Annotation
Functions accepting this type or a list of this type as a parameter:
BRepShape
A BRepShape is a Shape that contains BRep geometry.
Base class: scene.Shape
Functions accepting this type or a list of this type as a parameter:
- geom.applyTransform
- geom.getEntityAABB
- 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
CameraComponent
A camera component.
Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:
- scene.getComponentOccurrence
- scene.getComponentType
- scene.setComponentOccurrence
- scene.getAnnotationGroups
- view.drawCappingPlane
- 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
Component
A component add behavior to an occurrence.
Base class: core.Entity
Derived classes:
- AnimationComponent
- CameraComponent
- ExternalDataComponent
- JointComponent
- LODComponent
- LightComponent
- Metadata
- PMIComponent
- Part
- ReferencedDataComponent
- SubPartMaterialComponent
- VariantComponent
Functions accepting this type or a list of this type as a parameter:
- scene.getComponentOccurrence
- scene.getComponentType
- scene.setComponentOccurrence
- scene.getAnnotationGroups
- view.drawCappingPlane
- 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
ComponentChangeType
Enum of core.Long
Name | Value |
|---|---|
| COMPONENT_ADDED | 0 |
| COMPONENT_REMOVED | 1 |
| COMPONENT_MODIFIED | 2 |
ComponentList
List of scene.Component
ComponentType
Enum
Name | Value |
|---|---|
| Part | 0 |
| PMI | 1 |
| Light | 2 |
| VisualBehavior | 3 |
| InteractionBehavior | 4 |
| Metadata | 5 |
| Variant | 6 |
| Animation | 7 |
| Joint | 8 |
| Widget | 9 |
| LODComponent | 10 |
| ExternalDataComponent | 11 |
| HLODComponent | 12 |
| CuttingPlaneComponent | 13 |
| ReferencedDataComponent | 14 |
| CameraComponent | 15 |
| FeatureComponent | 16 |
| SubpartMaterial | 17 |
Functions accepting this type or a list of this type as a parameter:
- scene.addComponent
- scene.addComponents
- scene.deleteComponentByType
- scene.deleteComponentsByType
- scene.getComponent
- scene.getComponentByOccurrence
- scene.getComponents
- scene.getOccurrencesWithComponent
- scene.hasComponent
- scene.listComponent
ExternalDataComponent
A ExternalDataComponent is a component that add external data to an occurrence.
Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:
- scene.getComponentOccurrence
- scene.getComponentType
- scene.setComponentOccurrence
- scene.getAnnotationGroups
- view.drawCappingPlane
- 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
Filter
Fields
Type | Name | Default | Description |
|---|---|---|---|
| id | Ident | 0 | |
| name | String | ||
| expr | FilterExpression |
FilterExpression
A filter expression (see documentation).
Base class: core.String
Functions accepting this type or a list of this type as a parameter:
- scene.addFilterToLibrary
- scene.evaluateExpression
- scene.evaluateExpressionOnOccurrences
- scene.evaluateExpressionOnSubTree
- scene.getFilteredOccurrences
- 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
FilterList
List of scene.Filter
JointComponent
A joint for rigged animations.
Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:
- scene.getComponentOccurrence
- scene.getComponentType
- scene.setComponentOccurrence
- scene.getAnnotationGroups
- view.drawCappingPlane
- 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
JointDefinition
Joint definition.
Fields
Type | Name | Default | Description |
|---|---|---|---|
| id | Joint | 0 | The joint from which we get the definition. |
| jointComponent | Component | 0 | The JointComponent attached to this joint. |
| isRoot | Boolean | False | Is this joint the root. |
| rootJoint | Joint | 0 | The joint used as root. |
| parent | Joint | 0 | Vertices tangents. |
| children | JointList | All direct hildren joint. | |
| matrix | Matrix4 | Local matrix. | |
| gloablMatrix | Matrix4 | Global matrix. |
JointDefinitionList
List of scene.JointDefinition
Keyframe
A keyframe to interpolate an AnimCurve from.
Base class: core.Entity
Functions accepting this type or a list of this type as a parameter:
- scene.getKeyframeParentAnimChannel
- 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
KeyframeList
List of scene.Keyframe
LOD
A Level of Detail (references an Occurrence).
Base class: core.Entity
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
LODComponent
A Levels of Detail component (contains multiple LOD).
Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:
- scene.getComponentOccurrence
- scene.getComponentType
- scene.setComponentOccurrence
- scene.getAnnotationGroups
- view.drawCappingPlane
- 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
LODComponentList
List of scene.LODComponent
LODList
List of scene.LOD
LightComponent
A LightComponent is a component that add a light behavior to an occurrence.
Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:
- scene.getComponentOccurrence
- scene.getComponentType
- scene.setComponentOccurrence
- scene.getAnnotationGroups
- view.drawCappingPlane
- 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
LightType
Enum
Name | Value |
|---|---|
| DirectionalLight | 0 |
| PositionalLight | 1 |
| SpotLight | 2 |
Functions accepting this type or a list of this type as a parameter:
MaterialCount
Fields
Type | Name | Default | Description |
|---|---|---|---|
| material | Material | 0 | |
| count | Int | -1 |
MaterialCountList
List of scene.MaterialCount
MergeByRegionsStrategy
Select between:
-
NumberOfRegions: core.Int
-
SizeOfRegions: geom.Distance Functions accepting this type or a list of this type as a parameter:
MergeHiddenPartsMode
Enum
Name | Value |
|---|---|
| Destroy | 0 |
| MakeVisible | 1 |
| MergeSeparately | 2 |
Functions accepting this type or a list of this type as a parameter:
- scene.mergeOccurrencesByTreeLevel
- scene.mergePartOccurrences
- scene.mergePartOccurrencesByAssemblies
- scene.mergePartOccurrencesByFinalAssemblies
- scene.mergePartOccurrencesByMaterials
- scene.mergePartOccurrencesByName
MergeStrategy
Enum of core.Int
Name | Value |
|---|---|
| mergePartOccurrences | 0 |
| MergeByMaterials | 1 |
Functions accepting this type or a list of this type as a parameter:
Metadata
A metadata is a component that contains all metadata properties of an occurrence.
Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:
- scene.addMetadata
- scene.addMetadataBlock
- scene.getMetadata
- scene.getMetadatasDefinitions
- scene.removeMetadata
- scene.getComponentOccurrence
- scene.getComponentType
- scene.setComponentOccurrence
- scene.getAnnotationGroups
- view.drawCappingPlane
- 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
MetadataDefinition
All properties of a metadata component.
Base class: scene.PropertyValueList
Functions accepting this type or a list of this type as a parameter:
MetadataDefinitionList
List of scene.MetadataDefinition
Functions accepting this type or a list of this type as a parameter:
MetadataList
List of scene.Metadata
Functions accepting this type or a list of this type as a parameter:
Occurrence
An occurrence is the main type of node in the product structure, it can have children and prototypes.
Base class: geom.GeomEntity
Functions accepting this type or a list of this type as a parameter:
- algo.assembleCAD
- algo.backToInitialBRep
- algo.bakeImpostor
- algo.bakeVertexAttributes
- algo.calculateNormalsInPointClouds
- algo.crackCADMoebiusStrip
- algo.crackEdges
- algo.crackMeshEdges
- algo.createFreeEdgesFromPatches
- algo.createIdentifiedPatchesFromPatches
- algo.createIndexMapFromOccurrences
- algo.createNormals
- algo.createPointCloudKDTree
- algo.createTangents
- algo.createVertexColorFromMaterials
- algo.createVisibilityPatchesFromPatch
- algo.decimate
- algo.decimateEdgeCollapse
- algo.decimatePointClouds
- algo.decimateTarget
- algo.deleteAttribute
- algo.deleteBRepShapes
- algo.deleteFreeVertices
- algo.deleteLines
- algo.deleteNormals
- algo.deletePatches
- algo.deletePolygons
- algo.deleteTangents
- algo.deleteTextureCoordinates
- algo.deleteVisibilityPatches
- algo.evalDecimateErrorForTarget
- algo.extractNeutralAxis
- algo.filletMesh
- algo.filterHiddenPolygons
- algo.filterMeshVertexColors
- algo.findBestPivotBetweenOccurrences
- algo.getAllAxisFromCADModel
- algo.getMeshVertexColors
- algo.getOptimalTextureResolution
- algo.getTessellations
- algo.getUV3dRatio
- algo.getVisibilityStats
- algo.getVisualComparisonFootprint
- algo.identifyLinesOfInterest
- algo.identifyPatches
- algo.identifySharpEdges
- algo.invertTangents
- algo.lineToTexture
- algo.listFeatures
- algo.loopSubdivMesh
- algo.mergeVertices
- algo.meshBooleanOperation
- algo.meshComparison
- algo.meshComparisonBatch
- algo.meshIntersections
- algo.noiseMesh
- algo.optimizeCADLoops
- algo.optimizeForRendering
- algo.optimizeSubMeshes
- algo.optimizeTextureSize
- algo.removeHoles
- algo.repairCAD
- algo.segmentMesh
- algo.setFeatureComponentMaxIndex
- algo.setMeshVertexColors
- algo.smoothMesh
- algo.splitUVForAtlas
- algo.sweep
- algo.tessellate
- algo.tessellatePointClouds
- algo.tessellateRelativelyToAABB
- algo.transferUV
- algo.voxelizePointClouds
- algo.beginBakingSession
- algo.beginVertexBakingSession
- algo.combineMaterials
- algo.convexDecomposition
- algo.explodeBodies
- algo.explodeByMaterials
- algo.explodeByTopoDimension
- algo.explodeByVertexCount
- algo.explodeByVoxel
- algo.explodeConnectedMeshes
- algo.explodePatches
- algo.createVisibilityInformation
- algo.createVisibilityInformationAdvanced
- algo.createVisibilityInformationFromViewPoints
- algo.findOccludedPartOccurrences
- algo.findOccludedPartOccurrencesAdvanced
- algo.removeOccludedGeometries
- algo.removeOccludedGeometriesAdvanced
- algo.removeOccludedGeometriesFromPoints
- algo.removeOccludedGeometriesFromViewPoints
- algo.createOcclusionMesh
- algo.dualContouring
- algo.marchingCubes
- algo.proxyMesh
- algo.retopologize
- algo.voxelize
- algo.replaceBy
- algo.replaceByBox
- algo.replaceByConvexHull
- algo.replaceByPrimitive
- algo.sawWithAABB
- algo.sawWithOBB
- algo.sawWithOctree
- algo.sawWithPlane
- algo.convertSimilarPartOccurrencesToInstances
- algo.convertSimilarPartOccurrencesToInstancesFast
- algo.findSimilarPartOccurrencesFast
- algo.alignUVIslands
- algo.applyUvTransform
- algo.automaticUVMapping
- algo.copyUV
- algo.getRatioUV3D
- algo.getUVQualityMetrics
- algo.getUvAabr
- algo.hasOverlappingUV
- 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.getFittingCylinder
- algo.getFittingSphere
- algo.convertNormalMap
- algo.createBillboard
- algo.barySmooth
- algo.crackMoebiusStrips
- algo.crackNonManifoldVertices
- algo.createCavityOccurrences
- algo.invertPolygonFacesOrientation
- algo.moebiusCracker
- algo.orientNormals
- algo.remeshSurfacicHoles
- algo.removeDegeneratedPolygons
- algo.removeMultiplePolygon
- algo.removeZFighting
- algo.repairMesh
- algo.repairNullNormals
- algo.separateToManifold
- algo.sewBoundary
- algo.vertexOffset
- algo.orientPolygonFaces
- algo.orientPolygonFacesAdvanced
- algo.orientPolygonFacesFromCamera
- algo.equilateralize
- algo.quadify
- algo.requadify
- algo.triangularize
- algo.createVertexWeightsFromVertexColors
- algo.createVertexWeightsFromVisibilityAttributes
- algo.deleteVertexWeights
- algo.createVisibilityAttributes
- algo.deletePolygonalWeightAttribute
- algo.deleteVisibilityAttributes
- algo.flagVisibilityAttributesOnTransparents
- algo.transferVisibilityToPolygonalWeight
- io.exportScene
- io.importFiles
- io.importPicture
- io.importRemote3mxFile
- io.importScene
- scene.addComponent
- scene.addComponents
- scene.addInParentInstances
- scene.computeSubTreeChecksum
- scene.createOBBMesh
- scene.createOccurrence
- scene.createOccurrenceFromSelection
- scene.createOccurrences
- scene.createPartsFromMeshes
- scene.deleteComponentByType
- scene.deleteComponentsByType
- scene.deleteEmptyOccurrences
- scene.deleteOccurrences
- scene.getAABB
- scene.getActiveMaterial
- scene.getActiveMaterials
- scene.getActivePropertyValue
- scene.getActivePropertyValues
- scene.getAncestors
- scene.getComponent
- scene.getComponentByOccurrence
- scene.getComponents
- scene.getGlobalMatrices
- scene.getGlobalMatrix
- scene.getGlobalVisibility
- scene.getLocalMatrices
- scene.getLocalMatrix
- scene.getMBB
- scene.getMaterialsFromSubtree
- scene.getOBB
- scene.getOccurrenceActiveMaterial
- scene.getOccurrenceName
- scene.getOccurrencesWithComponent
- scene.getPartOccurrences
- scene.getPolygonCount
- scene.getSubTreeStats
- scene.getVertexCount
- scene.getVolume
- scene.getVolumes
- scene.hasComponent
- scene.hide
- scene.inverseVisibility
- scene.isAncestorOf
- scene.keepAncestors
- scene.listComponents
- scene.removeMaterials
- scene.replaceMaterial
- scene.setComponentOccurrence
- scene.setOccurrenceMaterial
- scene.setOccurrenceName
- scene.show
- scene.showOnly
- scene.transferCADMaterialsOnPartOccurrences
- scene.transferMaterialsOnPatches
- scene.createHierarchicalClusters
- scene.generateOctree
- scene.getClusters
- scene.getPartOccurrencesGroupedBySimilarity
- scene.findDuplicatedPartOccurrences
- scene.findOccurrencesByMetadata
- scene.findOccurrencesByMetadataValue
- scene.findOccurrencesByProperty
- scene.findPartOccurrencesByActiveMaterial
- scene.findPartOccurrencesByMaximumSize
- scene.createSubTree
- scene.getChildren
- scene.getChildrenCount
- scene.getFirstChild
- scene.getNextSibling
- scene.getOccurrenceAncestors
- scene.getOccurrencesAncestors
- scene.getParent
- scene.getPreviousSibling
- scene.getSubTree
- scene.moveOccurrences
- scene.setParent
- scene.addLightComponent
- scene.createLight
- scene.createMetadatasFromDefinitions
- scene.getSubpartMaterial
- scene.listSubpartMaterials
- scene.listSubpartVariantMaterials
- scene.setSubpartMaterial
- scene.setSubpartMaterials
- scene.setSubpartVariantMaterials
- scene.transferSubpartMaterialsOnPatches
- scene.createAlternativeTree
- scene.animatesThisOccurrence
- scene.bakeAnimation
- scene.createSkeletonMesh
- scene.getAnimChannelIfExists
- scene.getOccurrenceJoint
- scene.moveAnimation
- scene.getTessellationInfos
- scene.print
- scene.evaluateExpressionOnOccurrences
- scene.evaluateExpressionOnSubTree
- scene.getFilteredOccurrences
- scene.isolate
- scene.findPartOccurrencesWithUnstitchedOpenShells
- scene.mergeOccurrencesByTreeLevel
- scene.mergePartOccurrences
- scene.mergePartOccurrencesByAssemblies
- scene.mergePartOccurrencesByFinalAssemblies
- scene.mergePartOccurrencesByMaterials
- scene.mergePartOccurrencesByName
- scene.mergePartOccurrencesByRegions
- scene.mergePartOccurrencesWithSingleOpenShellByAssemblies
- scene.applyTransformation
- scene.createSymmetry
- scene.rotate
- scene.setLocalMatrices
- scene.setLocalMatrix
- scene.alignPivotPointToWorld
- scene.movePivotPointToOccurrenceCenter
- scene.movePivotPointToOrigin
- scene.movePivotPointToSelectionCenter
- scene.movePivotPointToTargetedOccurrenceCenter
- scene.setPivotOnly
- scene.convertPMIToOccurrences
- scene.getOccurrenceAnnotationDefinitions
- scene.cleanInstances
- scene.getDirectInstances
- scene.getFinalPrototype
- scene.getInstances
- scene.getPrototype
- scene.getPrototypes
- scene.prototypeSubTree
- scene.setPrototype
- scene.setPrototypes
- scene.updateChildrenPrototypes
- scene.invertSelect
- scene.select
- scene.unselect
- scene.compress
- scene.convertToOldSchoolVisibility
- scene.getHiddenPartOccurrences
- scene.getVisiblePartOccurrences
- scene.makeInstanceUnique
- scene.rake
- scene.removeSymmetryMatrices
- scene.resetPartTransform
- scene.resetTransform
- scene.rayCast
- scene.rayCastAll
- scene.getMultipleOccurrenceUserData
- scene.getOccurrenceUserData
- scene.hasMultipleOccurrenceUserData
- scene.hasOccurrenceUserData
- scene.setMultipleOccurrenceUserData
- scene.setOccurrenceUserData
- scene.unsetMultipleOccurrenceUserData
- scene.unsetOccurrenceUserData
- view.createGPUScene
- view.getOccurrenceIndex
- view.fitCamera
- geom.applyTransform
- geom.getEntityAABB
- 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
OccurrenceList
List of scene.Occurrence
Functions accepting this type or a list of this type as a parameter:
- algo.assembleCAD
- algo.backToInitialBRep
- algo.bakeVertexAttributes
- algo.calculateNormalsInPointClouds
- algo.crackCADMoebiusStrip
- algo.crackEdges
- algo.crackMeshEdges
- algo.createFreeEdgesFromPatches
- algo.createIdentifiedPatchesFromPatches
- algo.createIndexMapFromOccurrences
- algo.createNormals
- algo.createPointCloudKDTree
- algo.createTangents
- algo.createVertexColorFromMaterials
- algo.createVisibilityPatchesFromPatch
- algo.decimate
- algo.decimateEdgeCollapse
- algo.decimatePointClouds
- algo.decimateTarget
- algo.deleteBRepShapes
- algo.deleteFreeVertices
- algo.deleteLines
- algo.deleteNormals
- algo.deletePatches
- algo.deletePolygons
- algo.deleteTangents
- algo.deleteTextureCoordinates
- algo.deleteVisibilityPatches
- algo.evalDecimateErrorForTarget
- algo.extractNeutralAxis
- algo.filletMesh
- algo.filterHiddenPolygons
- algo.filterMeshVertexColors
- algo.findBestPivotBetweenOccurrences
- algo.getAllAxisFromCADModel
- algo.getMeshVertexColors
- algo.getOptimalTextureResolution
- algo.getTessellations
- algo.getUV3dRatio
- algo.getVisibilityStats
- algo.getVisualComparisonFootprint
- algo.identifyLinesOfInterest
- algo.identifyPatches
- algo.identifySharpEdges
- algo.invertTangents
- algo.lineToTexture
- algo.listFeatures
- algo.loopSubdivMesh
- algo.mergeVertices
- algo.meshBooleanOperation
- algo.meshComparisonBatch
- algo.meshIntersections
- algo.noiseMesh
- algo.optimizeCADLoops
- algo.optimizeForRendering
- algo.optimizeSubMeshes
- algo.removeHoles
- algo.repairCAD
- algo.segmentMesh
- algo.setFeatureComponentMaxIndex
- algo.setMeshVertexColors
- algo.smoothMesh
- algo.splitUVForAtlas
- algo.sweep
- algo.tessellate
- algo.tessellatePointClouds
- algo.tessellateRelativelyToAABB
- algo.voxelizePointClouds
- algo.beginBakingSession
- algo.beginVertexBakingSession
- algo.combineMaterials
- algo.convexDecomposition
- algo.explodeBodies
- algo.explodeByMaterials
- algo.explodeByTopoDimension
- algo.explodeByVertexCount
- algo.explodeByVoxel
- algo.explodeConnectedMeshes
- algo.explodePatches
- algo.createVisibilityInformation
- algo.createVisibilityInformationAdvanced
- algo.createVisibilityInformationFromViewPoints
- algo.findOccludedPartOccurrences
- algo.findOccludedPartOccurrencesAdvanced
- algo.removeOccludedGeometries
- algo.removeOccludedGeometriesAdvanced
- algo.removeOccludedGeometriesFromPoints
- algo.removeOccludedGeometriesFromViewPoints
- algo.createOcclusionMesh
- algo.dualContouring
- algo.marchingCubes
- algo.proxyMesh
- algo.retopologize
- algo.voxelize
- algo.replaceBy
- algo.replaceByBox
- algo.replaceByConvexHull
- algo.replaceByPrimitive
- algo.sawWithAABB
- algo.sawWithOBB
- algo.sawWithOctree
- algo.sawWithPlane
- algo.convertSimilarPartOccurrencesToInstances
- algo.convertSimilarPartOccurrencesToInstancesFast
- algo.findSimilarPartOccurrencesFast
- algo.alignUVIslands
- algo.applyUvTransform
- algo.automaticUVMapping
- algo.copyUV
- algo.getRatioUV3D
- algo.getUVQualityMetrics
- algo.getUvAabr
- algo.hasOverlappingUV
- 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.getFittingCylinder
- algo.getFittingSphere
- algo.convertNormalMap
- algo.createBillboard
- algo.barySmooth
- algo.crackMoebiusStrips
- algo.crackNonManifoldVertices
- algo.createCavityOccurrences
- algo.invertPolygonFacesOrientation
- algo.moebiusCracker
- algo.orientNormals
- algo.remeshSurfacicHoles
- algo.removeDegeneratedPolygons
- algo.removeMultiplePolygon
- algo.removeZFighting
- algo.repairMesh
- algo.repairNullNormals
- algo.separateToManifold
- algo.sewBoundary
- algo.vertexOffset
- algo.orientPolygonFaces
- algo.orientPolygonFacesAdvanced
- algo.orientPolygonFacesFromCamera
- algo.equilateralize
- algo.quadify
- algo.requadify
- algo.triangularize
- algo.createVertexWeightsFromVertexColors
- algo.createVertexWeightsFromVisibilityAttributes
- algo.deleteVertexWeights
- algo.createVisibilityAttributes
- algo.deletePolygonalWeightAttribute
- algo.deleteVisibilityAttributes
- algo.flagVisibilityAttributesOnTransparents
- algo.transferVisibilityToPolygonalWeight
- scene.addComponents
- scene.createOccurrenceFromSelection
- scene.createOccurrences
- scene.createPartsFromMeshes
- scene.deleteOccurrences
- scene.getAABB
- scene.getActiveMaterials
- scene.getActivePropertyValues
- scene.getComponentByOccurrence
- scene.getComponents
- scene.getGlobalMatrices
- scene.getLocalMatrices
- scene.getMBB
- scene.getOBB
- scene.getPolygonCount
- scene.getSubTreeStats
- scene.getVertexCount
- scene.getVolumes
- scene.hide
- scene.inverseVisibility
- scene.keepAncestors
- scene.removeMaterials
- scene.replaceMaterial
- scene.show
- scene.showOnly
- scene.getClusters
- scene.findOccurrencesByMetadata
- scene.findOccurrencesByMetadataValue
- scene.findOccurrencesByProperty
- scene.findPartOccurrencesByActiveMaterial
- scene.findPartOccurrencesByMaximumSize
- scene.getOccurrencesAncestors
- scene.moveOccurrences
- scene.createMetadatasFromDefinitions
- scene.evaluateExpressionOnOccurrences
- scene.isolate
- scene.mergeOccurrencesByTreeLevel
- scene.mergePartOccurrences
- scene.mergePartOccurrencesByAssemblies
- scene.mergePartOccurrencesByFinalAssemblies
- scene.mergePartOccurrencesByMaterials
- scene.mergePartOccurrencesByRegions
- scene.createSymmetry
- scene.setLocalMatrices
- scene.alignPivotPointToWorld
- scene.movePivotPointToOccurrenceCenter
- scene.movePivotPointToSelectionCenter
- scene.movePivotPointToTargetedOccurrenceCenter
- scene.convertPMIToOccurrences
- scene.getPrototypes
- scene.setPrototypes
- scene.invertSelect
- scene.select
- scene.unselect
- scene.getHiddenPartOccurrences
- scene.getVisiblePartOccurrences
- scene.makeInstanceUnique
- scene.getMultipleOccurrenceUserData
- scene.hasMultipleOccurrenceUserData
- scene.setMultipleOccurrenceUserData
- scene.unsetMultipleOccurrenceUserData
- view.createGPUScene
- view.fitCamera
OccurrenceListList
List of scene.OccurrenceList
OccurrenceUserData
Identifier of occurrences userdata.
Base class: core.Ident
Functions accepting this type or a list of this type as a parameter:
- scene.getMultipleOccurrenceUserData
- scene.getOccurrenceUserData
- scene.hasMultipleOccurrenceUserData
- scene.hasOccurrenceUserData
- scene.setMultipleOccurrenceUserData
- scene.setOccurrenceUserData
- scene.unsetMultipleOccurrenceUserData
- scene.unsetOccurrenceUserData
- scene.unsubscribeFromOccurrenceUserData
PMIComponent
A PMI component (Product Manufacturing informations).
Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:
- scene.addAnnotationGroup
- scene.getComponentOccurrence
- scene.getComponentType
- scene.setComponentOccurrence
- scene.getAnnotationGroups
- view.drawCappingPlane
- 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
PackedTree
Packed view of the scene tree.
Fields
Type | Name | Default | Description |
|---|---|---|---|
| occurrences | OccurrenceList | List of all occurrences of the tree. (Note: all parent occurrences appears before their children, thus the first occurrence is the root). | |
| parents | IntList | Specifies the parent index for each occurrence (same index than occurrences). root's parent is -1. | |
| names | StringList | Name of each occurrence (same index than occurrences). | |
| visible | InheritableBoolList | Visibility of each occurrence (same index than occurrences). | |
| materials | MaterialList | Material identifier of each occurrence (same index than occurrences). | |
| transformIndices | IntList | Indices of transform matrix of each occurrence (same index than occurrences). (Note: Identity matrix is always 0). | |
| transformMatrices | Matrix4List | Matrices referenced by transformIndices. (Note: The first matrix is always Identity). | |
| customProperties | StringPairListList | Custom properties of each occurrence (same index than occurrences), pair is name -> value. |
Functions accepting this type or a list of this type as a parameter:
Part
A part is the geometrical definition of product occurrence.
Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:
- io.applyAutoTessellate
- scene.getBrepShape
- scene.getPartActiveShape
- scene.getPartLocalMatrix
- scene.getPartShapeType
- scene.listActiveShapeMaterials
- scene.getTessellationParameters
- scene.getPartMesh
- scene.getPartModel
- scene.getPartsMeshes
- scene.getPartsModels
- scene.getPartsTransforms
- scene.getPartsTransformsIndexed
- scene.setPartMesh
- scene.setPartModel
- scene.setPartsTransforms
- scene.setPartsTransformsIndexed
- scene.getPartUserData
- scene.hasPartUserData
- scene.setPartUserData
- scene.unsetPartUserData
- scene.getComponentOccurrence
- scene.getComponentType
- scene.setComponentOccurrence
- scene.getAnnotationGroups
- view.drawCappingPlane
- 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
PartList
List of scene.Part
Functions accepting this type or a list of this type as a parameter:
- scene.getPartsMeshes
- scene.getPartsModels
- scene.getPartsTransforms
- scene.getPartsTransformsIndexed
- scene.setPartsTransforms
- scene.setPartsTransformsIndexed
PartUserData
Identifier of part userdata.
Base class: core.Ident
Functions accepting this type or a list of this type as a parameter:
- scene.getPartUserData
- scene.hasPartUserData
- scene.setPartUserData
- scene.unsetPartUserData
- scene.unsubscribeFromPartUserData
PartialLoad_Status
Enum of core.Long
Name | Value |
|---|---|
| NOT_LOADED | 0 |
| LOADED | 1 |
| LOADING | 2 |
| LOADING_ALL | 3 |
Primitive_Type
Enum of core.Long
Name | Value |
|---|---|
| CUBE | 0 |
| SPHERE | 1 |
| PLAN | 2 |
| CONE | 3 |
| ARROW | 4 |
| CYLINDER | 5 |
| CAPSULE | 6 |
ProberInfo
Fields
Type | Name | Default | Description |
|---|---|---|---|
| occurrence | Occurrence | 0 | |
| position | Point3 |
ProductView
A product view defines a variant with a camera view and annotations.
Base class: core.Entity
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
ProductViewDefinition
ProductionView definition.
Fields
Type | Name | Default | Description |
|---|---|---|---|
| id | Variant | 0 | The productview we get the definition. |
| name | String | Name of the view. | |
| groupName | String | Name of the group of view. | |
| view | Matrix4 | View matrix of this view. | |
| viewIsSet | Boolean | False | True if view is set. |
| viewIsOrtho | Boolean | False | True if view is orthographic. |
| viewFov | Double | 60 | Fov of the camera. |
| cuttingPlane | Boolean | False | True if cutting plane is set. |
| cuttingPlanePosition | Vector3 | Position of the cutting plane. | |
| cuttingPlaneNormal | Vector3 | Normal of the cutting plane. | |
| explodedViewFactor | Double | 60 | Fov of the camera. |
| explodedViewX | Boolean | False | True if exploded along X axis. |
| explodedViewY | Boolean | False | True if exploded along Y axis. |
| explodedViewZ | Boolean | False | True if exploded along Z axis. |
| annotations | AnnotationList | Annotations linked to this view. |
Functions accepting this type or a list of this type as a parameter:
ProductViewDefinitionList
List of scene.ProductViewDefinition
PropertyValue
A structure containing a property name and its value.
Fields
Type | Name | Default | Description |
|---|---|---|---|
| name | String | Name of the property. | |
| value | String | Value of the property. |
PropertyValueList
List of PropertyValue.
List of scene.PropertyValue
Derived class: MetadataDefinition
RayHit
Fields
Type | Name | Default | Description |
|---|---|---|---|
| rayParam | Double | -1 | |
| occurrence | Occurrence | 0 | |
| triangleIndex | Int | -1 | |
| triangleParam | Point2 |
RayHitList
List of scene.RayHit
ReferencedDataComponent
A ReferencedDataComponent contains the information necessary to individually load referenced sub-models.
Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:
- io.loadReferencedData
- io.unloadReferencedData
- scene.getPartialLoadingStatus
- scene.setReferencedDataComponentParent
- scene.setReferencedDataComponentPath
- scene.getComponentOccurrence
- scene.getComponentType
- scene.setComponentOccurrence
- scene.getAnnotationGroups
- view.drawCappingPlane
- 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
ResizeByMaximumSizeOptions
Fields
Type | Name | Default | Description |
|---|---|---|---|
| TextureSize | Int | 4096 | |
| KeepTextureRatio | Boolean | True |
ResizeByTexturesOptions
Select between:
- AllTextures: core.None
- Selection: material.ImageList
ResizeTexturesInputMode
Select between:
-
Occurrences: scene.OccurrenceList
-
Textures: scene.ResizeByTexturesOptions Functions accepting this type or a list of this type as a parameter:
ResizeTexturesResizeMode
Select between:
-
Ratio: core.Percent
-
MaximumSize: scene.ResizeByMaximumSizeOptions Functions accepting this type or a list of this type as a parameter:
SceneChangeType
Enum of core.Long
Name | Value |
|---|---|
| PRE_CHILD_INSERTED | 0 |
| CHILD_REMOVED | 1 |
| PROPERTY_CHANGED | 2 |
| COMPLETE_CHANGE | 3 |
| COMPONENT_CHANGED | 4 |
| POST_CHILD_INSERTED | 5 |
| POST_CHILD_REMOVED | 6 |
SelectionChangeType
Enum of core.Long
Name | Value |
|---|---|
| CLEARED | 0 |
| ADDED | 1 |
| REMOVED | 2 |
Shape
A Shape is the geometrical representation of a Part. It can be BRep or polygonal.
Base class: geom.GeomEntity
Derived classes:
Functions accepting this type or a list of this type as a parameter:
- geom.applyTransform
- geom.getEntityAABB
- 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
ShapeType
Enum of core.Long
Name | Value |
|---|---|
| TESSELLATED | 0 |
| CAD | 1 |
| JOINT | 2 |
SubPartMaterialComponent
A sub part ( or sub mesh ) material component.
Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:
- scene.getMaterialsFromSubPart
- scene.getComponentOccurrence
- scene.getComponentType
- scene.setComponentOccurrence
- scene.getAnnotationGroups
- view.drawCappingPlane
- 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
TessellatedShape
A TessellatedShape is a Shape that contains Polygonal geometry.
Base class: scene.Shape
Functions accepting this type or a list of this type as a parameter:
- geom.applyTransform
- geom.getEntityAABB
- 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
TessellatedShapeList
List of scene.TessellatedShape
UVGenerationMode
Enum
Name | Value |
|---|---|
| NO_UV | 0 |
| INTRINSIC_UV | 1 |
| CONFORMED_SCALED_UV | 2 |
Variant
A variant allows to override some occurrences properties.
Base class: core.Entity
Functions accepting this type or a list of this type as a parameter:
- scene.setSubpartVariantMaterialsList
- scene.getProductViewDefinition
- scene.duplicateVariant
- scene.getVariantTree
- scene.removeVariant
- scene.setCurrentVariant
- scene.setVariantTree
- 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
VariantChangeType
Enum of core.Long
Name | Value |
|---|---|
| ADDED | 0 |
| REMOVED | 1 |
| CURRENT_CHANGED | 2 |
VariantComponent
A variant component is a component that contains variant definitions for an occurrence.
Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:
- scene.getVariantComponentsDefinitions
- scene.getComponentOccurrence
- scene.getComponentType
- scene.setComponentOccurrence
- scene.getAnnotationGroups
- view.drawCappingPlane
- 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
VariantComponentList
List of scene.VariantComponent
Functions accepting this type or a list of this type as a parameter:
VariantDefinition
Fields
Type | Name | Default | Description |
|---|---|---|---|
| variant | Variant | 0 | |
| overridedProperties | PropertyValueList | [] |
VariantDefinitionList
List of scene.VariantDefinition
VariantDefinitionListList
List of scene.VariantDefinitionList
VariantList
List of scene.Variant
Functions accepting this type or a list of this type as a parameter:
VariantMaterialList
List of scene.VariantMaterials
Functions accepting this type or a list of this type as a parameter:
VariantMaterials
Variant and materials in variant .
Fields
Type | Name | Default | Description |
|---|---|---|---|
| id | Variant | 0 | The variant id. |
| materials | MaterialList | The material list. |
Functions accepting this type or a list of this type as a parameter:
VisibilityMode
Enum
Name | Value |
|---|---|
| Inherited | 0 |
| Hide | 1 |
Functions accepting this type or a list of this type as a parameter: