bacommon.workspace.assetsv1

 1# Released under the MIT License. See LICENSE for details.
 2#
 3"""Public types for assets-v1 workspaces.
 4
 5These types may only be used server-side, but they are exposed here
 6for reference when setting workspace config data by hand or for use
 7in client-side workspace modification tools. There may be advanced
 8settings that are not accessible through the UI/etc.
 9"""
10
11from __future__ import annotations
12
13from enum import Enum
14from dataclasses import dataclass
15from typing import TYPE_CHECKING, Annotated, override, assert_never
16
17from efro.dataclassio import ioprepped, IOAttrs, IOMultiType
18
19
20if TYPE_CHECKING:
21    pass
22
23
24@ioprepped
25@dataclass
26class AssetsV1GlobalVals:
27    """Global values for an assets_v1 workspace."""
28
29    base_assets: Annotated[
30        str | None, IOAttrs('base_assets', store_default=False)
31    ] = None
32
33    base_assets_filter: Annotated[
34        str, IOAttrs('base_assets_filter', store_default=False)
35    ] = ''
36
37
38class AssetsV1PathValsTypeID(Enum):
39    """Types of vals we can store for paths."""
40
41    TEX_V1 = 'tex_v1'
42
43
44class AssetsV1PathVals(IOMultiType[AssetsV1PathValsTypeID]):
45    """Top level class for path vals classes."""
46
47    @override
48    @classmethod
49    def get_type_id_storage_name(cls) -> str:
50        return 'type'
51
52    @override
53    @classmethod
54    def get_type_id(cls) -> AssetsV1PathValsTypeID:
55        # Require child classes to supply this themselves. If we
56        # did a full type registry/lookup here it would require us
57        # to import everything and would prevent lazy loading.
58        raise NotImplementedError()
59
60    @override
61    @classmethod
62    def get_type(
63        cls, type_id: AssetsV1PathValsTypeID
64    ) -> type[AssetsV1PathVals]:
65        # pylint: disable=cyclic-import
66        out: type[AssetsV1PathVals]
67        t = AssetsV1PathValsTypeID
68
69        if type_id is t.TEX_V1:
70            out = AssetsV1PathValsTexV1
71        else:
72            # Important to make sure we provide all types.
73            assert_never(type_id)
74        return out
75
76
77@ioprepped
78@dataclass
79class AssetsV1PathValsTexV1(AssetsV1PathVals):
80    """Path-specific values for an assets_v1 workspace path."""
81
82    class TextureQuality(Enum):
83        """Quality settings for our textures."""
84
85        LOW = 'low'
86        MEDIUM = 'medium'
87        HIGH = 'high'
88
89    # Just dummy testing values for now.
90    texture_quality: Annotated[
91        TextureQuality, IOAttrs('texture_quality', store_default=False)
92    ] = TextureQuality.MEDIUM
93
94    @override
95    @classmethod
96    def get_type_id(cls) -> AssetsV1PathValsTypeID:
97        return AssetsV1PathValsTypeID.TEX_V1