Studio
Python API types
Read time 3 minutesLast updated 8 hours ago
CoordinateSystemOptions
Fields
Type | Name | Default | Description |
|---|---|---|---|
| orientation | studio.OrientationSelect | Defines how the imported model's orientation (or coordinate system) is evaluated, to be correctly converted to match Pixyz Studio's own system (right-handed, Y is the Up-axis).<br>If 'Automatic Orientation' is enabled, Pixyz Studio performs an automatic conversion.<br>Use 'Manual Orientation' if the automatic detection does not work: fill in the characteristics about the imported file's coordinate system to help Studio convert the file correctly. | |
| scale | studio.ScaleSelect | Defines how the imported models' scale and units are evaluated, to be correctly converted to match Pixyz Studio's own units (mm).<br>If 'Automatic scale' is enabled, Pixyz Studio performs an automatic units conversion, and applies a corrective scale if required.<br>Use 'Manual Scale' if the automatic detection does not work: for example set a 0.1 scale value to convert a file in centimeters to millimeters. | |
| snapToGround | Boolean | False | Automatically snaps/moves the imported model onto the ground of the scene (on the grid).<br>This parameter changes the imported model's original position relatively to the origin, in the upward direction (Y-axis).<br>Do not use to keep model's original absolute position. |
| centerToOrigin | Boolean | False | Automatically centers the imported model to the origin of the scene.<br>This parameter changes the imported model's original position relatively to the origin, in all directions.<br>Do not use to keep model's original absolute position. |
Functions accepting this type or a list of this type as a parameter:
HandEnum
Enum of core.Int
Name | Value |
|---|---|
| leftHanded | 0 |
| rightHanded | 1 |
HierarchyMode
Enum of core.Long
Name | Value |
|---|---|
| Full | 0 |
| Compress | 1 |
| Rake | 2 |
| MergeAll | 3 |
| MergeFinalLevel | 4 |
ImportOptions
Fields
Type | Name | Default | Description |
|---|---|---|---|
| orientFaces | Boolean | False | If enabled, Pixyz Studio tries to orient model's faces (normals) consistently so they face the proper direction.<br>Do not use if the original's model faces orientation is already correct, as the process may destroy it.<br>If the model is not 100% properly oriented after import, use the functions from the 'Mesh' menu to fix faces orientation. |
| preserveOriginalUVs | Boolean | True | UVs applied to a mesh are used to properly display materials using texture maps.<br>If 'Preserve Original UVs' is enabled, Pixyz Studio imports the UVs included in the imported model (on any channel), and creates UVs on meshes that do not have any UVs (by a 400x400mm BoundingBox projection on channel 0).<br>If the parameter is disabled, all UVs (from any channel) are destroyed and new ones are created (same BoundingBox projection). |
| removeDuplicatedMeshes | Boolean | True | Use to remove duplicated/superimposed meshes (= parts).<br>Do not use if the imported model includes different configurations of the same model, resulting in intentionnaly duplicated parts. |
Functions accepting this type or a list of this type as a parameter:
Orientation
Fields
Type | Name | Default | Description |
|---|---|---|---|
| upAxis | UpEnum | zUp | |
| handedness | HandEnum | rightHanded |
OrientationSelect
Select between:
- automaticOrientation: core.None
- manualOrientation: studio.Orientation
QualityPreset
Enum of core.Long
Name | Value |
|---|---|
| VeryHigh | 0 |
| High | 1 |
| Medium | 2 |
| Low | 3 |
ScaleSelect
Select between:
- automaticScale: core.None
- manualScale: core.Double
StudioComboBox
Functions accepting this type or a list of this type as a parameter:
TessellationQuality
Fields
Type | Name | Default | Description |
|---|---|---|---|
| maxSag | Distance | 0.1 | Maximum distance between the geometry and the tessellation. |
| maxLength | Distance | -1 | Maximum length of elements. |
| maxAngle | Angle | -1 | Maximum angle between normals of two adjacent elements. |
TessellationSettings
Select between:
- usePreset: studio.QualityPreset
- useCustomValues: studio.TessellationQuality Functions accepting this type or a list of this type as a parameter:
UpEnum
Enum of core.Int
Name | Value |
|---|---|
| yUp | 0 |
| zUp | 1 |