tree-clipper 0.1.0__py3-none-any.whl

tree_clipper/common.py

@@ -0,0 +1,150 @@
+import bpy
+
+from types import NoneType
+from typing import Any, Callable, TYPE_CHECKING
+from pathlib import Path
+import tempfile
+
+
+if TYPE_CHECKING:
+    from .export_nodes import Exporter
+    from .import_nodes import Importer
+
+# these fields are in the top level JSON object
+BLENDER_VERSION = "blender_version"
+TREE_CLIPPER_VERSION = "tree_clipper_version"
+CURRENT_TREE_CLIPPER_VERSION = "0.1.0"  # tested to match pyproject.toml
+MATERIAL_NAME = "name"
+TREES = "node_trees"
+EXTERNAL = "external"
+SCENES = "scenes"
+
+# within each external item
+EXTERNAL_DESCRIPTION = "description"
+EXTERNAL_FIXED_TYPE_NAME = "fixed_type_name"
+EXTERNAL_SCENE_ID = "scene_id"
+
+# for every object
+ID = "id"  # to reference it from elsewhere
+DATA = "data"  # the actual data
+FROM_ROOT = "from_root"  # optional, for debugging
+
+# every compressed serialization starts with this
+MAGIC_STRING = "TreeClipper::"
+
+# to help prevent typos
+BL_RNA = "bl_rna"
+BL_IDNAME = "bl_idname"
+RNA_TYPE = "rna_type"  # TODO: another 'forbidden' category?
+DEFAULT_VALUE = "default_value"
+DISPLAY_SHAPE = "display_shape"
+ITEMS = "items"
+NAME = "name"
+PROP_TYPE_BOOLEAN = "BOOLEAN"
+PROP_TYPE_INT = "INT"
+PROP_TYPE_FLOAT = "FLOAT"
+PROP_TYPE_STRING = "STRING"
+PROP_TYPE_ENUM = "ENUM"
+PROP_TYPE_POINTER = "POINTER"
+PROP_TYPE_COLLECTION = "COLLECTION"
+SIMPLE_PROPERTY_TYPES_AS_STRS = set(
+    [
+        PROP_TYPE_BOOLEAN,
+        PROP_TYPE_INT,
+        PROP_TYPE_FLOAT,
+        PROP_TYPE_STRING,
+        PROP_TYPE_ENUM,
+    ]
+)
+NODE_TREE = "node_tree"
+DIMENSIONS = "dimensions"
+
+
+# bl_* properties can be dangerous to set
+# https://github.com/Algebraic-UG/tree_clipper/issues/39
+# they should probably be read-only in most cases?
+FORBIDDEN_PROPERTIES = [
+    "bl_idname",
+    "bl_label",
+    "bl_subtype_label",
+    "bl_static_type",
+    "bl_description",
+    "bl_icon",
+    "bl_width_default",
+    "bl_width_min",
+    "bl_width_max",
+    "bl_height_default",
+    "bl_height_min",
+    "bl_height_max",
+    "bl_socket_idname",
+]
+
+
+def no_clobber(data: dict, key: str | int, value) -> None:
+    if key in data:
+        raise RuntimeError(f"Clobbering '{key}'")
+    data[key] = value
+
+
+class FromRoot:
+    def __init__(self, path: list) -> None:
+        self.path = path
+
+    def add(self, piece: str) -> "FromRoot":
+        return FromRoot(self.path + [piece])
+
+    def add_prop(self, prop: bpy.types.Property) -> "FromRoot":
+        return self.add(f"{prop.type} ({prop.identifier})")
+
+    def to_str(self) -> str:
+        return str(" -> ".join(self.path))
+
+
+def most_specific_type_handled(
+    specific_handlers: dict[type, Callable],
+    obj: bpy.types.bpy_struct,
+) -> type:
+    # collections are too weird, this is False:
+    # type(bpy.data.node_groups['Geometry Nodes'].nodes) == bpy.types.Nodes
+    if isinstance(obj, bpy.types.bpy_prop_collection):
+        return next(
+            (
+                ty
+                for ty in specific_handlers.keys()
+                if ty != NoneType and ty.bl_rna.identifier == obj.bl_rna.identifier  # type: ignore
+            ),
+            NoneType,
+        )
+
+    ty = type(obj)
+    while True:
+        if ty in specific_handlers.keys():
+            return ty
+        if len(ty.__bases__) == 0:
+            return NoneType
+        if len(ty.__bases__) > 1:
+            raise RuntimeError(f"multiple inheritence {ty}, unclear what to choose")
+        ty = ty.__bases__[0]
+
+
+GETTER = Callable[[], bpy.types.bpy_struct]
+SERIALIZER = Callable[["Exporter", bpy.types.bpy_struct, FromRoot], dict[str, Any]]
+DESERIALIZER = Callable[["Importer", GETTER, dict, FromRoot], None]
+SIMPLE_DATA_TYPE = list[str] | list[float] | list[int] | str | float | int
+SIMPLE_PROP_TYPE = (
+    bpy.types.BoolProperty
+    | bpy.types.IntProperty
+    | bpy.types.FloatProperty
+    | bpy.types.StringProperty
+    | bpy.types.EnumProperty
+)
+SIMPLE_PROP_TYPE_TUPLE = (
+    bpy.types.BoolProperty,
+    bpy.types.IntProperty,
+    bpy.types.FloatProperty,
+    bpy.types.StringProperty,
+    bpy.types.EnumProperty,
+)
+EXTERNAL_SERIALIZATION = dict[str, int | str | None]
+
+DEFAULT_FILE = str(Path(tempfile.gettempdir()) / "default.json")

