Class Scene

Inheritance

Scene

Namespace:

Syntax

Methods

addComponent

Add a component to an occurrence

Declaration

scene.addComponent(occurrence, componentType) -> scene.Component

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence to add the new component
ComponentType	componentType	Type of the component

Returns

Type	Description
Component	The new component added to occurrence

addComponents

Add a components to each occurrence in the array

Declaration

scene.addComponents(occurrences, componentType) -> scene.ComponentList

Parameters

Type	Name	Description
OccurrenceList	occurrences	Occurrences that need the component to be added
ComponentType	componentType	Type of the component

Returns

Type	Description
ComponentList	Component that were added or retrieved

addInParentInstances

Add an instance of prototype's child as child in current occurrence recursively

Declaration

scene.addInParentInstances(root)

Parameters

Type	Name	Description
Occurrence	root	The occurrence to test.

cleanUnusedImages

Remove unused images from texture library

Declaration

scene.cleanUnusedImages() -> core.Int

Returns

Type	Description
Int	The number of texture deleted by the clean

cleanUnusedMaterials

Remove unused materials from material library

Declaration

scene.cleanUnusedMaterials(cleanImages=False) -> core.Int

Parameters

Type	Name	Description
Boolean	cleanImages	Call cleanUnusedImages if true

Returns

Type	Description
Int	The number of material deleted by the clean

computeSubTreeChecksum

Compute the checksum of a sub-tree

Declaration

scene.computeSubTreeChecksum(root=None) -> core.String

Parameters

Type	Name	Description
Occurrence	root	Occurrence to compute

Returns

Type	Description
String

configureFunctionLogger

Declaration

scene.configureFunctionLogger(functionName, enableFunction, enableParameters, enableExecutionTime)

Parameters

Type	Name	Description
String	functionName
Boolean	enableFunction
Boolean	enableParameters
Boolean	enableExecutionTime

convertMaterialsToColor

Convert all materials to materials with a color pattern, trying to keep the visual aspect as similar as possible

Declaration

scene.convertMaterialsToColor(materials=[])

Parameters

Type	Name	Description
MaterialList	materials	Materials to merge (merge all materials if empty)

convertMaterialsToPBR

Convert all materials to materials with a PBR pattern, trying to keep the visual aspect as similar as possible

Declaration

scene.convertMaterialsToPBR(materials=[])

Parameters

Type	Name	Description
MaterialList	materials	Materials to merge (merge all materials if empty)

createHierarchicalClusters

Reorganize a sub tree with hierarchical clustering

Declaration

scene.createHierarchicalClusters(root, childrenCountByNode=2, minFitting=-1) -> scene.Occurrence

Parameters

Type	Name	Description
Occurrence	root	Root of the sub-tree to reorganize
Int	childrenCountByNode	Order of the hierarchical tree
Coeff	minFitting	Minimal fitting coefficient to allow 2 nodes to be merged/clustered

Returns

Type	Description
Occurrence	Hierarchical clustering root

createOBBMesh

Declaration

scene.createOBBMesh(occurrence) -> scene.Occurrence

Parameters

Type	Name	Description
Occurrence	occurrence

Returns

Type	Description
Occurrence	The create occurrence

createOccurrence

Create a new occurrence

Declaration

scene.createOccurrence(name, parent=None) -> scene.Occurrence

Parameters

Type	Name	Description
String	name	Name of the new occurrence
Occurrence	parent	Create the occurrence as a child of parent, if not set the parent will be root

Returns

Type	Description
Occurrence	Created occurrence

createOccurrenceFromSelection

Create a new occurrence and add the given occurrences as children

Declaration

scene.createOccurrenceFromSelection(name, children, parent, keepMaterialAssignment=True) -> scene.Occurrence

Parameters

Type	Name	Description
String	name	Name of the new occurrence
OccurrenceList	children	Add given occurrence as children (if any)
Occurrence	parent	If defined, the new occurrence will be created as a child of this parent. Else if children are defined, the first common parent of children will be used as a parent for this new occurrence. Last resort will be to use the root as parent
Boolean	keepMaterialAssignment	If defined, material assignation will be updated to keep the visual same aspect

Returns

Type	Description
Occurrence	Created occurrence

createOccurrenceFromText

Creates an occurrence from string

Declaration

scene.createOccurrenceFromText(text, font="ChicFont", fontSize=64, color=None, heigth3D=40) -> scene.Occurrence

Parameters

Type	Name	Description
String	text	The occurrence's name
String	font	The font to use
Int	fontSize	The font size
ColorAlpha	color	The occurrence color
Double	heigth3D	3D height of text

Returns

Type	Description
Occurrence

createOccurrences

Create one new occurrence under each given parent

Declaration

scene.createOccurrences(name, parents=None) -> scene.OccurrenceList

Parameters

Type	Name	Description
String	name	Name of the new occurrence
OccurrenceList	parents	Create the occurrences as a child of each parent. If empty, one occurrence will be created with root as parent

Returns

Type	Description
OccurrenceList	Created occurrences

createPartsFromMeshes

Create a set of Parts given meshes and occurrences

Declaration

scene.createPartsFromMeshes(occurrences, meshes) -> scene.PartList

Parameters

Type	Name	Description
OccurrenceList	occurrences	The occurrence which will contains the part component of the mesh at the same index
MeshList	meshes	List of mesh to create part, if the mesh is invalid (e.g 0) no part will be created and 0 will be returned in the parts list at this index

Returns

Type	Description
PartList	List of created parts components, if there is no mesh at an index, no part is created and the identifier is 0

createSceneFromMeshes

Create a scene tree with a list of meshes, all meshes becomes part occurrences with the same root. The same mesh Id can be used several times to handle create instances (prototypes)

Declaration

scene.createSceneFromMeshes(meshes, matrices, centerPartPivots=True) -> scene.Occurrence

Parameters

Type	Name	Description
MeshList	meshes	List of input meshes
Matrix4List	matrices	List of matrices of input meshes (if empty Identity will be used)
Boolean	centerPartPivots	If True, the input meshes will be centered in their local coordinate system and the translation will be set as part matrix. If you want to rollback the meshes to their initial pivots use 'resetPartTransform' function

Returns

Type	Description
Occurrence	The created root occurrence

deleteComponentByType

Delete component from type

Declaration

scene.deleteComponentByType(componentType, occurrence, followPrototypes=True)

Parameters

Type	Name	Description
ComponentType	componentType	Type of the component
Occurrence	occurrence	The occurrence to remove components from
Bool	followPrototypes	If true and if the component is not set on the occurrence, try to find it on its prototyping chain

deleteComponentsByType

Delete all components on subtree from type

Declaration

scene.deleteComponentsByType(componentType, rootOccurrence=None)

Parameters

Type	Name	Description
ComponentType	componentType	Type of the component
Occurrence	rootOccurrence	The root occurrence to remove components from

deleteEmptyOccurrences

Delete all empty assemblies

Declaration

scene.deleteEmptyOccurrences(root=0)

Parameters

Type	Name	Description
Occurrence	root	Root occurrence for the process

deleteOccurrences

Delete a liste of occurrences

Declaration

scene.deleteOccurrences(occurrences)

Parameters

Type	Name	Description
OccurrenceList	occurrences	Occurrences to delete

generateOctaViews

Declaration

scene.generateOctaViews(radius, XFrames, YFrames, hemi=False) -> scene.Occurrence

Parameters

Type	Name	Description
Double	radius
Int	XFrames
Int	YFrames
Bool	hemi

Returns

Type	Description
Occurrence	The created Occurrence

generateOctree

Generate a loose octree from the given sub-tree

Declaration

scene.generateOctree(occurrence, maxDepth=5, looseFactor=2) -> scene.Occurrence

Parameters

Type	Name	Description
Occurrence	occurrence	Root occurrence of the sub-tree
Int	maxDepth	Defines the depth maximum of the octree
Double	looseFactor	Defines the loose factor of the octree

Returns

Type	Description
Occurrence

getAABB

Returns the axis aligned bounding box of a list of occurrences

Declaration

scene.getAABB(occurrences, precise=False) -> geom.AABB

Parameters

Type	Name	Description
OccurrenceList	occurrences	List of occurrences to retrieve the AABB
Boolean	precise	If true, will take more time but returns the minimal AABB and use the current animation pose. If false, fast but the AABB is approximated and multiple rotation matrices in the tree structure may extend it a lot, also the static pose of the meshes will be used.

Returns

Type	Description
AABB	The axis aligned bounding box of all given occurrences

getActiveMaterial

Get the active material on occurrence

Declaration

scene.getActiveMaterial(occurrence) -> material.Material

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence

Returns

Type	Description
Material	The material

getActiveMaterials

Get the active materials on multiple occurrences

Declaration

scene.getActiveMaterials(occurrences) -> material.MaterialList

Parameters

Type	Name	Description
OccurrenceList	occurrences	The occurrences to retrieve active material on

Returns

Type	Description
MaterialList	The active material for each given occurrence

getActivePropertyValue

Get the value of a property on the first parent that own it

Declaration

scene.getActivePropertyValue(occurrence, propertyName, cacheProperty=False) -> core.String

Parameters

Type	Name	Description
Occurrence	occurrence	An occurrence
String	propertyName	Property name
Boolean	cacheProperty	If true, the property will be copied on all ancestor of occurrence below the property owner to speed up future calls

Returns

Type	Description
String	Property value

getActivePropertyValues

Get the value of a property on the first parent that own it for each given occurrence

Declaration

scene.getActivePropertyValues(occurrences, propertyName, cacheProperty=False) -> core.StringList

Parameters

Type	Name	Description
OccurrenceList	occurrences	List of occurrences
String	propertyName	Property name
Boolean	cacheProperty	If true, the property will be copied on all ancestor of occurrence below the property owner to speed up future calls

Returns

Type	Description
StringList	Property value for each occurrence

getAncestors

Returns the list of ancestors for one occurrence

Declaration

scene.getAncestors(occurrence) -> scene.OccurrenceList

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence to test.

Returns

Type	Description
OccurrenceList	The list of ancestors.

getBrepShape

Returns the Brep shape of a part

Declaration

scene.getBrepShape(part) -> scene.BRepShape

Parameters

Type	Name	Description
Part	part	The Part

Returns

Type	Description
BRepShape	The brep shape of the part

getComponent

Returns a component on an occurrence

Declaration

scene.getComponent(occurrence, componentType, followPrototypes=True) -> scene.Component

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence
ComponentType	componentType	Type of the component
Bool	followPrototypes	If true and if the component is not set on the occurrence, try to find it on its prototyping chain

Returns

Type	Description
Component	The component

getComponentByOccurrence

Returns one component of the specified type by occurrence if it exists

Warning

This function is tagged as DEPRECATED.

Declaration

scene.getComponentByOccurrence(occurrences, componentType, followPrototypes=True) -> scene.ComponentList

Parameters

Type	Name	Description
OccurrenceList	occurrences	The occurrences list
ComponentType	componentType	Type of the component
Bool	followPrototypes	If true and if the component is not set on the occurrence, try to find it on its prototyping chain

Returns

Type	Description
ComponentList	List of component synchronized with occurrences

getComponentOccurrence

Get the occurrence that own a component

Declaration

scene.getComponentOccurrence(component) -> scene.Occurrence

Parameters

Type	Name	Description
Component	component	The component

Returns

Type	Description
Occurrence	The occurrence

getComponentType

Get the type of a component

Declaration

scene.getComponentType(component) -> scene.ComponentType

Parameters

Type	Name	Description
Component	component	The component

Returns

Type	Description
ComponentType	Type of the component

getComponents

Returns one component of the specified type by occurrence if it exists

Declaration

scene.getComponents(occurrences, componentType, followPrototypes=True) -> scene.ComponentList

Parameters

Type	Name	Description
OccurrenceList	occurrences	The occurrences list
ComponentType	componentType	Type of the component
Bool	followPrototypes	If true and if the component is not set on the occurrence, try to find it on its prototyping chain

