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 
 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
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
@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:
            layer = Layer()
            layer._children = [self]
            return layer

    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.
        """
        layer = self.__get_working_layer(in_place)
        match data:
            case str() | Path():
                mesh = lagrange.io.load_mesh(data, quiet=True, stitch_vertices=True)  # type: ignore
                layer._spec.data = DataFrame(mesh=mesh, roi_box=roi_box)
            case lagrange.SurfaceMesh():
                layer._spec.data = DataFrame(mesh=data, roi_box=roi_box)
            case DataFrame():
                layer._spec.data = data
                if roi_box is not None:
                    layer._spec.data.roi_box = roi_box
            case _:
                raise TypeError(f"Unsupported data type: {type(data)}!")
        return layer

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

        Args:
            mark (Mark | str): The new mark component. When a string is given, accepted
                values are ``"point"`` / ``"Point"`` / ``"POINT"``,
                ``"curve"`` / ``"Curve"`` / ``"CURVE"``, and
                ``"surface"`` / ``"Surface"`` / ``"SURFACE"``.
            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.
        """
        layer = self.__get_working_layer(in_place)
        match mark:
            case Mark():
                layer._spec.mark = mark
            case "point" | "Point" | "POINT":
                layer._spec.mark = Mark.Point
            case "curve" | "Curve" | "CURVE":
                layer._spec.mark = Mark.Curve
            case "surface" | "Surface" | "SURFACE":
                layer._spec.mark = Mark.Surface
            case _:
                raise ValueError(f"Unsupported mark type: {mark}!")
        return layer

    def channel(
        self,
        *,
        position: Position | AttributeLike | None = None,
        normal: Normal | AttributeLike | None = None,
        size: float | Size | AttributeLike | None = None,
        shape: _BaseShapeStr | 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 | AttributeLike, optional): The new position channel.
            normal (Normal | AttributeLike, optional): The new normal channel.
            size (float | Size | AttributeLike, optional): The new size channel.
                An ``Attribute`` (e.g. from ``hakowan.norm()``) maps a data
                field to size.
            shape (Literal["sphere", "disk", "cube"] | Shape, optional): The new shape channel.
                When a string is given, it sets ``Shape.base_shape`` directly.
            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.
        """
        layer = self.__get_working_layer(in_place)

        def convert(value, cls):
            if isinstance(value, (str, Attribute)):
                return cls(data=to_attribute(value))
            return value

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

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

        Args:
            type (str): The material type. Accepted values (case-insensitive canonical forms):
                ``"diffuse"``, ``"conductor"``, ``"rough_conductor"``, ``"plastic"``,
                ``"rough_plastic"``, ``"principled"``, ``"thin_principled"``,
                ``"dielectric"``, ``"thin_dielectric"``, ``"rough_dielectric"``,
                ``"hair"``. PascalCase (e.g. ``"RoughConductor"``) and UPPER_CASE
                (e.g. ``"ROUGH_CONDUCTOR"``) variants are also accepted.
            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.
        """
        layer = self.__get_working_layer(in_place)
        match type:
            case "diffuse" | "Diffuse" | "DIFFUSE":
                layer._spec.channels.append(Diffuse(*args, **kwargs))
            case "conductor" | "Conductor" | "CONDUCTOR":
                layer._spec.channels.append(Conductor(*args, **kwargs))
            case "rough_conductor" | "RoughConductor" | "ROUGH_CONDUCTOR":
                layer._spec.channels.append(RoughConductor(*args, **kwargs))
            case "plastic" | "Plastic" | "PLASTIC":
                layer._spec.channels.append(Plastic(*args, **kwargs))
            case "rough_plastic" | "RoughPlastic" | "ROUGH_PLASTIC":
                layer._spec.channels.append(RoughPlastic(*args, **kwargs))
            case "principled" | "Principled" | "PRINCIPLED":
                layer._spec.channels.append(Principled(*args, **kwargs))
            case "thin_principled" | "ThinPrincipled" | "THIN_PRINCIPLED":
                layer._spec.channels.append(ThinPrincipled(*args, **kwargs))
            case "dielectric" | "Dielectric" | "DIELECTRIC":
                layer._spec.channels.append(Dielectric(*args, **kwargs))
            case "thin_dielectric" | "ThinDielectric" | "THIN_DIELECTRIC":
                layer._spec.channels.append(ThinDielectric(*args, **kwargs))
            case "rough_dielectric" | "RoughDielectric" | "ROUGH_DIELECTRIC":
                layer._spec.channels.append(RoughDielectric(*args, **kwargs))
            case "hair" | "Hair" | "HAIR":
                layer._spec.channels.append(Hair(*args, **kwargs))
            case _:
                raise ValueError(f"Unsupported material type: {type}!")
        return layer

    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.
        """
        layer = self.__get_working_layer(in_place)
        layer._spec.transform = transform
        return layer

    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.
        """
        layer = self.__get_working_layer(in_place)
        v = np.array(axis, dtype=np.float64)
        eye3 = np.eye(3)
        H = np.outer(v, v)
        S = np.cross(eye3, v)
        M = eye3 * np.cos(angle) + S * np.sin(angle) + H * (1 - np.cos(angle))
        if layer._spec.transform is None:
            layer._spec.transform = Affine(M)
        else:
            layer._spec.transform *= Affine(M)
        return layer

    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.
        """
        layer = self.__get_working_layer(in_place)
        M = np.eye(4)
        M[:3, 3] = np.array(offset, dtype=np.float64)

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

    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.
        """
        layer = self.__get_working_layer(in_place)
        M = np.eye(4)
        M[0, 0] = M[1, 1] = M[2, 2] = factor
        if layer._spec.transform is None:
            layer._spec.transform = Affine(M)
        else:
            layer._spec.transform *= Affine(M)
        return layer

    @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)

    def _repr_html_(self) -> str:
        """Return an interactive Three.js viewer for Jupyter display.

        Requires the ``pygltflib`` package (WebGL backend).  If it is not
        installed the method falls back to a plain-text representation.
        """
        try:
            from ...backends.webgl import WebGLBackend
        except ImportError:
            return (
                "<pre>Install pygltflib for inline preview: pip install pygltflib</pre>"
            )
        try:
            from ...compiler.compile import compile as _compile
            from ...setup.config import Config

            scene = _compile(self)
            html_str = WebGLBackend().html_string(scene, Config())
        except Exception as exc:
            return f"<pre>hakowan preview error: {exc}</pre>"

        # Embed the full HTML page in an srcdoc iframe.
        # Double-quotes inside srcdoc must be entity-encoded.
        escaped = html_str.replace("&", "&amp;").replace('"', "&quot;")
        return (
            f'<iframe srcdoc="{escaped}" width="100%" height="500"'
            f' style="border:none;"></iframe>'
        )

