Scene

Python API types

読み終わるまでの所要時間 32 分

最終更新 2日前

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
name	String
type	AnimChannelType	SIMPLE
mainPropertyBinder	Ident	0
hasKeyFrames	Bool	False

AnimChannelList

List of scene.AnimChannel

AnimChannelType

Enum of core.Long

Name	Value
SIMPLE	0
VECTOR3	1
QUATERNION	2
MATRIX4	3

AnimPropertyBinder

Fields

Type	Name	Default	Description
occurrence	Occurrence	0
animation	Animation	0
mainChannel	AnimChannel	0

AnimPropertyBinderList

List of scene.AnimPropertyBinder

Animation

An Animation allows to animate several properties through several AnimPropertyBinder. Base class: core.Entity

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

AnimationComponent

An Animation component. Base class: scene.Component

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

AnimationInfo

Fields

Type	Name	Default
name	String
group	String
length	AnimationTime	0

AnimationList

List of scene.Animation

AnimationTime

Base class: core.ULong

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

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
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

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:

scene.getAnnotationListAABB

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_ADDED	0
COMPONENT_REMOVED	1
COMPONENT_MODIFIED	2

ComponentList

List of scene.Component

ComponentType

Enum

Name	Value
Part	0
PMI	1
Light	2
VisualBehavior	3
InteractionBehavior	4
Metadata	5
Variant	6
Animation	7
Joint	8
Widget	9
LODComponent	10
ExternalDataComponent	11
HLODComponent	12
CuttingPlaneComponent	13
ReferencedDataComponent	14
CameraComponent	15
FeatureComponent	16
SubpartMaterial	17

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

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
id	Ident	0
name	String
expr	FilterExpression

FilterExpression

A filter expression (see documentation). Base class: core.String

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

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
id	Joint	0	The joint from which we get the definition.
jointComponent	Component	0	The JointComponent attached to this joint.
isRoot	Boolean	False	Is this joint the root.
rootJoint	Joint	0	The joint used as root.
parent	Joint	0	Vertices tangents.
children	JointList		All direct hildren joint.
matrix	Matrix4		Local matrix.
gloablMatrix	Matrix4		Global matrix.

JointDefinitionList

List of scene.JointDefinition

Keyframe

A keyframe to interpolate an AnimCurve from. Base class: core.Entity

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

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
DirectionalLight	0
PositionalLight	1
SpotLight	2

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

MaterialCount

Fields

Type	Name	Default	Description
material	Material	0
count	Int	-1

MaterialCountList

List of scene.MaterialCount

MergeByRegionsStrategy

Select between:

NumberOfRegions: core.Int
SizeOfRegions: geom.Distance Functions accepting this type or a list of this type as a parameter:
scene.getClusters
scene.mergePartOccurrencesByRegions

MergeHiddenPartsMode

Enum

Name	Value
Destroy	0
MakeVisible	1
MergeSeparately	2

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

MergeStrategy

Enum of core.Int

Name	Value
mergePartOccurrences	0
MergeByMaterials	1

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

scene.mergePartOccurrencesByRegions

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:

scene.createMetadatasFromDefinitions

MetadataDefinitionList

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

scene.createMetadatasFromDefinitions

MetadataList

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

scene.getMetadatasDefinitions

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	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

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:

PartUserData

Identifier of part userdata. Base class: core.Ident

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

PartialLoad_Status

Enum of core.Long

Name	Value
NOT_LOADED	0
LOADED	1
LOADING	2
LOADING_ALL	3

Primitive_Type

Enum of core.Long

Name	Value
CUBE	0
SPHERE	1
PLAN	2
CONE	3
ARROW	4
CYLINDER	5
CAPSULE	6

ProberInfo

Fields

Type	Name	Default	Description
occurrence	Occurrence	0
position	Point3

ProductView

A product view defines a variant with a camera view and annotations. Base class: core.Entity

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

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

ProductViewDefinitionList

List of scene.ProductViewDefinition

PropertyValue