Returns

Type	Description
ComponentList	List of component synchronized with occurrences

getGlobalMatrices

Returns the global matrix for each given occurrence

Declaration

scene.getGlobalMatrices(occurrences) -> geom.Matrix4List

Parameters

Type	Name	Description
OccurrenceList	occurrences	Nodes to get the local matrix

Returns

Type	Description
Matrix4List	The global matrix for each given node

getGlobalMatrix

Returns the global matrix on an occurrence

Declaration

scene.getGlobalMatrix(occurrence) -> geom.Matrix4

Parameters

Type	Name	Description
Occurrence	occurrence	Occurrence to get the global matrix

Returns

Type	Description
Matrix4	The global matrix of the occurrence

getGlobalVisibility

Returns the global visibility of a given occurrence

Declaration

scene.getGlobalVisibility(occurrence) -> core.Boolean

Parameters

Type	Name	Description
Occurrence	occurrence	Occurrence to get the global visibility

Returns

Type	Description
Boolean	True if the occurrence is visible, else False

getLocalMatrices

Returns the local matrix for each given occurrence

Declaration

scene.getLocalMatrices(occurrences) -> geom.Matrix4List

Parameters

Type	Name	Description
OccurrenceList	occurrences	Nodes to get the local matrix

Returns

Type	Description
Matrix4List	The local matrix for each given node

getLocalMatrix

Returns the local matrix on an occurrence

Declaration

scene.getLocalMatrix(occurrence) -> geom.Matrix4

Parameters

Type	Name	Description
Occurrence	occurrence	Node to get the local matrix

Returns

Type	Description
Matrix4	The node local matrix

getMBB

Returns the Minimum Bounding Box of a list of occurrences

Declaration

scene.getMBB(occurrences, forcedAxis=geom.Vector3(0,0,0)) -> geom.MBB

Parameters

Type	Name	Description
OccurrenceList	occurrences	List of occurrences to retrieve the MBB
Vector3	forcedAxis	Forced axis of the mbb

Returns

Type	Description
MBB	The minimum bounding box of all given occurrences

getMaterialsFromSubtree

Declaration

scene.getMaterialsFromSubtree(occurrence) -> material.MaterialList

Parameters

Type	Name	Description
Occurrence	occurrence	Root occurrence of the subtree on which to get the materials and images

Returns

Type	Description
MaterialList	The retrieved materials

getOBB

Returns the Oriented Bounding Box of a list of occurrences (works only on meshes, fast method, not the Minimum Volume Box)

Declaration

scene.getOBB(occurrences) -> geom.OBB

Parameters

Type	Name	Description
OccurrenceList	occurrences	List of occurrences to retrieve the OBB

Returns

Type	Description
OBB	The oriented bounding box of all given occurrences

getOccurrenceActiveMaterial

Returns the active material on a given occurrence

Declaration

scene.getOccurrenceActiveMaterial(occurrence) -> material.Material

Parameters

Type	Name	Description
Occurrence	occurrence	Occurrence to get the active material

Returns

Type	Description
Material	The active material of the occurrence

getOccurrenceName

Returns the name of an occurrence

Declaration

scene.getOccurrenceName(occurrence) -> core.String

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence to get the name

Returns

Type	Description
String	The occurrence name

getOccurrencesWithComponent

Recursively get all the occurrences containing a component of the specified type

Declaration

scene.getOccurrencesWithComponent(componentType, fromOcc=None) -> scene.OccurrenceList

Parameters

Type	Name	Description
ComponentType	componentType	The component type
Occurrence	fromOcc	Source occurrence of the recursion

Returns

Type	Description
OccurrenceList	Result occurrences

getPartActiveShape

Returns the active shape of a part

Declaration

scene.getPartActiveShape(part) -> scene.Shape

Parameters

Type	Name	Description
Part	part	The part

Returns

Type	Description
Shape	The active shape of a part

getPartOccurrences

Recursively get all the occurrences containing a part component

Declaration

scene.getPartOccurrences(fromOcc=None) -> scene.OccurrenceList

Parameters

Type	Name	Description
Occurrence	fromOcc	Source occurrence of the recursion

Returns

Type	Description
OccurrenceList	Result occurrences

getPartShapeType

Get the part's shape type

Declaration

scene.getPartShapeType(part) -> scene.ShapeType

Parameters

Type	Name	Description
Part	part	The part to test

Returns

Type	Description
ShapeType	Shape's type

getPolygonCount

Returns the number of polygon in the parts meshes

Declaration

scene.getPolygonCount(occurrences, asTriangleCount=False, countOnceEachInstance=False, countHidden=False) -> core.ULong

Parameters

Type	Name	Description
OccurrenceList	occurrences	The part occurrences
Bool	asTriangleCount	If true count the equivalent of triangles for each polygon
Bool	countOnceEachInstance	If true ignore multiple instance of each tessellation
Bool	countHidden	If true, also count hidden components

Returns

Type	Description
ULong	The number of polygons

getSubTreeStats

Returns some stats of a sub tree

Declaration

scene.getSubTreeStats(roots) -> core.ULong, core.ULong, core.ULong, core.ULong, core.ULong, core.ULong, core.ULong, core.ULong, core.ULong, core.ULong, core.ULong

Parameters

Type	Name	Description
OccurrenceList	roots	The root occurrences to get stats on.

Returns

Type	Description
ULong	Number of parts in the sub-tree (instances are counted once)

getVertexCount

Returns the number of vertices in the parts meshes

Declaration

scene.getVertexCount(occurrences, countOnceEachInstance=False, countHidden=False, countPoints=False, countMergedVertices=False) -> core.ULong

Parameters

Type	Name	Description
OccurrenceList	occurrences	The part occurrences
Bool	countOnceEachInstance	If true ignore multiple instance of each tessellation
Bool	countHidden	If true, also count hidden components
Bool	countPoints	If true, also count points (for points cloud)
Bool	countMergedVertices	If true count all merged vertices in each tessellation

Returns

Type	Description
ULong	The number of vertices

getViewpointsFromCavities

Returns viewpoints from model cavities

Declaration

scene.getViewpointsFromCavities(voxelSize, minCavityVolume) -> geom.Point3List, geom.Point3List

Parameters

Type	Name	Description
Distance	voxelSize	Precision for cavities detection
Distance	minCavityVolume	Minimum volume for a cavity to be returned

Returns

Type	Description
Point3List	List of viewpoint positions

getVolume

Return the volume of the occurrence

Declaration

scene.getVolume(occurrence) -> core.Double

Parameters

Type	Name	Description
Occurrence	occurrence	Entry occurrence

Returns

Type	Description
Double	The computed volume

getVolumes

Return the volume of a set of root occurrences

Declaration

scene.getVolumes(iRoots) -> core.DoubleList

Parameters

Type	Name	Description
OccurrenceList	iRoots	List of roots

Returns

Type	Description
DoubleList	The computed volumes

hasComponent

Returns True if the given occurrence has the given component type

Declaration

scene.hasComponent(occurrence, componentType, followPrototypes=True) -> core.Boolean

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence
ComponentType	componentType	Type of the component
Bool	followPrototypes	If true and if the component is not set on the occurrence, try to find it on its prototyping chain

Returns

Type	Description
Boolean

hide

Hide the given occurrences

Declaration

scene.hide(occurrences)

Parameters

Type	Name	Description
OccurrenceList	occurrences	The list of occurrences to hide

inverseVisibility

Inverse the visibility of the given occurrences

Declaration

scene.inverseVisibility(occurrences)

Parameters

Type	Name	Description
OccurrenceList	occurrences	The list of occurrences

isAncestorOf

Test if an occurrence is an ancestor of another one.

Declaration

scene.isAncestorOf(maybeAncestor, occurrence) -> core.Bool

Parameters

Type	Name	Description
Occurrence	maybeAncestor	The potential ancestor of the occurrence
Occurrence	occurrence	The occurrence to test

Returns

Type	Description
Bool	If occurrences are ancestor to one another.

keepAncestors

Filter a list of occurrences by removing all occurrences which have an ancestor inside the list.

Declaration

scene.keepAncestors(occurrences) -> scene.OccurrenceList

Parameters

Type	Name	Description
OccurrenceList	occurrences	The list that shall be filtered.

Returns

Type	Description
OccurrenceList	The list without descendants of members.

listComponent

List all components on a type on the whole tree

Declaration

scene.listComponent(componentType) -> scene.ComponentList

Parameters

Type	Name	Description
ComponentType	componentType	The component type

Returns

Type	Description
ComponentList	The component list of the type chosen

listComponents

List all components on an occurrence

Declaration

scene.listComponents(occurrence, followPrototypes=True) -> scene.ComponentList

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence to list the components
Bool	followPrototypes	If true list also components owned by the prototype

Returns

Type	Description
ComponentList	The components owned by the occurrence

mergeImages

Merge all equivalent images (i.e. with same pixels)

Declaration

scene.mergeImages(images=[]) -> core.Int

Parameters

Type	Name	Description
ImageList	images	Images to merge (merge all images if empty)

Returns

Type	Description
Int	The number of texture after the merge

mergeMaterials

Merge all equivalent materials (i.e. with same appearance)

Declaration

scene.mergeMaterials(materials=[], evaluateNames=False) -> core.Int

Parameters

Type	Name	Description
MaterialList	materials	Materials to merge (merge all materials if empty)
Boolean	evaluateNames	If true, materials names will be taken into consideration (on top of other properties). It means that materials having same properties but different names won't be merged together.

Returns

Type	Description
Int	The number of material after the merge

removeMaterials

Recursively remove all materials

Declaration

scene.removeMaterials(roots=None)

Parameters

Type	Name	Description
OccurrenceList	roots	If specified, remove materials only from the given occurrences and their descendants

renameLongOccurrenceName

truncate names of occurrence with too long names

Declaration

scene.renameLongOccurrenceName(maxLength=128)

Parameters

Type	Name	Description
Int	maxLength	Maximum name length

replaceMaterial

Replace a material by another everywhere it is used

Declaration

scene.replaceMaterial(originalMaterial, newMaterial, occurrences=None)

Parameters

Type	Name	Description
Material	originalMaterial	The material to replace everywhere
Material	newMaterial	The new material to set in place of originalMaterial
OccurrenceList	occurrences	The occurrences on which replacing the materials

resizeTextures

Resizes the textures from a selection of occurrences (resizes all textures used by these occurrences), or from a selection of textures

Declaration

scene.resizeTextures(inputMode, resizeMode, replaceTextures=True)

Parameters

Type	Name	Description
ResizeTexturesInputMode	inputMode	Defines if the textures to resize are textures used by a selection of Occurrences, or a selection among the textures available in the scene
ResizeTexturesResizeMode	resizeMode	Defines if the textures are resized following a ratio or following a maximum size/resolution (only textures above the defined maximum are downsized)
Bool	replaceTextures	If True, overwrites textures from the selection

setComponentOccurrence

Move a component to an occurrence

Declaration

scene.setComponentOccurrence(component, occurrence)

Parameters

Type	Name	Description
Component	component	The component
Occurrence	occurrence	The occurrence

setDefaultVariant

Set the default variant

Declaration

scene.setDefaultVariant()

setOccurrenceMaterial

Set the material on a occurrence

Declaration

scene.setOccurrenceMaterial(occurrence, material)

Parameters

Type	Name	Description
Occurrence	occurrence	Occurrence to set the material
Material	material	The new occurrence material

setOccurrenceName

Returns the name of an occurrence

Declaration

scene.setOccurrenceName(occurrence, name)

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence to get the name
String	name	The occurrence name

show

Show the given occurrences

Declaration

scene.show(occurrences)

Parameters

Type	Name	Description
OccurrenceList	occurrences	The list occurrences to show

showOnly

Show only the given occurrences

Declaration

scene.showOnly(occurrences)

Parameters

