FastenerTimberInterface

class compas_timber.elements.FastenerTimberInterface[source]

Bases: Data

A class to represent the interface between a fastener and a timber element.

# TODO: we need to put some thought as to what’s the minimal representation of an interface. # TODO: the responsibilities of the Fastener-based-joint vs. Fastener vs. FastenerTimberInterface should be perhaps more clearly defined # TODO: prehaps it would make sense to move stuff over from here to the BallNodeJoint # TODO: while it attempts to be generic, it is tightly coupled with the BallNodeJoint. # TODO: what is the differece between the outline and the shapes? they seem to all just result in geometry.

Parameters:
outline_pointsList of Point

The points of the polyline outline of the fastener geometry.

thicknessfloat

The thickness of the fastener plate.

holeslist of dict, optional

The holes of the fastener. Structure is as follows: { “point”: compas.geometry.Point, “diameter”: float, “vector”: compas.geometry.Vector, optional, if none, the hole is assumed to be perpendicular to the frame “through”: bool, optional, if True, the hole goes through the timber element }

frameFrame

The frame of the instance of the fastener that is applied to the model.

shapesGeometry

Input for extra geometric elements. These should be solids that can be booleaned with the fastener geometry.

featurelist of compas_timber.elements.Feature

A list of user defined features that are applied to the timber element.

Attributes:
outline_pointsList of Point

The points of the polyline outline of the fastener geometry.

thicknessfloat

The thickness of the fastener plate.

holeslist of dict, optional

The holes of the fastener. Structure is as follows: { “point”: compas.geometry.Point, “diameter”: float, “vector”: compas.geometry.Vector, optional, if none, the hole is assumed to be perpendicular to the frame “through”: bool, optional, if True, the hole goes through the timber element }

frameFrame

The frame of the instance of the fastener that is applied to the model.

featureslist of Feature

The features that are applied by this interface to the timber element. This returns the features in world coordinates.

Methods

get_features

Add a feature to the interface.

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.