Skip to content

three_dimensional

3D traits.

Geometry dataclass

Bases: TraitBase

Geometry type trait model.

Type trait for geometry data.

Sync with OpenAssetIO MediaCreation Traits.

Source code in client/ayon_core/pipeline/traits/three_dimensional.py
38
39
40
41
42
43
44
45
46
47
48
49
50
@dataclass
class Geometry(TraitBase):
    """Geometry type trait model.

    Type trait for geometry data.

    Sync with OpenAssetIO MediaCreation Traits.
    """

    id: ClassVar[str] = "ayon.3d.Geometry.v1"
    name: ClassVar[str] = "Geometry"
    description: ClassVar[str] = "Geometry trait model."
    persistent: ClassVar[bool] = True

IESProfile dataclass

Bases: TraitBase

IES profile (IES-LM-64) type trait model.

Sync with OpenAssetIO MediaCreation Traits.

Source code in client/ayon_core/pipeline/traits/three_dimensional.py
83
84
85
86
87
88
89
90
91
92
93
@dataclass
class IESProfile(TraitBase):
    """IES profile (IES-LM-64) type trait model.

    Sync with OpenAssetIO MediaCreation Traits.
    """

    id: ClassVar[str] = "ayon.3d.IESProfile.v1"
    name: ClassVar[str] = "IESProfile"
    description: ClassVar[str] = "IES profile trait model."
    persistent: ClassVar[bool] = True

Lighting dataclass

Bases: TraitBase

Lighting trait model.

Type trait for lighting data.

Sync with OpenAssetIO MediaCreation Traits.

Source code in client/ayon_core/pipeline/traits/three_dimensional.py
68
69
70
71
72
73
74
75
76
77
78
79
80
@dataclass
class Lighting(TraitBase):
    """Lighting trait model.

    Type trait for lighting data.

    Sync with OpenAssetIO MediaCreation Traits.
    """

    id: ClassVar[str] = "ayon.3d.Lighting.v1"
    name: ClassVar[str] = "Lighting"
    description: ClassVar[str] = "Lighting trait model."
    persistent: ClassVar[bool] = True

Shader dataclass

Bases: TraitBase

Shader trait model.

Type trait for shader data.

Sync with OpenAssetIO MediaCreation Traits.

Source code in client/ayon_core/pipeline/traits/three_dimensional.py
53
54
55
56
57
58
59
60
61
62
63
64
65
@dataclass
class Shader(TraitBase):
    """Shader trait model.

    Type trait for shader data.

    Sync with OpenAssetIO MediaCreation Traits.
    """

    id: ClassVar[str] = "ayon.3d.Shader.v1"
    name: ClassVar[str] = "Shader"
    description: ClassVar[str] = "Shader trait model."
    persistent: ClassVar[bool] = True

Spatial dataclass

Bases: TraitBase

Spatial trait model.

Trait describing spatial information. Up axis valid strings are "Y", "Z", "X". Handedness valid strings are "left", "right". Meters per unit is a float value.

Example::

    Spatial(up_axis="Y", handedness="right", meters_per_unit=1.0)
Todo
  • Add value validation for up_axis and handedness.

Attributes:

Name Type Description
up_axis str

Up axis.

handedness str

Handedness.

meters_per_unit float

Meters per unit.

Source code in client/ayon_core/pipeline/traits/three_dimensional.py
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
@dataclass
class Spatial(TraitBase):
    """Spatial trait model.

    Trait describing spatial information. Up axis valid strings are
    "Y", "Z", "X". Handedness valid strings are "left", "right". Meters per
    unit is a float value.

    Example::

            Spatial(up_axis="Y", handedness="right", meters_per_unit=1.0)

    Todo:
        * Add value validation for up_axis and handedness.

    Attributes:
        up_axis (str): Up axis.
        handedness (str): Handedness.
        meters_per_unit (float): Meters per unit.
    """

    id: ClassVar[str] = "ayon.3d.Spatial.v1"
    name: ClassVar[str] = "Spatial"
    description: ClassVar[str] = "Spatial trait model."
    persistent: ClassVar[bool] = True
    up_axis: str
    handedness: str
    meters_per_unit: float