children 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 
134
135
136
137
138
139
140
141
142
143
144
145
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 
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
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 | AttributeLike

The new position channel.

 None
normal Normal | AttributeLike

The new normal channel.

 None
size float | Size | AttributeLike

The new size channel. An Attribute (e.g. from hakowan.norm()) maps a data field to size.

 None
shape Literal['sphere', 'disk', 'cube'] | Shape

The new shape channel. When a string is given, it sets Shape.base_shape directly.

 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 
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
def channel(
    self,
    *,
    position: Position | AttributeLike | None = None,
    normal: Normal | AttributeLike | None = None,
    size: float | Size | AttributeLike | None = None,
    shape: _BaseShapeStr | 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 | AttributeLike, optional): The new position channel.
        normal (Normal | AttributeLike, optional): The new normal channel.
        size (float | Size | AttributeLike, optional): The new size channel.
            An ``Attribute`` (e.g. from ``hakowan.norm()``) maps a data
            field to size.
        shape (Literal["sphere", "disk", "cube"] | Shape, optional): The new shape channel.
            When a string is given, it sets ``Shape.base_shape`` directly.
        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.
    """
    layer = self.__get_working_layer(in_place)

    def convert(value, cls):
        if isinstance(value, (str, Attribute)):
            return cls(data=to_attribute(value))
        return value

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

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 
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
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.
    """
    layer = self.__get_working_layer(in_place)
    match data:
        case str() | Path():
            mesh = lagrange.io.load_mesh(data, quiet=True, stitch_vertices=True)  # type: ignore
            layer._spec.data = DataFrame(mesh=mesh, roi_box=roi_box)
        case lagrange.SurfaceMesh():
            layer._spec.data = DataFrame(mesh=data, roi_box=roi_box)
        case DataFrame():
            layer._spec.data = data
            if roi_box is not None:
                layer._spec.data.roi_box = roi_box
        case _:
            raise TypeError(f"Unsupported data type: {type(data)}!")
    return layer

mark(mark, *, in_place=False)

Overwrite the mark component of this layer.

Parameters:

Name Type Description Default
mark Mark | str

The new mark component. When a string is given, accepted values are "point" / "Point" / "POINT", "curve" / "Curve" / "CURVE", and "surface" / "Surface" / "SURFACE".

 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 
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
def mark(self, mark: Mark | _MarkStr, *, in_place: bool = False) -> "Layer":
    """Overwrite the mark component of this layer.

    Args:
        mark (Mark | str): The new mark component. When a string is given, accepted
            values are ``"point"`` / ``"Point"`` / ``"POINT"``,
            ``"curve"`` / ``"Curve"`` / ``"CURVE"``, and
            ``"surface"`` / ``"Surface"`` / ``"SURFACE"``.
        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.
    """
    layer = self.__get_working_layer(in_place)
    match mark:
        case Mark():
            layer._spec.mark = mark
        case "point" | "Point" | "POINT":
            layer._spec.mark = Mark.Point
        case "curve" | "Curve" | "CURVE":
            layer._spec.mark = Mark.Curve
        case "surface" | "Surface" | "SURFACE":
            layer._spec.mark = Mark.Surface
        case _:
            raise ValueError(f"Unsupported mark type: {mark}!")
    return layer

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

