VolMeshObject

class compas_blender.scene.VolMeshObject[source]

Bases: BlenderSceneObject, VolMeshObject

A scene object for drawing volumetric mesh data structures in Blender.

Parameters:
vertex_uint, optional

Number of segments in the U direction of the vertex spheres. Default is 16.

vertex_vint, optional

Number of segments in the V direction of the vertex spheres. Default is 16.

**kwargsdict, optional

Additional keyword arguments.

Attributes:
vertex_uint

Number of segments in the U direction of the vertex spheres.

vertex_vint

Number of segments in the V direction of the vertex spheres.

vertexobjectslist[bpy.types.Object]

The Blender objects representing the vertices.

edgeobjectslist[bpy.types.Object]

The Blender objects representing the edges.

faceobjectslist[bpy.types.Object]

The Blender objects representing the faces.

cellobjectslist[bpy.types.Object]

The Blender objects representing the cells.

Methods

clear

The main clearing method.

clear_cells

Clear the objects contained in the cell collection (self.cellcollection).

clear_edges

Clear the objects contained in the edge collection (self.edgecollection).

clear_faces

Clear the objects contained in the face collection (self.facecollection).

clear_vertices

Clear the objects contained in the vertex collection (self.vertexcollection).

draw

Draw a selection of cells.

draw_cells

Draw a selection of cells.

draw_edges

Draw a selection of edges.

draw_faces

Draw a selection of faces.

draw_vertices

Draw a selection of vertices.

Inherited Methods

ToString

Converts the instance to a string.

add

Add a child item to the scene object.

add_object_to_collection

Add an object to a collection.

clear_collection

Clear the objects in a collection.

copy

Make an independent copy of the data object.

create_collection

Create a collection with the given name.

create_object

Add an object to the Blender scene.

delete_collection

Delete a collection.

from_json

Construct an object of this type from a JSON file.

from_jsonstring

Construct an object of this type from a JSON string.

remove

Remove a child node from this node.

set_object_color

Set the color of a Blender object.

set_object_tranformation

Set the transformation of a Blender object.

sha256

Compute a hash of the data for comparison during version control using the sha256 algorithm.

to_json

Convert an object to its native data representation and save it to a JSON file.

to_jsonstring

Convert an object to its native data representation and save it to a JSON string.

traverse

Traverse the tree from this node.

update_object

Update an object in the Blender scene.

validate_data

Validate the data against the object's data schema.