Type	Name	Description
OccurrenceList	occurrences	The list occurrences to show

transferCADMaterialsOnPartOccurrences

Set all materials on part occurrences

Declaration

scene.transferCADMaterialsOnPartOccurrences(rootOccurrence=None)

Parameters

Type	Name	Description
Occurrence	rootOccurrence	Root occurrence

transferMaterialsOnPatches

Take the first instance material and set it one the mesh patches

Declaration

scene.transferMaterialsOnPatches(rootOccurrence=None)

Parameters

Type	Name	Description
Occurrence	rootOccurrence	Root occurrence

createCapsule

Create a new capsule

See also:

Declaration

scene.createCapsule(radius=250, height=250, subdivisionLatitude=16, subdivisionLongitude=16, generateUV=True) -> scene.Occurrence

Parameters

Type	Name	Description
Double	radius	Radius of the Capsule
Double	height	Height of the Capsule (excluding the two size of half spheres)
Int	subdivisionLatitude	Subdivision of the Capsule on the Latitude
Int	subdivisionLongitude	Subdivision of the Capsule (two half spheres) on the Longitude
Boolean	generateUV	Generation of the UV

Returns

Type	Description
Occurrence	The created Occurrence

createCone

Create a new cone

See also:

Declaration

scene.createCone(bottomRadius=250, height=500, sides=16, generateUV=True) -> scene.Occurrence

Parameters

Type	Name	Description
Double	bottomRadius	Radius of the bottom of the cone
Double	height	Height of the cone
Int	sides	Number of sides of the cone
Boolean	generateUV	Generation of the UV

Returns

Type	Description
Occurrence	The created Occurrence

createCube

Create a new cube

See also:

Declaration

scene.createCube(sizeX=1000, sizeY=1000, sizeZ=1000, subdivision=1, generateUV=True) -> scene.Occurrence

Parameters

Type	Name	Description
Double	sizeX	Size of the Cube on the x axis
Double	sizeY	Size of the Cube on the y axis
Double	sizeZ	Size of the Cube on the z axis
Int	subdivision	Subdivision of the Cube on all the axis
Boolean	generateUV	Generation of the UV

Returns

Type	Description
Occurrence	The created Occurrence

createCylinder

Create a new cylinder

See also:

Declaration

scene.createCylinder(radius=250, height=1000, sides=16, generateUV=True) -> scene.Occurrence

Parameters

Type	Name	Description
Double	radius	Radius of the Cylinder
Double	height	Height of the Cylinder
Int	sides	Number of Sides of the Cylinder
Boolean	generateUV	Generation of the UV

Returns

Type	Description
Occurrence	The created Occurrence

createImmersion

Create a new bagel klein

See also:

Declaration

scene.createImmersion(radius=2.5, subdivisionX=100, subdivisionY=15) -> scene.Occurrence

Parameters

Type	Name	Description
Double	radius	Radius of the Immersion
Int	subdivisionX	Subdivision of the Immersion on the Latitude
Int	subdivisionY	Subdivision of the Immersion on the Longitude

Returns

Type	Description
Occurrence	The created Occurrence

createPlane

Create a new plane

See also:

Declaration

scene.createPlane(sizeY=1000, sizeX=1000, subdivisionX=1, subdivisionY=1, generateUV=True) -> scene.Occurrence

Parameters

Type	Name	Description
Double	sizeY	Size of the Plane on the y axis
Double	sizeX	Size of the Plane on the x axis
Int	subdivisionX	Subdivision of the Plane on the x axis
Int	subdivisionY	Subdivision of the Plane on the y axis
Boolean	generateUV	Generation of the UV

Returns

Type	Description
Occurrence	The created Occurrence

createSphere

Create a new sphere

See also:

Declaration

scene.createSphere(radius=500, subdivisionLatitude=16, subdivisionLongitude=16, generateUV=True) -> scene.Occurrence

Parameters

Type	Name	Description
Double	radius	Radius of the Sphere
Int	subdivisionLatitude	Subdivision of the Sphere on the Latitude
Int	subdivisionLongitude	Subdivision of the Sphere on the Longitude
Boolean	generateUV	Generation of the UV

Returns

Type	Description
Occurrence	The created Occurrence

createTorus

Create a new torus

See also:

Declaration

scene.createTorus(majorRadius=250, minorRadius=75, subdivisionLatitude=16, subdivisionLongitude=16, generateUV=True) -> scene.Occurrence

Parameters

Type	Name	Description
Double	majorRadius	Major Radius
Double	minorRadius	Minor Radius
Int	subdivisionLatitude	Subdivision of the Torus on the Latitude
Int	subdivisionLongitude	Subdivision of the Torus on the Longitude
Boolean	generateUV	Generation of the UV

Returns

Type	Description
Occurrence	The created Occurrence

findDuplicatedPartOccurrences

Get duplicated parts

See also:

Declaration

scene.findDuplicatedPartOccurrences(root=0, acceptVolumeRatio=0.01, acceptPolycountRatio=0.1, acceptAABBAxisRatio=0.01, acceptAABBCenterDistance=0.1) -> scene.OccurrenceList

Parameters

Type	Name	Description
Occurrence	root	Root occurrence for the process
Real	acceptVolumeRatio	If the ratio of volumes of two part is lower than acceptVolumeRatio, they will be considered duplicated
Real	acceptPolycountRatio	If the ratio of polygon counts of two part is lower than acceptPolycountRatio, they will be considered duplicated
Real	acceptAABBAxisRatio	If the ratio of AABB axis of two part is lower than acceptAABBAxisRatio, they will be considered duplicated
Distance	acceptAABBCenterDistance	If the ratio of AABB centers of two part is lower than acceptAABBCenterRatio, they will be considered duplicated

Returns

Type	Description
OccurrenceList	Duplicated part occurrences

findOccurrencesByMaterial

get occurrences for which the property "Material" is the given material

See also:

Declaration

scene.findOccurrencesByMaterial(material) -> scene.OccurrenceList

Parameters

Type	Name	Description
Material	material	A material

Returns

Type	Description
OccurrenceList	The list of occurrences meeting the criteria

findOccurrencesByMetadata

Returns all occurrences which a metadata property value matches the given regular expression (ECMAScript)

See also:

Declaration

scene.findOccurrencesByMetadata(property, regex, roots=None, caseInsensitive=False) -> scene.OccurrenceList

Parameters

Type	Name	Description
String	property	Property name
Regex	regex	Regular expression (ECMAScript)
OccurrenceList	roots	If specified, restrict the search from the given roots
Bool	caseInsensitive	If True, the regex will be insensitive to upper and lower cases

Returns

Type	Description
OccurrenceList	Occurrences which matches the given regular expression

findOccurrencesByMetadataValue

Returns all occurrences with a metadata value matching the given regular expression (ECMAScript)

See also:

Declaration

scene.findOccurrencesByMetadataValue(regex, roots=None, caseInsensitive=False) -> scene.OccurrenceList

Parameters

Type	Name	Description
Regex	regex	Regular expression (ECMAScript)
OccurrenceList	roots	If specified, restrict the search from the given roots
Bool	caseInsensitive	If True, the regex will be insensitive to upper and lower cases

Returns

Type	Description
OccurrenceList	Occurrences which matches the given regular expression

findOccurrencesByProperty

Returns all occurrences which a property value matches the given regular expression (ECMAScript)

See also:

Declaration

scene.findOccurrencesByProperty(property, regex, roots=None, caseInsensitive=False) -> scene.OccurrenceList

Parameters

Type	Name	Description
String	property	Property name
Regex	regex	Regular expression (ECMAScript)
OccurrenceList	roots	If specified, restrict the search from the given roots
Bool	caseInsensitive	If True, the regex will be insensitive to upper and lower cases

Returns

Type	Description
OccurrenceList	Occurrences which matches the given regular expression

findPartOccurrencesByActiveMaterial

Find all part occurrence with a given material as active material (i.e. as seen in the rendering)

See also:

Declaration

scene.findPartOccurrencesByActiveMaterial(material, roots=None) -> scene.OccurrenceList

Parameters

Type	Name	Description
Material	material	A material
OccurrenceList	roots	If specified, restrict the search from the given roots

Returns

Type	Description
OccurrenceList	Occurrences of parts with the given material as active material

findPartOccurrencesByMaximumSize

Get part occurrences by size

See also:

Declaration

scene.findPartOccurrencesByMaximumSize(roots, maxDiagLength=150, maxSize=-1, getHidden=False) -> scene.OccurrenceList

Parameters

Type	Name	Description
OccurrenceList	roots	Roots occurrences for the process
Distance	maxDiagLength	If the diagonal axis of the bounding box is less than maxDiagLength, part will be filtered. -1 to ignore
Distance	maxSize	If the longer axis of the box is less than maxLength, part will be filtered. -1 to ignore
Boolean	getHidden	If true, hidden part occurrences meeting the criteria will be filtered as well

Returns

Type	Description
OccurrenceList	The list of occurrences meeting the criteria

findPartOccurrencesByMinimumNumberOfInstances

get part occurrences with more than "minInstanciationCount" occurrence on the scene

See also:

Declaration

scene.findPartOccurrencesByMinimumNumberOfInstances(minInstanciationCount=2) -> scene.OccurrenceList

Parameters

Type	Name	Description
Int	minInstanciationCount	Min occurrence count

Returns

Type	Description
OccurrenceList	The list of occurrences meeting the criteria

findPartOccurrencesByVisibleMaterial

get part occurrences for which the given material is visible in the viewer

See also:

Declaration

scene.findPartOccurrencesByVisibleMaterial(material) -> scene.OccurrenceList

Parameters

Type	Name	Description
Material	material	A material

Returns

Type	Description
OccurrenceList	The list of occurrences meeting the criteria

findPartOccurrencesInAABB

find part occurrences in the scene in a given axis aligned bounding box

See also:

scene.findPartOccurrencesInBox

Declaration

scene.findPartOccurrencesInAABB(aabb) -> scene.OccurrenceList

Parameters

Type	Name	Description
AABB	aabb	The axis aligned bounding box

Returns

Type	Description
OccurrenceList	Occurrences found in the given axis aligned bounded box

findPartOccurrencesInBox

get part occurrences contained in a given box

See also:

scene.findPartOccurrencesInAABB

Declaration

scene.findPartOccurrencesInBox(box, strictlyIncludes) -> scene.OccurrenceList

Parameters

Type	Name	Description
ExtendedBox	box	The extension box
Boolean	strictlyIncludes	If false, parts only need to intersect the box to be selected

Returns

Type	Description
OccurrenceList	Part occurrences contained in the box

createSubTree

Create a complete scene tree

See also:

Declaration

scene.createSubTree(tree, root=0, replaceRoot=True) -> scene.OccurrenceList

Parameters

Type	Name	Description
PackedTree	tree
Occurrence	root	Specify the root occurrence of the scene
Bool	replaceRoot	If true, the root occurrence will be replaced by the root of the given tree, else it will be added as a child

Returns

Type	Description
OccurrenceList	Create occurrences (equivalent to tree.occurrences)

getChildren

Get the children of an occurrence

See also:

Declaration

scene.getChildren(occurrence) -> scene.OccurrenceList

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence

Returns

Type	Description
OccurrenceList	Children occurrences

getChildrenCount

Get the children count of an occurrence

See also:

Declaration

scene.getChildrenCount(occurrence) -> core.Int

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence

Returns

Type	Description
Int	Children count

getCurrentVariantRoot

Get the current active root. Returns active variant's root if one or global root.

See also:

Declaration

scene.getCurrentVariantRoot() -> scene.Occurrence

Returns

Type	Description
Occurrence	The active variant root occurrence or global root if no active variant.

getFirstChild

Get the children of an occurrence

See also:

Declaration

scene.getFirstChild(occurrence) -> scene.Occurrence

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence

Returns

Type	Description
Occurrence	Child occurrence

getNextSibling

Get the children of an occurrence

