Skip to content

Texture

This page contains types/classes defined in hakowan.texture module.

TextureLike: TypeAlias = ColorLike | Texture module-attribute

TextureLike is a type alias for a texture or color.

Texture dataclass

Texture provides the mapping from raw data to visual properties such as color.

Source code in hakowan/grammar/texture/texture.py 
 9
10
11
12
13
@dataclass(kw_only=True, slots=True)
class Texture:
    """Texture provides the mapping from raw data to visual properties such as color."""

    _uv: Attribute | None = None

Uniform dataclass

Bases: Texture

The uniform texture provides a constant color field.

Attributes:

Name Type Description
color ColorLike

The color of the uniform texture.
Source code in hakowan/grammar/texture/texture.py 
20
21
22
23
24
25
26
27
28
@dataclass(slots=True)
class Uniform(Texture):
    """The uniform texture provides a constant color field.

    Attributes:
        color (ColorLike): The color of the uniform texture.
    """

    color: ColorLike

Image dataclass

Bases: Texture

The image texture uses a texture image to provide a color field.

Attributes:

Name Type Description
filename PathLike

The path to the texture image.
uv AttributeLike

The attribute to use as the texture coordinates.
raw bool

Whether to use the raw image data, i.e. use linear color transfer function. This should be set to True for normal maps.
Source code in hakowan/grammar/texture/texture.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
@dataclass(slots=True)
class Image(Texture):
    """The image texture uses a texture image to provide a color field.

    Attributes:
        filename (PathLike): The path to the texture image.
        uv (AttributeLike): The attribute to use as the texture coordinates.
        raw (bool): Whether to use the raw image data, i.e. use linear color transfer function.
            This should be set to True for normal maps.
    """

    filename: PathLike
    uv: AttributeLike | None = None
    raw: bool = False

Checkerboard dataclass

Bases: Texture

The checkerboard texture provides a checkerboard color/value field.

Attributes:

Name Type Description
uv AttributeLike

The attribute to use as the texture coordinates.
texture1 TextureLike

The texture to use for the first color/value.
texture2 TextureLike

The texture to use for the second color/value.
size int

The size of the checkerboard (e.g. 8 means 8x8 checkerboard).
Source code in hakowan/grammar/texture/texture.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
@dataclass(slots=True)
class Checkerboard(Texture):
    """The checkerboard texture provides a checkerboard color/value field.

    Attributes:
        uv (AttributeLike): The attribute to use as the texture coordinates.
        texture1 (TextureLike): The texture to use for the first color/value.
        texture2 (TextureLike): The texture to use for the second color/value.
        size (int): The size of the checkerboard (e.g. 8 means 8x8 checkerboard).
    """

    uv: AttributeLike | None = None
    texture1: TextureLike = 0.8
    texture2: TextureLike = 0.2
    size: int = 8

Isocontour dataclass

Bases: Texture

The isocontour texture provides a color/value field based on the isocontours of an attribute.

Attributes:

Name Type Description
data AttributeLike

The attribute used to generate the isocontours.
ratio float

The ratio of the isocontour thickness to non-isocontour thickness.
texture1 TextureLike

The texture to use for the isocontour regions.
texture2 TextureLike

The texture to use for the non-isocontour regions.
num_contours int

The number of isocontours to generate within a unit distance.
Source code in hakowan/grammar/texture/texture.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
@dataclass(slots=True)
class Isocontour(Texture):
    """The isocontour texture provides a color/value field based on the isocontours of an attribute.

    Attributes:
        data (AttributeLike): The attribute used to generate the isocontours.
        ratio (float): The ratio of the isocontour thickness to non-isocontour thickness.
        texture1 (TextureLike): The texture to use for the isocontour regions.
        texture2 (TextureLike): The texture to use for the non-isocontour regions.
        num_contours (int): The number of isocontours to generate within a unit distance.
    """

    data: AttributeLike
    ratio: float = 0.1
    texture1: TextureLike = 0.4
    texture2: TextureLike = 0.2
    num_contours: int = 8

ScalarField dataclass

Bases: Texture

The scalar field texture converts an attribute to a either a value field or color field.

Attributes:

Name Type Description
data AttributeLike

The attribute to convert to a color field.
colormap str | list[ColorLike]

The name of the colormap to use or a list colors.
domain tuple[float, float]

The domain of the attribute to map to the colormap.
range tuple[float, float]

The range of the colormap to map the attribute to.
categories bool

Whether the attribute represents categorical data (i.e. discrete values).
Source code in hakowan/grammar/texture/texture.py 
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
@dataclass(slots=True)
class ScalarField(Texture):
    """The scalar field texture converts an attribute to a either a value field or color field.

    Attributes:
        data (AttributeLike): The attribute to convert to a color field.
        colormap (str | list[ColorLike]): The name of the colormap to use or a list colors.
        domain (tuple[float, float]): The domain of the attribute to map to the colormap.
        range (tuple[float, float]): The range of the colormap to map the attribute to.
        categories (bool): Whether the attribute represents categorical data (i.e. discrete values).
    """

    data: AttributeLike
    colormap: str | list[ColorLike] = "viridis"
    domain: tuple[float, float] | None = None
    range: tuple[float, float] | None = None
    categories: bool = False