Feature

class compas_model.elements.Feature(name=None)

Bases: Data

Base class for all element features.

Parameters:
namestr, optional

The name of the feature.

Methods

apply

Apply the feature to the given shape, which represents the base geometry of the host element of the feature.

Inherited Methods

ToString

Converts the instance to a string.

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.

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.

validate_data

Validate the data against the object's data schema.