See also:

Declaration

scene.getNextSibling(occurrence) -> scene.Occurrence

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence

Returns

Type	Description
Occurrence	Next sibling occurrence

getOccurrenceAncestors

Get all ancestors from occurrence until root (occurrence is not included)

See also:

Declaration

scene.getOccurrenceAncestors(occurrence) -> scene.OccurrenceList

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence to find ancestors

Returns

Type	Description
OccurrenceList	List of ancestors (start with the root and end with occurrence parent). Empty if occurrence is a root

getOccurrencesAncestors

Batch version of getOccurrenceAncestors

See also:

Declaration

scene.getOccurrencesAncestors(occurrences) -> scene.OccurrenceListList

Parameters

Type	Name	Description
OccurrenceList	occurrences	The list of occurrences to find ancestors

Returns

Type	Description
OccurrenceListList	For each given occurrence, the list of ancestors (start with the root and end with occurrence parent). Empty if occurrence is a root

getParent

Get the parent of an occurrence

See also:

Declaration

scene.getParent(occurrence) -> scene.Occurrence

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence

Returns

Type	Description
Occurrence	The parent occurrence

getRoot

Get the root occurrence of the product structure

See also:

Declaration

scene.getRoot() -> scene.Occurrence

Returns

Type	Description
Occurrence	The root occurrence

getSubTree

Returns a packed version of the whole scene tree

See also:

Declaration

scene.getSubTree(root=0, visibilityMode=1, depth=-1) -> scene.PackedTree

Parameters

Type	Name	Description
Occurrence	root	Specify the root of the returned scene
VisibilityMode	visibilityMode	The visibility mode
Int	depth	Maximum depth

Returns

Type	Description
PackedTree

moveOccurrences

Move an occurrence, adjusting the transformation to keep objects at the same place in the world space

See also:

Declaration

scene.moveOccurrences(occurrences, destination, insertBefore=0)

Parameters

Type	Name	Description
OccurrenceList	occurrences	The occurrences to move
Occurrence	destination	Destination occurrence (the new parent)
Occurrence	insertBefore	Occurrence before witch to move, if null append to destination children

setParent

Set the parent of an occurrence

See also:

Declaration

scene.setParent(occurrence, parent, addInParentInstances=False, insertBefore=None, worldPositionStays=False)

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence
Occurrence	parent	The parent occurrence
Boolean	addInParentInstances	If True, each occurrence whose prototype is the target parent will generate a child whose prototype is the occurrence itself
Occurrence	insertBefore	Add before this child occurrence in the children list of the parent occurrence
Boolean	worldPositionStays	If true, the parent-relative position, scale and rotation are modified such that the object keeps the same world space position, rotation and scale as before.

addLightComponent

Add a light component to an occurrence

See also:

scene.createLight

Declaration

scene.addLightComponent(occurrence, lightType, color=core.Color(1,1,1,1), power=1.0, cutOff=20.0) -> scene.Component

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence to add the new component
LightType	lightType	The type of the light
Color	color	Color of the light
Double	power	The power of the light
Angle	cutOff	The cutoff angle of the light

Returns

Type	Description
Component	The new component added to occurrence

createLight

Create an occurrence with a light component

See also:

scene.addLightComponent

Declaration

scene.createLight(name, lightType, color=core.Color(1,1,1,1), power=1.0, cutOff=20.0, parent=0) -> scene.Occurrence

Parameters

Type	Name	Description
String	name	Name of the light
LightType	lightType	The type of the light
Color	color	Color of the light
Double	power	The power of the light
Angle	cutOff	The cutoff angle of the light
Occurrence	parent	The parent of the light occurrence

Returns

Type	Description
Occurrence	The light created

addMetadata

Add a new metadata property to a metadata component

See also:

Declaration

scene.addMetadata(metadata, name, value)

Parameters

Type	Name	Description
Metadata	metadata	The metadata component
String	name	The new property name
String	value	The new property value

addMetadataBlock

Add a new metadata property to a metadata component

See also:

Declaration

scene.addMetadataBlock(metadata, names, values)

Parameters

Type	Name	Description
Metadata	metadata	The metadata component
StringList	names	The new properties names
StringList	values	The new properties values

createMetadatasFromDefinitions

Create Metadata components from definitions

See also:

Declaration

scene.createMetadatasFromDefinitions(occurrences, definitions) -> scene.MetadataList

Parameters

Type	Name	Description
OccurrenceList	occurrences	List of occurrences to add the metadata components
MetadataDefinitionList	definitions	List of metadata definition

Returns

Type	Description
MetadataList	List of metadata components created from definitions (if definition is empty no component is created)

getMetadata

Get a metadata property value from a metadata component

See also:

Declaration

scene.getMetadata(metadata, name) -> core.String

Parameters

Type	Name	Description
Metadata	metadata	The metadata component
String	name	The metadata property name

Returns

Type	Description
String	The property value

getMetadatasDefinitions

Returns definition of Metadata components

See also:

Declaration

scene.getMetadatasDefinitions(metadatas) -> scene.MetadataDefinitionList

Parameters

Type	Name	Description
MetadataList	metadatas	List of metadata component to retrieve definition

Returns

Type	Description
MetadataDefinitionList	List of metadata definition for each given metadata component

removeMetadata

Remove a property from a metadata

See also:

Declaration

scene.removeMetadata(metadata, name)

Parameters

Type	Name	Description
Metadata	metadata	The occurrence
String	name	The name of the property

getSubpartMaterial

Get a subpart material assignment according to overrides on the scene tree with SubpartMaterial components

See also:

Declaration

scene.getSubpartMaterial(occurrence, subpartIndex) -> material.Material

Parameters

Type	Name	Description
Occurrence	occurrence	The Occurrence
UInt	subpartIndex	The subpart index

Returns

Type	Description
Material	The assigned material

listActiveShapeMaterials

list all the materials used in the part shape

See also:

Declaration

scene.listActiveShapeMaterials(part) -> material.MaterialList

Parameters

Type	Name	Description
Part	part	The part which contains sub materials

Returns

Type	Description
MaterialList	Used materials

listSubpartMaterials

list all the materials used in the part shape or overrided with a SubpartMaterial component

See also:

Declaration

scene.listSubpartMaterials(occurrence) -> material.MaterialList

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence which contains sub materials

Returns

Type	Description
MaterialList	Used materials

listSubpartVariantMaterials

list all the materials variants in subpart

See also:

Declaration

scene.listSubpartVariantMaterials(occurrence) -> scene.VariantMaterialList

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence which contains variants

Returns

Type	Description
VariantMaterialList	List of variant and materials

setSubpartMaterial

Set a subpart material assignment using a SubpartMaterial component

See also:

Declaration

scene.setSubpartMaterial(occurrence, subpartIndex, material)

Parameters

Type	Name	Description
Occurrence	occurrence	The Occurrence
UInt	subpartIndex	The subpart index
Material	material	The material

setSubpartMaterials

Set multiple subpart materials at once using a SubpartMaterial component

See also:

Declaration

scene.setSubpartMaterials(occurrence, materials, startIndex=0)

Parameters

Type	Name	Description
Occurrence	occurrence	The Occurrence on which to apply the materials
MaterialList	materials	Materials to set
UInt	startIndex	The subpart start index

setSubpartVariantMaterials

set materials in variant

See also:

Declaration

scene.setSubpartVariantMaterials(occurrence, variantMaterials)

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence which contains variants
VariantMaterialList	variantMaterials	List of variant and materials

setSubpartVariantMaterialsList

set all the materials list in variants

See also:

Declaration

scene.setSubpartVariantMaterialsList(variants, materialListList) -> scene.VariantMaterialList

Parameters

Type	Name	Description
VariantList	variants	The part which contains variants
MaterialListList	materialListList	The part which contains the list of material variant list

Returns

Type	Description
VariantMaterialList	List of variant and materials

transferSubpartMaterialsOnPatches

Assign SubpartMaterialComponent materials on the occurrence's part shapes. This might affect other Part in the scene if not singularized before.

See also:

Declaration

scene.transferSubpartMaterialsOnPatches(occurrence)

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence which has sub materials assigned

createAlternativeTree

Create a new alternative tree

See also:

Declaration

scene.createAlternativeTree(name, root=None) -> scene.AlternativeTree

Parameters

Type	Name	Description
String	name	The name of the new alternative tree
Occurrence	root	The root occurrence

Returns

Type	Description
AlternativeTree	The new alternative tree

getAlternativeTreeRoot

Returns the root occurrence associated with the given AlternativeTree

See also:

Declaration

scene.getAlternativeTreeRoot(tree) -> scene.Occurrence

Parameters

Type	Name	Description
AlternativeTree	tree	Targeted alternative tree

Returns

Type	Description
Occurrence	The root occurrence

listAlternativeTrees

Returns all the available alternative trees

See also:

Declaration

scene.listAlternativeTrees() -> scene.AlternativeTreeList

Returns

Type	Description
AlternativeTreeList	All alternative trees

addAnimation

Add an animation in Animation library

See also:

Declaration

scene.addAnimation(animation)

Parameters

Type	Name	Description
Animation	animation	Animation to add

addKeyframe

Adds a keyframe in the curve

See also:

Declaration

scene.addKeyframe(channel, time, value) -> scene.Keyframe

Parameters

Type	Name	Description
AnimChannel	channel	The channel one wants to add a keyframe in
AnimationTime	time	The time
Double	value	The value

Returns

Type	Description
Keyframe	The corresponding keyframe

addKeyframeFromCurrentPosition

Adds keyframes in a given AnimChannel based on current position

See also:

Declaration

scene.addKeyframeFromCurrentPosition(channel, time)

Parameters

Type	Name	Description
AnimChannel	channel	The channel one wants to add a keyframe in
AnimationTime	time	The time

animatesThisOccurrence

Does this Animation animates this Occurrence - or one of its parents (thus animating it indirectly) ?

See also:

Declaration

scene.animatesThisOccurrence(animation, occurrence) -> core.Bool

Parameters

Type	Name	Description
Animation	animation	The Animation
Occurrence	occurrence	The supposedly animated occurrence

Returns

Type	Description
Bool	The answer to this question

bakeAnimation

Bake an animation. The values are now precalculated and no longer interpolated.

Warning

This function is tagged as EXPERIMENTAL.

See also:

Declaration

scene.bakeAnimation(animation, occurrence, end, interval)

Parameters

Type	Name	Description
Animation	animation	The Animation
Occurrence	occurrence	The occurrence
Occurrence	end	The parent occurrence
AnimationTime	interval	The interval

createAnimation

Creates an animation, need to use addAnimation when animation is filled

See also:

Declaration

scene.createAnimation(name) -> scene.Animation

Parameters

Type	Name	Description
String	name	Name of the animation

Returns

Type	Description
Animation	The created animation

createSkeletonMesh

Create a skeleton mesh from a joint component tree

See also:

Declaration

scene.createSkeletonMesh(root) -> scene.Occurrence

Parameters

Type	Name	Description
Occurrence	root	Root joint component node

Returns

Type	Description
Occurrence	New occurrence containing the skeleton mesh

decimateAnimChannelBySegment

Decimates by segment a given AnimChannel

See also:

Declaration

scene.decimateAnimChannelBySegment(channel, precision)

Parameters

Type	Name	Description
AnimChannel	channel	The channel
Double	precision	The precision

deleteAnimation

Deletes an animation

See also:

Declaration

scene.deleteAnimation(animation)

Parameters

Type	Name	Description
Animation	animation	The created animation

deleteEmptyAnimation

Delete all animation that contain 0 keyframes

See also:

Declaration

scene.deleteEmptyAnimation()

displayAllKeyframesFromAnimChannel

Displays info on the selected AnimChannel

See also:

Declaration

scene.displayAllKeyframesFromAnimChannel(channel)

Parameters

Type	Name	Description
AnimChannel	channel	The channel

