Documentation

Support

Asset Transformer SDK

User Manual

Python API

C# API

Changelog

Discussions

Asset Transformer SDK

Scene

Python API types
Read time 31 minutesLast updated 21 hours ago

AlternativeTree

An AlternativeTree is an alternative product structure tree. Base class: core.Entity
Functions accepting this type or a list of this type as a parameter:

AlternativeTreeList

List of scene.AlternativeTree

AnimChannel

A container of AnimCurves. Base class: core.Entity
Functions accepting this type or a list of this type as a parameter:

AnimChannelInfo

Fields

Type

Name

Default

Description

nameString
typeAnimChannelTypeSIMPLE
mainPropertyBinderIdent0
hasKeyFramesBoolFalse

AnimChannelList

List of scene.AnimChannel

AnimChannelType

Enum of core.Long

Name

Value

SIMPLE0
VECTOR31
QUATERNION2
MATRIX43

AnimPropertyBinder

Fields

Type

Name

Default

Description

occurrenceOccurrence0
animationAnimation0
mainChannelAnimChannel0

AnimPropertyBinderList

List of scene.AnimPropertyBinder

Animation

An Animation allows to animate several properties through several AnimPropertyBinder. Base class: core.Entity
Functions accepting this type or a list of this type as a parameter:

AnimationComponent

A Levels of Detail component (contains multiple LOD). Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:

AnimationInfo

Fields

Type

Name

Default

Description

nameString
groupString
lengthAnimationTime0

AnimationList

List of scene.Animation

AnimationTime

Base class: core.ULong
Functions accepting this type or a list of this type as a parameter:

Annotation

An annotation. Base class: core.Entity
Functions accepting this type or a list of this type as a parameter:

AnnotationDefinition

Annotation definition. Fields

Type

Name

Default

Description

idAnnotation0The annotation we get the definition.
nameStringName of the annotation.
visibleBooleanFalseVisibility of the annotation.
groupAnnotationGroup0Group of the annotation.
shapesTessellatedShapeListShapes of the annotation.
Functions accepting this type or a list of this type as a parameter:

AnnotationDefinitionList

List of scene.AnnotationDefinition

AnnotationGroup

A group of annotation. Base class: core.Entity
Functions accepting this type or a list of this type as a parameter:

AnnotationGroupList

List of scene.AnnotationGroup

AnnotationList

List of scene.Annotation Functions accepting this type or a list of this type as a parameter:

BRepShape

A BRepShape is a Shape that contains BRep geometry. Base class: scene.Shape
Functions accepting this type or a list of this type as a parameter:

CameraComponent

A camera component. Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:

Component

A component add behavior to an occurrence. Base class: core.Entity Derived classes:
Functions accepting this type or a list of this type as a parameter:

ComponentChangeType

Enum of core.Long

Name

Value

COMPONENT_ADDED0
COMPONENT_REMOVED1
COMPONENT_MODIFIED2

ComponentList

List of scene.Component

ComponentType

Enum

Name

Value

Part0
PMI1
Light2
VisualBehavior3
InteractionBehavior4
Metadata5
Variant6
Animation7
Joint8
Widget9
LODComponent10
ExternalDataComponent11
HLODComponent12
CuttingPlaneComponent13
ReferencedDataComponent14
CameraComponent15
FeatureComponent16
SubpartMaterial17
Functions accepting this type or a list of this type as a parameter:

ExternalDataComponent

A ExternalDataComponent is a component that add external data to an occurrence. Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:

Filter

Fields

Type

Name

Default

Description

idIdent0
nameString
exprFilterExpression

FilterExpression

A filter expression (see documentation). Base class: core.String
Functions accepting this type or a list of this type as a parameter:

FilterList

List of scene.Filter

JointComponent

A joint for rigged animations. Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:

JointDefinition

Joint definition. Fields

Type

Name

Default

Description

idJoint0The joint from which we get the definition.
jointComponentComponent0The JointComponent attached to this joint.
isRootBooleanFalseIs this joint the root.
rootJointJoint0The joint used as root.
parentJoint0Vertices tangents.
childrenJointListAll direct hildren joint.
matrixMatrix4Local matrix.
gloablMatrixMatrix4Global matrix.