Overwrite material for this layer.

Parameters:

Name Type Description Default
type str

The material type. Accepted values (case-insensitive canonical forms): "diffuse", "conductor", "rough_conductor", "plastic", "rough_plastic", "principled", "thin_principled", "dielectric", "thin_dielectric", "rough_dielectric", "hair". PascalCase (e.g. "RoughConductor") and UPPER_CASE (e.g. "ROUGH_CONDUCTOR") variants are also accepted.

 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 Any

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

 ()
**kwargs Any

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 
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
def material(
    self, type: _MaterialTypeStr, *args: Any, in_place: bool = False, **kwargs: Any
) -> "Layer":
    """Overwrite material for this layer.

    Args:
        type (str): The material type. Accepted values (case-insensitive canonical forms):
            ``"diffuse"``, ``"conductor"``, ``"rough_conductor"``, ``"plastic"``,
            ``"rough_plastic"``, ``"principled"``, ``"thin_principled"``,
            ``"dielectric"``, ``"thin_dielectric"``, ``"rough_dielectric"``,
            ``"hair"``. PascalCase (e.g. ``"RoughConductor"``) and UPPER_CASE
            (e.g. ``"ROUGH_CONDUCTOR"``) variants are also accepted.
        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.
    """
    layer = self.__get_working_layer(in_place)
    match type:
        case "diffuse" | "Diffuse" | "DIFFUSE":
            layer._spec.channels.append(Diffuse(*args, **kwargs))
        case "conductor" | "Conductor" | "CONDUCTOR":
            layer._spec.channels.append(Conductor(*args, **kwargs))
        case "rough_conductor" | "RoughConductor" | "ROUGH_CONDUCTOR":
            layer._spec.channels.append(RoughConductor(*args, **kwargs))
        case "plastic" | "Plastic" | "PLASTIC":
            layer._spec.channels.append(Plastic(*args, **kwargs))
        case "rough_plastic" | "RoughPlastic" | "ROUGH_PLASTIC":
            layer._spec.channels.append(RoughPlastic(*args, **kwargs))
        case "principled" | "Principled" | "PRINCIPLED":
            layer._spec.channels.append(Principled(*args, **kwargs))
        case "thin_principled" | "ThinPrincipled" | "THIN_PRINCIPLED":
            layer._spec.channels.append(ThinPrincipled(*args, **kwargs))
        case "dielectric" | "Dielectric" | "DIELECTRIC":
            layer._spec.channels.append(Dielectric(*args, **kwargs))
        case "thin_dielectric" | "ThinDielectric" | "THIN_DIELECTRIC":
            layer._spec.channels.append(ThinDielectric(*args, **kwargs))
        case "rough_dielectric" | "RoughDielectric" | "ROUGH_DIELECTRIC":
            layer._spec.channels.append(RoughDielectric(*args, **kwargs))
        case "hair" | "Hair" | "HAIR":
            layer._spec.channels.append(Hair(*args, **kwargs))
        case _:
            raise ValueError(f"Unsupported material type: {type}!")
    return layer

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 
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
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.
    """
    layer = self.__get_working_layer(in_place)
    v = np.array(axis, dtype=np.float64)
    eye3 = np.eye(3)
    H = np.outer(v, v)
    S = np.cross(eye3, v)
    M = eye3 * np.cos(angle) + S * np.sin(angle) + H * (1 - np.cos(angle))
    if layer._spec.transform is None:
        layer._spec.transform = Affine(M)
    else:
        layer._spec.transform *= Affine(M)
    return layer

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 
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
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.
    """
    layer = self.__get_working_layer(in_place)
    M = np.eye(4)
    M[0, 0] = M[1, 1] = M[2, 2] = factor
    if layer._spec.transform is None:
        layer._spec.transform = Affine(M)
    else:
        layer._spec.transform *= Affine(M)
    return layer

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 
355
356
357
358
359
360
361
362
363
364
365
366
367
368
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.
    """
    layer = self.__get_working_layer(in_place)
    layer._spec.transform = transform
    return layer

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 
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
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.
    """
    layer = self.__get_working_layer(in_place)
    M = np.eye(4)
    M[:3, 3] = np.array(offset, dtype=np.float64)

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