displayAllKeyframesFromAnimation

Displays info on the selected animation

See also:

Declaration

scene.displayAllKeyframesFromAnimation(animation)

Parameters

Type	Name	Description
Animation	animation	The animation

displayValueFromAnimChannelAtTime

Displays the value

See also:

Declaration

scene.displayValueFromAnimChannelAtTime(channel, time, defaultValue=False)

Parameters

Type	Name	Description
AnimChannel	channel	The channel
AnimationTime	time	The time
Bool	defaultValue	Show default instead ?

getAnimChannelIfExists

Returns the main AnimChannel of an Occurrence according to a given Animation

See also:

Declaration

scene.getAnimChannelIfExists(animation, occurrence) -> scene.AnimChannel

Parameters

Type	Name	Description
Animation	animation	The Animation
Occurrence	occurrence	The Occurrence

Returns

Type	Description
AnimChannel	The channel

getAnimChannelInfo

get an animation channel informations

Warning

This function is tagged as EXPERIMENTAL.

See also:

Declaration

scene.getAnimChannelInfo(channel) -> scene.AnimChannelInfo

Parameters

Type	Name	Description
AnimChannel	channel	Animation to get info of

Returns

Type	Description
AnimChannelInfo

getAnimChannelOccurrence

Returns the Occurrence related to a given AnimChannel

See also:

Declaration

scene.getAnimChannelOccurrence(channel) -> scene.Occurrence

Parameters

Type	Name	Description
AnimChannel	channel	The channel

Returns

Type	Description
Occurrence	The corresponding occurrence

getAnimationComponentPropertyBinderLists

packs all animation-related info in an object

Warning

This function is tagged as EXPERIMENTAL.

See also:

Declaration

scene.getAnimationComponentPropertyBinderLists(animationComponent) -> scene.AnimPropertyBinderList

Parameters

Type	Name	Description
AnimationComponent	animationComponent	Animation to get info of

Returns

Type	Description
AnimPropertyBinderList

getAnimationInfo

packs all animation-related info in an object

Warning

This function is tagged as EXPERIMENTAL.

See also:

Declaration

scene.getAnimationInfo(animation) -> scene.AnimationInfo

Parameters

Type	Name	Description
Animation	animation	Animation to get info of

Returns

Type	Description
AnimationInfo

getAnimationPropertyBinderLists

packs all animation-related info in an object

Warning

This function is tagged as EXPERIMENTAL.

See also:

Declaration

scene.getAnimationPropertyBinderLists(animation) -> scene.AnimPropertyBinderList

Parameters

Type	Name	Description
Animation	animation	Animation to get info of

Returns

Type	Description
AnimPropertyBinderList

getJointDefinition

Get joint definition from id

See also:

Declaration

scene.getJointDefinition(joint) -> scene.JointDefinition

Parameters

Type	Name	Description
Joint	joint	Id of the joint

Returns

Type	Description
JointDefinition	The jointDefinition matching the id provided

getJointDefinitions

Get joint definition from id

See also:

Declaration

scene.getJointDefinitions(joints) -> scene.JointDefinitionList

Parameters

Type	Name	Description
JointList	joints	Ids of joints

Returns

Type	Description
JointDefinitionList	An array of all jointDefinition matching joint provided

getKeyframeParentAnimChannel

Returns the parent AnimChannel of a given Keyframe

See also:

Declaration

scene.getKeyframeParentAnimChannel(keyframe) -> scene.AnimChannel

Parameters

Type	Name	Description
Keyframe	keyframe	The keyframe one wants the parent of

Returns

Type	Description
AnimChannel	The Parent

getKeyframes

Returns a list of all keyframes of a simple animChannel

See also:

Declaration

scene.getKeyframes(channel) -> scene.KeyframeList

Parameters

Type	Name	Description
AnimChannel	channel	The channel one wants to extract the keyframs from

Returns

Type	Description
KeyframeList	The list of keyframes

getMainChannel

Returns the main AnimChannel of a given AnimChannel

See also:

Declaration

scene.getMainChannel(channel) -> scene.AnimChannel

Parameters

Type	Name	Description
AnimChannel	channel	The channel one wants the main of

Returns

Type	Description
AnimChannel	The corresponding main Channel

getOccurrenceJoint

Returns the Joint assigned to an occurrence if any

See also:

Declaration

scene.getOccurrenceJoint(occurrence) -> polygonal.Joint

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence

Returns

Type	Description
Joint	The joint assigned to the given occurrence

getParentChannel

Returns (if exists) the parent AnimChannel of a given AnimChannel

See also:

Declaration

scene.getParentChannel(channel) -> scene.AnimChannel

Parameters

Type	Name	Description
AnimChannel	channel	The channel one wants the parent of

Returns

Type	Description
AnimChannel	The corresponding parent Channel

getSubChannel

Returns the subchannel of a given name from an AnimChannel

See also:

Declaration

scene.getSubChannel(channel, name) -> scene.AnimChannel

Parameters

Type	Name	Description
AnimChannel	channel	The channel one wants the subchannel of
String	name	The name of the subchannel

Returns

Type	Description
AnimChannel	The corresponding subchannel

getSubChannels

Returns all the sub channel of an AnimChannel

See also:

Declaration

scene.getSubChannels(channel) -> scene.AnimChannelList

Parameters

Type	Name	Description
AnimChannel	channel	The channel one wants the subchannel of

Returns

Type	Description
AnimChannelList	The list of direct sub channels

linkPropertyToAnimation

Creates a Binder in an Animation stack to animate an entity's property

See also:

Declaration

scene.linkPropertyToAnimation(animation, entity, propertyName) -> scene.AnimChannel

Parameters

Type	Name	Description
Animation	animation	The Animation stack where to put a animated property
Entity	entity	The entity object to animate
String	propertyName	The name of the property to animate

Returns

Type	Description
AnimChannel	The main channel of the binder

listAnimations

List all Animations from the scene

See also:

Declaration

scene.listAnimations() -> scene.AnimationList

Returns

Type	Description
AnimationList	The list containing animations

listMainChannels

List all main AnimChannel from a given Animation

See also:

Declaration

scene.listMainChannels(animation) -> scene.AnimChannelList

Parameters

Type	Name	Description
Animation	animation	The Animation one wants to list the channels from

Returns

Type	Description
AnimChannelList	The list containing the AnimChannels

makeDefaultKeyframe

Creates keyframes with the default values of the channel at time 0

See also:

Declaration

scene.makeDefaultKeyframe(channel)

Parameters

Type	Name	Description
AnimChannel	channel	The channel

moveAnimation

Moving animation

See also:

Declaration

scene.moveAnimation(animation, target, newParent, interval)

Parameters

Type	Name	Description
Animation	animation	The Animation
Occurrence	target	The target occurrence
Occurrence	newParent	The new parent occurrence
AnimationTime	interval	The interval

removeKeyframe

Removes a keyframe in the curve

See also:

Declaration

scene.removeKeyframe(channel, time)

Parameters

Type	Name	Description
AnimChannel	channel	The channel one wants to remove a keyframe from
AnimationTime	time	The time

unlinkPropertyToAnimation

Unlinks a binder

See also:

Declaration

scene.unlinkPropertyToAnimation(animation, entity, propertyName)

Parameters

Type	Name	Description
Animation	animation	The Animation stack where to put a animated property
Entity	entity	The entity object to animate
String	propertyName	The name of the property to animate

getBRepInfos

Get BRep info

See also:

Declaration

scene.getBRepInfos() -> core.Int, core.Int, core.Int, core.Int, core.Int, core.Int, core.Int, core.Int, core.Int, core.Int, core.Double, core.Int, core.Int, core.Int

Returns

Type	Description
Int	The part count

getTessellationInfos

Get tessellation info

See also:

Declaration

scene.getTessellationInfos(root=0) -> core.Int, core.Int, core.Int, core.Int, core.Int, core.Int, core.Int, core.Int, core.Int, core.Int, core.Int, core.Int, core.Int

Parameters

Type	Name	Description
Occurrence	root	Occurrence tree root

Returns

Type	Description
Int	The part count

getTessellationParameters

Get tessellation parameters

See also:

Declaration

scene.getTessellationParameters(part) -> core.Double, core.Double, core.Double, core.Bool, scene.UVGenerationMode, core.Int, core.Double, core.Bool, core.Bool

Parameters

Type	Name	Description
Part	part	The tessellated part

Returns

Type	Description
Double	The MaxSag value in mm

print

Print an occurrence tree on log

See also:

Declaration

scene.print(root=0)

Parameters

Type	Name	Description
Occurrence	root	Occurrence tree root

addFilterToLibrary

Add a filter to the filters library

See also:

Declaration

scene.addFilterToLibrary(name, expr) -> core.Ident

Parameters

Type	Name	Description
String	name	Name of the filter
FilterExpression	expr	The filter expression

Returns

Type	Description
Ident	Identifier of the created filter

evaluateExpression

Evaluate the given filter expression

See also:

Declaration

scene.evaluateExpression(filter) -> core.String

Parameters

Type	Name	Description
FilterExpression	filter	The filter expression

Returns

Type	Description
String	Result of the given expression

evaluateExpressionOnOccurrences

evaluate the given filter expression on all occurrences under the given occurrence and returns the result

See also:

Declaration

scene.evaluateExpressionOnOccurrences(occurrences, filter) -> core.StringList

Parameters

Type	Name	Description
OccurrenceList	occurrences	Occurrences on which to evaluate the expression
FilterExpression	filter	The filter expression

Returns

Type	Description
StringList	The evaluation of the expression on the occurrence at the same index in given occurrences

evaluateExpressionOnSubTree

evaluate the given filter expression on all occurrences under the given occurrence and returns the result

See also:

Declaration

scene.evaluateExpressionOnSubTree(filter, fromOcc=None) -> scene.OccurrenceList, core.StringList

Parameters

Type	Name	Description
FilterExpression	filter	The filter expression
Occurrence	fromOcc	Source occurrence of the recursion

Returns

Type	Description
OccurrenceList

exportFilterLibrary

Export filters from a given file

See also:

Declaration

scene.exportFilterLibrary(file)

Parameters

Type	Name	Description
FilePath	file	File path to export

findFilterByName

Returns the first filter in the filter library with the given name

See also:

Declaration

scene.findFilterByName(name) -> scene.Filter

Parameters

Type	Name	Description
String	name	Name of the filter to retrieve (case sensitive)

Returns

Type	Description
Filter	The retrieved filter

getFilterExpression

Returns the filter expression (string) from a filter id stored in the library

See also:

Declaration

scene.getFilterExpression(filterId) -> scene.FilterExpression

Parameters

Type	Name	Description
Ident	filterId	Identifier of the filter to fetch

Returns

Type	Description
FilterExpression	Filter expression

getFilterFromLibrary

Retrieve a filter from the library with its identifier

See also:

Declaration

scene.getFilterFromLibrary(filterId) -> scene.Filter

Parameters

Type	Name	Description
Ident	filterId	Identifier of the filter to retrieve

Returns

Type	Description
Filter	The retrieved filter

getFilteredOccurrences

Recursively get all the occurrences validating the given filter expression

See also:

Declaration

scene.getFilteredOccurrences(filter, fromOcc=None) -> scene.OccurrenceList

Parameters

Type	Name	Description
FilterExpression	filter	The filter expression
Occurrence	fromOcc	Source occurrence of the recursion

Returns

Type	Description
OccurrenceList	Result occurrences

importFilterLibrary

Import filters from a given file

See also:

Declaration

scene.importFilterLibrary(file)

Parameters

Type	Name	Description
FilePath	file	File containing the filter library

listFilterLibrary

Returns all the filter stored in the filter library

See also:

Declaration

scene.listFilterLibrary() -> scene.FilterList

Returns

Type	Description
FilterList	All the filters stored in the filter library

removeFilterFromLibrary

Remove a filter from the filters library

See also:

Declaration

scene.removeFilterFromLibrary(filterId)