JointDefinitionList

List of scene.JointDefinition

Keyframe

A keyframe to interpolate an AnimCurve from. Base class: core.Entity
Functions accepting this type or a list of this type as a parameter:

KeyframeList

List of scene.Keyframe

LOD

A Level of Detail (references an Occurrence). Base class: core.Entity
Functions accepting this type or a list of this type as a parameter:

LODComponent

A Levels of Detail component (contains multiple LOD). Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:

LODComponentList

List of scene.LODComponent

LODList

List of scene.LOD

LightComponent

A LightComponent is a component that add a light behavior to an occurrence. Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:

LightType

Enum

Name

Value

DirectionalLight0
PositionalLight1
SpotLight2
Functions accepting this type or a list of this type as a parameter:

MaterialCount

Fields

Type

Name

Default

Description

materialMaterial0
countInt-1

MaterialCountList

List of scene.MaterialCount

MergeByRegionsStrategy

Select between:

MergeHiddenPartsMode

Enum

Name

Value

Destroy0
MakeVisible1
MergeSeparately2
Functions accepting this type or a list of this type as a parameter:

MergeStrategy

Enum of core.Int

Name

Value

mergePartOccurrences0
MergeByMaterials1
Functions accepting this type or a list of this type as a parameter:

Metadata

A metadata is a component that contains all metadata properties of an occurrence. Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:

MetadataDefinition

All properties of a metadata component. Base class: scene.PropertyValueList
Functions accepting this type or a list of this type as a parameter:

MetadataDefinitionList

List of scene.MetadataDefinition Functions accepting this type or a list of this type as a parameter:

MetadataList

List of scene.Metadata Functions accepting this type or a list of this type as a parameter:

Occurrence

An occurrence is the main type of node in the product structure, it can have children and prototypes. Base class: geom.GeomEntity
Functions accepting this type or a list of this type as a parameter:

OccurrenceList

List of scene.Occurrence Functions accepting this type or a list of this type as a parameter:

OccurrenceListList

List of scene.OccurrenceList

OccurrenceUserData

Identifier of occurrences userdata. Base class: core.Ident
Functions accepting this type or a list of this type as a parameter:

PMIComponent

A PMI component (Product Manufacturing informations). Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:

PackedTree

Packed view of the scene tree. Fields

Type

Name

Default

Description

occurrencesOccurrenceListList of all occurrences of the tree. (Note: all parent occurrences appears before their children, thus the first occurrence is the root).
parentsIntListSpecifies the parent index for each occurrence (same index than occurrences). root's parent is -1.
namesStringListName of each occurrence (same index than occurrences).
visibleInheritableBoolListVisibility of each occurrence (same index than occurrences).
materialsMaterialListMaterial identifier of each occurrence (same index than occurrences).
transformIndicesIntListIndices of transform matrix of each occurrence (same index than occurrences). (Note: Identity matrix is always 0).
transformMatricesMatrix4ListMatrices referenced by transformIndices. (Note: The first matrix is always Identity).
customPropertiesStringPairListListCustom properties of each occurrence (same index than occurrences), pair is name -> value.
Functions accepting this type or a list of this type as a parameter:

Part

A part is the geometrical definition of product occurrence. Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:

PartList

List of scene.Part Functions accepting this type or a list of this type as a parameter:

PartialLoad_Status

Enum of core.Long

Name

Value

NOT_LOADED0
LOADED1
LOADING2
LOADING_ALL3

Primitive_Type

Enum of core.Long

Name

Value

CUBE0
SPHERE1
PLAN2
CONE3
ARROW4
CYLINDER5
CAPSULE6

ProberInfo

Fields

Type

Name

Default

Description

occurrenceOccurrence0
positionPoint3

ProductView

A product view defines a variant with a camera view and annotations. Base class: core.Entity
Functions accepting this type or a list of this type as a parameter:

ProductViewDefinition

ProductionView definition. Fields

Type

Name

Default

Description

