Version: 2021.1 2020.2 2020.1 2019.2 2019.1 2018.3
Back to list
Scene types
AlternativeTree Definition Type AlternativeTree is inherited from Entity Description An AlternativeTree is an alternative product structure treeGUI Widget
AlternativeTreeList Definition Type AlternativeTreeList is a list of AlternativeTree
AnimChannel Definition Type AnimChannel is inherited from Entity Description A container of AnimCurvesGUI Widget
AnimChannelList Definition Type AnimChannelList is a list of AnimChannel
Animation Definition Type Animation is inherited from Entity Description An Animation allows to animate several properties through several AnimPropertyBinderGUI Widget
AnimationList Definition Type AnimationList is a list of Animation
AnimationTime Definition Type AnimationTime is inherited from Long GUI Widget
BRepShape Definition Type BRepShape is inherited from Shape Description A BRepShape is a Shape that contains BRep geometryGUI Widget
Camera Definition Type Camera is a structured type composed of these fields :GUI Widget
Component Definition Type Component is inherited from Entity Description A component add behavior to an occurrenceGUI Widget
ComponentList Definition Type ComponentList is a list of Component
ComponentType Definition Type ComponentType is an enumeration type composed of these values :Part (0)
PMI (1)
Light (2)
VisualBehavior (3)
InteractionBehavior (4)
Metadata (5)
Variant (6)
Animation (7)
Joint (8)
Widget (9)
GUI Widget
DirectionalLight Definition Type DirectionalLight is inherited from Entity Description A Directional Light is a light which emit in one direction (mostly used as sky lighting)GUI Widget
Filter Definition Type Filter is a structured type composed of these fields :GUI Widget
FilterExpression Definition Type FilterExpression is inherited from String Description A filter expression (see documentation)GUI Widget
FilterList Definition Type FilterList is a list of Filter
JointComponent Definition Type JointComponent is inherited from Component Description A joint for rigged animationsGUI Widget
Keyframe Definition Type Keyframe is inherited from Entity Description A keyframe to interpolate an AnimCurve fromGUI Widget
KeyframeList Definition Type KeyframeList is a list of Keyframe
Light Definition Type Light is inherited from Entity Description A Light is a an entity, can be positional, spot or directionalGUI Widget
LightComponent Definition Type LightComponent is inherited from Component Description A LightComponent is a component that add a light behavior to an occurrenceGUI Widget
MergeHiddenPartsMode Definition Type MergeHiddenPartsMode is an enumeration type composed of these values :Destroy (0)
MakeVisible (1)
MergeSeparately (2)
GUI Widget
Definition Type Metadata is inherited from Component Description A metadata is a component that contains all metadata properties of an occurrenceGUI Widget
Definition Type MetadataDefinition is inherited from PropertyValueList Description All properties of a metadata componentGUI Widget
Definition Type MetadataDefinitionList is a list of MetadataDefinition
Definition Type MetadataList is a list of Metadata
Occurrence Definition Type Occurrence is inherited from GeomEntity Description An occurrence is the main type of node in the product structure, it can have children and prototypesGUI Widget
OccurrenceList Definition Type OccurrenceList is a list of Occurrence
OccurrenceListList Definition Type OccurrenceListList is a list of OccurrenceList
PackedTree Definition Type PackedTree is a structured type composed of these fields :occurrences (OccurrenceList )list of all occurrences of the tree. (Note: all parent occurrences appears before their children, thus the first occurrence is the root)
parents (IntList )specifies the parent for each occurrence (same index than occurrences). root's parent is -1
names (StringList )name of each occurrence (same index than occurrences)
visibles (InheritableBoolList )visibility of each occurrence (same index than occurrences)
materials (MaterialList )material identifier of each occurrence (same index than occurrences)
transformIndices (IntList )indices of transform matrix of each occurrence (same index than occurrences). (Note: Identity matrix is always 0)
transformMatrices (Matrix4List )Matrices referenced by transformIndices. (Note: The first matrix is always Identity)
customProperties (StringPairListList )custom properties of each occurrence (same index than occurrences), pair is name -> value
Description Packed view of the scene treeGUI Widget
Part Definition Type Part is inherited from Component Description A part is the geometrical definition of product occurrenceGUI Widget
PartList Definition Type PartList is a list of Part
PositionalLight Definition Type PositionalLight is inherited from Entity Description A Positional Light is a light positioned in the space which emit in all directionsGUI Widget
Primitive_Type Definition Type Primitive_Type is an enumeration type composed of these values :CUBE (0)
SPHERE (1)
PLAN (2)
CONE (3)
ARROW (4)
CYLINDER (5)
GUI Widget
ProberInfo Definition Type ProberInfo is a structured type composed of these fields :GUI Widget
PropertyValue Definition Type PropertyValue is a structured type composed of these fields :name (String )name of the property
value (String )value of the property
Description A structure containing a property name and its valueGUI Widget
PropertyValueList Definition Type PropertyValueList is a list of PropertyValue Description list of PropertyValue
RayHit Definition Type RayHit is a structured type composed of these fields :GUI Widget
RayHitList Definition Type RayHitList is a list of RayHit
ResizeByMaximumSizeOptions Definition Type ResizeByMaximumSizeOptions is a structured type composed of these fields :GUI Widget
ResizeByOccurrencesOptions Definition Type ResizeByOccurrencesOptions is a structured type composed of these fields :GUI Widget
ResizeByRatioOptions Definition Type ResizeByRatioOptions is a structured type composed of these fields :GUI Widget
ResizeByTexturesOptions Definition Type ResizeByTexturesOptions is a structured type composed of these fields :GUI Widget
ResizeTexturesInputMode Definition Type ResizeTexturesInputMode is a select type composed of these choices :GUI Widget
ResizeTexturesResizeMode Definition Type ResizeTexturesResizeMode is a select type composed of these choices :GUI Widget
Shape Definition Type Shape is inherited from GeomEntity Description A Shape is the geometrical representation of a Part. It can be BRep or polygonalGUI Widget
SpotLight Definition Type SpotLight is inherited from Entity Description A Positional Light is a light positioned in the space which emit in a coneGUI Widget
TessellatedShape Definition Type TessellatedShape is inherited from Shape Description A TessellatedShape is a Shape that contains Polygonal geometryGUI Widget
Variant Definition Type Variant is inherited from Entity Description A variant allows to override some occurrences propertiesGUI Widget
VariantComponent Definition Type VariantComponent is inherited from Component Description A variant component is a component that contains variant definitions for an occurrenceGUI Widget
VariantComponentList Definition Type VariantComponentList is a list of VariantComponent
VariantDefinition Definition Type VariantDefinition is a structured type composed of these fields :GUI Widget
VariantDefinitionList Definition Type VariantDefinitionList is a list of VariantDefinition
VariantDefinitionListList Definition Type VariantDefinitionListList is a list of VariantDefinitionList
VariantList Definition Type VariantList is a list of Variant
VisibilityMode Definition Type VisibilityMode is an enumeration type composed of these values :GUI Widget