Parameters

Type	Name	Description
Ident	filterId	Identifier of the filter to remove

isolate

Enter isolate mode by isolating a subset of the scene for process, export, viewer, ...

See also:

scene.unisolate

Declaration

scene.isolate(occurrences)

Parameters

Type	Name	Description
OccurrenceList	occurrences	Occurrences to isolate

unisolate

Exit the isolate mode

See also:

scene.isolate

Declaration

scene.unisolate()

sceneReadLock

Lock the scene to prevent modification while allowing reading from other threads

See also:

Declaration

scene.sceneReadLock()

sceneReadUnlock

Unlock the scene for modification

See also:

Declaration

scene.sceneReadUnlock()

sceneTryReadLock

Try lock the scene to prevent modification while allowing reading from other threads

See also:

Declaration

scene.sceneTryReadLock() -> core.Boolean

Returns

Type	Description
Boolean	Returns if the scene has been locked

sceneWriteLock

Lock the scene from being read/write by other threads

See also:

Declaration

scene.sceneWriteLock()

sceneWriteUnlock

Unlock the scene for modification and reading

See also:

Declaration

scene.sceneWriteUnlock()

findPartOccurrencesWithUnstitchedOpenShells

Find Part occurrences containing multiple unstitched openShell entities

See also:

Declaration

scene.findPartOccurrencesWithUnstitchedOpenShells(root) -> scene.OccurrenceList

Parameters

Type	Name	Description
Occurrence	root	Root occurrence

Returns

Type	Description
OccurrenceList	Unstitched faces occurrences

mergeOccurrencesByTreeLevel

Merge all parts over maxLevel level

See also:

Declaration

scene.mergeOccurrencesByTreeLevel(roots, maxLevel=5, mergeHiddenPartsMode=2)

Parameters

Type	Name	Description
OccurrenceList	roots	Roots occurrences for the process
Int	maxLevel	Maximum tree level
MergeHiddenPartsMode	mergeHiddenPartsMode	Hidden parts handling mode, Destroy them, make visible or merge separately

mergePartOccurrences

Merge a set of parts

See also:

Declaration

scene.mergePartOccurrences(partOccurrences, mergeHiddenPartsMode=2) -> scene.OccurrenceList

Parameters

Type	Name	Description
OccurrenceList	partOccurrences	Occurrence of the parts to merge
MergeHiddenPartsMode	mergeHiddenPartsMode	Hidden parts handling mode, Destroy them, make visible or merge separately

Returns

Type	Description
OccurrenceList	Resulting merged occurrences

mergePartOccurrencesByAssemblies

Merge all parts under each assembly together

See also:

Declaration

scene.mergePartOccurrencesByAssemblies(roots=None, mergeHiddenPartsMode=2)

Parameters

Type	Name	Description
OccurrenceList	roots	Roots occurrences for the process (will not be removed)
MergeHiddenPartsMode	mergeHiddenPartsMode	Hidden parts handling mode, Destroy them, make visible or merge separately

mergePartOccurrencesByFinalAssemblies

Merge final level (occurrences with only occurrence with part component as children)

See also:

Declaration

scene.mergePartOccurrencesByFinalAssemblies(roots=None, mergeHiddenPartsMode=0, CollapseToParent=True)

Parameters

Type	Name	Description
OccurrenceList	roots	Roots occurrences for the process (will not be removed)
MergeHiddenPartsMode	mergeHiddenPartsMode	Hidden parts handling mode, Destroy them, make visible or merge separately
Boolean	CollapseToParent	If true, final level unique merged part will replace it's parent

mergePartOccurrencesByMaterials

Merge a set of parts by materials

See also:

Declaration

scene.mergePartOccurrencesByMaterials(partOccurrences, mergeNoMaterials=True, mergeHiddenPartsMode=2, combineMeshes=True) -> scene.OccurrenceList

Parameters

Type	Name	Description
OccurrenceList	partOccurrences	Occurrence of the parts to merge
Boolean	mergeNoMaterials	If true, merge all parts with no active material together, else do not merge them
MergeHiddenPartsMode	mergeHiddenPartsMode	Hidden parts handling mode, Destroy them, make visible or merge separately
Boolean	combineMeshes	If true, explode and remerge the input parts by visible materials

Returns

Type	Description
OccurrenceList	Resulting merged occurrences

mergePartOccurrencesByName

Merge all parts by occurrences names

See also:

Declaration

scene.mergePartOccurrencesByName(root=0, mergeHiddenPartsMode=2)

Parameters

Type	Name	Description
Occurrence	root	Root occurrence of the subtree to process
MergeHiddenPartsMode	mergeHiddenPartsMode	Hidden parts handling mode, Destroy them, make visible or merge separately

mergePartOccurrencesByRegions

Merge all parts within the same area.

See also:

Declaration

scene.mergePartOccurrencesByRegions(roots, mergeBy, strategy) -> scene.OccurrenceList

Parameters

Type	Name	Description
OccurrenceList	roots	Roots occurrences for the process (will not be removed)
MergeByRegionsStrategy	mergeBy	Number: number of output parts (or regions of parts) Size: diagonal size of output regions
MergeStrategy	strategy	Choose the regions merging strategy

Returns

Type	Description
OccurrenceList	Resulting merged occurrences

mergePartOccurrencesWithSingleOpenShellByAssemblies

Merge Part occurrences containing a single openShell entity, by assemblies

See also:

Declaration

scene.mergePartOccurrencesWithSingleOpenShellByAssemblies(root) -> scene.OccurrenceList

Parameters

Type	Name	Description
Occurrence	root	Root of the main assembly to merge

Returns

Type	Description
OccurrenceList	List of the merged occurrence that contained only openShell

applyTransformation

apply a transformation to the local matrix of an occurrence

See also:

Declaration

scene.applyTransformation(occurrence, matrix)

Parameters

Type	Name	Description
Occurrence	occurrence	Occurrence to apply the matrix on
Matrix4	matrix	Transformation to matrix

createSymmetry

Create symmetries from selection

See also:

Declaration

scene.createSymmetry(occurrences, plane)

Parameters

Type	Name	Description
OccurrenceList	occurrences	Selection of occurrences
AxisPlane	plane	Symmetry plane

rotate

Modify the local matrix of the scene node to apply a rotation

See also:

Declaration

scene.rotate(occurrence, axis, angle)

Parameters

Type	Name	Description
Occurrence	occurrence	Occurrence to rotate
Vector3	axis	Axis of rotation
Angle	angle	Angle of rotation

setLocalMatrices

change the local matrices on a list of occurrences

See also:

Declaration

scene.setLocalMatrices(occurrencesIds, matrices, batchSize)

Parameters

Type	Name	Description
OccurrenceList	occurrencesIds	List of occurrences on which to set the local matrices
Matrix4List	matrices	The occurrences' new local matrices
UInt	batchSize	Number of matrices to be set per thread.

setLocalMatrix

change the local matrix on an occurrence

See also:

Declaration

scene.setLocalMatrix(occurrence, matrix)

Parameters

Type	Name	Description
Occurrence	occurrence	Occurrence to set the local matrix
Matrix4	matrix	The new occurrence local matrix

getPartMesh

Return the mesh of the TesselatedShape

See also:

Declaration

scene.getPartMesh(part) -> polygonal.Mesh

Parameters

Type	Name	Description
Part	part	The part component

Returns

Type	Description
Mesh	The mesh of the tessellated shape of the part

getPartModel

Return the model of the BRepShape

See also:

Declaration

scene.getPartModel(part) -> cad.Model

Parameters

Type	Name	Description
Part	part	The part component

Returns

Type	Description
Model	The model of the BRep shape of the part

getPartsMeshes

Return the meshes of the TesselatedShape for each given parts if any

See also:

Declaration

scene.getPartsMeshes(parts) -> polygonal.MeshList

Parameters

Type	Name	Description
PartList	parts	The list of part component

Returns

Type	Description
MeshList	The list of mesh of the tessellated shape of each part

getPartsModels

Return the models of the BRepShape for each given parts if any

See also:

Declaration

scene.getPartsModels(parts) -> cad.ModelList

Parameters

Type	Name	Description
PartList	parts	The list of part component

Returns

Type	Description
ModelList	The list of models of the BRep shape of each part

getPartsTransforms

Returns the transform matrix of each given parts

See also:

Declaration

scene.getPartsTransforms(parts) -> geom.Matrix4List

Parameters

Type	Name	Description
PartList	parts	The parts to retrieve transform

Returns

Type	Description
Matrix4List	The transform matrix of each part

getPartsTransformsIndexed

Returns the transform matrix of each given parts (indexed mode)

See also:

Declaration

scene.getPartsTransformsIndexed(parts) -> core.IntList, geom.Matrix4List

Parameters

Type	Name	Description
PartList	parts	The parts to retrieve transform

Returns

Type	Description
IntList	The transform matrix index for each parts (0 for Identity)

setPartMesh

Add a mesh to a part (create a TessellatedShape on the part)

See also:

Declaration

scene.setPartMesh(part, mesh)

Parameters

Type	Name	Description
Part	part	The part component
Mesh	mesh	The mesh to add to the part

setPartModel

Add a model to a part (create a BRepShape on the part)

See also:

Declaration

scene.setPartModel(part, model)

Parameters

Type	Name	Description
Part	part	The part component
Model	model	The model to add to the part

setPartsTransforms

Set the transform matrix of each given parts

See also:

Declaration

scene.setPartsTransforms(parts, transforms)

Parameters

Type	Name	Description
PartList	parts	The parts to retrieve transform
Matrix4List	transforms	The transform matrix of each part

setPartsTransformsIndexed

Set the transform matrix of each given parts (indexed mode)

See also:

Declaration

scene.setPartsTransformsIndexed(parts, indices, transforms)

Parameters

Type	Name	Description
PartList	parts	The parts to retrieve transform
IntList	indices	The transform matrix index for each parts
Matrix4List	transforms	The list of transform matrices

getPartialLoadingStatus

Get the current status of a partial loading component

See also:

Declaration

scene.getPartialLoadingStatus(component) -> scene.PartialLoad_Status

Parameters

Type	Name	Description
ReferencedDataComponent	component	Referenced Data component

Returns

Type	Description
PartialLoad_Status	The current status

setReferencedDataComponentParent

Defines which referenced data is parent to the given component

See also:

Declaration

scene.setReferencedDataComponentParent(component, parent)

Parameters

Type	Name	Description
ReferencedDataComponent	component	The referenced data component to alter
ReferencedDataComponent	parent	The parent

setReferencedDataComponentPath

Defines which path the referenced data is at

See also:

Declaration

scene.setReferencedDataComponentPath(component, filePath)

Parameters

Type	Name	Description
ReferencedDataComponent	component	The referenced data component to alter
String	filePath	The filepath

alignPivotPointToWorld

Re-orient the Pivot Point straight to world origin (the grid)

See also:

Declaration

scene.alignPivotPointToWorld(occurrences, applyToChildren=False)

Parameters

Type	Name	Description
OccurrenceList	occurrences	The occurrences to modify
Bool	applyToChildren	If True, all the pivot of the descending occurrences from occurrence will be affected

movePivotPointToOccurrenceCenter

Move the pivot point of each occurrence listed in the function input, to the center of its bounding box (and of its children if the parameter is True)

See also:

Declaration

scene.movePivotPointToOccurrenceCenter(occurrences, applyToChildren=False)

Parameters

Type	Name	Description
OccurrenceList	occurrences	Occurrences (or the roots occurrences if recursively=True)
Bool	applyToChildren	If True, all the pivot of the descending occurrences from occurrence will be affected

movePivotPointToOrigin

Move the pivot point of an occurrence (and its descendants if recursively) to the origin (0,0,0)

See also:

Declaration

scene.movePivotPointToOrigin(occurrence, applyToChildren=False)

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence (or the root occurrence if recursively=True)
Bool	applyToChildren	If True, all the pivot of the descending occurrences from occurrence will be affected