idVariant0The productview we get the definition.
nameStringName of the view.
groupNameStringName of the group of view.
viewMatrix4View matrix of this view.
viewIsSetBooleanFalseTrue if view is set.
viewIsOrthoBooleanFalseTrue if view is orthographic.
viewFovDouble60Fov of the camera.
cuttingPlaneBooleanFalseTrue if cutting plane is set.
cuttingPlanePositionVector3Position of the cutting plane.
cuttingPlaneNormalVector3Normal of the cutting plane.
explodedViewFactorDouble60Fov of the camera.
explodedViewXBooleanFalseTrue if exploded along X axis.
explodedViewYBooleanFalseTrue if exploded along Y axis.
explodedViewZBooleanFalseTrue if exploded along Z axis.
annotationsAnnotationListAnnotations linked to this view.
Functions accepting this type or a list of this type as a parameter:

ProductViewDefinitionList

List of scene.ProductViewDefinition

PropertyValue

A structure containing a property name and its value. Fields

Type

Name

Default

Description

nameStringName of the property.
valueStringValue of the property.

PropertyValueList

List of PropertyValue. List of scene.PropertyValue Derived class: MetadataDefinition

RayHit

Fields

Type

Name

Default

Description

rayParamDouble-1
occurrenceOccurrence0
triangleIndexInt-1
triangleParamPoint2

RayHitList

List of scene.RayHit

ReferencedDataComponent

A ReferencedDataComponent contains the information necessary to individually load referenced sub-models. Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:

ResizeByMaximumSizeOptions

Fields

Type

Name

Default

Description

TextureSizeInt4096
KeepTextureRatioBooleanTrue

ResizeByTexturesOptions

Select between:

ResizeTexturesInputMode

Select between:

ResizeTexturesResizeMode

Select between:

SceneChangeType

Enum of core.Long

Name

Value

PRE_CHILD_INSERTED0
CHILD_REMOVED1
PROPERTY_CHANGED2
COMPLETE_CHANGE3
COMPONENT_CHANGED4
POST_CHILD_INSERTED5
POST_CHILD_REMOVED6

SelectionChangeType

Enum of core.Long

Name

Value

CLEARED0
ADDED1
REMOVED2

Shape

A Shape is the geometrical representation of a Part. It can be BRep or polygonal. Base class: geom.GeomEntity Derived classes:
Functions accepting this type or a list of this type as a parameter:

ShapeType

Enum of core.Long

Name

Value

TESSELLATED0
CAD1
JOINT2

TessellatedShape

A TessellatedShape is a Shape that contains Polygonal geometry. Base class: scene.Shape
Functions accepting this type or a list of this type as a parameter:

TessellatedShapeList

List of scene.TessellatedShape

UVGenerationMode

Enum

Name

Value

NO_UV0
INTRINSIC_UV1
CONFORMED_SCALED_UV2

Variant

A variant allows to override some occurrences properties. Base class: core.Entity
Functions accepting this type or a list of this type as a parameter:

VariantChangeType

Enum of core.Long

Name

Value

ADDED0
REMOVED1
CURRENT_CHANGED2

VariantComponent

A variant component is a component that contains variant definitions for an occurrence. Base class: scene.Component
Functions accepting this type or a list of this type as a parameter:

VariantComponentList

List of scene.VariantComponent Functions accepting this type or a list of this type as a parameter:

VariantDefinition

Fields

Type

Name

Default

Description

variantVariant0
overridedPropertiesPropertyValueList[]

VariantDefinitionList

List of scene.VariantDefinition

VariantDefinitionListList

List of scene.VariantDefinitionList

VariantList

List of scene.Variant Functions accepting this type or a list of this type as a parameter:

VariantMaterialList

List of scene.VariantMaterials Functions accepting this type or a list of this type as a parameter:

VariantMaterials

Variant and materials in variant . Fields

Type

Name

Default

Description

idVariant0The variant id.
materialsMaterialListThe material list.
Functions accepting this type or a list of this type as a parameter:

VisibilityMode

Enum

Name

Value

Inherited0
Hide1
Functions accepting this type or a list of this type as a parameter: