Skip to content

Material

This page contains classes defined in hakowan.material module.

Material dataclass

Bases: Channel

Material base class.

Attributes:

Name Type Description
two_sided bool

Whether to render both sides of the surface (default: False).
Source code in hakowan/grammar/channel/material/material.py 
 9
10
11
12
13
14
15
16
17
@dataclass(kw_only=True, slots=True)
class Material(Channel):
    """Material base class.

    Attributes:
        two_sided: Whether to render both sides of the surface (default: False).
    """

    two_sided: bool = False

Diffuse dataclass

Bases: Material

Diffuse material.

Attributes:

Name Type Description
reflectance TextureLike

Diffuse reflectance (i.e. base color) texture (default: 0.5).
Source code in hakowan/grammar/channel/material/material.py 
20
21
22
23
24
25
26
27
28
@dataclass(slots=True)
class Diffuse(Material):
    """Diffuse material.

    Attributes:
        reflectance: Diffuse reflectance (i.e. base color) texture (default: 0.5).
    """

    reflectance: TextureLike = 0.5

Conductor dataclass

Bases: Material

Conductor material.

Attributes:

Name Type Description
material str

Conductor material name based on Mitsuba preset.
Source code in hakowan/grammar/channel/material/material.py 
31
32
33
34
35
36
37
38
39
@dataclass(slots=True)
class Conductor(Material):
    """Conductor material.

    Attributes:
        material: Conductor material name based on [Mitsuba preset](https://mitsuba.readthedocs.io/en/stable/src/generated/plugins_bsdfs.html#conductor-ior-list).
    """

    material: str

RoughConductor dataclass

Bases: Conductor

Rough conductor material.

Attributes:

Name Type Description
distribution str

Microfacet distribution (default: "beckmann").
alpha Texture | float

Roughness value (default: 0.1).
Source code in hakowan/grammar/channel/material/material.py 
42
43
44
45
46
47
48
49
50
51
@dataclass(slots=True)
class RoughConductor(Conductor):
    """Rough conductor material.

    Attributes:
        distribution: Microfacet distribution (default: "beckmann").
        alpha: Roughness value (default: 0.1).
    """
    distribution: str = "beckmann"
    alpha: Texture | float = 0.1

Plastic dataclass

Bases: Material

Plastic material.

Attributes:

Name Type Description
diffuse_reflectance TextureLike

Diffuse reflectance (i.e. base color) texture (default: 0.5).
specular_reflectance Texture | float

Specular reflectance texture (default: 1.0).
Source code in hakowan/grammar/channel/material/material.py 
54
55
56
57
58
59
60
61
62
63
@dataclass(slots=True)
class Plastic(Material):
    """Plastic material.

    Attributes:
        diffuse_reflectance: Diffuse reflectance (i.e. base color) texture (default: 0.5).
        specular_reflectance: Specular reflectance texture (default: 1.0).
    """
    diffuse_reflectance: TextureLike = 0.5
    specular_reflectance: Texture | float = 1.0

RoughPlastic dataclass

Bases: Plastic

Rough plastic material.

Attributes:

Name Type Description
distribution str

Microfacet distribution (default: "beckmann").
alpha float

Roughness value (default: 0.1).
Source code in hakowan/grammar/channel/material/material.py 
66
67
68
69
70
71
72
73
74
75
@dataclass(slots=True)
class RoughPlastic(Plastic):
    """Rough plastic material.

    Attributes:
        distribution: Microfacet distribution (default: "beckmann").
        alpha: Roughness value (default: 0.1).
    """
    distribution: str = "beckmann"
    alpha: float = 0.1

Principled dataclass

Bases: Material

Principled material.

Attributes:

Name Type Description
color TextureLike

Base color texture (default: 0.5).
roughness Texture | float

Roughness texture (default: 0.5).
metallic Texture | float

Metallic texture (default: 0.0).
Source code in hakowan/grammar/channel/material/material.py 
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
@dataclass(slots=True)
class Principled(Material):
    """Principled material.

    Attributes:
        color: Base color texture (default: 0.5).
        roughness: Roughness texture (default: 0.5).
        metallic: Metallic texture (default: 0.0).
    """
    color: TextureLike = 0.5
    roughness: Texture | float = 0.5
    metallic: Texture | float = 0.0
    anisotropic: float = 0.0
    spec_trans: float = 0.0
    eta: float = 1.5
    spec_tint: float = 0.0
    sheen: float = 0.0
    sheen_tint: float = 0.0
    flatness: float = 0.0

ThinPrincipled dataclass

Bases: Principled

Thin Principled material.

Source code in hakowan/grammar/channel/material/material.py 
 99
100
101
102
@dataclass(slots=True)
class ThinPrincipled(Principled):
    """Thin Principled material."""
    diff_trans: float = 0.0

Dielectric dataclass

Bases: Material

Dielectric material.

Attributes:

Name Type Description
int_ior str | float

Interior index of refraction (default: "bk7").
ext_ior str | float

Exterior index of refraction (default: "air").
medium Medium | None

Medium (default: None).
specular_reflectance float

Specular reflectance texture (default: 1.0).
Source code in hakowan/grammar/channel/material/material.py 
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
@dataclass(slots=True)
class Dielectric(Material):
    """Dielectric material.

    Attributes:
        int_ior: Interior index of refraction (default: "bk7").
        ext_ior: Exterior index of refraction (default: "air").
        medium: Medium (default: None).
        specular_reflectance: Specular reflectance texture (default: 1.0).
    """
    int_ior: str | float = "bk7"
    ext_ior: str | float = "air"
    medium: Medium | None = None
    specular_reflectance: float = 1.0
    specular_transmittance: float = 1.0

ThinDielectric dataclass

Bases: Dielectric

Thin dielectric material.

Source code in hakowan/grammar/channel/material/material.py 
122
123
124
125
@dataclass(slots=True)
class ThinDielectric(Dielectric):
    """Thin dielectric material."""
    pass

RoughDielectric dataclass

Bases: Dielectric

Rough dielectric material.

Attributes:

Name Type Description
distribution str

Microfacet distribution (default: "beckmann").
alpha Texture | float

Roughness value (default: 0.1).
Source code in hakowan/grammar/channel/material/material.py 
128
129
130
131
132
133
134
135
136
137
@dataclass(slots=True)
class RoughDielectric(Dielectric):
    """Rough dielectric material.

    Attributes:
        distribution: Microfacet distribution (default: "beckmann").
        alpha: Roughness value (default: 0.1).
    """
    distribution: str = "beckmann"
    alpha: Texture | float = 0.1

Hair dataclass

Bases: Material

Hair material.

Attributes:

Name Type Description
eumelanin float

Eumelanin (dark/brown pigment) concentration (default: 1.3).
pheomelanin float

Pheomelanin (reddish-yellow pigment) concentration (default: 0.2).
Source code in hakowan/grammar/channel/material/material.py 
140
141
142
143
144
145
146
147
148
149
@dataclass(slots=True)
class Hair(Material):
    """Hair material.

    Attributes:
        eumelanin: Eumelanin (dark/brown pigment) concentration (default: 1.3).
        pheomelanin: Pheomelanin (reddish-yellow pigment) concentration (default: 0.2).
    """
    eumelanin: float = 1.3
    pheomelanin: float = 0.2