movePivotPointToSelectionCenter

Move the pivot point of all given occurrences to the center of all occurrences

See also:

Declaration

scene.movePivotPointToSelectionCenter(occurrences)

Parameters

Type	Name	Description
OccurrenceList	occurrences	The occurrences to modify

movePivotPointToTargetedOccurrenceCenter

Move the pivot point of each occurrence listed in the function input, to the center of the targeted occurrence Center (and of its children if the parameter is True)

See also:

Declaration

scene.movePivotPointToTargetedOccurrenceCenter(occurrences, target, applyToChildren=False)

Parameters

Type	Name	Description
OccurrenceList	occurrences	The occurrence (or the root occurrence if recursively=True)
Occurrence	target	The target occurrence
Bool	applyToChildren	If True, all the pivot of the descending occurrences from occurrence will be affected

setPivotOnly

Set the pivot of an occurrence to the given transformation matrix, the geometry will not be moved (warning: do not confuse with property Transform which actually move the occurrence)

See also:

Declaration

scene.setPivotOnly(occurrence, pivot)

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence to move the pivot
Matrix4	pivot	The new transformation matrix for the occurrence (pivot)

addAnnotationGroup

add a Annotation Group to the pmi component

See also:

Declaration

scene.addAnnotationGroup(component, name) -> scene.AnnotationGroup

Parameters

Type	Name	Description
PMIComponent	component	Component to add the Annotation Group
String	name	Name of the annotation group

Returns

Type	Description
AnnotationGroup	Annotation group created

addMeshToAnnotation

add a mesh and its material to a annotation

See also:

Declaration

scene.addMeshToAnnotation(annotation, material, staticmesh)

Parameters

Type	Name	Description
Annotation	annotation
Material	material
StaticMesh	staticmesh

convertPMIToOccurrences

Convert each PMI component into a set of occurrences with mesh geometries

See also:

Declaration

scene.convertPMIToOccurrences(occurrences, convertVisibility=False)

Parameters

Type	Name	Description
OccurrenceList	occurrences	Occurrence selection
Boolean	convertVisibility	If True, the visibility will be converted (useful to select a specific view/variant), else all occurrences will be visible

createAnnotationFromDefinition

Create Annotation from definition

See also:

Declaration

scene.createAnnotationFromDefinition(definition) -> scene.Annotation

Parameters

Type	Name	Description
AnnotationDefinition	definition	Annotation definition

Returns

Type	Description
Annotation	Annotation created from definition

createOccurrenceFromAnnotation

Convert a single annotation on an occurrence into an occurrence with mesh geometry

See also:

Declaration

scene.createOccurrenceFromAnnotation(annotation, convertVisibility=False) -> scene.Occurrence

Parameters

Type	Name	Description
Annotation	annotation	Annotation that shall be converted to an occurrence with mesh geometry
Boolean	convertVisibility	If True, the visibility will be converted (useful to select a specific view/variant), else all occurrences will be visible

Returns

Type	Description
Occurrence	Annotation as occurrence with mesh geometry

createProductView

Create a productview from definition

See also:

Declaration

scene.createProductView(definition) -> scene.ProductView

Parameters

Type	Name	Description
ProductViewDefinition	definition

Returns

Type	Description
ProductView	The product view

getAnnotationDefinition

get definition of given annotation

See also:

Declaration

scene.getAnnotationDefinition(annotation) -> scene.AnnotationDefinition

Parameters

Type	Name	Description
Annotation	annotation

Returns

Type	Description
AnnotationDefinition

getAnnotationGroups

Returns the list of the AnnotationGroup from a PMIComponent

See also:

Declaration

scene.getAnnotationGroups(pmiComponent) -> scene.AnnotationGroupList

Parameters

Type	Name	Description
Component	pmiComponent	The pmi component

Returns

Type	Description
AnnotationGroupList	List of AnnotationGroup

getAnnotationListAABB

get the AABB of the annotation list

See also:

Declaration

scene.getAnnotationListAABB(annotationList) -> geom.AABB

Parameters

Type	Name	Description
AnnotationList	annotationList

Returns

Type	Description
AABB	The axis aligned bounding box of the given annotation list

getAnnotations

Returns the list of the Annotation from a AnnotationGroup

See also:

Declaration

scene.getAnnotations(group) -> scene.AnnotationList

Parameters

Type	Name	Description
AnnotationGroup	group	The AnnotationGroup

Returns

Type	Description
AnnotationList	List of Annotation

getOccurrenceAnnotationDefinitions

get all annotations definition of given occurrence

See also:

Declaration

scene.getOccurrenceAnnotationDefinitions(occurrence) -> scene.AnnotationDefinitionList

Parameters

Type	Name	Description
Occurrence	occurrence

Returns

Type	Description
AnnotationDefinitionList

getProductViewDefinition

get productview definition

See also:

Declaration

scene.getProductViewDefinition(view) -> scene.ProductViewDefinition

Parameters

Type	Name	Description
Variant	view	The product view

Returns

Type	Description
ProductViewDefinition

getProductViewDefinitions

get all productviews definitions

See also:

Declaration

scene.getProductViewDefinitions() -> scene.ProductViewDefinitionList

Returns

Type	Description
ProductViewDefinitionList

setAnnotationToGroup

set Annotation to a Annotation Group

See also:

Declaration

scene.setAnnotationToGroup(annotation, group)

Parameters

Type	Name	Description
Annotation	annotation
AnnotationGroup	group

cleanInstances

Clean prototypes and instances (lonely instances, overriding their prototypes hierarchies...).

See also:

Declaration

scene.cleanInstances(removeUselessInstances=True, removeHierarchyOverridingInstances=False, occurrence=0)

Parameters

Type	Name	Description
Boolean	removeUselessInstances	Remove instances where they are not needed (prototype referenced once, ...)
Boolean	removeHierarchyOverridingInstances	Remove instances overriding their prototypes sub-hierarchies.
Occurrence	occurrence	Root occurrence for the process

getDirectInstances

Returns all the occurrences prototyping the given occurrence

See also:

Declaration

scene.getDirectInstances(prototype) -> scene.OccurrenceList

Parameters

Type	Name	Description
Occurrence	prototype	The prototype occurrence

Returns

Type	Description
OccurrenceList	The instances

getInstances

Get occurrences sharing the same prototype as the given one

See also:

Declaration

scene.getInstances(occurrence) -> scene.OccurrenceList

Parameters

Type	Name	Description
Occurrence	occurrence	Reference part occurrence

Returns

Type	Description
OccurrenceList	The list of occurrences sharing the same prototype

getPrototype

Returns the prototype of an occurrence

See also:

Declaration

scene.getPrototype(occurrence) -> scene.Occurrence

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence

Returns

Type	Description
Occurrence	The prototype (if any)

getPrototypes

Returns the prototype for each given occurrence

See also:

Declaration

scene.getPrototypes(occurrences) -> scene.OccurrenceList

Parameters

Type	Name	Description
OccurrenceList	occurrences	The occurrence

Returns

Type	Description
OccurrenceList	The prototype of each occurrence

prototypeSubTree

Create occurrences that prototype the given occurrence and all its subtree

See also:

Declaration

scene.prototypeSubTree(prototype) -> scene.Occurrence

Parameters

Type	Name	Description
Occurrence	prototype	The root occurrence of the sub-tree to prototype

Returns

Type	Description
Occurrence	The root occurrence of the prototyped sub-tree

setPrototype

Sets the prototype of an occurrence

See also:

Declaration

scene.setPrototype(occurrence, prototype)

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence
Occurrence	prototype	The prototype

setPrototypes

Sets the prototype for each given occurrence

See also:

Declaration

scene.setPrototypes(occurrences, prototypes)

Parameters

Type	Name	Description
OccurrenceList	occurrences	The occurrences
OccurrenceList	prototypes	The prototypes

updateChildrenPrototypes

Update children prototypes of the given occurrence

See also:

Declaration

scene.updateChildrenPrototypes(occurrence)

Parameters

Type	Name	Description
Occurrence	occurrence	The occurrence

clearSelection

Clear the current selection

See also:

Declaration

scene.clearSelection()

deleteSelection

Delete all selected occurrences, and/or sub-occurrence elements

See also:

Declaration

scene.deleteSelection()

explodeSelection

For each occurrence, create a new occurrence with the selected sub-occurrence elements and remove them from the original occurrence

See also:

Declaration

scene.explodeSelection()

getSelectedOccurrences

Returns all the selected occurrences

See also:

Declaration

scene.getSelectedOccurrences(keepAncestors=False) -> scene.OccurrenceList

Parameters

Type	Name	Description
Boolean	keepAncestors	If True, occurrences with ancestors selected will be remove from the list

Returns

Type	Description
OccurrenceList	The list of selected occurrences

getSelectedPolygonCount

Returns the number of selected polygons

See also:

Declaration

scene.getSelectedPolygonCount() -> core.ULong

Returns

Type	Description
ULong	Number of selected Polygons

invertOrientationSelection