A structure containing a property name and its value. Fields

Type	Name	Default	Description
name	String		Name of the property.
value	String		Value of the property.

PropertyValueList

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

RayHit

Fields

Type	Name	Default
rayParam	Double	-1
occurrence	Occurrence	0
triangleIndex	Int	-1
triangleParam	Point2

RayHitList

List of scene.RayHit

ReferencedDataComponent

A ReferencedDataComponent contains the information necessary to individually load referenced sub-models. Base class: scene.Component

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

ResizeByMaximumSizeOptions

Fields

Type	Name	Default	Description
TextureSize	Int	4096
KeepTextureRatio	Boolean	True

ResizeByTexturesOptions

Select between:

AllTextures: core.None
Selection: material.ImageList

ResizeTexturesInputMode

Select between:

Occurrences: scene.OccurrenceList
Textures: scene.ResizeByTexturesOptions Functions accepting this type or a list of this type as a parameter:
scene.resizeTextures

ResizeTexturesResizeMode

Select between:

Ratio: core.Percent
MaximumSize: scene.ResizeByMaximumSizeOptions Functions accepting this type or a list of this type as a parameter:
scene.resizeTextures

SceneChangeType

Enum of core.Long

Name	Value
PRE_CHILD_INSERTED	0
CHILD_REMOVED	1
PROPERTY_CHANGED	2
COMPLETE_CHANGE	3
COMPONENT_CHANGED	4
POST_CHILD_INSERTED	5
POST_CHILD_REMOVED	6

SelectionChangeType

Enum of core.Long

Name	Value
CLEARED	0
ADDED	1
REMOVED	2

Shape

A Shape is the geometrical representation of a Part. It can be BRep or polygonal. Base class: geom.GeomEntity Derived classes:

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

ShapeType

Enum of core.Long

Name	Value
TESSELLATED	0
CAD	1
JOINT	2

SubPartMaterialComponent

A sub part ( or sub mesh ) material component. Base class: scene.Component

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

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_UV	0
INTRINSIC_UV	1
CONFORMED_SCALED_UV	2

Variant

A variant allows to override some occurrences properties. Base class: core.Entity

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

VariantChangeType

Enum of core.Long

Name	Value
ADDED	0
REMOVED	1
CURRENT_CHANGED	2

VariantComponent

A variant component is a component that contains variant definitions for an occurrence. Base class: scene.Component

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

VariantComponentList

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

scene.getVariantComponentsDefinitions

VariantDefinition

Fields

Type	Name	Default	Description
variant	Variant	0
overridedProperties	PropertyValueList	[]

VariantDefinitionList

List of scene.VariantDefinition

VariantDefinitionListList

List of scene.VariantDefinitionList

VariantList

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

scene.setSubpartVariantMaterialsList

VariantMaterialList

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

scene.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

VisibilityMode

Enum

Name	Value
Inherited	0
Hide	1

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

scene.getSubTree

Scene

AlternativeTree

AlternativeTreeList

AnimChannel

AnimChannelInfo

Type

Name

Default

Description

AnimChannelList

AnimChannelType

Name

Value

AnimPropertyBinder

Type

Name

Default

Description

AnimPropertyBinderList

Animation

AnimationComponent

AnimationInfo

Type

Name

Default

Description

AnimationList

AnimationTime

Annotation

AnnotationDefinition

Type

Name

Default

Description

AnnotationDefinitionList

AnnotationGroup

AnnotationGroupList

AnnotationList

BRepShape

CameraComponent

Component

ComponentChangeType

Name

Value

ComponentList

ComponentType

Name

Value

ExternalDataComponent

Filter

Type

Name

Default

Description

FilterExpression

FilterList

JointComponent

JointDefinition

Type

Name

Default

Description

JointDefinitionList

Keyframe

KeyframeList

LOD

LODComponent

LODComponentList

LODList

LightComponent

LightType

Name

Value

MaterialCount

Type

Name

Default

Description

MaterialCountList

MergeByRegionsStrategy