ElementObject

class compas_model.scene.ElementObject(item=None, **kwargs)

Bases: SceneObject

Base class for all element scene objects.

Parameters:

elementcompas_model.elements.Element

A COMPAS element.

Attributes:

elementcompas_model.elements.Element

The element.

colorcompas.colors.Color

The base RGB color of the element.

vertexcolorcompas.colors.ColorDict

Vertex colors.

edgecolorcompas.colors.ColorDict

Edge colors.

facecolorcompas.colors.ColorDict

Face colors.

vertexsizefloat

The size of the vertices. Default is 1.0.

edgewidthfloat

The width of the edges. Default is 1.0.

show_verticesUnion[bool, sequence[float]]

Flag for showing or hiding the vertices, or a list of keys for the vertices to show. Default is False.

show_edgesUnion[bool, sequence[tuple[int, int]]]

Flag for showing or hiding the edges, or a list of keys for the edges to show. Default is True.

show_facesUnion[bool, sequence[int]]

Flag for showing or hiding the faces, or a list of keys for the faces to show. Default is True.

See also

compas.scene.GraphObject

compas.scene.VolElementObject

Methods

clear	Clear all components of the element.
draw	draw the element.

Inherited Methods

ToString	Converts the instance to a string.
add	Add a child item to the scene object.
copy	Make an independent copy of the data object.
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.
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.
validate_data	Validate the data against the object's data schema.