Invert the orientation of each selected item (occurrences and/or sub-occurrence elements

See also:

Declaration

scene.invertOrientationSelection()

invertSelect

Invert occurrences to selection

See also:

Declaration

scene.invertSelect(occurrence)

Parameters

Type	Name	Description
OccurrenceList	occurrence	Occurrences to invert from the selection

invertSelection

Replace the selection by all unselected part occurrences

See also:

Declaration

scene.invertSelection()

select

Add occurrences to selection

See also:

Declaration

scene.select(occurrences)

Parameters

Type	Name	Description
OccurrenceList	occurrences	Occurrences to add to the selection

separateSelection

Separate all polygons form their original parts into a new one

See also:

Declaration

scene.separateSelection() -> scene.Occurrence

Returns

Type	Description
Occurrence	The new occurrence created

unselect

Remove occurrences to selection

See also:

Declaration

scene.unselect(occurrence)

Parameters

Type	Name	Description
OccurrenceList	occurrence	Occurrences to remove from the selection

compress

Compress a sub-tree by removing occurrence containing only one Child or empty, and by removing useless instances (see removeUselessInstances)

See also:

Declaration

scene.compress(occurrence=0) -> scene.Occurrence

Parameters

Type	Name	Description
Occurrence	occurrence	Root occurrence for the process

Returns

Type	Description
Occurrence	The resulting occurrences of compression

convertToOldSchoolVisibility

Modify the visible properties of the sub-tree to look like old school visibility (only hidden/inherited)

See also:

Declaration

scene.convertToOldSchoolVisibility(root=0)

Parameters

Type	Name	Description
Occurrence	root	Root occurrence

getHiddenPartOccurrences

Get hidden part occurrences

See also:

Declaration

scene.getHiddenPartOccurrences(roots=None) -> scene.OccurrenceList

Parameters

Type	Name	Description
OccurrenceList	roots	Roots occurrences for the process

Returns

Type	Description
OccurrenceList	The list of hidden occurrences (visibility status)

getVisiblePartOccurrences

Get visible part occurrences

See also:

Declaration

scene.getVisiblePartOccurrences(roots=None) -> scene.OccurrenceList

Parameters

Type	Name	Description
OccurrenceList	roots	Roots occurrences for the process

Returns

Type	Description
OccurrenceList	The list of visible part occurrences (visibility status)

makeInstanceUnique

Singularize all instances on the sub-tree of an occurrence

See also:

Declaration

scene.makeInstanceUnique(occurrences=0, keepOnlyPartInstances=False)

Parameters

Type	Name	Description
OccurrenceList	occurrences	Root occurrence for the process
Boolean	keepOnlyPartInstances	If true, instances of part will not be singularized

rake

Set the same parent to all descending parts (all parts will be singularized)

See also:

Declaration

scene.rake(occurrence=0, keepInstances=False)

Parameters

Type	Name	Description
Occurrence	occurrence	Root occurrence for the process
Boolean	keepInstances	If false, the part will be singularized

removeSymmetryMatrices

Remove symmetry matrices (apply matrices on geometries on nodes under an occurrence with a symmetry matrix

See also:

Declaration

scene.removeSymmetryMatrices(occurrence=0)

Parameters

Type	Name	Description
Occurrence	occurrence	Root occurrence for the process

resetPartTransform

Set all part transformation matrices to identity in a sub-tree, transformation will be applied to the shapes

See also:

Declaration

scene.resetPartTransform(root=0)

Parameters

Type	Name	Description
Occurrence	root	Root occurrence for the process

resetTransform

Set all transformation matrices to identity in a sub-tree.

See also:

Declaration

scene.resetTransform(root, recursive=True, keepInstantiation=True, keepPartTransform=False)

Parameters

Type	Name	Description
Occurrence	root	Root occurrence for the process
Boolean	recursive	If False, transformation will be applied only on the root and its components
Boolean	keepInstantiation	If False, all occurrences will be singularized
Boolean	keepPartTransform	If False, transformation will be applied to the shapes (BRepShape points or TessellatedShape vertices)

createRayProber

Creates a ray prober

See also:

Declaration

scene.createRayProber() -> core.Ident

Returns

Type	Description
Ident

createSphereProber

Creates a sphere prober

See also:

Declaration

scene.createSphereProber() -> core.Ident

Returns

Type	Description
Ident

rayCast

See also:

Declaration

scene.rayCast(ray, root) -> scene.RayHit

Parameters

Type	Name	Description
Ray	ray	The ray to cast
Occurrence	root	The root occurrence to cast from

Returns

Type	Description
RayHit	Information of the first ray hit

rayCastAll

See also:

Declaration

scene.rayCastAll(ray, root) -> scene.RayHitList

Parameters

Type	Name	Description
Ray	ray	The ray to cast
Occurrence	root	The root occurrence to cast from

Returns

Type	Description
RayHitList	Information of the first ray hit

updateRayProber

Updates the designed ray prober

See also:

Declaration

scene.updateRayProber(proberID, ray)

Parameters

Type	Name	Description
Ident	proberID	The ray prober Id
Ray	ray	Update the prober's ray values

updateSphereProber

Updates the designed sphere prober

See also:

Declaration

scene.updateSphereProber(proberID, sphereCenter, sphereRadius)

Parameters

Type	Name	Description
Ident	proberID	The sphere prober Id
Vector3	sphereCenter	The new prober center
Double	sphereRadius	The new prober radius

getMultipleOccurrenceUserData

Batch version of getOccurrenceUserData

See also:

Declaration

scene.getMultipleOccurrenceUserData(userDataId, occurrences) -> core.PtrList

Parameters

Type	Name	Description
OccurrenceUserData	userDataId	UserData identifier provided by subscribeToOccurrenceUserData
OccurrenceList	occurrences	Occurrences that store the user data

Returns

Type	Description
PtrList	User data stored for each given occurrence

getOccurrenceUserData

Set or replace a userdata stored on an occurrence

See also:

Declaration

scene.getOccurrenceUserData(userDataId, occurrence) -> core.Ptr

Parameters

Type	Name	Description
OccurrenceUserData	userDataId	UserData identifier provided by subscribeToOccurrenceUserData
Occurrence	occurrence	Occurrence that store the user data

Returns

Type	Description
Ptr	User data stored in the given occurrence

hasMultipleOccurrenceUserData

Batch version of hasOccurrenceUserData

See also:

Declaration

scene.hasMultipleOccurrenceUserData(userDataId, occurrences) -> core.BoolList

Parameters

Type	Name	Description
OccurrenceUserData	userDataId	UserData identifier provided by subscribeToOccurrenceUserData
OccurrenceList	occurrences	Occurrences that potentially store the user data

Returns

Type	Description
BoolList	Returns an array of bool that are true if a userdata is stored on the occurrence at the same index for the given userDataId

hasOccurrenceUserData

Set or replace a userdata stored on an occurrence

See also:

Declaration

scene.hasOccurrenceUserData(userDataId, occurrence) -> core.Bool

Parameters

Type	Name	Description
OccurrenceUserData	userDataId	UserData identifier provided by subscribeToOccurrenceUserData
Occurrence	occurrence	Occurrence that potentially store the user data

Returns

Type	Description
Bool	Returns true if a userdata is stored on this occurrence for the given userDataId

setMultipleOccurrenceUserData

Batch version of setOccurrenceUserData

See also:

Declaration

scene.setMultipleOccurrenceUserData(userDataId, occurrences, userDataList)

Parameters

Type	Name	Description
OccurrenceUserData	userDataId	UserData identifier provided by subscribeToOccurrenceUserData
OccurrenceList	occurrences	Occurrences that will store the user data
PtrList	userDataList	User data to store on each occurrence

setOccurrenceUserData

Set or replace a userdata stored on an occurrence

See also:

Declaration

scene.setOccurrenceUserData(userDataId, occurrence, userData)

Parameters

Type	Name	Description
OccurrenceUserData	userDataId	UserData identifier provided by subscribeToOccurrenceUserData
Occurrence	occurrence	Occurrence that will store the user data
Ptr	userData	User data to store in the given occurrence

subscribeToOccurrenceUserData

subscribe to occurrence user data. multiple different userdata can be stored on the same occurrences if subscribeToOccurrenceUserData is called multiple times

See also:

Declaration

scene.subscribeToOccurrenceUserData() -> scene.OccurrenceUserData

Returns

Type	Description
OccurrenceUserData	UserData identifier to pass to setUserData/getUserData functions

unsetMultipleOccurrenceUserData

Batch version of unsetOccurrenceUserData

See also:

Declaration

scene.unsetMultipleOccurrenceUserData(userDataId, occurrences)

Parameters

Type	Name	Description
OccurrenceUserData	userDataId	UserData identifier provided by subscribeToOccurrenceUserData
OccurrenceList	occurrences	Occurrences that will store the user data

unsetOccurrenceUserData

Unset the userdata stored on an occurrence

See also:

Declaration

scene.unsetOccurrenceUserData(userDataId, occurrence)

Parameters

Type	Name	Description
OccurrenceUserData	userDataId	UserData identifier provided by subscribeToOccurrenceUserData
Occurrence	occurrence	Occurrence that will store the user data

unsubscribeFromOccurrenceUserData

See also:

Declaration

scene.unsubscribeFromOccurrenceUserData(userDataId)

Parameters

Type	Name	Description
OccurrenceUserData	userDataId	UserData identifier to unsubscribe

addVariant

Create a new variant

See also:

Declaration

scene.addVariant(name) -> scene.Variant

Parameters

Type	Name	Description
String	name	The name of the new variant

Returns

Type	Description
Variant	The new variant

duplicateVariant

Create a new variant which is a copy of an existing variant

See also:

Declaration

scene.duplicateVariant(variant, name) -> scene.Variant

Parameters

Type	Name	Description
Variant	variant	The variant to duplicated
String	name	Name of the new variant

Returns

Type	Description
Variant	The created variant

endModifyAllVariants

Call this function to disable the modifications of all variants at the same time.

See also:

Declaration

scene.endModifyAllVariants()

getVariantComponentsDefinitions

Returns the definitions of multiple variant components

See also:

Declaration

scene.getVariantComponentsDefinitions(variantComponents) -> scene.VariantDefinitionListList

Parameters

Type	Name	Description
VariantComponentList	variantComponents	The list of variant components to retrieve definitions

Returns

Type	Description
VariantDefinitionListList	For each variant component, returns one list of variant definition (one by variant)

getVariantTree

Get the alternative tree used by this variant

See also:

Declaration

scene.getVariantTree(variant) -> scene.AlternativeTree

Parameters

Type	Name	Description
Variant	variant	The variant

Returns

Type	Description
AlternativeTree	The alternative tree used by this variant

listVariants

Returns all the available variants

See also:

Declaration

scene.listVariants() -> scene.VariantList

Returns

Type	Description
VariantList	All variants

removeVariant

Remove a variant

See also:

Declaration

scene.removeVariant(variant)

Parameters

Type	Name	Description
Variant	variant	The variant to remove

setCurrentVariant

Change the current variant used

See also:

Declaration

scene.setCurrentVariant(variant=None)

Parameters

Type	Name	Description
Variant	variant	The variant to enable (can be null)

setVariantTree

Set the alternative tree to use for this variant

See also:

Declaration

scene.setVariantTree(variant, tree)

Parameters

Type	Name	Description
Variant	variant	The variant to modify
AlternativeTree	tree	The alternative tree to use for this variant

startModifyAllVariants

Call this function to to enable the modifications of all variants at the same time.

See also:

Declaration

scene.startModifyAllVariants()

ComponentChanged

Declaration

def onComponentChanged(eventType, occurrence, component):
    pass

id = scene.addComponentChangedCallback(onComponentChanged)

...

scene.removeComponentChangedCallback(id)

Parameters

Type	Name	Description
ComponentChangeType	eventType	Type of change
Occurrence	occurrence	Occurrence the component belongs to
Component	component	Component concerned by change

SceneChanged

Declaration

def onSceneChanged(eventType, occurrence, child, finalOccurrence):
    pass

id = scene.addSceneChangedCallback(onSceneChanged)

...

scene.removeSceneChangedCallback(id)

Parameters

Type	Name	Description
SceneChangeType	eventType	Type of change
Occurrence	occurrence	Occurrence concerned by change
Occurrence	child	Child occurrence for child insertion/removal
Occurrence	finalOccurrence	Occurrence in the tree impact by the event

AnimationAdded

Declaration

def onAnimationAdded(animation):
    pass

id = scene.addAnimationAddedCallback(onAnimationAdded)

...

scene.removeAnimationAddedCallback(id)

Parameters

Type	Name	Description
Animation	animation	Added animation

AnimationChanged

Declaration

def onAnimationChanged(animation):
    pass

id = scene.addAnimationChangedCallback(onAnimationChanged)

...

scene.removeAnimationChangedCallback(id)

Parameters

Type	Name	Description
Animation	animation	Changed Animation

AnimationCleared

Declaration

def onAnimationCleared():
    pass

id = scene.addAnimationClearedCallback(onAnimationCleared)

...

scene.removeAnimationClearedCallback(id)

AnimationRemoved

Declaration

def onAnimationRemoved(animation):
    pass

id = scene.addAnimationRemovedCallback(onAnimationRemoved)

...

scene.removeAnimationRemovedCallback(id)

Parameters

Type	Name	Description
Animation	animation	Removed Animation

SelectionChanged

Declaration

def onSelectionChanged(type, occurrences):
    pass

id = scene.addSelectionChangedCallback(onSelectionChanged)

...

scene.removeSelectionChangedCallback(id)

Parameters

Type	Name	Description
SelectionChangeType	type	Type of change (CLEARED, ADDED or REMOVED)
OccurrenceList	occurrences	Only if type is ADDED or REMOVED, list of added or removed occurrences

VariantChanged

Declaration

def onVariantChanged(type, variant):
    pass

id = scene.addVariantChangedCallback(onVariantChanged)

...

scene.removeVariantChangedCallback(id)

Parameters

Type	Name	Description
VariantChangeType	type	Type of change (ADDED, REMOVED, CURRENT_CHANGED)
Variant	variant

onRayProbe

Declaration

def ononRayProbe(proberID, proberInfo):
    pass

id = scene.addonRayProbeCallback(ononRayProbe)

...

scene.removeonRayProbeCallback(id)

Parameters

Type	Name	Description
Ident	proberID	The ray propber ID
ProberInfo	proberInfo	The prober's info

onSphereProbe

Declaration

def ononSphereProbe(proberID, proberInfo):
    pass

id = scene.addonSphereProbeCallback(ononSphereProbe)

...

scene.removeonSphereProbeCallback(id)

Parameters

Type	Name	Description
Ident	proberID	The sphere propber ID
ProberInfo	proberInfo	The prober's info