tree_clipper/dynamic_pointer.py

@@ -0,0 +1,122 @@
+import bpy
+
+from typing import Type
+
+from .common import no_clobber
+
+
+# TODO: we might need to return a list that fits the Blender version
+KNOWN_POINTABLES = {
+    bpy.types.SunLight,
+    bpy.types.Texture,
+    bpy.types.Object,
+    bpy.types.WorkSpace,
+    bpy.types.Mesh,
+    bpy.types.Text,
+    bpy.types.Lattice,
+    bpy.types.Material,
+    bpy.types.Camera,
+    bpy.types.World,
+    bpy.types.Volume,
+    bpy.types.FreestyleLineStyle,
+    bpy.types.MovieClip,
+    bpy.types.PointLight,
+    bpy.types.LightProbeVolume,
+    bpy.types.TextureNodeTree,
+    bpy.types.AreaLight,
+    bpy.types.VoronoiTexture,
+    bpy.types.CompositorNodeTree,
+    bpy.types.NoiseTexture,
+    bpy.types.Image,
+    bpy.types.SpotLight,
+    bpy.types.ImageTexture,
+    bpy.types.VectorFont,
+    bpy.types.ParticleSettings,
+    bpy.types.Screen,
+    bpy.types.Annotation,
+    bpy.types.MagicTexture,
+    bpy.types.MetaBall,
+    bpy.types.Key,
+    bpy.types.MarbleTexture,
+    bpy.types.MusgraveTexture,
+    bpy.types.StucciTexture,
+    bpy.types.WoodTexture,
+    bpy.types.DistortedNoiseTexture,
+    bpy.types.LightProbeSphere,
+    bpy.types.Scene,
+    bpy.types.CloudsTexture,
+    bpy.types.Brush,
+    bpy.types.WindowManager,
+    bpy.types.Library,
+    bpy.types.Collection,
+    bpy.types.Sound,
+    bpy.types.NodeTree,
+    bpy.types.GreasePencil,
+    bpy.types.Curves,
+    bpy.types.Armature,
+    bpy.types.Light,
+    bpy.types.Curve,
+    bpy.types.Speaker,
+    bpy.types.Action,
+    bpy.types.GeometryNodeTree,
+    bpy.types.ShaderNodeTree,
+    bpy.types.PointCloud,
+    bpy.types.LightProbe,
+    bpy.types.CacheFile,
+    bpy.types.TextCurve,
+    bpy.types.BlendTexture,
+    bpy.types.Mask,
+    bpy.types.PaintCurve,
+    bpy.types.LightProbePlane,
+    bpy.types.Palette,
+    bpy.types.SurfaceCurve,
+}
+
+
+def add_all_known_pointer_properties(
+    *,
+    cls: Type[bpy.types.PropertyGroup],
+    prefix: str,
+):
+    def get_pointer_property_name(ty: type):
+        return f"{prefix}{ty.__name__}"
+
+    # does this even ever happen
+    if not hasattr(cls, "__annotations__"):
+        cls.__annotations__ = {}
+
+    # we store which kind of thing we're pointing to, used in get_pointer
+    no_clobber(
+        cls.__annotations__,
+        "active_ptr_type_name",
+        bpy.props.StringProperty(),
+    )
+
+    # now actually register all the properties
+    for pointable in KNOWN_POINTABLES:
+        no_clobber(
+            cls.__annotations__,
+            get_pointer_property_name(pointable),
+            bpy.props.PointerProperty(type=pointable),
+        )
+
+    # this switches the type we're pointing to and clears all
+    def set_active_pointer_type(self, type_name: str):
+        self.active_ptr_type_name = type_name
+        for ty in KNOWN_POINTABLES:
+            setattr(self, get_pointer_property_name(ty), None)
+
+    # this is needed to display the property
+    def get_active_pointer_identifier(self) -> str:
+        return f"{prefix}{self.active_ptr_type_name}"
+
+    # directly return the pointer
+    def get_active_pointer(self) -> bpy.types.PointerProperty:
+        return getattr(self, self.get_active_pointer_identifier())
+
+    assert not hasattr(cls, set_active_pointer_type.__name__)
+    setattr(cls, set_active_pointer_type.__name__, set_active_pointer_type)
+    assert not hasattr(cls, get_active_pointer_identifier.__name__)
+    setattr(cls, get_active_pointer_identifier.__name__, get_active_pointer_identifier)
+    assert not hasattr(cls, get_active_pointer.__name__)
+    setattr(cls, get_active_pointer.__name__, get_active_pointer)