Skip to content

Layer

This page contains classes from hakowan.grammar.layer module.

Layer dataclass

Layer contains the specification of data, mark, channels and transform.

Note

hakowan.layer() method is an alias of the constructor of this class.

Source code in hakowan/grammar/layer/layer.py 
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
@dataclass(kw_only=True, slots=True)
class Layer:
    """Layer contains the specification of data, mark, channels and transform.

    Note:
        `hakowan.layer()` method is an alias of the constructor of this class.
    """

    _spec: LayerSpec = field(default_factory=LayerSpec)
    _children: list["Layer"] = field(default_factory=list)

    def __init__(
        self,
        data: DataFrameLike | None = None,
        *,
        mark: Mark | None = None,
        channels: list[Channel] | None = None,
        transform: Transform | None = None,
    ):
        """Constructor of Layer.

        Args:
            data (DataFrameLike | None, optional): The data component of
                the layer.
            mark (Mark|None, optional): The mark component of the layer.
            channels (list[Channel], optional): The channels of the layer.
            transform (Transform, optional): The transform component of the layer.

        Returns:
            (Layer): The constructed layer object.
        """
        self._spec = LayerSpec()
        self._children = []

        if data is not None:
            self.data(data, in_place=True)
        if mark is not None:
            self.mark(mark, in_place=True)
        if transform is not None:
            self.transform(transform, in_place=True)
        if channels is not None:
            self._spec.channels = channels

    def __add__(self, other: "Layer") -> "Layer":
        """Combine two layers into a composite layer.

        Args:
            other (Layer): The other layer to be combined with.

        Returns:
            (Layer): The composite layer.
        """
        parent = Layer()
        parent._children = [self, other]
        return parent

    def __get_working_layer(self, in_place: bool = False) -> "Layer":
        if in_place:
            return self
        else:
            l = Layer()
            l._children = [self]
            return l

    def data(
        self,
        data: DataFrameLike,
        *,
        roi_box: npt.ArrayLike | None = None,
        in_place: bool = False,
    ) -> "Layer":
        """Overwrite the data component of this layer.

        Args:
            data (DataFrameLike): The new data component.
            roi_box (npt.ArrayLike, optional): The region of interest box of the data.
            in_place (bool, optional): Whether to modify the current layer in place or create new
                layer. Defaults to False (i.e. create a new layer).

        Returns:
            result (Layer): The layer object with data component overwritten.
        """
        l = self.__get_working_layer(in_place)
        match (data):
            case str() | Path():
                mesh = lagrange.io.load_mesh(data)  # type: ignore
                l._spec.data = DataFrame(mesh=mesh, roi_box=roi_box)
            case lagrange.SurfaceMesh():
                l._spec.data = DataFrame(mesh=data, roi_box=roi_box)
            case DataFrame():
                l._spec.data = data
                if roi_box is not None:
                    l._spec.data.roi_box = roi_box
            case _:
                raise TypeError(f"Unsupported data type: {type(data)}!")
        return l

    def mark(self, mark: Mark | str, *, in_place: bool = False) -> "Layer":
        """Overwrite the mark component of this layer.

        Args:
            mark (Mark | str): The new mark component.
            in_place (bool, optional): Whether to modify the current layer in place or create new
                layer. Defaults to False (i.e. create a new layer).

        Returns:
            result (Layer): The layer object with mark component overwritten.
        """
        l = self.__get_working_layer(in_place)
        match (mark):
            case Mark():
                l._spec.mark = mark
            case "point" | "Point" | "POINT":
                l._spec.mark = Mark.Point
            case "curve" | "Curve" | "CURVE":
                l._spec.mark = Mark.Curve
            case "surface" | "Surface" | "SURFACE":
                l._spec.mark = Mark.Surface
            case _:
                raise ValueError(f"Unsupported mark type: {mark}!")
        return l

    def channel(
        self,
        *,
        position: Position | str | None = None,
        normal: Normal | str | None = None,
        size: float | str | Size | None = None,
        shape: str | Shape | None = None,
        vector_field: VectorField | str | None = None,
        covariance: Covariance | str | None = None,
        material: Material | None = None,
        bump_map: BumpMap | TextureLike | None = None,
        normal_map: NormalMap | TextureLike | None = None,
        in_place: bool = False,
    ) -> "Layer":
        """Overwrite a channel component of this layer.

        Args:
            position (Position | str, optional): The new position channel.
            normal (Normal | str, optional): The new normal channel.
            size (float | str | Size, optional): The new size channel.
            vector_field (VectorField | str, optional): The new vector field channel.
            material (Material, optional): The new material channel.
            bump_map (BumpMap | TextureLike, optional): The new bump map channel.
            normal_map (NormalMap | TextureLike, optional): The new normal map channel.
            in_place (bool, optional): Whether to modify the current layer in place or create new
                layer. Defaults to False (i.e. create a new layer).

        Returns:
            result (Layer): The layer object with the channel component overwritten.
        """
        l = self.__get_working_layer(in_place)

        convert = (
            lambda value, cls: cls(data=Attribute(name=value))
            if isinstance(value, str)
            else value
        )
        if position is not None:
            assert isinstance(
                position, (Position, str)
            ), f"Unsupported position type: {type(position)}!"
            l._spec.channels.append(convert(position, Position))
        if normal is not None:
            assert isinstance(
                normal, (Normal, str)
            ), f"Unsupported normal type: {type(normal)}!"
            l._spec.channels.append(convert(normal, Normal))
        if size is not None:
            if isinstance(size, (int, float)):
                l._spec.channels.append(Size(data=float(size)))
            else:
                assert isinstance(
                    size, (Size, str)
                ), f"Unsupported size type: {type(size)}!"
                l._spec.channels.append(convert(size, Size))
        if shape is not None:
            if isinstance(shape, str):
                l._spec.channels.append(Shape(base_shape=shape))
            else:
                assert isinstance(
                    shape, Shape
                ), f"Unsupported shape type: {type(shape)}!"
                l._spec.channels.append(shape)
        if vector_field is not None:
            assert isinstance(
                vector_field, (VectorField, str)
            ), f"Unsupported vector_field type: {type(vector_field)}!"
            l._spec.channels.append(convert(vector_field, VectorField))
        if covariance is not None:
            assert isinstance(
                covariance, (Covariance, str)
            ), f"Unsupported covariance type: {type(covariance)}!"
            l._spec.channels.append(convert(covariance, Covariance))
        if material is not None:
            l._spec.channels.append(material)
        if bump_map is not None:
            if isinstance(bump_map, BumpMap):
                l._spec.channels.append(bump_map)
            else:
                l._spec.channels.append(BumpMap(bump_map))
        if normal_map is not None:
            if isinstance(normal_map, NormalMap):
                l._spec.channels.append(normal_map)
            else:
                l._spec.channels.append(NormalMap(normal_map))
        return l

    def material(self, type: str, *args, in_place: bool = False, **kwargs) -> "Layer":
        """Overwrite material for this layer.

        Args:
            type (str): The material type.
            in_place (bool, optional): Whether to modify the current layer in place or create new
                layer. Defaults to False (i.e. create a new layer).
            *args: Variable length argument list that will be forwarded to material constructor.
            **kwargs: Arbitrary keyword arguments that will be forwarded to material constructor.

        Returns:
            result (Layer): The layer object with the channel component overwritten.
        """
        l = self.__get_working_layer(in_place)
        match type:
            case "diffuse" | "Diffuse" | "DIFFUSE":
                l._spec.channels.append(Diffuse(*args, **kwargs))
            case "conductor" | "Conductor" | "CONDUCTOR":
                l._spec.channels.append(Conductor(*args, **kwargs))
            case "rough_conductor" | "RoughConductor" | "ROUGH_CONDUCTOR":
                l._spec.channels.append(RoughConductor(*args, **kwargs))
            case "plastic" | "Plastic" | "PLASTIC":
                l._spec.channels.append(Plastic(*args, **kwargs))
            case "rough_plastic" | "RoughPlastic" | "ROUGH_PLASTIC":
                l._spec.channels.append(RoughPlastic(*args, **kwargs))
            case "principled" | "Principled" | "PRINCIPLED":
                l._spec.channels.append(Principled(*args, **kwargs))
            case "thin_principled" | "ThinPrincipled" | "THIN_PRINCIPLED":
                l._spec.channels.append(ThinPrincipled(*args, **kwargs))
            case "dielectric" | "Dielectric" | "DIELECTRIC":
                l._spec.channels.append(Dielectric(*args, **kwargs))
            case "thin_dielectric" | "ThinDielectric" | "THIN_DIELECTRIC":
                l._spec.channels.append(ThinDielectric(*args, **kwargs))
            case "rough_dielectric" | "RoughDielectric" | "ROUGH_DIELECTRIC":
                l._spec.channels.append(RoughDielectric(*args, **kwargs))
            case "hair" | "Hair" | "HAIR":
                l._spec.channels.append(Hair(*args, **kwargs))
            case _:
                raise ValueError(f"Unsupported material type: {type}!")
        return l

    def transform(self, transform: Transform, *, in_place: bool = False) -> "Layer":
        """Overwrite the transform component of this layer.

        Args:
            transform (Transform): The new transform component.
            in_place (bool, optional): Whether to modify the current layer in place or create new
                layer. Defaults to False (i.e. create a new layer).

        Returns:
            result (Layer): The layer object with transform component overwritten.
        """
        l = self.__get_working_layer(in_place)
        l._spec.transform = transform
        return l

    def rotate(
        self, axis: npt.ArrayLike, angle: float, in_place: bool = False
    ) -> "Layer":
        """Update the transform component of the current layer by applying a rotation.

        Args:
            axis (npt.ArrayLike): The unit rotation axis.
            angle (float): The rotation angle (in radians).
            in_place (bool, optional): Whether to modify the current layer in place or create new
                layer. Defaults to False (i.e. create a new layer).

        Returns:
            result (Layer): The layer object with transform component updated.
        """
        l = self.__get_working_layer(in_place)
        v = np.array(axis, dtype=np.float64)
        I = np.eye(3)
        H = np.outer(v, v)
        S = np.cross(I, v)
        M = I * np.cos(angle) + S * np.sin(angle) + H * (1 - np.cos(angle))
        if l._spec.transform is None:
            l._spec.transform = Affine(M)
        else:
            l._spec.transform *= Affine(M)
        return l

    def translate(self, offset: npt.ArrayLike, in_place: bool = False) -> "Layer":
        """Update the transform component of the current layer by applying a translation.

        Args:
            offset (npt.ArrayLike): The translation offset.
            in_place (bool, optional): Whether to modify the current layer in place or create new
                layer. Defaults to False (i.e. create a new layer).

        Returns:
            result (Layer): The layer object with transform component updated.
        """
        l = self.__get_working_layer(in_place)
        M = np.eye(4)
        M[:3, 3] = np.array(offset, dtype=np.float64)

        if l._spec.transform is None:
            l._spec.transform = Affine(M)
        else:
            l._spec.transform *= Affine(M)
        return l

    def scale(self, factor: float, in_place: bool = False) -> "Layer":
        """Update the transform component of the current layer by applying uniform scaling.

        Args:
            factor (float): The scaling factor.
            in_place (bool, optional): Whether to modify the current layer in place or create new
                layer. Defaults to False (i.e. create a new layer).

        Returns:
            result (Layer): The layer object with transform component updated.
        """
        l = self.__get_working_layer(in_place)
        M = np.eye(4)
        M[0, 0] = M[1, 1] = M[2, 2] = factor
        if l._spec.transform is None:
            l._spec.transform = Affine(M)
        else:
            l._spec.transform *= Affine(M)
        return l

    @property
    def children(self) -> list["Layer"]:
        """Get the child layers of this layer."""
        return self._children

    @children.setter
    def children(self, value: Sequence["Layer"]) -> None:
        """Set the child layers of this layer."""
        self._children = list(value)

