Version:

Back to list

Scene types

Assembly

GUI Icon

Definition

Type Assembly

is inherited from Component

Description

An Assembly is a Component that permits to groups other Components in the Product Structure

AssemblyList

Definition

Type AssemblyList is a list of Assembly

BRepShape

GUI Icon

Definition

Type BRepShape

is inherited from Shape

Description

A BRepShape is a Shape that contains BRep geometry

Component

GUI Icon

Definition

Type Component

is inherited from SceneNode

Description

A Component is a SceneNode that can be instanciated. By example, Part and Assembly are Components

ComponentType

Definition

Type ComponentType is an enumeration type composed of these values :

PART (0)
ASSEMBLY (1)
CAMERA (2)
LIGHT (3)

DirectionalLight

GUI Icon

Definition

Type DirectionalLight

is inherited from Component

Description

A Directional Light is a light which emit in one direction (mostly used as sky lighting)

Group

GUI Icon

Definition

Type Group

is inherited from Entity

Description

A Group is an Entity that is not in the scene tree but can contains a set of occurrences (ScenePath) and other groups. It can be used to create groups of selection to apply some process by kind of parts (e.g group by materials, group by size, etc...)

GroupList

Definition

Type GroupList is a list of Group

Instance

GUI Icon

Definition

Type Instance

is inherited from SceneNode

Description

An Instance is a SceneNode used to instanciate a Component

Light

GUI Icon

Definition

Type Light

is inherited from Component

Description

A Light is a Component that represents a light (can be positional, spot or directional)

MaterialExtractMode

Definition

Type MaterialExtractMode is an enumeration type composed of these values :

NONE (0)
AS_IS (1)
PART_ONLY (2)

MatrixExtractMode

Definition

Type MatrixExtractMode is an enumeration type composed of these values :

NONE (0)
LOCAL (1)
GLOBAL (2)

Modifier

GUI Icon

Definition

Type Modifier

is inherited from Entity

Description

A Modifier is an Entity which save the parameters of an action launched on some occurrences

ModifierList

Definition

Type ModifierList is a list of Modifier

Occurrence

GUI Icon

Definition

Type Occurrence

is inherited from Entity

Description

An occurrence is an entity representing one occurrence of a SceneNode (a SceneNode can be instanciated multiple times)

OccurrenceList

Definition

Type OccurrenceList is a list of Occurrence

Part

GUI Icon

Definition

Type Part

is inherited from Component

Description

A Part is a Component that represents a single object. A Part has a Shape which represents its geometry

PartList

Definition

Type PartList is a list of Part

PositionalLight

GUI Icon

Definition

Type PositionalLight

is inherited from Component

Description

A Positional Light is a light positioned in the space which emit in all directions

Properties

Definition

Type Properties is a structured type composed of these fields :

names (StringList)
array of properties name
values (StringList)
array of properties value

Description

Metadata

PropertiesList

Definition

Type PropertiesList is a list of Properties

Scene

GUI Icon

Definition

Type Scene

is inherited from Assembly

Description

Scene is the root Assembly of the product structure

SceneExtract

Definition

Type SceneExtract is a structured type composed of these fields :

tree (IntList)
definition of the tree, negative values are pop to parent
partsRef (IntList)
If >=0 , the current node is a part and reference a meshesRef (referenced by tree)
names (StringList)
Name of the node (referenced by tree)
properties (PropertiesList)
User properties stored on node (referenced by tree)
instanceProperties (PropertiesList)
User properties stored on Instance node (referenced by tree)
matrixMode (MatrixExtractMode)
Defines how the matrices are extracted
matricesRef (IntList)
matrices references , -1 stands for Identity (referenced by partsRef if matrixMode=PART_ONLY | referenced by tree if matrixMode=AS_IS | empty if matrixMode=NONE)
matrices (Matrix4List)
matrices (referenced by matricesRef)
materialsMode (MaterialExtractMode)
Defines how the materials are extracted
materialsRef (IntList)
materials references (referenced by partsRef if materialsMode=PART_ONLY | referenced by tree if materialsMode=AS_IS | empty if materialsMode=NONE)
materials (MaterialExtractList)
Materials extracts (referenced by materialsRef)
images (ImageDefinitionList)
Texture extracts (referenced by each MaterialExtract)
visibilityMode (VisibilityExtractMode)
Defines how the visibilities are extracted
visibilities (BoolList)
visibilities extract (referenced by partsRef if visibilityMode=PART_ONLY | referenced by tree if visibilityMode=AS_IS | empty if visibilityMode=VISIBLE_ONLY)
meshesRef (IntList)
references a mesh (referenced by partsRef)
meshes (MeshDefinitionList)
Meshes definition (referenced by meshRefs)

SceneNode

GUI Icon

Definition

Type SceneNode

is inherited from GeomEntity

Description

A SceneNode is the base entity for the Scene module. It represents a node in the scene tree (Product Structure)

SceneNodeType

Definition

Type SceneNodeType is an enumeration type composed of these values :

COMPONENT (0)
INSTANCE (1)

ScenePath

Definition

Type ScenePath is a list of SceneNode

Description

A ScenePath represents an occurrence in the product structure. It is an array of SceneNode across the scene which come from the root and go to a Component throught the scene tree

ScenePathList

Definition

Type ScenePathList is a list of ScenePath

ScenePathListList

Definition

Type ScenePathListList is a list of ScenePathList

Shape

GUI Icon

Definition

Type Shape

is inherited from GeomEntity

Description

A Shape is the geometrical representation of a Part. It can be BRep or polygonal

ShapeList

Definition

Type ShapeList is a list of Shape

SpotLight

GUI Icon

Definition

Type SpotLight

is inherited from Component

Description

A Positional Light is a light positioned in the space which emit in a cone

TessellatedShape

GUI Icon

Definition

Type TessellatedShape

is inherited from Shape

Description

A TessellatedShape is a Shape that contains Polygonal geometry

VisibilityExtractMode

Definition

Type VisibilityExtractMode is an enumeration type composed of these values :

VISIBLE_ONLY (0)
AS_IS (1)
PART_ONLY (2)