FastenerTimberInterface
- class compas_timber.elements.FastenerTimberInterface[source]
Bases:
DataA 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[
Point], optional The points of the polyline outline of the fastener geometry.
- thicknessfloat, optional
The thickness of the fastener plate.
- holeslist[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 }
- shapeslist[
Geometry], optional Input for extra geometric elements. These should be solids that can be booleaned with the fastener geometry.
- frame
Frame, optional The frame of the instance of the fastener that is applied to the model.
- elementobject, optional
The timber element this interface is associated with.
- featureslist[
BTLxFromGeometryDefinition], optional The features that are applied by this interface to the timber element. The features are defined in world coordinates.
- outline_pointslist[
- Attributes:
- outline_pointslist[
Point] The points of the polyline outline of the fastener geometry.
- thicknessfloat
The thickness of the fastener plate.
- holeslist[dict]
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 }
- frame
Frame The frame of the instance of the fastener that is applied to the model.
- elementobject
The timber element this interface is associated with.
- shapeslist[
Geometry] Input for extra geometric elements. These should be solids that can be booleaned with the fastener geometry.
- featureslist[
BTLxFromGeometryDefinition] The features that are applied by this interface to the timber element. This returns the features in world coordinates.
- outline_pointslist[
Methods
Get features to be applied to a timber element.
Inherited Methods
Converts the instance to a string.
Make an independent copy of the data object.
Construct an object of this type from a JSON file.
Construct an object of this type from a JSON string.
Compute a hash of the data for comparison during version control using the sha256 algorithm.
Convert an object to its native data representation and save it to a JSON file.
Convert an object to its native data representation and save it to a JSON string.
Validate the data against the object's data schema.