children: list[Layer] property writable

Get the child layers of this layer.

__add__(other)

Combine two layers into a composite layer.

Parameters:

Name Type Description Default
other Layer

The other layer to be combined with.

 required

Returns:

Type Description
Layer

The composite layer.
Source code in hakowan/grammar/layer/layer.py 
84
85
86
87
88
89
90
91
92
93
94
95
def __add__(self, other: "Layer") -> "Layer":
    """Combine two layers into a composite layer.

    Args:
        other (Layer): The other layer to be combined with.

    Returns:
        (Layer): The composite layer.
    """
    parent = Layer()
    parent._children = [self, other]
    return parent

__init__(data=None, *, mark=None, channels=None, transform=None)

Constructor of Layer.

Parameters:

Name Type Description Default
data DataFrameLike | None

The data component of the layer.

 None
mark Mark | None

The mark component of the layer.

 None
channels list[Channel]

The channels of the layer.

 None
transform Transform

The transform component of the layer.

 None

Returns:

Type Description
Layer

The constructed layer object.
Source code in hakowan/grammar/layer/layer.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def __init__(
    self,
    data: DataFrameLike | None = None,
    *,
    mark: Mark | None = None,
    channels: list[Channel] | None = None,
    transform: Transform | None = None,
):
    """Constructor of Layer.

    Args:
        data (DataFrameLike | None, optional): The data component of
            the layer.
        mark (Mark|None, optional): The mark component of the layer.
        channels (list[Channel], optional): The channels of the layer.
        transform (Transform, optional): The transform component of the layer.

    Returns:
        (Layer): The constructed layer object.
    """
    self._spec = LayerSpec()
    self._children = []

    if data is not None:
        self.data(data, in_place=True)
    if mark is not None:
        self.mark(mark, in_place=True)
    if transform is not None:
        self.transform(transform, in_place=True)
    if channels is not None:
        self._spec.channels = channels

channel(*, position=None, normal=None, size=None, shape=None, vector_field=None, covariance=None, material=None, bump_map=None, normal_map=None, in_place=False)

Overwrite a channel component of this layer.

Parameters:

Name Type Description Default
position Position | str

The new position channel.

 None
normal Normal | str

The new normal channel.

 None
size float | str | Size

The new size channel.

 None
vector_field VectorField | str

The new vector field channel.

 None
material Material

The new material channel.

 None
bump_map BumpMap | TextureLike

The new bump map channel.

 None
normal_map NormalMap | TextureLike

The new normal map channel.

 None
in_place bool

Whether to modify the current layer in place or create new layer. Defaults to False (i.e. create a new layer).

 False

Returns:

Name Type Description
result Layer

The layer object with the channel component overwritten.
Source code in hakowan/grammar/layer/layer.py 
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
def channel(
    self,
    *,
    position: Position | str | None = None,
    normal: Normal | str | None = None,
    size: float | str | Size | None = None,
    shape: str | Shape | None = None,
    vector_field: VectorField | str | None = None,
    covariance: Covariance | str | None = None,
    material: Material | None = None,
    bump_map: BumpMap | TextureLike | None = None,
    normal_map: NormalMap | TextureLike | None = None,
    in_place: bool = False,
) -> "Layer":
    """Overwrite a channel component of this layer.

    Args:
        position (Position | str, optional): The new position channel.
        normal (Normal | str, optional): The new normal channel.
        size (float | str | Size, optional): The new size channel.
        vector_field (VectorField | str, optional): The new vector field channel.
        material (Material, optional): The new material channel.
        bump_map (BumpMap | TextureLike, optional): The new bump map channel.
        normal_map (NormalMap | TextureLike, optional): The new normal map channel.
        in_place (bool, optional): Whether to modify the current layer in place or create new
            layer. Defaults to False (i.e. create a new layer).

    Returns:
        result (Layer): The layer object with the channel component overwritten.
    """
    l = self.__get_working_layer(in_place)

    convert = (
        lambda value, cls: cls(data=Attribute(name=value))
        if isinstance(value, str)
        else value
    )
    if position is not None:
        assert isinstance(
            position, (Position, str)
        ), f"Unsupported position type: {type(position)}!"
        l._spec.channels.append(convert(position, Position))
    if normal is not None:
        assert isinstance(
            normal, (Normal, str)
        ), f"Unsupported normal type: {type(normal)}!"
        l._spec.channels.append(convert(normal, Normal))
    if size is not None:
        if isinstance(size, (int, float)):
            l._spec.channels.append(Size(data=float(size)))
        else:
            assert isinstance(
                size, (Size, str)
            ), f"Unsupported size type: {type(size)}!"
            l._spec.channels.append(convert(size, Size))
    if shape is not None:
        if isinstance(shape, str):
            l._spec.channels.append(Shape(base_shape=shape))
        else:
            assert isinstance(
                shape, Shape
            ), f"Unsupported shape type: {type(shape)}!"
            l._spec.channels.append(shape)
    if vector_field is not None:
        assert isinstance(
            vector_field, (VectorField, str)
        ), f"Unsupported vector_field type: {type(vector_field)}!"
        l._spec.channels.append(convert(vector_field, VectorField))
    if covariance is not None:
        assert isinstance(
            covariance, (Covariance, str)
        ), f"Unsupported covariance type: {type(covariance)}!"
        l._spec.channels.append(convert(covariance, Covariance))
    if material is not None:
        l._spec.channels.append(material)
    if bump_map is not None:
        if isinstance(bump_map, BumpMap):
            l._spec.channels.append(bump_map)
        else:
            l._spec.channels.append(BumpMap(bump_map))
    if normal_map is not None:
        if isinstance(normal_map, NormalMap):
            l._spec.channels.append(normal_map)
        else:
            l._spec.channels.append(NormalMap(normal_map))
    return l

data(data, *, roi_box=None, in_place=False)

Overwrite the data component of this layer.

Parameters:

Name Type Description Default
data DataFrameLike

The new data component.

 required
roi_box ArrayLike

The region of interest box of the data.

 None
in_place bool

Whether to modify the current layer in place or create new layer. Defaults to False (i.e. create a new layer).

 False

Returns:

Name Type Description
result Layer

The layer object with data component overwritten.
Source code in hakowan/grammar/layer/layer.py 
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
def data(
    self,
    data: DataFrameLike,
    *,
    roi_box: npt.ArrayLike | None = None,
    in_place: bool = False,
) -> "Layer":
    """Overwrite the data component of this layer.

    Args:
        data (DataFrameLike): The new data component.
        roi_box (npt.ArrayLike, optional): The region of interest box of the data.
        in_place (bool, optional): Whether to modify the current layer in place or create new
            layer. Defaults to False (i.e. create a new layer).

    Returns:
        result (Layer): The layer object with data component overwritten.
    """
    l = self.__get_working_layer(in_place)
    match (data):
        case str() | Path():
            mesh = lagrange.io.load_mesh(data)  # type: ignore
            l._spec.data = DataFrame(mesh=mesh, roi_box=roi_box)
        case lagrange.SurfaceMesh():
            l._spec.data = DataFrame(mesh=data, roi_box=roi_box)
        case DataFrame():
            l._spec.data = data
            if roi_box is not None:
                l._spec.data.roi_box = roi_box
        case _:
            raise TypeError(f"Unsupported data type: {type(data)}!")
    return l

mark(mark, *, in_place=False)

Overwrite the mark component of this layer.

Parameters:

Name Type Description Default
mark Mark | str

The new mark component.

 required
in_place bool

Whether to modify the current layer in place or create new layer. Defaults to False (i.e. create a new layer).

 False

Returns:

Name Type Description
result Layer

The layer object with mark component overwritten.
Source code in hakowan/grammar/layer/layer.py 
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
def mark(self, mark: Mark | str, *, in_place: bool = False) -> "Layer":
    """Overwrite the mark component of this layer.

    Args:
        mark (Mark | str): The new mark component.
        in_place (bool, optional): Whether to modify the current layer in place or create new
            layer. Defaults to False (i.e. create a new layer).

    Returns:
        result (Layer): The layer object with mark component overwritten.
    """
    l = self.__get_working_layer(in_place)
    match (mark):
        case Mark():
            l._spec.mark = mark
        case "point" | "Point" | "POINT":
            l._spec.mark = Mark.Point
        case "curve" | "Curve" | "CURVE":
            l._spec.mark = Mark.Curve
        case "surface" | "Surface" | "SURFACE":
            l._spec.mark = Mark.Surface
        case _:
            raise ValueError(f"Unsupported mark type: {mark}!")
    return l

material(type, *args, in_place=False, **kwargs)

Overwrite material for this layer.

Parameters:

Name Type Description Default
type str

The material type.

 required
in_place bool

Whether to modify the current layer in place or create new layer. Defaults to False (i.e. create a new layer).

 False
*args

Variable length argument list that will be forwarded to material constructor.

 ()
**kwargs

Arbitrary keyword arguments that will be forwarded to material constructor.

 {}

Returns:

Name Type Description
result Layer

The layer object with the channel component overwritten.
Source code in hakowan/grammar/layer/layer.py 
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
def material(self, type: str, *args, in_place: bool = False, **kwargs) -> "Layer":
    """Overwrite material for this layer.

    Args:
        type (str): The material type.
        in_place (bool, optional): Whether to modify the current layer in place or create new
            layer. Defaults to False (i.e. create a new layer).
        *args: Variable length argument list that will be forwarded to material constructor.
        **kwargs: Arbitrary keyword arguments that will be forwarded to material constructor.

    Returns:
        result (Layer): The layer object with the channel component overwritten.
    """
    l = self.__get_working_layer(in_place)
    match type:
        case "diffuse" | "Diffuse" | "DIFFUSE":
            l._spec.channels.append(Diffuse(*args, **kwargs))
        case "conductor" | "Conductor" | "CONDUCTOR":
            l._spec.channels.append(Conductor(*args, **kwargs))
        case "rough_conductor" | "RoughConductor" | "ROUGH_CONDUCTOR":
            l._spec.channels.append(RoughConductor(*args, **kwargs))
        case "plastic" | "Plastic" | "PLASTIC":
            l._spec.channels.append(Plastic(*args, **kwargs))
        case "rough_plastic" | "RoughPlastic" | "ROUGH_PLASTIC":
            l._spec.channels.append(RoughPlastic(*args, **kwargs))
        case "principled" | "Principled" | "PRINCIPLED":
            l._spec.channels.append(Principled(*args, **kwargs))
        case "thin_principled" | "ThinPrincipled" | "THIN_PRINCIPLED":
            l._spec.channels.append(ThinPrincipled(*args, **kwargs))
        case "dielectric" | "Dielectric" | "DIELECTRIC":
            l._spec.channels.append(Dielectric(*args, **kwargs))
        case "thin_dielectric" | "ThinDielectric" | "THIN_DIELECTRIC":
            l._spec.channels.append(ThinDielectric(*args, **kwargs))
        case "rough_dielectric" | "RoughDielectric" | "ROUGH_DIELECTRIC":
            l._spec.channels.append(RoughDielectric(*args, **kwargs))
        case "hair" | "Hair" | "HAIR":
            l._spec.channels.append(Hair(*args, **kwargs))
        case _:
            raise ValueError(f"Unsupported material type: {type}!")
    return l

rotate(axis, angle, in_place=False)

Update the transform component of the current layer by applying a rotation.

Parameters:

Name Type Description Default
axis ArrayLike

The unit rotation axis.

 required
angle float

The rotation angle (in radians).

 required
in_place bool

Whether to modify the current layer in place or create new layer. Defaults to False (i.e. create a new layer).

 False

Returns:

Name Type Description
result Layer

The layer object with transform component updated.
Source code in hakowan/grammar/layer/layer.py 
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
def rotate(
    self, axis: npt.ArrayLike, angle: float, in_place: bool = False
) -> "Layer":
    """Update the transform component of the current layer by applying a rotation.

    Args:
        axis (npt.ArrayLike): The unit rotation axis.
        angle (float): The rotation angle (in radians).
        in_place (bool, optional): Whether to modify the current layer in place or create new
            layer. Defaults to False (i.e. create a new layer).

    Returns:
        result (Layer): The layer object with transform component updated.
    """
    l = self.__get_working_layer(in_place)
    v = np.array(axis, dtype=np.float64)
    I = np.eye(3)
    H = np.outer(v, v)
    S = np.cross(I, v)
    M = I * np.cos(angle) + S * np.sin(angle) + H * (1 - np.cos(angle))
    if l._spec.transform is None:
        l._spec.transform = Affine(M)
    else:
        l._spec.transform *= Affine(M)
    return l

scale(factor, in_place=False)

Update the transform component of the current layer by applying uniform scaling.

Parameters:

Name Type Description Default
factor float

The scaling factor.

 required
in_place bool

Whether to modify the current layer in place or create new layer. Defaults to False (i.e. create a new layer).

 False

Returns:

Name Type Description
result Layer

The layer object with transform component updated.
Source code in hakowan/grammar/layer/layer.py 
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
def scale(self, factor: float, in_place: bool = False) -> "Layer":
    """Update the transform component of the current layer by applying uniform scaling.

    Args:
        factor (float): The scaling factor.
        in_place (bool, optional): Whether to modify the current layer in place or create new
            layer. Defaults to False (i.e. create a new layer).

    Returns:
        result (Layer): The layer object with transform component updated.
    """
    l = self.__get_working_layer(in_place)
    M = np.eye(4)
    M[0, 0] = M[1, 1] = M[2, 2] = factor
    if l._spec.transform is None:
        l._spec.transform = Affine(M)
    else:
        l._spec.transform *= Affine(M)
    return l

transform(transform, *, in_place=False)

Overwrite the transform component of this layer.

Parameters:

Name Type Description Default
transform Transform

The new transform component.

 required
in_place bool

Whether to modify the current layer in place or create new layer. Defaults to False (i.e. create a new layer).

 False

Returns:

Name Type Description
result Layer

The layer object with transform component overwritten.
Source code in hakowan/grammar/layer/layer.py 
291
292
293
294
295
296
297
298
299
300
301
302
303
304
def transform(self, transform: Transform, *, in_place: bool = False) -> "Layer":
    """Overwrite the transform component of this layer.

    Args:
        transform (Transform): The new transform component.
        in_place (bool, optional): Whether to modify the current layer in place or create new
            layer. Defaults to False (i.e. create a new layer).

    Returns:
        result (Layer): The layer object with transform component overwritten.
    """
    l = self.__get_working_layer(in_place)
    l._spec.transform = transform
    return l

translate(offset, in_place=False)

Update the transform component of the current layer by applying a translation.

Parameters:

Name Type Description Default
offset ArrayLike

The translation offset.

 required
in_place bool

Whether to modify the current layer in place or create new layer. Defaults to False (i.e. create a new layer).

 False

Returns:

Name Type Description
result Layer

The layer object with transform component updated.
Source code in hakowan/grammar/layer/layer.py 
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
def translate(self, offset: npt.ArrayLike, in_place: bool = False) -> "Layer":
    """Update the transform component of the current layer by applying a translation.

    Args:
        offset (npt.ArrayLike): The translation offset.
        in_place (bool, optional): Whether to modify the current layer in place or create new
            layer. Defaults to False (i.e. create a new layer).

    Returns:
        result (Layer): The layer object with transform component updated.
    """
    l = self.__get_working_layer(in_place)
    M = np.eye(4)
    M[:3, 3] = np.array(offset, dtype=np.float64)

    if l._spec.transform is None:
        l._spec.transform = Affine(M)
    else:
        l._spec.transform *= Affine(M)
    return l