Geometry ¶

Base class for concrete geometries.

Geometry defines common behaviors shared by actual geometries such as Mesh or Curve : attribute propagation across domains, Blender I/O helpers, simple transforms, and material bookkeeping. Concrete subclasses override domain_names and implement domain-specific logic.

Attributes:

Name	Type	Description
`domain_names`	`list[str]`	Names of available domains in the concrete geometry. Overridden by subclasses (e.g., `["points", "corners", "faces", "edges"]` for Mesh).

Notes

Subclasses are expected to provide the domains listed in domain_names as attributes (e.g., self.points, self.faces, ...).
Blender interoperability helpers (load_object, load_models, and context managers) rely on the presence of to_object / from_object implemented by subclasses.

bounding_box `property` ¶

bounding_box

Axis-aligned bounding box of the point positions.

Returns:

Type	Description
`tuple of numpy.ndarray`	`(min_xyz, max_xyz)`. If empty, returns two zero vectors.

bounding_box_dims `property` ¶

bounding_box_dims

Extents of the axis-aligned bounding box.

Returns:

Type	Description
`numpy.ndarray of shape (3,)`	`max_xyz - min_xyz`.

max_size `property` ¶

max_size

Maximum dimension of the bounding box.

Returns:

Type	Description
`float`	`max(bounding_box_dims)`.

add_materials ¶

add_materials(materials)

Append material name(s) to the geometry.

Parameters:

Name	Type	Description	Default
`materials`	`str or sequence of str`	One name or a sequence of names to append.	required

Returns:

Type	Description
`None`

Notes

This method does not deduplicate names; duplicates may be appended.

apply_scale ¶

apply_scale(scale, pivot=None)

Scale points (convenience wrapper).

See: transformation

Parameters:

Name	Type	Description	Default
`scale`	`ndarray`	Per-point or broadcastable scales.	required
`pivot`	`ndarray`	Optional pivot(s) for scaling.	`None`

Returns:

Type	Description
`Geometry`	`self`.

check ¶

check(title='Geometry Check', halt=True)

Validate the geometry consistency.

Placeholder in the base class: returns True. Subclasses may override to perform domain-level checks.

Parameters:

Name	Type	Description	Default
`title`	`str`	Label for messages or errors.	`"Geometry Check"`
`halt`	`bool`	Whether to raise on failure (in subclasses that implement checks).	`True`

Returns:

Type	Description
`bool`	Always `True` in the base class.

compute_attribute_on_domain ¶

compute_attribute_on_domain(domain_from, attr, domain_to)

Transfer an attribute from one domain to another.

Performs a domain mapping (e.g., points → faces) using the appropriate domain operator, and returns the computed array on the target domain.

Parameters:

Name	Type	Description	Default
`domain_from`	`str`	Source domain name (e.g., `"points"`, `"faces"`, `"edges"`, `"corners"`, `"splines"`).	required
`attr`	`str or ndarray`	Source attribute to transfer. If a string, it is looked up on the source domain; if an array, it must match the source domain length.	required
`domain_to`	`str`	Target domain name.	required

Returns:

Type	Description
`ndarray`	Attribute values on the target domain. If `domain_from == domain_to`, returns `attr` unchanged.

Raises:

Type	Description
`AttributeError`	If either `domain_from` or `domain_to` is not a valid domain of this geometry.
`Exception`	If the requested mapping is not implemented.

Notes

Implemented mappings include: - points → faces: [Point.compute_attribute_on_faces][npblender.Point.compute_attribute_on_faces] - points → edges: [Point.compute_attribute_on_edges][npblender.Point.compute_attribute_on_edges] - points → corners: [Point.compute_attribute_on_corners][npblender.Point.compute_attribute_on_corners] - points → splines: [Point.compute_attribute_on_splines][npblender.Point.compute_attribute_on_splines] - faces → points: Face.compute_attribute_on_points - edges → points: Edge.compute_attribute_on_points - corners → points: Corner.compute_attribute_on_points

from_dict `classmethod` ¶

from_dict(d)

Construct a geometry from a serialized payload.

Dispatches to the appropriate subclass based on d["geometry"] (supported: "Mesh", "Curve", "Cloud", "Instances", "Meshes").

Parameters:

Name	Type	Description	Default
`d`	`dict`	Serialized geometry dictionary as produced by `to_dict()` of the corresponding subclass.	required

Returns:

Type	Description
`Geometry`	An instance of the appropriate subclass.

Raises:

Type	Description
`ValueError`	If `d["geometry"]` is unknown.

get_cubic_envelop ¶

get_cubic_envelop()

Return a cube mesh that encloses the geometry’s bounding box.

Uses the bounding box dimensions to build a cube via Mesh.cube, forwarding this geometry’s materials if present.

Returns:

Type	Description
`Mesh`	A cube mesh sized to the bounding box.

get_material_index ¶

get_material_index(mat_name)

Return the index of a material name, creating it if needed.

Parameters:

Name	Type	Description	Default
`mat_name`	`str`	Material name to look up or append.	required

Returns:

Type	Description
`int`	Index of `mat_name` in `self.materials`.

Notes

If mat_name is not present, it is appended to self.materials and the new index is returned.

get_points_selection ¶

get_points_selection()

Selection of points relevant to operations.

Returns slice(None) in the base class (all points). Subclasses (e.g., curves) may override to select only referenced points.

Returns:

Type	Description
`slice`	`slice(None)` by default.

join_attributes ¶

join_attributes(other, **kwargs)

Merge attribute schemas from another geometry.

For each domain listed in self.domain_names and also present in other, copies (joins) the attribute definitions (names, dtypes, metadata) from other into this geometry's domains. Use keyword flags to include/exclude domains by name (e.g., faces=False).

Parameters:

Name	Type	Description	Default
`other`	`Geometry or None`	Source geometry. If `None`, does nothing and returns `self`.	required
`**kwargs`		Per-domain boolean switches to filter which domains to join.	`{}`

Returns:

Type	Description
`Geometry`	`self`, for chaining.

Examples:

mesh.join_attributes(other_mesh, faces=False)
curve.join_attributes(mesh)  # only common domains are merged

load_models `staticmethod` ¶

load_models(*specs)

Load multiple geometries from collections, objects, or instances.

Accepts mixed inputs such as Blender collections, Blender objects, lists/ tuples of either, or already-instantiated Mesh/Curve. Returns a flat list of geometries discovered or constructed.

This method is mainly intended to be used by Instances to load its models.

Parameters:

Name	Type	Description	Default
`*specs`		Collections, objects, lists/tuples, or `Mesh`/`Curve` instances.	`()`

Returns:

Type	Description
`list`	List of geometries (`Mesh`/`Curve`).

Raises:

Type	Description
`ValueError`	If a spec cannot be resolved to a geometry.

load_object `staticmethod` ¶

load_object(name)

Load a Blender object and return a Mesh or a Curve.

Resolves name to a Blender object, inspects its data type, and returns a matching geometry by calling the subclass' from_object.

Parameters:

Name	Type	Description	Default
`name`	`str or Object`	Object name or object instance.	required

Returns:

Type	Description
`Mesh or Curve or None`	A `Mesh` or a `Curve`, or `None` if the object is not found.

Raises:

Type	Description
`Exception`	If the object exists but is neither a `bpy.types.Mesh` nor `bpy.types.Curve`.

Examples:

geo = Geometry.load_object("MyObject")
if geo is not None:
    print(type(geo).__name__)

object ¶

object(index=0, readonly=True, **kwargs)

Temporary access to a Blender Object built from this geometry.

Creates a transient object (named "BPBL Temp {index}" unless index is a string), selects and activates it, yields it for editing, then cleans up. If readonly=True, the edited object is captured back into self.

This method can be used to set and apply a modifier (see exemple below).

Parameters:

Name	Type	Description	Default
`index`	`int or str`	Index or name used to label the temporary object.	`0`
`readonly`	`bool`	If `False`, re-capture the possibly edited object back into this geometry.	`True`
`kwargs`	`dict`	Keyword arguments passed to `self.to_object`.	`{}`

Yields:

Type	Description
`Object`	The temporary Blender object built from `self`.

Examples:

plane = Mesh.Grid()
with plane.object(readonly=False) as obj:
    mod = obj.modifiers.new("Solidify", 'SOLIDIFY')
    mod.thickness = .1
    bpy.ops.object.modifier_apply(modifier=mod.name)

# plane is now solidifed

rotate ¶

rotate(rotation, pivot=None)

Rotate points (convenience wrapper).

See: transformation

Parameters:

Name	Type	Description	Default
`rotation`	`ndarray or Rotation - like`	Rotation(s) to apply as `R @ v`.	required
`pivot`	`ndarray`	Optional pivot(s) for rotation.	`None`

Returns:

Type	Description
`Geometry`	`self`.

transform ¶

transform(transformation)

Apply a rotation matrix or batch of matrices.

See: transformation

Parameters:

Name	Type	Description	Default
`transformation`	`ndarray`	Rotation matrix or batch of rotation matrices.	required

Returns:

Type	Description
`Geometry`	`self`.

transformation ¶

transformation(rotation=None, scale=None, translation=None, pivot=None)

Apply rotation/scale/translation (with optional per-packet broadcasting).

Operates in-place on points.position and, when present, Bezier handles (points.handle_left, points.handle_right). Shapes can represent packets of points: broadcasting rules are handled by [Point._get_shape_for_operation][npblender.Point._get_shape_for_operation].

Parameters:

Name	Type	Description	Default
`rotation`	`ndarray or Rotation - like`	Rotation matrix/matrices applied as `R @ v`. Shape may broadcast over points (see notes).	`None`
`scale`	`ndarray`	Per-axis scaling. Shape may broadcast over points.	`None`
`translation`	`ndarray`	Per-point translation. Shape may broadcast over points.	`None`
`pivot`	`ndarray`	Pivot(s) subtracted before, and added after, the rotation/scale; same broadcasting rules as `scale`/`translation`.	`None`

Returns:

Type	Description
`Geometry`	`self`, for chaining.

Notes

If handles exist, they are transformed consistently with positions.

Examples:

# 12 cubes laid out randomly with per-instance transforms
cubes = Mesh.cube(size=1).multiply(12)
T = np.random.uniform(-1, 1, (12, 3))
S = np.random.uniform(0.5, 2.0, (12, 3))
R = Rotation.from_euler(np.random.uniform(0, 2*np.pi, (12, 3)))
cubes.transformation(rotation=R, scale=S, translation=T)

translate ¶

translate(translation)

Translate points (convenience wrapper).

See: transformation

Parameters:

Name	Type	Description	Default
`translation`	`ndarray`	Per-point or broadcastable translation vectors.	required

Returns:

Type	Description
`Geometry`	`self`.

Geometry ¶

bounding_box property ¶

bounding_box_dims property ¶

max_size property ¶

add_materials ¶

apply_scale ¶

check ¶

compute_attribute_on_domain ¶

from_dict classmethod ¶

get_cubic_envelop ¶

get_material_index ¶

get_points_selection ¶

join_attributes ¶

load_models staticmethod ¶

load_object staticmethod ¶

object ¶

rotate ¶

transform ¶

transformation ¶

translate ¶

bounding_box `property` ¶

bounding_box_dims `property` ¶

max_size `property` ¶

from_dict `classmethod` ¶

load_models `staticmethod` ¶

load_object `staticmethod` ¶