GeometryObject

class compas.scene.GeometryObject[source]

Bases: SceneObject

Base class for scene objects for geometry objects.

Parameters:
geometrycompas.geometry.Geometry

The geometry of the geometry.

Attributes:
geometrycompas.geometry.Geometry

The geometry object associated with the scene object.

pointcolorcompas.colors.Color

The color of the points.

linecolorcompas.colors.Color

The color of the lines or curves.

surfacecolorcompas.colors.Color

The color of the surfaces.

pointsizefloat

The size of the points.

linewidthfloat

The width of the lines or curves.

show_pointsbool

Flag for showing or hiding the points. Default is False.

show_linesbool

Flag for showing or hiding the lines or curves. Default is True.

show_surfacesbool

Flag for showing or hiding the surfaces. Default is True.

Methods

draw

Draw the geometry.

Inherited Methods

ToString

Converts the instance to a string.

add

Add a child item to the scene object.

clear

The main clearing method.

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.