# Scene > Python API types ### AlternativeTree An AlternativeTree is an alternative product structure tree. Base class: [core.Entity](./core_types#entity) **Frame:** ```mermaid classDiagram class AlternativeTree Entity <|-- AlternativeTree AlternativeTree : +core.Ident Id AlternativeTree : +core.String Name ``` Functions accepting this type or a list of this type as a parameter: * [scene.getAlternativeTreeRoot](./scene_functions#getalternativetreeroot) * [scene.setVariantTree](./scene_functions#setvarianttree) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) *** ### AlternativeTreeList List of [scene.AlternativeTree](./scene_types#alternativetree) *** ### AnimChannel A container of AnimCurves. Base class: [core.Entity](./core_types#entity) **Frame:** ```mermaid classDiagram class AnimChannel Entity <|-- AnimChannel ``` Functions accepting this type or a list of this type as a parameter: * [scene.addKeyframe](./scene_functions#addkeyframe) * [scene.addKeyframeFromCurrentPosition](./scene_functions#addkeyframefromcurrentposition) * [scene.decimateAnimChannelBySegment](./scene_functions#decimateanimchannelbysegment) * [scene.displayAllKeyframesFromAnimChannel](./scene_functions#displayallkeyframesfromanimchannel) * [scene.displayValueFromAnimChannelAtTime](./scene_functions#displayvaluefromanimchannelattime) * [scene.getAnimChannelInfo](./scene_functions#getanimchannelinfo) * [scene.getAnimChannelOccurrence](./scene_functions#getanimchanneloccurrence) * [scene.getKeyframes](./scene_functions#getkeyframes) * [scene.getMainChannel](./scene_functions#getmainchannel) * [scene.getParentChannel](./scene_functions#getparentchannel) * [scene.getSubChannel](./scene_functions#getsubchannel) * [scene.getSubChannels](./scene_functions#getsubchannels) * [scene.makeDefaultKeyframe](./scene_functions#makedefaultkeyframe) * [scene.removeKeyframe](./scene_functions#removekeyframe) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) *** ### AnimChannelInfo Fields | Type | Name | Default | Description | | ------------------ | --------------- | ------- | ----------- | | name | String | | | | type | AnimChannelType | SIMPLE | | | mainPropertyBinder | Ident | 0 | | | hasKeyFrames | Bool | False | | *** ### AnimChannelList List of [scene.AnimChannel](./scene_types#animchannel) *** ### AnimChannelType Enum of [core.Long](./core_types#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](./scene_types#animpropertybinder) *** ### Animation An Animation allows to animate several properties through several AnimPropertyBinder. Base class: [core.Entity](./core_types#entity) **Frame:** ```mermaid classDiagram class Animation Entity <|-- Animation Animation : +core.String Name Animation : +core.String Group ``` Functions accepting this type or a list of this type as a parameter: * [scene.addAnimation](./scene_functions#addanimation) * [scene.animatesThisOccurrence](./scene_functions#animatesthisoccurrence) * [scene.bakeAnimation](./scene_functions#bakeanimation) * [scene.deleteAnimation](./scene_functions#deleteanimation) * [scene.displayAllKeyframesFromAnimation](./scene_functions#displayallkeyframesfromanimation) * [scene.getAnimChannelIfExists](./scene_functions#getanimchannelifexists) * [scene.getAnimationInfo](./scene_functions#getanimationinfo) * [scene.getAnimationPropertyBinderLists](./scene_functions#getanimationpropertybinderlists) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.listMainChannels](./scene_functions#listmainchannels) * [scene.moveAnimation](./scene_functions#moveanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) * [view.getAnimationPlayerInfo](./view_functions#getanimationplayerinfo) * [view.isAnimationPlaying](./view_functions#isanimationplaying) * [view.pauseAnimation](./view_functions#pauseanimation) * [view.playAnimation](./view_functions#playanimation) * [view.resumeAnimation](./view_functions#resumeanimation) * [view.setAnimationFrame](./view_functions#setanimationframe) * [view.setAnimationLoop](./view_functions#setanimationloop) * [view.setAnimationSpeed](./view_functions#setanimationspeed) * [view.stopAnimation](./view_functions#stopanimation) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) *** ### AnimationComponent An Animation component. Base class: [scene.Component](./scene_types#component) **Frame:** ```mermaid classDiagram class AnimationComponent Component <|-- AnimationComponent AnimationComponent : +core.Ident Id ``` Functions accepting this type or a list of this type as a parameter: * [scene.getAnimationComponentPropertyBinderLists](./scene_functions#getanimationcomponentpropertybinderlists) * [scene.getComponentOccurrence](./scene_functions#getcomponentoccurrence) * [scene.getComponentType](./scene_functions#getcomponenttype) * [scene.setComponentOccurrence](./scene_functions#setcomponentoccurrence) * [scene.getAnnotationGroups](./scene_functions#getannotationgroups) * [view.drawCappingPlane](./view_functions#drawcappingplane) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) *** ### AnimationInfo Fields | Type | Name | Default | Description | | ------ | ------------- | ------- | ----------- | | name | String | | | | group | String | | | | length | AnimationTime | 0 | | *** ### AnimationList List of [scene.Animation](./scene_types#animation) *** ### AnimationTime Base class: [core.ULong](./core_types#ulong) **Frame:** ```mermaid classDiagram class AnimationTime ULong <|-- AnimationTime ``` Functions accepting this type or a list of this type as a parameter: * [scene.addKeyframe](./scene_functions#addkeyframe) * [scene.addKeyframeFromCurrentPosition](./scene_functions#addkeyframefromcurrentposition) * [scene.bakeAnimation](./scene_functions#bakeanimation) * [scene.displayValueFromAnimChannelAtTime](./scene_functions#displayvaluefromanimchannelattime) * [scene.moveAnimation](./scene_functions#moveanimation) * [scene.removeKeyframe](./scene_functions#removekeyframe) * [view.applyPlayingAnimations](./view_functions#applyplayinganimations) * [view.setAnimationFrame](./view_functions#setanimationframe) * [algo.decimateTarget](./algo_functions#decimatetarget) * [polygonal.createJointPlaceholders](./polygonal_functions#createjointplaceholders) *** ### Annotation An annotation. Base class: [core.Entity](./core_types#entity) **Frame:** ```mermaid classDiagram class Annotation Entity <|-- Annotation Annotation : +core.Ident Id Annotation : +core.String Name Annotation : +core.Boolean Visible ``` Functions accepting this type or a list of this type as a parameter: * [scene.addAnnotationToProductView](./scene_functions#addannotationtoproductview) * [scene.addMeshToAnnotation](./scene_functions#addmeshtoannotation) * [scene.createOccurrenceFromAnnotation](./scene_functions#createoccurrencefromannotation) * [scene.getAnnotationDefinition](./scene_functions#getannotationdefinition) * [scene.getAnnotationListAABB](./scene_functions#getannotationlistaabb) * [scene.setAnnotationToGroup](./scene_functions#setannotationtogroup) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#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: * [scene.createAnnotationFromDefinition](./scene_functions#createannotationfromdefinition) *** ### AnnotationDefinitionList List of [scene.AnnotationDefinition](./scene_types#annotationdefinition) *** ### AnnotationGroup A group of annotation. Base class: [core.Entity](./core_types#entity) **Frame:** ```mermaid classDiagram class AnnotationGroup Entity <|-- AnnotationGroup AnnotationGroup : +core.Ident Id ``` Functions accepting this type or a list of this type as a parameter: * [scene.getAnnotations](./scene_functions#getannotations) * [scene.setAnnotationToGroup](./scene_functions#setannotationtogroup) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) *** ### AnnotationGroupList List of [scene.AnnotationGroup](./scene_types#annotationgroup) *** ### AnnotationList List of [scene.Annotation](./scene_types#annotation) Functions accepting this type or a list of this type as a parameter: * [scene.getAnnotationListAABB](./scene_functions#getannotationlistaabb) *** ### BRepShape A BRepShape is a Shape that contains BRep geometry. Base class: [scene.Shape](./scene_types#shape) **Frame:** ```mermaid classDiagram class BRepShape Shape <|-- BRepShape BRepShape : +core.Ident Id BRepShape : +core.Entity Model ``` Functions accepting this type or a list of this type as a parameter: * [geom.applyTransform](./geom_functions#applytransform) * [geom.getEntityAABB](./geom_functions#getentityaabb) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) *** ### CameraComponent A camera component. Base class: [scene.Component](./scene_types#component) **Frame:** ```mermaid classDiagram class CameraComponent Component <|-- CameraComponent CameraComponent : +core.Ident Id CameraComponent : +core.Boolean IsPerspective CameraComponent : +core.Real AspectRatio CameraComponent : +core.Real Yfov CameraComponent : +core.Real Xmag CameraComponent : +core.Real Ymag CameraComponent : +core.Real Zfar CameraComponent : +core.Real Znear ``` Functions accepting this type or a list of this type as a parameter: * [scene.getComponentOccurrence](./scene_functions#getcomponentoccurrence) * [scene.getComponentType](./scene_functions#getcomponenttype) * [scene.setComponentOccurrence](./scene_functions#setcomponentoccurrence) * [scene.getAnnotationGroups](./scene_functions#getannotationgroups) * [view.drawCappingPlane](./view_functions#drawcappingplane) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) *** ### Component A component add behavior to an occurrence. Base class: [core.Entity](./core_types#entity) Derived classes: * [AnimationComponent](./scene_types#animationcomponent) * [CameraComponent](./scene_types#cameracomponent) * [ExternalDataComponent](./scene_types#externaldatacomponent) * [JointComponent](./scene_types#jointcomponent) * [LODComponent](./scene_types#lodcomponent) * [LightComponent](./scene_types#lightcomponent) * [Metadata](./scene_types#metadata) * [PMIComponent](./scene_types#pmicomponent) * [Part](./scene_types#part) * [ReferencedDataComponent](./scene_types#referenceddatacomponent) * [SubPartMaterialComponent](./scene_types#subpartmaterialcomponent) * [VariantComponent](./scene_types#variantcomponent) **Frame:** ```mermaid classDiagram class Component Entity <|-- Component Component <|-- AnimationComponent AnimationComponent : +core.Ident Id Component <|-- CameraComponent CameraComponent : +core.Ident Id CameraComponent : +core.Boolean IsPerspective CameraComponent : +core.Real AspectRatio CameraComponent : +core.Real Yfov CameraComponent : +core.Real Xmag CameraComponent : +core.Real Ymag CameraComponent : +core.Real Zfar CameraComponent : +core.Real Znear Component <|-- ExternalDataComponent Component <|-- JointComponent JointComponent : +core.Ident Id JointComponent : +core.Entity Joint Component <|-- LODComponent LODComponent : +core.Ident Id Component <|-- LightComponent LightComponent : +core.Ident Id LightComponent : +ENUM LightType LightComponent : +core.Color Color LightComponent : +core.Real Power LightComponent : +geom.Angle CutOff Component <|-- Metadata Metadata : +core.Ident Id Component <|-- PMIComponent PMIComponent : +core.Ident Id Component <|-- Part Part : +core.Ident Id Part : +core.Entity BRepShapeInitial Part : +core.Entity BRepShapeModified Part : +core.Entity TessellatedShape Part : +geom.Matrix4 Transform Component <|-- ReferencedDataComponent ReferencedDataComponent : +core.Ident Id ReferencedDataComponent : +core.String FilePath ReferencedDataComponent : +core.String IdPath ReferencedDataComponent : +core.String ParentFilePath Component <|-- SubPartMaterialComponent SubPartMaterialComponent : +core.Ident Id Component <|-- VariantComponent VariantComponent : +core.Ident Id VariantComponent : +core.InheritableBool VariantSensitive VariantComponent : +core.String GroupName ``` Functions accepting this type or a list of this type as a parameter: * [scene.getComponentOccurrence](./scene_functions#getcomponentoccurrence) * [scene.getComponentType](./scene_functions#getcomponenttype) * [scene.setComponentOccurrence](./scene_functions#setcomponentoccurrence) * [scene.getAnnotationGroups](./scene_functions#getannotationgroups) * [view.drawCappingPlane](./view_functions#drawcappingplane) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) *** ### ComponentChangeType Enum of [core.Long](./core_types#long) | Name | Value | | ------------------- | ----- | | COMPONENT\_ADDED | 0 | | COMPONENT\_REMOVED | 1 | | COMPONENT\_MODIFIED | 2 | *** ### ComponentList List of [scene.Component](./scene_types#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_functions#addcomponent) * [scene.addComponents](./scene_functions#addcomponents) * [scene.deleteComponentByType](./scene_functions#deletecomponentbytype) * [scene.deleteComponentsByType](./scene_functions#deletecomponentsbytype) * [scene.getComponent](./scene_functions#getcomponent) * [scene.getComponentByOccurrence](./scene_functions#getcomponentbyoccurrence) * [scene.getComponents](./scene_functions#getcomponents) * [scene.getOccurrencesWithComponent](./scene_functions#getoccurrenceswithcomponent) * [scene.hasComponent](./scene_functions#hascomponent) * [scene.listComponent](./scene_functions#listcomponent) *** ### ExternalDataComponent A ExternalDataComponent is a component that add external data to an occurrence. Base class: [scene.Component](./scene_types#component) **Frame:** ```mermaid classDiagram class ExternalDataComponent Component <|-- ExternalDataComponent ``` Functions accepting this type or a list of this type as a parameter: * [scene.getComponentOccurrence](./scene_functions#getcomponentoccurrence) * [scene.getComponentType](./scene_functions#getcomponenttype) * [scene.setComponentOccurrence](./scene_functions#setcomponentoccurrence) * [scene.getAnnotationGroups](./scene_functions#getannotationgroups) * [view.drawCappingPlane](./view_functions#drawcappingplane) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) *** ### Filter Fields | Type | Name | Default | Description | | ---- | ---------------- | ------- | ----------- | | id | Ident | 0 | | | name | String | | | | expr | FilterExpression | | | *** ### FilterExpression A filter expression (see documentation). Base class: [core.String](./core_types#string) **Frame:** ```mermaid classDiagram class FilterExpression String <|-- FilterExpression ``` Functions accepting this type or a list of this type as a parameter: * [scene.addFilterToLibrary](./scene_functions#addfiltertolibrary) * [scene.evaluateExpression](./scene_functions#evaluateexpression) * [scene.evaluateExpressionOnOccurrences](./scene_functions#evaluateexpressiononoccurrences) * [scene.evaluateExpressionOnSubTree](./scene_functions#evaluateexpressiononsubtree) * [scene.getFilteredOccurrences](./scene_functions#getfilteredoccurrences) * [algo.configureFunctionLogger](./algo_functions#configurefunctionlogger) * [algo.bakeMaterialPropertyMap](./algo_functions#bakematerialpropertymap) * [algo.bakeOccurrencePropertyMap](./algo_functions#bakeoccurrencepropertymap) * [algo.sawWithAABB](./algo_functions#sawwithaabb) * [algo.sawWithOBB](./algo_functions#sawwithobb) * [algo.sawWithPlane](./algo_functions#sawwithplane) * [cad.configureFunctionLogger](./cad_functions#configurefunctionlogger) * [core.configureFunctionLogger](./core_functions#configurefunctionlogger) * [core.getEvent](./core_functions#getevent) * [core.getEvents](./core_functions#getevents) * [core.getFunction](./core_functions#getfunction) * [core.getFunctions](./core_functions#getfunctions) * [core.getGroup](./core_functions#getgroup) * [core.getGroups](./core_functions#getgroups) * [core.getModuleTypes](./core_functions#getmoduletypes) * [core.getType](./core_functions#gettype) * [core.getTypeAttributes](./core_functions#gettypeattributes) * [core.addWantedToken](./core_functions#addwantedtoken) * [core.checkWebLogin](./core_functions#checkweblogin) * [core.configureLicenseServer](./core_functions#configurelicenseserver) * [core.needToken](./core_functions#needtoken) * [core.ownToken](./core_functions#owntoken) * [core.releaseToken](./core_functions#releasetoken) * [core.releaseWebLicense](./core_functions#releaseweblicense) * [core.removeWantedToken](./core_functions#removewantedtoken) * [core.requestWebLicense](./core_functions#requestweblicense) * [core.retrieveWebLicenses](./core_functions#retrieveweblicenses) * [core.tokenValid](./core_functions#tokenvalid) * [core.parallelStart](./core_functions#parallelstart) * [core.removeModule](./core_functions#removemodule) * [core.pushProgression](./core_functions#pushprogression) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getModuleProperty](./core_functions#getmoduleproperty) * [core.getModulePropertyInfo](./core_functions#getmodulepropertyinfo) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listModuleProperties](./core_functions#listmoduleproperties) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.restoreModulePropertyDefaultValue](./core_functions#restoremodulepropertydefaultvalue) * [core.setModuleProperty](./core_functions#setmoduleproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.unsetProperty](./core_functions#unsetproperty) * [core.startUndoRedoStep](./core_functions#startundoredostep) * [core.log](./core_functions#log) * [geom.configureFunctionLogger](./geom_functions#configurefunctionlogger) * [io.configureFunctionLogger](./io_functions#configurefunctionlogger) * [io.addAssetPaths](./io_functions#addassetpaths) * [io.findInDirectories](./io_functions#findindirectories) * [io.setAssetPaths](./io_functions#setassetpaths) * [io.importRemote3mxFile](./io_functions#importremote3mxfile) * [io.registerIOCallbacks](./io_functions#registeriocallbacks) * [io.getExtensionPriority](./io_functions#getextensionpriority) * [material.addUniformProperty](./material_functions#adduniformproperty) * [material.configureFunctionLogger](./material_functions#configurefunctionlogger) * [material.createCustomMaterialPattern](./material_functions#createcustommaterialpattern) * [material.createMaterial](./material_functions#creatematerial) * [material.findCustomMaterialPatternByName](./material_functions#findcustommaterialpatternbyname) * [material.findMaterialsByPattern](./material_functions#findmaterialsbypattern) * [material.findMaterialsByProperty](./material_functions#findmaterialsbyproperty) * [material.getPointsAndMaterialFromText](./material_functions#getpointsandmaterialfromtext) * [material.getUniformPropertyType](./material_functions#getuniformpropertytype) * [material.setCoeffOrTextureProperty](./material_functions#setcoeffortextureproperty) * [material.setColorAlphaProperty](./material_functions#setcoloralphaproperty) * [material.setColorOrTextureProperty](./material_functions#setcolorortextureproperty) * [material.setFragmentShader](./material_functions#setfragmentshader) * [material.setMaterialPattern](./material_functions#setmaterialpattern) * [material.setVertexShader](./material_functions#setvertexshader) * [material.createImageFromData](./material_functions#createimagefromdata) * [polygonal.configureFunctionLogger](./polygonal_functions#configurefunctionlogger) * [polygonal.createMeshFromText](./polygonal_functions#createmeshfromtext) * [scene.configureFunctionLogger](./scene_functions#configurefunctionlogger) * [scene.createOccurrence](./scene_functions#createoccurrence) * [scene.createOccurrenceFromSelection](./scene_functions#createoccurrencefromselection) * [scene.createOccurrenceFromText](./scene_functions#createoccurrencefromtext) * [scene.createOccurrences](./scene_functions#createoccurrences) * [scene.getActivePropertyValue](./scene_functions#getactivepropertyvalue) * [scene.getActivePropertyValues](./scene_functions#getactivepropertyvalues) * [scene.setOccurrenceName](./scene_functions#setoccurrencename) * [scene.findOccurrencesByMetadata](./scene_functions#findoccurrencesbymetadata) * [scene.findOccurrencesByProperty](./scene_functions#findoccurrencesbyproperty) * [scene.createLight](./scene_functions#createlight) * [scene.addMetadata](./scene_functions#addmetadata) * [scene.addMetadataBlock](./scene_functions#addmetadatablock) * [scene.getMetadata](./scene_functions#getmetadata) * [scene.removeMetadata](./scene_functions#removemetadata) * [scene.createAlternativeTree](./scene_functions#createalternativetree) * [scene.createAnimation](./scene_functions#createanimation) * [scene.getSubChannel](./scene_functions#getsubchannel) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) * [scene.addFilterToLibrary](./scene_functions#addfiltertolibrary) * [scene.findFilterByName](./scene_functions#findfilterbyname) * [scene.setReferencedDataComponentPath](./scene_functions#setreferenceddatacomponentpath) * [scene.addAnnotationGroup](./scene_functions#addannotationgroup) * [scene.addVariant](./scene_functions#addvariant) * [scene.duplicateVariant](./scene_functions#duplicatevariant) * [unity.configureFunctionLogger](./unity_functions#configurefunctionlogger) * [view.configureFunctionLogger](./view_functions#configurefunctionlogger) * [view.getViewerProperty](./view_functions#getviewerproperty) * [view.getViewerPropertyInfo](./view_functions#getviewerpropertyinfo) * [view.setViewerProperty](./view_functions#setviewerproperty) * [view.startRecording](./view_functions#startrecording) *** ### FilterList List of [scene.Filter](./scene_types#filter) *** ### JointComponent A joint for rigged animations. Base class: [scene.Component](./scene_types#component) **Frame:** ```mermaid classDiagram class JointComponent Component <|-- JointComponent JointComponent : +core.Ident Id JointComponent : +core.Entity Joint ``` Functions accepting this type or a list of this type as a parameter: * [scene.getComponentOccurrence](./scene_functions#getcomponentoccurrence) * [scene.getComponentType](./scene_functions#getcomponenttype) * [scene.setComponentOccurrence](./scene_functions#setcomponentoccurrence) * [scene.getAnnotationGroups](./scene_functions#getannotationgroups) * [view.drawCappingPlane](./view_functions#drawcappingplane) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#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](./scene_types#jointdefinition) *** ### Keyframe A keyframe to interpolate an AnimCurve from. Base class: [core.Entity](./core_types#entity) **Frame:** ```mermaid classDiagram class Keyframe Entity <|-- Keyframe Keyframe : +core.Ident Id Keyframe : +core.Real Value Keyframe : +UNKNOWN Time ``` Functions accepting this type or a list of this type as a parameter: * [scene.getKeyframeParentAnimChannel](./scene_functions#getkeyframeparentanimchannel) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) *** ### KeyframeList List of [scene.Keyframe](./scene_types#keyframe) *** ### LOD A Level of Detail (references an Occurrence). Base class: [core.Entity](./core_types#entity) **Frame:** ```mermaid classDiagram class LOD Entity <|-- LOD LOD : +core.Ident Id LOD : +core.Entity Occurrence LOD : +geom.Distance Distance ``` Functions accepting this type or a list of this type as a parameter: * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) *** ### LODComponent A Levels of Detail component (contains multiple LOD). Base class: [scene.Component](./scene_types#component) **Frame:** ```mermaid classDiagram class LODComponent Component <|-- LODComponent LODComponent : +core.Ident Id ``` Functions accepting this type or a list of this type as a parameter: * [scene.getComponentOccurrence](./scene_functions#getcomponentoccurrence) * [scene.getComponentType](./scene_functions#getcomponenttype) * [scene.setComponentOccurrence](./scene_functions#setcomponentoccurrence) * [scene.getAnnotationGroups](./scene_functions#getannotationgroups) * [view.drawCappingPlane](./view_functions#drawcappingplane) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) *** ### LODComponentList List of [scene.LODComponent](./scene_types#lodcomponent) *** ### LODList List of [scene.LOD](./scene_types#lod) *** ### LightComponent A LightComponent is a component that add a light behavior to an occurrence. Base class: [scene.Component](./scene_types#component) **Frame:** ```mermaid classDiagram class LightComponent Component <|-- LightComponent LightComponent : +core.Ident Id LightComponent : +ENUM LightType LightComponent : +core.Color Color LightComponent : +core.Real Power LightComponent : +geom.Angle CutOff ``` Functions accepting this type or a list of this type as a parameter: * [scene.getComponentOccurrence](./scene_functions#getcomponentoccurrence) * [scene.getComponentType](./scene_functions#getcomponenttype) * [scene.setComponentOccurrence](./scene_functions#setcomponentoccurrence) * [scene.getAnnotationGroups](./scene_functions#getannotationgroups) * [view.drawCappingPlane](./view_functions#drawcappingplane) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) *** ### LightType Enum | Name | Value | | ---------------- | ----- | | DirectionalLight | 0 | | PositionalLight | 1 | | SpotLight | 2 | Functions accepting this type or a list of this type as a parameter: * [scene.addLightComponent](./scene_functions#addlightcomponent) * [scene.createLight](./scene_functions#createlight) *** ### MaterialCount Fields | Type | Name | Default | Description | | -------- | -------- | ------- | ----------- | | material | Material | 0 | | | count | Int | -1 | | *** ### MaterialCountList List of [scene.MaterialCount](./scene_types#materialcount) *** ### MergeByRegionsStrategy Select between: * NumberOfRegions: [core.Int](./core_types#int) * SizeOfRegions: [geom.Distance](./geom_types#distance) Functions accepting this type or a list of this type as a parameter: * [scene.getClusters](./scene_functions#getclusters) * [scene.mergePartOccurrencesByRegions](./scene_functions#mergepartoccurrencesbyregions) *** ### 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_functions#mergeoccurrencesbytreelevel) * [scene.mergePartOccurrences](./scene_functions#mergepartoccurrences) * [scene.mergePartOccurrencesByAssemblies](./scene_functions#mergepartoccurrencesbyassemblies) * [scene.mergePartOccurrencesByFinalAssemblies](./scene_functions#mergepartoccurrencesbyfinalassemblies) * [scene.mergePartOccurrencesByMaterials](./scene_functions#mergepartoccurrencesbymaterials) * [scene.mergePartOccurrencesByName](./scene_functions#mergepartoccurrencesbyname) *** ### MergeStrategy Enum of [core.Int](./core_types#int) | Name | Value | | -------------------- | ----- | | mergePartOccurrences | 0 | | MergeByMaterials | 1 | Functions accepting this type or a list of this type as a parameter: * [scene.mergePartOccurrencesByRegions](./scene_functions#mergepartoccurrencesbyregions) *** ### Metadata A metadata is a component that contains all metadata properties of an occurrence. Base class: [scene.Component](./scene_types#component) **Frame:** ```mermaid classDiagram class Metadata Component <|-- Metadata Metadata : +core.Ident Id ``` Functions accepting this type or a list of this type as a parameter: * [scene.addMetadata](./scene_functions#addmetadata) * [scene.addMetadataBlock](./scene_functions#addmetadatablock) * [scene.getMetadata](./scene_functions#getmetadata) * [scene.getMetadatasDefinitions](./scene_functions#getmetadatasdefinitions) * [scene.removeMetadata](./scene_functions#removemetadata) * [scene.getComponentOccurrence](./scene_functions#getcomponentoccurrence) * [scene.getComponentType](./scene_functions#getcomponenttype) * [scene.setComponentOccurrence](./scene_functions#setcomponentoccurrence) * [scene.getAnnotationGroups](./scene_functions#getannotationgroups) * [view.drawCappingPlane](./view_functions#drawcappingplane) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) *** ### MetadataDefinition All properties of a metadata component. Base class: [scene.PropertyValueList](./scene_types#propertyvaluelist) **Frame:** ```mermaid classDiagram class MetadataDefinition PropertyValueList <|-- MetadataDefinition ``` Functions accepting this type or a list of this type as a parameter: * [scene.createMetadatasFromDefinitions](./scene_functions#createmetadatasfromdefinitions) *** ### MetadataDefinitionList List of [scene.MetadataDefinition](./scene_types#metadatadefinition) Functions accepting this type or a list of this type as a parameter: * [scene.createMetadatasFromDefinitions](./scene_functions#createmetadatasfromdefinitions) *** ### MetadataList List of [scene.Metadata](./scene_types#metadata) Functions accepting this type or a list of this type as a parameter: * [scene.getMetadatasDefinitions](./scene_functions#getmetadatasdefinitions) *** ### Occurrence An occurrence is the main type of node in the product structure, it can have children and prototypes. Base class: [geom.GeomEntity](./geom_types#geomentity) **Frame:** ```mermaid classDiagram class Occurrence GeomEntity <|-- Occurrence Occurrence : +core.Ident Id Occurrence : +core.String Name Occurrence : +core.InheritableBool Visible Occurrence : +core.Entity Material Occurrence : +geom.Matrix4 Transform Occurrence : +core.Entity Prototype ``` Functions accepting this type or a list of this type as a parameter: * [algo.assembleCAD](./algo_functions#assemblecad) * [algo.backToInitialBRep](./algo_functions#backtoinitialbrep) * [algo.bakeImpostor](./algo_functions#bakeimpostor) * [algo.bakeVertexAttributes](./algo_functions#bakevertexattributes) * [algo.calculateNormalsInPointClouds](./algo_functions#calculatenormalsinpointclouds) * [algo.crackCADMoebiusStrip](./algo_functions#crackcadmoebiusstrip) * [algo.crackEdges](./algo_functions#crackedges) * [algo.crackMeshEdges](./algo_functions#crackmeshedges) * [algo.createFreeEdgesFromPatches](./algo_functions#createfreeedgesfrompatches) * [algo.createIdentifiedPatchesFromPatches](./algo_functions#createidentifiedpatchesfrompatches) * [algo.createIndexMapFromOccurrences](./algo_functions#createindexmapfromoccurrences) * [algo.createNormals](./algo_functions#createnormals) * [algo.createPointCloudKDTree](./algo_functions#createpointcloudkdtree) * [algo.createTangents](./algo_functions#createtangents) * [algo.createVertexColorFromMaterials](./algo_functions#createvertexcolorfrommaterials) * [algo.createVisibilityPatchesFromPatch](./algo_functions#createvisibilitypatchesfrompatch) * [algo.decimate](./algo_functions#decimate) * [algo.decimateEdgeCollapse](./algo_functions#decimateedgecollapse) * [algo.decimatePointClouds](./algo_functions#decimatepointclouds) * [algo.decimateTarget](./algo_functions#decimatetarget) * [algo.deleteAttribute](./algo_functions#deleteattribute) * [algo.deleteBRepShapes](./algo_functions#deletebrepshapes) * [algo.deleteFreeVertices](./algo_functions#deletefreevertices) * [algo.deleteLines](./algo_functions#deletelines) * [algo.deleteNormals](./algo_functions#deletenormals) * [algo.deletePatches](./algo_functions#deletepatches) * [algo.deletePolygons](./algo_functions#deletepolygons) * [algo.deleteTangents](./algo_functions#deletetangents) * [algo.deleteTextureCoordinates](./algo_functions#deletetexturecoordinates) * [algo.deleteVisibilityPatches](./algo_functions#deletevisibilitypatches) * [algo.evalDecimateErrorForTarget](./algo_functions#evaldecimateerrorfortarget) * [algo.extractNeutralAxis](./algo_functions#extractneutralaxis) * [algo.filletMesh](./algo_functions#filletmesh) * [algo.filterHiddenPolygons](./algo_functions#filterhiddenpolygons) * [algo.filterMeshVertexColors](./algo_functions#filtermeshvertexcolors) * [algo.findBestPivotBetweenOccurrences](./algo_functions#findbestpivotbetweenoccurrences) * [algo.getAllAxisFromCADModel](./algo_functions#getallaxisfromcadmodel) * [algo.getMeshVertexColors](./algo_functions#getmeshvertexcolors) * [algo.getOptimalTextureResolution](./algo_functions#getoptimaltextureresolution) * [algo.getTessellations](./algo_functions#gettessellations) * [algo.getUV3dRatio](./algo_functions#getuv3dratio) * [algo.getVisibilityStats](./algo_functions#getvisibilitystats) * [algo.getVisualComparisonFootprint](./algo_functions#getvisualcomparisonfootprint) * [algo.identifyLinesOfInterest](./algo_functions#identifylinesofinterest) * [algo.identifyPatches](./algo_functions#identifypatches) * [algo.identifySharpEdges](./algo_functions#identifysharpedges) * [algo.invertTangents](./algo_functions#inverttangents) * [algo.lineToTexture](./algo_functions#linetotexture) * [algo.listFeatures](./algo_functions#listfeatures) * [algo.loopSubdivMesh](./algo_functions#loopsubdivmesh) * [algo.mergeVertices](./algo_functions#mergevertices) * [algo.meshBooleanOperation](./algo_functions#meshbooleanoperation) * [algo.meshComparison](./algo_functions#meshcomparison) * [algo.meshComparisonBatch](./algo_functions#meshcomparisonbatch) * [algo.meshIntersections](./algo_functions#meshintersections) * [algo.noiseMesh](./algo_functions#noisemesh) * [algo.optimizeCADLoops](./algo_functions#optimizecadloops) * [algo.optimizeForRendering](./algo_functions#optimizeforrendering) * [algo.optimizeSubMeshes](./algo_functions#optimizesubmeshes) * [algo.optimizeTextureSize](./algo_functions#optimizetexturesize) * [algo.removeHoles](./algo_functions#removeholes) * [algo.repairCAD](./algo_functions#repaircad) * [algo.segmentMesh](./algo_functions#segmentmesh) * [algo.setFeatureComponentMaxIndex](./algo_functions#setfeaturecomponentmaxindex) * [algo.setMeshVertexColors](./algo_functions#setmeshvertexcolors) * [algo.smoothMesh](./algo_functions#smoothmesh) * [algo.splitUVForAtlas](./algo_functions#splituvforatlas) * [algo.sweep](./algo_functions#sweep) * [algo.tessellate](./algo_functions#tessellate) * [algo.tessellatePointClouds](./algo_functions#tessellatepointclouds) * [algo.tessellateRelativelyToAABB](./algo_functions#tessellaterelativelytoaabb) * [algo.transferUV](./algo_functions#transferuv) * [algo.voxelizePointClouds](./algo_functions#voxelizepointclouds) * [algo.beginBakingSession](./algo_functions#beginbakingsession) * [algo.beginVertexBakingSession](./algo_functions#beginvertexbakingsession) * [algo.combineMaterials](./algo_functions#combinematerials) * [algo.convexDecomposition](./algo_functions#convexdecomposition) * [algo.explodeBodies](./algo_functions#explodebodies) * [algo.explodeByMaterials](./algo_functions#explodebymaterials) * [algo.explodeByTopoDimension](./algo_functions#explodebytopodimension) * [algo.explodeByVertexCount](./algo_functions#explodebyvertexcount) * [algo.explodeByVoxel](./algo_functions#explodebyvoxel) * [algo.explodeConnectedMeshes](./algo_functions#explodeconnectedmeshes) * [algo.explodePatches](./algo_functions#explodepatches) * [algo.createVisibilityInformation](./algo_functions#createvisibilityinformation) * [algo.createVisibilityInformationAdvanced](./algo_functions#createvisibilityinformationadvanced) * [algo.createVisibilityInformationFromViewPoints](./algo_functions#createvisibilityinformationfromviewpoints) * [algo.findOccludedPartOccurrences](./algo_functions#findoccludedpartoccurrences) * [algo.findOccludedPartOccurrencesAdvanced](./algo_functions#findoccludedpartoccurrencesadvanced) * [algo.removeOccludedGeometries](./algo_functions#removeoccludedgeometries) * [algo.removeOccludedGeometriesAdvanced](./algo_functions#removeoccludedgeometriesadvanced) * [algo.removeOccludedGeometriesFromPoints](./algo_functions#removeoccludedgeometriesfrompoints) * [algo.removeOccludedGeometriesFromViewPoints](./algo_functions#removeoccludedgeometriesfromviewpoints) * [algo.createOcclusionMesh](./algo_functions#createocclusionmesh) * [algo.dualContouring](./algo_functions#dualcontouring) * [algo.marchingCubes](./algo_functions#marchingcubes) * [algo.proxyMesh](./algo_functions#proxymesh) * [algo.retopologize](./algo_functions#retopologize) * [algo.voxelize](./algo_functions#voxelize) * [algo.replaceBy](./algo_functions#replaceby) * [algo.replaceByBox](./algo_functions#replacebybox) * [algo.replaceByConvexHull](./algo_functions#replacebyconvexhull) * [algo.replaceByPrimitive](./algo_functions#replacebyprimitive) * [algo.sawWithAABB](./algo_functions#sawwithaabb) * [algo.sawWithOBB](./algo_functions#sawwithobb) * [algo.sawWithOctree](./algo_functions#sawwithoctree) * [algo.sawWithPlane](./algo_functions#sawwithplane) * [algo.convertSimilarPartOccurrencesToInstances](./algo_functions#convertsimilarpartoccurrencestoinstances) * [algo.convertSimilarPartOccurrencesToInstancesFast](./algo_functions#convertsimilarpartoccurrencestoinstancesfast) * [algo.findSimilarPartOccurrencesFast](./algo_functions#findsimilarpartoccurrencesfast) * [algo.alignUVIslands](./algo_functions#alignuvislands) * [algo.applyUvTransform](./algo_functions#applyuvtransform) * [algo.automaticUVMapping](./algo_functions#automaticuvmapping) * [algo.copyUV](./algo_functions#copyuv) * [algo.getRatioUV3D](./algo_functions#getratiouv3d) * [algo.getUVQualityMetrics](./algo_functions#getuvqualitymetrics) * [algo.getUvAabr](./algo_functions#getuvaabr) * [algo.hasOverlappingUV](./algo_functions#hasoverlappinguv) * [algo.mapUvOnAABB](./algo_functions#mapuvonaabb) * [algo.mapUvOnBox](./algo_functions#mapuvonbox) * [algo.mapUvOnCubicAABB](./algo_functions#mapuvoncubicaabb) * [algo.mapUvOnCustomAABB](./algo_functions#mapuvoncustomaabb) * [algo.mapUvOnCylinder](./algo_functions#mapuvoncylinder) * [algo.mapUvOnFittingCylinder](./algo_functions#mapuvonfittingcylinder) * [algo.mapUvOnFittingSphere](./algo_functions#mapuvonfittingsphere) * [algo.mapUvOnMBB](./algo_functions#mapuvonmbb) * [algo.mapUvOnPlane](./algo_functions#mapuvonplane) * [algo.mapUvOnSphere](./algo_functions#mapuvonsphere) * [algo.mergeUVIslandsAffine](./algo_functions#mergeuvislandsaffine) * [algo.mergeUVIslandsRelaxed](./algo_functions#mergeuvislandsrelaxed) * [algo.normalizeUV](./algo_functions#normalizeuv) * [algo.removeUV](./algo_functions#removeuv) * [algo.repackUV](./algo_functions#repackuv) * [algo.resizeUVsToTextureSize](./algo_functions#resizeuvstotexturesize) * [algo.scaleUV](./algo_functions#scaleuv) * [algo.swapUvChannels](./algo_functions#swapuvchannels) * [algo.unwrapUV](./algo_functions#unwrapuv) * [algo.getFittingCylinder](./algo_functions#getfittingcylinder) * [algo.getFittingSphere](./algo_functions#getfittingsphere) * [algo.convertNormalMap](./algo_functions#convertnormalmap) * [algo.createBillboard](./algo_functions#createbillboard) * [algo.barySmooth](./algo_functions#barysmooth) * [algo.crackMoebiusStrips](./algo_functions#crackmoebiusstrips) * [algo.crackNonManifoldVertices](./algo_functions#cracknonmanifoldvertices) * [algo.createCavityOccurrences](./algo_functions#createcavityoccurrences) * [algo.invertPolygonFacesOrientation](./algo_functions#invertpolygonfacesorientation) * [algo.moebiusCracker](./algo_functions#moebiuscracker) * [algo.orientNormals](./algo_functions#orientnormals) * [algo.remeshSurfacicHoles](./algo_functions#remeshsurfacicholes) * [algo.removeDegeneratedPolygons](./algo_functions#removedegeneratedpolygons) * [algo.removeMultiplePolygon](./algo_functions#removemultiplepolygon) * [algo.removeZFighting](./algo_functions#removezfighting) * [algo.repairMesh](./algo_functions#repairmesh) * [algo.repairNullNormals](./algo_functions#repairnullnormals) * [algo.separateToManifold](./algo_functions#separatetomanifold) * [algo.sewBoundary](./algo_functions#sewboundary) * [algo.vertexOffset](./algo_functions#vertexoffset) * [algo.orientPolygonFaces](./algo_functions#orientpolygonfaces) * [algo.orientPolygonFacesAdvanced](./algo_functions#orientpolygonfacesadvanced) * [algo.orientPolygonFacesFromCamera](./algo_functions#orientpolygonfacesfromcamera) * [algo.equilateralize](./algo_functions#equilateralize) * [algo.quadify](./algo_functions#quadify) * [algo.requadify](./algo_functions#requadify) * [algo.triangularize](./algo_functions#triangularize) * [algo.createVertexWeightsFromVertexColors](./algo_functions#createvertexweightsfromvertexcolors) * [algo.createVertexWeightsFromVisibilityAttributes](./algo_functions#createvertexweightsfromvisibilityattributes) * [algo.deleteVertexWeights](./algo_functions#deletevertexweights) * [algo.createVisibilityAttributes](./algo_functions#createvisibilityattributes) * [algo.deletePolygonalWeightAttribute](./algo_functions#deletepolygonalweightattribute) * [algo.deleteVisibilityAttributes](./algo_functions#deletevisibilityattributes) * [algo.flagVisibilityAttributesOnTransparents](./algo_functions#flagvisibilityattributesontransparents) * [algo.transferVisibilityToPolygonalWeight](./algo_functions#transfervisibilitytopolygonalweight) * [io.exportScene](./io_functions#exportscene) * [io.importFiles](./io_functions#importfiles) * [io.importPicture](./io_functions#importpicture) * [io.importRemote3mxFile](./io_functions#importremote3mxfile) * [io.importScene](./io_functions#importscene) * [scene.addComponent](./scene_functions#addcomponent) * [scene.addComponents](./scene_functions#addcomponents) * [scene.addInParentInstances](./scene_functions#addinparentinstances) * [scene.computeSubTreeChecksum](./scene_functions#computesubtreechecksum) * [scene.createOBBMesh](./scene_functions#createobbmesh) * [scene.createOccurrence](./scene_functions#createoccurrence) * [scene.createOccurrenceFromSelection](./scene_functions#createoccurrencefromselection) * [scene.createOccurrences](./scene_functions#createoccurrences) * [scene.createPartsFromMeshes](./scene_functions#createpartsfrommeshes) * [scene.deleteComponentByType](./scene_functions#deletecomponentbytype) * [scene.deleteComponentsByType](./scene_functions#deletecomponentsbytype) * [scene.deleteEmptyOccurrences](./scene_functions#deleteemptyoccurrences) * [scene.deleteOccurrences](./scene_functions#deleteoccurrences) * [scene.getAABB](./scene_functions#getaabb) * [scene.getActiveMaterial](./scene_functions#getactivematerial) * [scene.getActiveMaterials](./scene_functions#getactivematerials) * [scene.getActivePropertyValue](./scene_functions#getactivepropertyvalue) * [scene.getActivePropertyValues](./scene_functions#getactivepropertyvalues) * [scene.getAncestors](./scene_functions#getancestors) * [scene.getComponent](./scene_functions#getcomponent) * [scene.getComponentByOccurrence](./scene_functions#getcomponentbyoccurrence) * [scene.getComponents](./scene_functions#getcomponents) * [scene.getGlobalMatrices](./scene_functions#getglobalmatrices) * [scene.getGlobalMatrix](./scene_functions#getglobalmatrix) * [scene.getGlobalVisibility](./scene_functions#getglobalvisibility) * [scene.getLocalMatrices](./scene_functions#getlocalmatrices) * [scene.getLocalMatrix](./scene_functions#getlocalmatrix) * [scene.getMBB](./scene_functions#getmbb) * [scene.getMaterialsFromSubtree](./scene_functions#getmaterialsfromsubtree) * [scene.getOBB](./scene_functions#getobb) * [scene.getOccurrenceActiveMaterial](./scene_functions#getoccurrenceactivematerial) * [scene.getOccurrenceName](./scene_functions#getoccurrencename) * [scene.getOccurrencesWithComponent](./scene_functions#getoccurrenceswithcomponent) * [scene.getPartOccurrences](./scene_functions#getpartoccurrences) * [scene.getPolygonCount](./scene_functions#getpolygoncount) * [scene.getSubTreeStats](./scene_functions#getsubtreestats) * [scene.getVertexCount](./scene_functions#getvertexcount) * [scene.getVolume](./scene_functions#getvolume) * [scene.getVolumes](./scene_functions#getvolumes) * [scene.hasComponent](./scene_functions#hascomponent) * [scene.hide](./scene_functions#hide) * [scene.inverseVisibility](./scene_functions#inversevisibility) * [scene.isAncestorOf](./scene_functions#isancestorof) * [scene.keepAncestors](./scene_functions#keepancestors) * [scene.listComponents](./scene_functions#listcomponents) * [scene.removeMaterials](./scene_functions#removematerials) * [scene.replaceMaterial](./scene_functions#replacematerial) * [scene.setComponentOccurrence](./scene_functions#setcomponentoccurrence) * [scene.setOccurrenceMaterial](./scene_functions#setoccurrencematerial) * [scene.setOccurrenceName](./scene_functions#setoccurrencename) * [scene.show](./scene_functions#show) * [scene.showOnly](./scene_functions#showonly) * [scene.transferCADMaterialsOnPartOccurrences](./scene_functions#transfercadmaterialsonpartoccurrences) * [scene.transferMaterialsOnPatches](./scene_functions#transfermaterialsonpatches) * [scene.createHierarchicalClusters](./scene_functions#createhierarchicalclusters) * [scene.generateOctree](./scene_functions#generateoctree) * [scene.getClusters](./scene_functions#getclusters) * [scene.getPartOccurrencesGroupedBySimilarity](./scene_functions#getpartoccurrencesgroupedbysimilarity) * [scene.findDuplicatedPartOccurrences](./scene_functions#findduplicatedpartoccurrences) * [scene.findOccurrencesByMetadata](./scene_functions#findoccurrencesbymetadata) * [scene.findOccurrencesByMetadataValue](./scene_functions#findoccurrencesbymetadatavalue) * [scene.findOccurrencesByProperty](./scene_functions#findoccurrencesbyproperty) * [scene.findPartOccurrencesByActiveMaterial](./scene_functions#findpartoccurrencesbyactivematerial) * [scene.findPartOccurrencesByMaximumSize](./scene_functions#findpartoccurrencesbymaximumsize) * [scene.createSubTree](./scene_functions#createsubtree) * [scene.getChildren](./scene_functions#getchildren) * [scene.getChildrenCount](./scene_functions#getchildrencount) * [scene.getFirstChild](./scene_functions#getfirstchild) * [scene.getNextSibling](./scene_functions#getnextsibling) * [scene.getOccurrenceAncestors](./scene_functions#getoccurrenceancestors) * [scene.getOccurrencesAncestors](./scene_functions#getoccurrencesancestors) * [scene.getParent](./scene_functions#getparent) * [scene.getPreviousSibling](./scene_functions#getprevioussibling) * [scene.getSubTree](./scene_functions#getsubtree) * [scene.moveOccurrences](./scene_functions#moveoccurrences) * [scene.setParent](./scene_functions#setparent) * [scene.addLightComponent](./scene_functions#addlightcomponent) * [scene.createLight](./scene_functions#createlight) * [scene.createMetadatasFromDefinitions](./scene_functions#createmetadatasfromdefinitions) * [scene.getSubpartMaterial](./scene_functions#getsubpartmaterial) * [scene.listSubpartMaterials](./scene_functions#listsubpartmaterials) * [scene.listSubpartVariantMaterials](./scene_functions#listsubpartvariantmaterials) * [scene.setSubpartMaterial](./scene_functions#setsubpartmaterial) * [scene.setSubpartMaterials](./scene_functions#setsubpartmaterials) * [scene.setSubpartVariantMaterials](./scene_functions#setsubpartvariantmaterials) * [scene.transferSubpartMaterialsOnPatches](./scene_functions#transfersubpartmaterialsonpatches) * [scene.createAlternativeTree](./scene_functions#createalternativetree) * [scene.animatesThisOccurrence](./scene_functions#animatesthisoccurrence) * [scene.bakeAnimation](./scene_functions#bakeanimation) * [scene.createSkeletonMesh](./scene_functions#createskeletonmesh) * [scene.getAnimChannelIfExists](./scene_functions#getanimchannelifexists) * [scene.getOccurrenceJoint](./scene_functions#getoccurrencejoint) * [scene.moveAnimation](./scene_functions#moveanimation) * [scene.getTessellationInfos](./scene_functions#gettessellationinfos) * [scene.print](./scene_functions#print) * [scene.evaluateExpressionOnOccurrences](./scene_functions#evaluateexpressiononoccurrences) * [scene.evaluateExpressionOnSubTree](./scene_functions#evaluateexpressiononsubtree) * [scene.getFilteredOccurrences](./scene_functions#getfilteredoccurrences) * [scene.isolate](./scene_functions#isolate) * [scene.findPartOccurrencesWithUnstitchedOpenShells](./scene_functions#findpartoccurrenceswithunstitchedopenshells) * [scene.mergeOccurrencesByTreeLevel](./scene_functions#mergeoccurrencesbytreelevel) * [scene.mergePartOccurrences](./scene_functions#mergepartoccurrences) * [scene.mergePartOccurrencesByAssemblies](./scene_functions#mergepartoccurrencesbyassemblies) * [scene.mergePartOccurrencesByFinalAssemblies](./scene_functions#mergepartoccurrencesbyfinalassemblies) * [scene.mergePartOccurrencesByMaterials](./scene_functions#mergepartoccurrencesbymaterials) * [scene.mergePartOccurrencesByName](./scene_functions#mergepartoccurrencesbyname) * [scene.mergePartOccurrencesByRegions](./scene_functions#mergepartoccurrencesbyregions) * [scene.mergePartOccurrencesWithSingleOpenShellByAssemblies](./scene_functions#mergepartoccurrenceswithsingleopenshellbyassemblies) * [scene.applyTransformation](./scene_functions#applytransformation) * [scene.createSymmetry](./scene_functions#createsymmetry) * [scene.rotate](./scene_functions#rotate) * [scene.setLocalMatrices](./scene_functions#setlocalmatrices) * [scene.setLocalMatrix](./scene_functions#setlocalmatrix) * [scene.alignPivotPointToWorld](./scene_functions#alignpivotpointtoworld) * [scene.movePivotPointToOccurrenceCenter](./scene_functions#movepivotpointtooccurrencecenter) * [scene.movePivotPointToOrigin](./scene_functions#movepivotpointtoorigin) * [scene.movePivotPointToSelectionCenter](./scene_functions#movepivotpointtoselectioncenter) * [scene.movePivotPointToTargetedOccurrenceCenter](./scene_functions#movepivotpointtotargetedoccurrencecenter) * [scene.setPivotOnly](./scene_functions#setpivotonly) * [scene.convertPMIToOccurrences](./scene_functions#convertpmitooccurrences) * [scene.getOccurrenceAnnotationDefinitions](./scene_functions#getoccurrenceannotationdefinitions) * [scene.cleanInstances](./scene_functions#cleaninstances) * [scene.getDirectInstances](./scene_functions#getdirectinstances) * [scene.getFinalPrototype](./scene_functions#getfinalprototype) * [scene.getInstances](./scene_functions#getinstances) * [scene.getPrototype](./scene_functions#getprototype) * [scene.getPrototypes](./scene_functions#getprototypes) * [scene.prototypeSubTree](./scene_functions#prototypesubtree) * [scene.setPrototype](./scene_functions#setprototype) * [scene.setPrototypes](./scene_functions#setprototypes) * [scene.updateChildrenPrototypes](./scene_functions#updatechildrenprototypes) * [scene.invertSelect](./scene_functions#invertselect) * [scene.select](./scene_functions#select) * [scene.unselect](./scene_functions#unselect) * [scene.compress](./scene_functions#compress) * [scene.convertToOldSchoolVisibility](./scene_functions#converttooldschoolvisibility) * [scene.getHiddenPartOccurrences](./scene_functions#gethiddenpartoccurrences) * [scene.getVisiblePartOccurrences](./scene_functions#getvisiblepartoccurrences) * [scene.makeInstanceUnique](./scene_functions#makeinstanceunique) * [scene.rake](./scene_functions#rake) * [scene.removeSymmetryMatrices](./scene_functions#removesymmetrymatrices) * [scene.resetPartTransform](./scene_functions#resetparttransform) * [scene.resetTransform](./scene_functions#resettransform) * [scene.rayCast](./scene_functions#raycast) * [scene.rayCastAll](./scene_functions#raycastall) * [scene.getMultipleOccurrenceUserData](./scene_functions#getmultipleoccurrenceuserdata) * [scene.getOccurrenceUserData](./scene_functions#getoccurrenceuserdata) * [scene.hasMultipleOccurrenceUserData](./scene_functions#hasmultipleoccurrenceuserdata) * [scene.hasOccurrenceUserData](./scene_functions#hasoccurrenceuserdata) * [scene.setMultipleOccurrenceUserData](./scene_functions#setmultipleoccurrenceuserdata) * [scene.setOccurrenceUserData](./scene_functions#setoccurrenceuserdata) * [scene.unsetMultipleOccurrenceUserData](./scene_functions#unsetmultipleoccurrenceuserdata) * [scene.unsetOccurrenceUserData](./scene_functions#unsetoccurrenceuserdata) * [view.createGPUScene](./view_functions#creategpuscene) * [view.getOccurrenceIndex](./view_functions#getoccurrenceindex) * [view.fitCamera](./view_functions#fitcamera) * [geom.applyTransform](./geom_functions#applytransform) * [geom.getEntityAABB](./geom_functions#getentityaabb) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) *** ### OccurrenceList List of [scene.Occurrence](./scene_types#occurrence) Functions accepting this type or a list of this type as a parameter: * [algo.assembleCAD](./algo_functions#assemblecad) * [algo.backToInitialBRep](./algo_functions#backtoinitialbrep) * [algo.bakeVertexAttributes](./algo_functions#bakevertexattributes) * [algo.calculateNormalsInPointClouds](./algo_functions#calculatenormalsinpointclouds) * [algo.crackCADMoebiusStrip](./algo_functions#crackcadmoebiusstrip) * [algo.crackEdges](./algo_functions#crackedges) * [algo.crackMeshEdges](./algo_functions#crackmeshedges) * [algo.createFreeEdgesFromPatches](./algo_functions#createfreeedgesfrompatches) * [algo.createIdentifiedPatchesFromPatches](./algo_functions#createidentifiedpatchesfrompatches) * [algo.createIndexMapFromOccurrences](./algo_functions#createindexmapfromoccurrences) * [algo.createNormals](./algo_functions#createnormals) * [algo.createPointCloudKDTree](./algo_functions#createpointcloudkdtree) * [algo.createTangents](./algo_functions#createtangents) * [algo.createVertexColorFromMaterials](./algo_functions#createvertexcolorfrommaterials) * [algo.createVisibilityPatchesFromPatch](./algo_functions#createvisibilitypatchesfrompatch) * [algo.decimate](./algo_functions#decimate) * [algo.decimateEdgeCollapse](./algo_functions#decimateedgecollapse) * [algo.decimatePointClouds](./algo_functions#decimatepointclouds) * [algo.decimateTarget](./algo_functions#decimatetarget) * [algo.deleteBRepShapes](./algo_functions#deletebrepshapes) * [algo.deleteFreeVertices](./algo_functions#deletefreevertices) * [algo.deleteLines](./algo_functions#deletelines) * [algo.deleteNormals](./algo_functions#deletenormals) * [algo.deletePatches](./algo_functions#deletepatches) * [algo.deletePolygons](./algo_functions#deletepolygons) * [algo.deleteTangents](./algo_functions#deletetangents) * [algo.deleteTextureCoordinates](./algo_functions#deletetexturecoordinates) * [algo.deleteVisibilityPatches](./algo_functions#deletevisibilitypatches) * [algo.evalDecimateErrorForTarget](./algo_functions#evaldecimateerrorfortarget) * [algo.extractNeutralAxis](./algo_functions#extractneutralaxis) * [algo.filletMesh](./algo_functions#filletmesh) * [algo.filterHiddenPolygons](./algo_functions#filterhiddenpolygons) * [algo.filterMeshVertexColors](./algo_functions#filtermeshvertexcolors) * [algo.findBestPivotBetweenOccurrences](./algo_functions#findbestpivotbetweenoccurrences) * [algo.getAllAxisFromCADModel](./algo_functions#getallaxisfromcadmodel) * [algo.getMeshVertexColors](./algo_functions#getmeshvertexcolors) * [algo.getOptimalTextureResolution](./algo_functions#getoptimaltextureresolution) * [algo.getTessellations](./algo_functions#gettessellations) * [algo.getUV3dRatio](./algo_functions#getuv3dratio) * [algo.getVisibilityStats](./algo_functions#getvisibilitystats) * [algo.getVisualComparisonFootprint](./algo_functions#getvisualcomparisonfootprint) * [algo.identifyLinesOfInterest](./algo_functions#identifylinesofinterest) * [algo.identifyPatches](./algo_functions#identifypatches) * [algo.identifySharpEdges](./algo_functions#identifysharpedges) * [algo.invertTangents](./algo_functions#inverttangents) * [algo.lineToTexture](./algo_functions#linetotexture) * [algo.listFeatures](./algo_functions#listfeatures) * [algo.loopSubdivMesh](./algo_functions#loopsubdivmesh) * [algo.mergeVertices](./algo_functions#mergevertices) * [algo.meshBooleanOperation](./algo_functions#meshbooleanoperation) * [algo.meshComparisonBatch](./algo_functions#meshcomparisonbatch) * [algo.meshIntersections](./algo_functions#meshintersections) * [algo.noiseMesh](./algo_functions#noisemesh) * [algo.optimizeCADLoops](./algo_functions#optimizecadloops) * [algo.optimizeForRendering](./algo_functions#optimizeforrendering) * [algo.optimizeSubMeshes](./algo_functions#optimizesubmeshes) * [algo.removeHoles](./algo_functions#removeholes) * [algo.repairCAD](./algo_functions#repaircad) * [algo.segmentMesh](./algo_functions#segmentmesh) * [algo.setFeatureComponentMaxIndex](./algo_functions#setfeaturecomponentmaxindex) * [algo.setMeshVertexColors](./algo_functions#setmeshvertexcolors) * [algo.smoothMesh](./algo_functions#smoothmesh) * [algo.splitUVForAtlas](./algo_functions#splituvforatlas) * [algo.sweep](./algo_functions#sweep) * [algo.tessellate](./algo_functions#tessellate) * [algo.tessellatePointClouds](./algo_functions#tessellatepointclouds) * [algo.tessellateRelativelyToAABB](./algo_functions#tessellaterelativelytoaabb) * [algo.voxelizePointClouds](./algo_functions#voxelizepointclouds) * [algo.beginBakingSession](./algo_functions#beginbakingsession) * [algo.beginVertexBakingSession](./algo_functions#beginvertexbakingsession) * [algo.combineMaterials](./algo_functions#combinematerials) * [algo.convexDecomposition](./algo_functions#convexdecomposition) * [algo.explodeBodies](./algo_functions#explodebodies) * [algo.explodeByMaterials](./algo_functions#explodebymaterials) * [algo.explodeByTopoDimension](./algo_functions#explodebytopodimension) * [algo.explodeByVertexCount](./algo_functions#explodebyvertexcount) * [algo.explodeByVoxel](./algo_functions#explodebyvoxel) * [algo.explodeConnectedMeshes](./algo_functions#explodeconnectedmeshes) * [algo.explodePatches](./algo_functions#explodepatches) * [algo.createVisibilityInformation](./algo_functions#createvisibilityinformation) * [algo.createVisibilityInformationAdvanced](./algo_functions#createvisibilityinformationadvanced) * [algo.createVisibilityInformationFromViewPoints](./algo_functions#createvisibilityinformationfromviewpoints) * [algo.findOccludedPartOccurrences](./algo_functions#findoccludedpartoccurrences) * [algo.findOccludedPartOccurrencesAdvanced](./algo_functions#findoccludedpartoccurrencesadvanced) * [algo.removeOccludedGeometries](./algo_functions#removeoccludedgeometries) * [algo.removeOccludedGeometriesAdvanced](./algo_functions#removeoccludedgeometriesadvanced) * [algo.removeOccludedGeometriesFromPoints](./algo_functions#removeoccludedgeometriesfrompoints) * [algo.removeOccludedGeometriesFromViewPoints](./algo_functions#removeoccludedgeometriesfromviewpoints) * [algo.createOcclusionMesh](./algo_functions#createocclusionmesh) * [algo.dualContouring](./algo_functions#dualcontouring) * [algo.marchingCubes](./algo_functions#marchingcubes) * [algo.proxyMesh](./algo_functions#proxymesh) * [algo.retopologize](./algo_functions#retopologize) * [algo.voxelize](./algo_functions#voxelize) * [algo.replaceBy](./algo_functions#replaceby) * [algo.replaceByBox](./algo_functions#replacebybox) * [algo.replaceByConvexHull](./algo_functions#replacebyconvexhull) * [algo.replaceByPrimitive](./algo_functions#replacebyprimitive) * [algo.sawWithAABB](./algo_functions#sawwithaabb) * [algo.sawWithOBB](./algo_functions#sawwithobb) * [algo.sawWithOctree](./algo_functions#sawwithoctree) * [algo.sawWithPlane](./algo_functions#sawwithplane) * [algo.convertSimilarPartOccurrencesToInstances](./algo_functions#convertsimilarpartoccurrencestoinstances) * [algo.convertSimilarPartOccurrencesToInstancesFast](./algo_functions#convertsimilarpartoccurrencestoinstancesfast) * [algo.findSimilarPartOccurrencesFast](./algo_functions#findsimilarpartoccurrencesfast) * [algo.alignUVIslands](./algo_functions#alignuvislands) * [algo.applyUvTransform](./algo_functions#applyuvtransform) * [algo.automaticUVMapping](./algo_functions#automaticuvmapping) * [algo.copyUV](./algo_functions#copyuv) * [algo.getRatioUV3D](./algo_functions#getratiouv3d) * [algo.getUVQualityMetrics](./algo_functions#getuvqualitymetrics) * [algo.getUvAabr](./algo_functions#getuvaabr) * [algo.hasOverlappingUV](./algo_functions#hasoverlappinguv) * [algo.mapUvOnAABB](./algo_functions#mapuvonaabb) * [algo.mapUvOnBox](./algo_functions#mapuvonbox) * [algo.mapUvOnCubicAABB](./algo_functions#mapuvoncubicaabb) * [algo.mapUvOnCustomAABB](./algo_functions#mapuvoncustomaabb) * [algo.mapUvOnCylinder](./algo_functions#mapuvoncylinder) * [algo.mapUvOnFittingCylinder](./algo_functions#mapuvonfittingcylinder) * [algo.mapUvOnFittingSphere](./algo_functions#mapuvonfittingsphere) * [algo.mapUvOnMBB](./algo_functions#mapuvonmbb) * [algo.mapUvOnPlane](./algo_functions#mapuvonplane) * [algo.mapUvOnSphere](./algo_functions#mapuvonsphere) * [algo.mergeUVIslandsAffine](./algo_functions#mergeuvislandsaffine) * [algo.mergeUVIslandsRelaxed](./algo_functions#mergeuvislandsrelaxed) * [algo.normalizeUV](./algo_functions#normalizeuv) * [algo.removeUV](./algo_functions#removeuv) * [algo.repackUV](./algo_functions#repackuv) * [algo.resizeUVsToTextureSize](./algo_functions#resizeuvstotexturesize) * [algo.scaleUV](./algo_functions#scaleuv) * [algo.swapUvChannels](./algo_functions#swapuvchannels) * [algo.unwrapUV](./algo_functions#unwrapuv) * [algo.getFittingCylinder](./algo_functions#getfittingcylinder) * [algo.getFittingSphere](./algo_functions#getfittingsphere) * [algo.convertNormalMap](./algo_functions#convertnormalmap) * [algo.createBillboard](./algo_functions#createbillboard) * [algo.barySmooth](./algo_functions#barysmooth) * [algo.crackMoebiusStrips](./algo_functions#crackmoebiusstrips) * [algo.crackNonManifoldVertices](./algo_functions#cracknonmanifoldvertices) * [algo.createCavityOccurrences](./algo_functions#createcavityoccurrences) * [algo.invertPolygonFacesOrientation](./algo_functions#invertpolygonfacesorientation) * [algo.moebiusCracker](./algo_functions#moebiuscracker) * [algo.orientNormals](./algo_functions#orientnormals) * [algo.remeshSurfacicHoles](./algo_functions#remeshsurfacicholes) * [algo.removeDegeneratedPolygons](./algo_functions#removedegeneratedpolygons) * [algo.removeMultiplePolygon](./algo_functions#removemultiplepolygon) * [algo.removeZFighting](./algo_functions#removezfighting) * [algo.repairMesh](./algo_functions#repairmesh) * [algo.repairNullNormals](./algo_functions#repairnullnormals) * [algo.separateToManifold](./algo_functions#separatetomanifold) * [algo.sewBoundary](./algo_functions#sewboundary) * [algo.vertexOffset](./algo_functions#vertexoffset) * [algo.orientPolygonFaces](./algo_functions#orientpolygonfaces) * [algo.orientPolygonFacesAdvanced](./algo_functions#orientpolygonfacesadvanced) * [algo.orientPolygonFacesFromCamera](./algo_functions#orientpolygonfacesfromcamera) * [algo.equilateralize](./algo_functions#equilateralize) * [algo.quadify](./algo_functions#quadify) * [algo.requadify](./algo_functions#requadify) * [algo.triangularize](./algo_functions#triangularize) * [algo.createVertexWeightsFromVertexColors](./algo_functions#createvertexweightsfromvertexcolors) * [algo.createVertexWeightsFromVisibilityAttributes](./algo_functions#createvertexweightsfromvisibilityattributes) * [algo.deleteVertexWeights](./algo_functions#deletevertexweights) * [algo.createVisibilityAttributes](./algo_functions#createvisibilityattributes) * [algo.deletePolygonalWeightAttribute](./algo_functions#deletepolygonalweightattribute) * [algo.deleteVisibilityAttributes](./algo_functions#deletevisibilityattributes) * [algo.flagVisibilityAttributesOnTransparents](./algo_functions#flagvisibilityattributesontransparents) * [algo.transferVisibilityToPolygonalWeight](./algo_functions#transfervisibilitytopolygonalweight) * [scene.addComponents](./scene_functions#addcomponents) * [scene.createOccurrenceFromSelection](./scene_functions#createoccurrencefromselection) * [scene.createOccurrences](./scene_functions#createoccurrences) * [scene.createPartsFromMeshes](./scene_functions#createpartsfrommeshes) * [scene.deleteOccurrences](./scene_functions#deleteoccurrences) * [scene.getAABB](./scene_functions#getaabb) * [scene.getActiveMaterials](./scene_functions#getactivematerials) * [scene.getActivePropertyValues](./scene_functions#getactivepropertyvalues) * [scene.getComponentByOccurrence](./scene_functions#getcomponentbyoccurrence) * [scene.getComponents](./scene_functions#getcomponents) * [scene.getGlobalMatrices](./scene_functions#getglobalmatrices) * [scene.getLocalMatrices](./scene_functions#getlocalmatrices) * [scene.getMBB](./scene_functions#getmbb) * [scene.getOBB](./scene_functions#getobb) * [scene.getPolygonCount](./scene_functions#getpolygoncount) * [scene.getSubTreeStats](./scene_functions#getsubtreestats) * [scene.getVertexCount](./scene_functions#getvertexcount) * [scene.getVolumes](./scene_functions#getvolumes) * [scene.hide](./scene_functions#hide) * [scene.inverseVisibility](./scene_functions#inversevisibility) * [scene.keepAncestors](./scene_functions#keepancestors) * [scene.removeMaterials](./scene_functions#removematerials) * [scene.replaceMaterial](./scene_functions#replacematerial) * [scene.show](./scene_functions#show) * [scene.showOnly](./scene_functions#showonly) * [scene.getClusters](./scene_functions#getclusters) * [scene.findOccurrencesByMetadata](./scene_functions#findoccurrencesbymetadata) * [scene.findOccurrencesByMetadataValue](./scene_functions#findoccurrencesbymetadatavalue) * [scene.findOccurrencesByProperty](./scene_functions#findoccurrencesbyproperty) * [scene.findPartOccurrencesByActiveMaterial](./scene_functions#findpartoccurrencesbyactivematerial) * [scene.findPartOccurrencesByMaximumSize](./scene_functions#findpartoccurrencesbymaximumsize) * [scene.getOccurrencesAncestors](./scene_functions#getoccurrencesancestors) * [scene.moveOccurrences](./scene_functions#moveoccurrences) * [scene.createMetadatasFromDefinitions](./scene_functions#createmetadatasfromdefinitions) * [scene.evaluateExpressionOnOccurrences](./scene_functions#evaluateexpressiononoccurrences) * [scene.isolate](./scene_functions#isolate) * [scene.mergeOccurrencesByTreeLevel](./scene_functions#mergeoccurrencesbytreelevel) * [scene.mergePartOccurrences](./scene_functions#mergepartoccurrences) * [scene.mergePartOccurrencesByAssemblies](./scene_functions#mergepartoccurrencesbyassemblies) * [scene.mergePartOccurrencesByFinalAssemblies](./scene_functions#mergepartoccurrencesbyfinalassemblies) * [scene.mergePartOccurrencesByMaterials](./scene_functions#mergepartoccurrencesbymaterials) * [scene.mergePartOccurrencesByRegions](./scene_functions#mergepartoccurrencesbyregions) * [scene.createSymmetry](./scene_functions#createsymmetry) * [scene.setLocalMatrices](./scene_functions#setlocalmatrices) * [scene.alignPivotPointToWorld](./scene_functions#alignpivotpointtoworld) * [scene.movePivotPointToOccurrenceCenter](./scene_functions#movepivotpointtooccurrencecenter) * [scene.movePivotPointToSelectionCenter](./scene_functions#movepivotpointtoselectioncenter) * [scene.movePivotPointToTargetedOccurrenceCenter](./scene_functions#movepivotpointtotargetedoccurrencecenter) * [scene.convertPMIToOccurrences](./scene_functions#convertpmitooccurrences) * [scene.getPrototypes](./scene_functions#getprototypes) * [scene.setPrototypes](./scene_functions#setprototypes) * [scene.invertSelect](./scene_functions#invertselect) * [scene.select](./scene_functions#select) * [scene.unselect](./scene_functions#unselect) * [scene.getHiddenPartOccurrences](./scene_functions#gethiddenpartoccurrences) * [scene.getVisiblePartOccurrences](./scene_functions#getvisiblepartoccurrences) * [scene.makeInstanceUnique](./scene_functions#makeinstanceunique) * [scene.getMultipleOccurrenceUserData](./scene_functions#getmultipleoccurrenceuserdata) * [scene.hasMultipleOccurrenceUserData](./scene_functions#hasmultipleoccurrenceuserdata) * [scene.setMultipleOccurrenceUserData](./scene_functions#setmultipleoccurrenceuserdata) * [scene.unsetMultipleOccurrenceUserData](./scene_functions#unsetmultipleoccurrenceuserdata) * [view.createGPUScene](./view_functions#creategpuscene) * [view.fitCamera](./view_functions#fitcamera) *** ### OccurrenceListList List of [scene.OccurrenceList](./scene_types#occurrencelist) *** ### OccurrenceUserData Identifier of occurrences userdata. Base class: [core.Ident](./core_types#ident) **Frame:** ```mermaid classDiagram class OccurrenceUserData Ident <|-- OccurrenceUserData ``` Functions accepting this type or a list of this type as a parameter: * [scene.getMultipleOccurrenceUserData](./scene_functions#getmultipleoccurrenceuserdata) * [scene.getOccurrenceUserData](./scene_functions#getoccurrenceuserdata) * [scene.hasMultipleOccurrenceUserData](./scene_functions#hasmultipleoccurrenceuserdata) * [scene.hasOccurrenceUserData](./scene_functions#hasoccurrenceuserdata) * [scene.setMultipleOccurrenceUserData](./scene_functions#setmultipleoccurrenceuserdata) * [scene.setOccurrenceUserData](./scene_functions#setoccurrenceuserdata) * [scene.unsetMultipleOccurrenceUserData](./scene_functions#unsetmultipleoccurrenceuserdata) * [scene.unsetOccurrenceUserData](./scene_functions#unsetoccurrenceuserdata) * [scene.unsubscribeFromOccurrenceUserData](./scene_functions#unsubscribefromoccurrenceuserdata) *** ### PMIComponent A PMI component (Product Manufacturing informations). Base class: [scene.Component](./scene_types#component) **Frame:** ```mermaid classDiagram class PMIComponent Component <|-- PMIComponent PMIComponent : +core.Ident Id ``` Functions accepting this type or a list of this type as a parameter: * [scene.addAnnotationGroup](./scene_functions#addannotationgroup) * [scene.getComponentOccurrence](./scene_functions#getcomponentoccurrence) * [scene.getComponentType](./scene_functions#getcomponenttype) * [scene.setComponentOccurrence](./scene_functions#setcomponentoccurrence) * [scene.getAnnotationGroups](./scene_functions#getannotationgroups) * [view.drawCappingPlane](./view_functions#drawcappingplane) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#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: * [scene.createSubTree](./scene_functions#createsubtree) *** ### Part A part is the geometrical definition of product occurrence. Base class: [scene.Component](./scene_types#component) **Frame:** ```mermaid classDiagram class Part Component <|-- Part Part : +core.Ident Id Part : +core.Entity BRepShapeInitial Part : +core.Entity BRepShapeModified Part : +core.Entity TessellatedShape Part : +geom.Matrix4 Transform ``` Functions accepting this type or a list of this type as a parameter: * [io.applyAutoTessellate](./io_functions#applyautotessellate) * [scene.getBrepShape](./scene_functions#getbrepshape) * [scene.getPartActiveShape](./scene_functions#getpartactiveshape) * [scene.getPartLocalMatrix](./scene_functions#getpartlocalmatrix) * [scene.getPartShapeType](./scene_functions#getpartshapetype) * [scene.listActiveShapeMaterials](./scene_functions#listactiveshapematerials) * [scene.getTessellationParameters](./scene_functions#gettessellationparameters) * [scene.getPartMesh](./scene_functions#getpartmesh) * [scene.getPartModel](./scene_functions#getpartmodel) * [scene.getPartsMeshes](./scene_functions#getpartsmeshes) * [scene.getPartsModels](./scene_functions#getpartsmodels) * [scene.getPartsTransforms](./scene_functions#getpartstransforms) * [scene.getPartsTransformsIndexed](./scene_functions#getpartstransformsindexed) * [scene.setPartMesh](./scene_functions#setpartmesh) * [scene.setPartModel](./scene_functions#setpartmodel) * [scene.setPartsTransforms](./scene_functions#setpartstransforms) * [scene.setPartsTransformsIndexed](./scene_functions#setpartstransformsindexed) * [scene.getPartUserData](./scene_functions#getpartuserdata) * [scene.hasPartUserData](./scene_functions#haspartuserdata) * [scene.setPartUserData](./scene_functions#setpartuserdata) * [scene.unsetPartUserData](./scene_functions#unsetpartuserdata) * [scene.getComponentOccurrence](./scene_functions#getcomponentoccurrence) * [scene.getComponentType](./scene_functions#getcomponenttype) * [scene.setComponentOccurrence](./scene_functions#setcomponentoccurrence) * [scene.getAnnotationGroups](./scene_functions#getannotationgroups) * [view.drawCappingPlane](./view_functions#drawcappingplane) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) *** ### PartList List of [scene.Part](./scene_types#part) Functions accepting this type or a list of this type as a parameter: * [scene.getPartsMeshes](./scene_functions#getpartsmeshes) * [scene.getPartsModels](./scene_functions#getpartsmodels) * [scene.getPartsTransforms](./scene_functions#getpartstransforms) * [scene.getPartsTransformsIndexed](./scene_functions#getpartstransformsindexed) * [scene.setPartsTransforms](./scene_functions#setpartstransforms) * [scene.setPartsTransformsIndexed](./scene_functions#setpartstransformsindexed) *** ### PartUserData Identifier of part userdata. Base class: [core.Ident](./core_types#ident) **Frame:** ```mermaid classDiagram class PartUserData Ident <|-- PartUserData ``` Functions accepting this type or a list of this type as a parameter: * [scene.getPartUserData](./scene_functions#getpartuserdata) * [scene.hasPartUserData](./scene_functions#haspartuserdata) * [scene.setPartUserData](./scene_functions#setpartuserdata) * [scene.unsetPartUserData](./scene_functions#unsetpartuserdata) * [scene.unsubscribeFromPartUserData](./scene_functions#unsubscribefrompartuserdata) *** ### PartialLoad\_Status Enum of [core.Long](./core_types#long) | Name | Value | | ------------ | ----- | | NOT\_LOADED | 0 | | LOADED | 1 | | LOADING | 2 | | LOADING\_ALL | 3 | *** ### Primitive\_Type Enum of [core.Long](./core_types#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](./core_types#entity) **Frame:** ```mermaid classDiagram class ProductView Entity <|-- ProductView ProductView : +core.Ident Id ProductView : +core.String Name ProductView : +core.Entity Tree ProductView : +core.String GroupName ProductView : +core.Boolean ViewIsSet ProductView : +geom.Matrix4 View ProductView : +core.Boolean ViewIsOrtho ProductView : +core.Real ViewFov ProductView : +core.Boolean CuttingPlane ProductView : +geom.Vector3 CuttingPlanePosition ProductView : +geom.Vector3 CuttingPlaneNormal ProductView : +core.Real ExplodedViewFactor ProductView : +core.Boolean ExplodedViewX ProductView : +core.Boolean ExplodedViewY ProductView : +core.Boolean ExplodedViewZ ``` Functions accepting this type or a list of this type as a parameter: * [scene.addAnnotationToProductView](./scene_functions#addannotationtoproductview) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#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: * [scene.createProductView](./scene_functions#createproductview) *** ### ProductViewDefinitionList List of [scene.ProductViewDefinition](./scene_types#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](./scene_types#propertyvalue) Derived class: [MetadataDefinition](./scene_types#metadatadefinition) **Frame:** ```mermaid classDiagram class PropertyValueList PropertyValueList <|-- MetadataDefinition ``` *** ### RayHit Fields | Type | Name | Default | Description | | ------------- | ---------- | ------- | ----------- | | rayParam | Double | -1 | | | occurrence | Occurrence | 0 | | | triangleIndex | Int | -1 | | | triangleParam | Point2 | | | *** ### RayHitList List of [scene.RayHit](./scene_types#rayhit) *** ### ReferencedDataComponent A ReferencedDataComponent contains the information necessary to individually load referenced sub-models. Base class: [scene.Component](./scene_types#component) **Frame:** ```mermaid classDiagram class ReferencedDataComponent Component <|-- ReferencedDataComponent ReferencedDataComponent : +core.Ident Id ReferencedDataComponent : +core.String FilePath ReferencedDataComponent : +core.String IdPath ReferencedDataComponent : +core.String ParentFilePath ``` Functions accepting this type or a list of this type as a parameter: * [io.loadReferencedData](./io_functions#loadreferenceddata) * [io.unloadReferencedData](./io_functions#unloadreferenceddata) * [scene.getPartialLoadingStatus](./scene_functions#getpartialloadingstatus) * [scene.setReferencedDataComponentParent](./scene_functions#setreferenceddatacomponentparent) * [scene.setReferencedDataComponentPath](./scene_functions#setreferenceddatacomponentpath) * [scene.getComponentOccurrence](./scene_functions#getcomponentoccurrence) * [scene.getComponentType](./scene_functions#getcomponenttype) * [scene.setComponentOccurrence](./scene_functions#setcomponentoccurrence) * [scene.getAnnotationGroups](./scene_functions#getannotationgroups) * [view.drawCappingPlane](./view_functions#drawcappingplane) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) *** ### ResizeByMaximumSizeOptions Fields | Type | Name | Default | Description | | ---------------- | ------- | ------- | ----------- | | TextureSize | Int | 4096 | | | KeepTextureRatio | Boolean | True | | *** ### ResizeByTexturesOptions Select between: * AllTextures: [core.None](./core_types#none) * Selection: [material.ImageList](./material_types#imagelist) *** ### ResizeTexturesInputMode Select between: * Occurrences: [scene.OccurrenceList](./scene_types#occurrencelist) * Textures: [scene.ResizeByTexturesOptions](./scene_types#resizebytexturesoptions) Functions accepting this type or a list of this type as a parameter: * [scene.resizeTextures](./scene_functions#resizetextures) *** ### ResizeTexturesResizeMode Select between: * Ratio: [core.Percent](./core_types#percent) * MaximumSize: [scene.ResizeByMaximumSizeOptions](./scene_types#resizebymaximumsizeoptions) Functions accepting this type or a list of this type as a parameter: * [scene.resizeTextures](./scene_functions#resizetextures) *** ### SceneChangeType Enum of [core.Long](./core_types#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](./core_types#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](./geom_types#geomentity) Derived classes: * [BRepShape](./scene_types#brepshape) * [TessellatedShape](./scene_types#tessellatedshape) **Frame:** ```mermaid classDiagram class Shape GeomEntity <|-- Shape Shape <|-- BRepShape BRepShape : +core.Ident Id BRepShape : +core.Entity Model Shape <|-- TessellatedShape TessellatedShape : +core.Ident Id TessellatedShape : +core.Entity Mesh ``` Functions accepting this type or a list of this type as a parameter: * [geom.applyTransform](./geom_functions#applytransform) * [geom.getEntityAABB](./geom_functions#getentityaabb) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) *** ### ShapeType Enum of [core.Long](./core_types#long) | Name | Value | | ----------- | ----- | | TESSELLATED | 0 | | CAD | 1 | | JOINT | 2 | *** ### SubPartMaterialComponent A sub part ( or sub mesh ) material component. Base class: [scene.Component](./scene_types#component) **Frame:** ```mermaid classDiagram class SubPartMaterialComponent Component <|-- SubPartMaterialComponent SubPartMaterialComponent : +core.Ident Id ``` Functions accepting this type or a list of this type as a parameter: * [scene.getMaterialsFromSubPart](./scene_functions#getmaterialsfromsubpart) * [scene.getComponentOccurrence](./scene_functions#getcomponentoccurrence) * [scene.getComponentType](./scene_functions#getcomponenttype) * [scene.setComponentOccurrence](./scene_functions#setcomponentoccurrence) * [scene.getAnnotationGroups](./scene_functions#getannotationgroups) * [view.drawCappingPlane](./view_functions#drawcappingplane) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) *** ### TessellatedShape A TessellatedShape is a Shape that contains Polygonal geometry. Base class: [scene.Shape](./scene_types#shape) **Frame:** ```mermaid classDiagram class TessellatedShape Shape <|-- TessellatedShape TessellatedShape : +core.Ident Id TessellatedShape : +core.Entity Mesh ``` Functions accepting this type or a list of this type as a parameter: * [geom.applyTransform](./geom_functions#applytransform) * [geom.getEntityAABB](./geom_functions#getentityaabb) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) *** ### TessellatedShapeList List of [scene.TessellatedShape](./scene_types#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](./core_types#entity) **Frame:** ```mermaid classDiagram class Variant Entity <|-- Variant Variant : +core.Ident Id Variant : +core.String Name Variant : +core.Entity Tree Variant : +core.String GroupName Variant : +core.Boolean ViewIsSet Variant : +geom.Matrix4 View Variant : +core.Boolean ViewIsOrtho Variant : +core.Real ViewFov Variant : +core.Boolean CuttingPlane Variant : +geom.Vector3 CuttingPlanePosition Variant : +geom.Vector3 CuttingPlaneNormal Variant : +core.Real ExplodedViewFactor Variant : +core.Boolean ExplodedViewX Variant : +core.Boolean ExplodedViewY Variant : +core.Boolean ExplodedViewZ ``` Functions accepting this type or a list of this type as a parameter: * [scene.setSubpartVariantMaterialsList](./scene_functions#setsubpartvariantmaterialslist) * [scene.getProductViewDefinition](./scene_functions#getproductviewdefinition) * [scene.duplicateVariant](./scene_functions#duplicatevariant) * [scene.getVariantTree](./scene_functions#getvarianttree) * [scene.removeVariant](./scene_functions#removevariant) * [scene.setCurrentVariant](./scene_functions#setcurrentvariant) * [scene.setVariantTree](./scene_functions#setvarianttree) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) *** ### VariantChangeType Enum of [core.Long](./core_types#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](./scene_types#component) **Frame:** ```mermaid classDiagram class VariantComponent Component <|-- VariantComponent VariantComponent : +core.Ident Id VariantComponent : +core.InheritableBool VariantSensitive VariantComponent : +core.String GroupName ``` Functions accepting this type or a list of this type as a parameter: * [scene.getVariantComponentsDefinitions](./scene_functions#getvariantcomponentsdefinitions) * [scene.getComponentOccurrence](./scene_functions#getcomponentoccurrence) * [scene.getComponentType](./scene_functions#getcomponenttype) * [scene.setComponentOccurrence](./scene_functions#setcomponentoccurrence) * [scene.getAnnotationGroups](./scene_functions#getannotationgroups) * [view.drawCappingPlane](./view_functions#drawcappingplane) * [core.cloneEntity](./core_functions#cloneentity) * [core.deleteEntities](./core_functions#deleteentities) * [core.entityExists](./core_functions#entityexists) * [core.getEntityType](./core_functions#getentitytype) * [core.getEntityTypeString](./core_functions#getentitytypestring) * [core.addCustomProperties](./core_functions#addcustomproperties) * [core.addCustomProperty](./core_functions#addcustomproperty) * [core.getProperties](./core_functions#getproperties) * [core.getProperty](./core_functions#getproperty) * [core.getPropertyInfo](./core_functions#getpropertyinfo) * [core.hasCustomProperty](./core_functions#hascustomproperty) * [core.hasProperty](./core_functions#hasproperty) * [core.listProperties](./core_functions#listproperties) * [core.listPropertiesBatch](./core_functions#listpropertiesbatch) * [core.removeCustomProperty](./core_functions#removecustomproperty) * [core.setProperties](./core_functions#setproperties) * [core.setProperty](./core_functions#setproperty) * [core.supportCustomProperties](./core_functions#supportcustomproperties) * [core.unsetProperty](./core_functions#unsetproperty) * [scene.linkPropertyToAnimation](./scene_functions#linkpropertytoanimation) * [scene.unlinkPropertyToAnimation](./scene_functions#unlinkpropertytoanimation) *** ### VariantComponentList List of [scene.VariantComponent](./scene_types#variantcomponent) Functions accepting this type or a list of this type as a parameter: * [scene.getVariantComponentsDefinitions](./scene_functions#getvariantcomponentsdefinitions) *** ### VariantDefinition Fields | Type | Name | Default | Description | | ------------------- | ----------------- | ------- | ----------- | | variant | Variant | 0 | | | overridedProperties | PropertyValueList | \[] | | *** ### VariantDefinitionList List of [scene.VariantDefinition](./scene_types#variantdefinition) *** ### VariantDefinitionListList List of [scene.VariantDefinitionList](./scene_types#variantdefinitionlist) *** ### VariantList List of [scene.Variant](./scene_types#variant) Functions accepting this type or a list of this type as a parameter: * [scene.setSubpartVariantMaterialsList](./scene_functions#setsubpartvariantmaterialslist) *** ### VariantMaterialList List of [scene.VariantMaterials](./scene_types#variantmaterials) Functions accepting this type or a list of this type as a parameter: * [scene.setSubpartVariantMaterials](./scene_functions#setsubpartvariantmaterials) *** ### 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: * [scene.setSubpartVariantMaterials](./scene_functions#setsubpartvariantmaterials) *** ### VisibilityMode Enum | Name | Value | | --------- | ----- | | Inherited | 0 | | Hide | 1 | Functions accepting this type or a list of this type as a parameter: * [scene.getSubTree](./scene_functions#getsubtree)