Bases: Exception
Indicates that an error has occurred while trying to join two or more beams.
This error should indicate that an error has occurred while calculating the features which diff --git a/latest/api/generated/compas_timber.connections.ConnectionSolver.find_intersecting_pairs.html b/latest/api/generated/compas_timber.connections.ConnectionSolver.find_intersecting_pairs.html index 0d97dac7e..44ba11919 100644 --- a/latest/api/generated/compas_timber.connections.ConnectionSolver.find_intersecting_pairs.html +++ b/latest/api/generated/compas_timber.connections.ConnectionSolver.find_intersecting_pairs.html @@ -509,12 +509,13 @@
Finds pairs of intersecting beams in the given list of beams.
If beam_a and beam_b intersect within the given max_distance, return the topology type of the intersection.
If the topology is role-sensitive, the method outputs the beams in a consistent specific order (e.g. main beam first, cross beam second), otherwise, the beams are outputted in the same diff --git a/latest/api/generated/compas_timber.connections.ConnectionSolver.html b/latest/api/generated/compas_timber.connections.ConnectionSolver.html index f5872e708..a4546e851 100644 --- a/latest/api/generated/compas_timber.connections.ConnectionSolver.html +++ b/latest/api/generated/compas_timber.connections.ConnectionSolver.html @@ -509,12 +509,13 @@
Bases: object
Provides tools for detecting beam intersections and joint topologies.
Methods
diff --git a/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.ToString.html b/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.ToString.html index 25aab8a3f..59d38db19 100644 --- a/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.ToString.html +++ b/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.ToString.html @@ -509,12 +509,13 @@Converts the instance to a string.
This method exists for .NET compatibility. When using IronPython, the implicit string conversion that usually takes place in CPython diff --git a/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.add_extensions.html b/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.add_extensions.html index 3cb13b92c..bb358e0eb 100644 --- a/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.add_extensions.html +++ b/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.add_extensions.html @@ -509,12 +509,13 @@
Adds the extensions defined by this joint to affected beam(s). This is optional and should only be implemented by joints that require it.
Adds the features defined by this joint to affected beam(s).
Make an independent copy of the data object.
Creates an instance of this joint and creates the new connection in model.
beams are expected to have been added to model before calling this method.
This code does not verify that the given beams are adjacent and/or lie in a topology which allows connecting diff --git a/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.from_json.html b/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.from_json.html index 6e83b929c..f14d8bd99 100644 --- a/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.from_json.html +++ b/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.from_json.html @@ -509,12 +509,13 @@
Construct an object of this type from a JSON file.
Construct an object of this type from a JSON string.
Of all the faces of beam_b, returns the one whose normal is most orthogonal to beam_a.
This is done by calculating the inner-product of beam_a’s centerline which each of the face normals of beam_b. The face with the result closest to 0 is chosen.
diff --git a/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.get_face_most_towards_beam.html b/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.get_face_most_towards_beam.html index 0bb2e486a..af0ad679e 100644 --- a/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.get_face_most_towards_beam.html +++ b/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.get_face_most_towards_beam.html @@ -509,12 +509,13 @@Of all the faces of beam_b, returns the one whose normal most faces beam_a.
This is done by calculating the inner-product of beam_a’s centerline which each of the face normals of beam_b. The face with the result closest to 1 is chosen.
diff --git a/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.html b/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.html index efc49db38..7c8494886 100644 --- a/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.html +++ b/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.html @@ -509,12 +509,13 @@Bases: Joint
Represents a French Ridge Lap type joint which joins two beam at their ends.
This joint type is compatible with beams in L topology.
diff --git a/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.restore_beams_from_keys.html b/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.restore_beams_from_keys.html index 3d31b86fc..945b96b49 100644 --- a/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.restore_beams_from_keys.html +++ b/latest/api/generated/compas_timber.connections.FrenchRidgeLapJoint.restore_beams_from_keys.html @@ -509,12 +509,13 @@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.
The data is the raw data that can be used to construct an object of this type with the classmethod __from_data__.
Converts the instance to a string.
This method exists for .NET compatibility. When using IronPython, the implicit string conversion that usually takes place in CPython diff --git a/latest/api/generated/compas_timber.connections.Joint.add_extensions.html b/latest/api/generated/compas_timber.connections.Joint.add_extensions.html index b5b0bffad..5e3c1a075 100644 --- a/latest/api/generated/compas_timber.connections.Joint.add_extensions.html +++ b/latest/api/generated/compas_timber.connections.Joint.add_extensions.html @@ -509,12 +509,13 @@
Adds the extensions defined by this joint to affected beam(s). This is optional and should only be implemented by joints that require it.
Adds the features defined by this joint to affected beam(s).
Make an independent copy of the data object.
Creates an instance of this joint and creates the new connection in model.
beams are expected to have been added to model before calling this method.
This code does not verify that the given beams are adjacent and/or lie in a topology which allows connecting diff --git a/latest/api/generated/compas_timber.connections.Joint.from_json.html b/latest/api/generated/compas_timber.connections.Joint.from_json.html index cc9fbfe13..323e57952 100644 --- a/latest/api/generated/compas_timber.connections.Joint.from_json.html +++ b/latest/api/generated/compas_timber.connections.Joint.from_json.html @@ -509,12 +509,13 @@
Construct an object of this type from a JSON file.
Construct an object of this type from a JSON string.
Of all the faces of beam_b, returns the one whose normal is most orthogonal to beam_a.
This is done by calculating the inner-product of beam_a’s centerline which each of the face normals of beam_b. The face with the result closest to 0 is chosen.
diff --git a/latest/api/generated/compas_timber.connections.Joint.get_face_most_towards_beam.html b/latest/api/generated/compas_timber.connections.Joint.get_face_most_towards_beam.html index db0bb7a58..eb7be8420 100644 --- a/latest/api/generated/compas_timber.connections.Joint.get_face_most_towards_beam.html +++ b/latest/api/generated/compas_timber.connections.Joint.get_face_most_towards_beam.html @@ -509,12 +509,13 @@Of all the faces of beam_b, returns the one whose normal most faces beam_a.
This is done by calculating the inner-product of beam_a’s centerline which each of the face normals of beam_b. The face with the result closest to 1 is chosen.
diff --git a/latest/api/generated/compas_timber.connections.Joint.html b/latest/api/generated/compas_timber.connections.Joint.html index 34d7722bc..c06caa6d6 100644 --- a/latest/api/generated/compas_timber.connections.Joint.html +++ b/latest/api/generated/compas_timber.connections.Joint.html @@ -509,12 +509,13 @@Bases: Interaction
Base class for a joint connecting two beams.
This is a base class and should not be instantiated directly. diff --git a/latest/api/generated/compas_timber.connections.Joint.restore_beams_from_keys.html b/latest/api/generated/compas_timber.connections.Joint.restore_beams_from_keys.html index 2127d6b58..c0ee7440f 100644 --- a/latest/api/generated/compas_timber.connections.Joint.restore_beams_from_keys.html +++ b/latest/api/generated/compas_timber.connections.Joint.restore_beams_from_keys.html @@ -509,12 +509,13 @@
Restores the reference to the beams associate with this joint.
During serialization, compas_timber.parts.Beam objects
are serialized by compas_timber.model. To avoid circular references, Joint only stores the keys
diff --git a/latest/api/generated/compas_timber.connections.Joint.sha256.html b/latest/api/generated/compas_timber.connections.Joint.sha256.html
index 4ed56b1f5..d2174ae7b 100644
--- a/latest/api/generated/compas_timber.connections.Joint.sha256.html
+++ b/latest/api/generated/compas_timber.connections.Joint.sha256.html
@@ -509,12 +509,13 @@
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.
The data is the raw data that can be used to construct an object of this type with the classmethod __from_data__.
Returns the string representation of given topology value.
For use in logging.
Bases: object
Enumeration of the possible joint topologies.
Converts the instance to a string.
This method exists for .NET compatibility. When using IronPython, the implicit string conversion that usually takes place in CPython diff --git a/latest/api/generated/compas_timber.connections.LButtJoint.add_extensions.html b/latest/api/generated/compas_timber.connections.LButtJoint.add_extensions.html index 6163f194e..27de755f8 100644 --- a/latest/api/generated/compas_timber.connections.LButtJoint.add_extensions.html +++ b/latest/api/generated/compas_timber.connections.LButtJoint.add_extensions.html @@ -509,12 +509,13 @@
Calculates and adds the necessary extensions to the beams.
This method is automatically called when joint is created by the call to Joint.create().
Calculate the parameters for a birdsmouth joint.
# TODO: break this function into smaller more readable parts # TODO: this is BTLx only code, it should move some where else diff --git a/latest/api/generated/compas_timber.connections.LButtJoint.copy.html b/latest/api/generated/compas_timber.connections.LButtJoint.copy.html index 2fd01a5b8..cf3548bf4 100644 --- a/latest/api/generated/compas_timber.connections.LButtJoint.copy.html +++ b/latest/api/generated/compas_timber.connections.LButtJoint.copy.html @@ -509,12 +509,13 @@
Make an independent copy of the data object.
Creates an instance of this joint and creates the new connection in model.
beams are expected to have been added to model before calling this method.
This code does not verify that the given beams are adjacent and/or lie in a topology which allows connecting diff --git a/latest/api/generated/compas_timber.connections.LButtJoint.from_json.html b/latest/api/generated/compas_timber.connections.LButtJoint.from_json.html index 7d249f752..15d581b93 100644 --- a/latest/api/generated/compas_timber.connections.LButtJoint.from_json.html +++ b/latest/api/generated/compas_timber.connections.LButtJoint.from_json.html @@ -509,12 +509,13 @@
Construct an object of this type from a JSON file.
Construct an object of this type from a JSON string.
Of all the faces of beam_b, returns the one whose normal is most orthogonal to beam_a.
This is done by calculating the inner-product of beam_a’s centerline which each of the face normals of beam_b. The face with the result closest to 0 is chosen.
diff --git a/latest/api/generated/compas_timber.connections.LButtJoint.get_face_most_towards_beam.html b/latest/api/generated/compas_timber.connections.LButtJoint.get_face_most_towards_beam.html index 518542b23..1db47611d 100644 --- a/latest/api/generated/compas_timber.connections.LButtJoint.get_face_most_towards_beam.html +++ b/latest/api/generated/compas_timber.connections.LButtJoint.get_face_most_towards_beam.html @@ -509,12 +509,13 @@Of all the faces of beam_b, returns the one whose normal most faces beam_a.
This is done by calculating the inner-product of beam_a’s centerline which each of the face normals of beam_b. The face with the result closest to 1 is chosen.
diff --git a/latest/api/generated/compas_timber.connections.LButtJoint.get_main_cutting_plane.html b/latest/api/generated/compas_timber.connections.LButtJoint.get_main_cutting_plane.html index b4d9f89cf..398acf7d8 100644 --- a/latest/api/generated/compas_timber.connections.LButtJoint.get_main_cutting_plane.html +++ b/latest/api/generated/compas_timber.connections.LButtJoint.get_main_cutting_plane.html @@ -509,12 +509,13 @@Bases: ButtJoint
Represents an L-Butt type joint which joins two beam in their ends, trimming the main beam.
This joint type is compatible with beams in L topology.
diff --git a/latest/api/generated/compas_timber.connections.LButtJoint.restore_beams_from_keys.html b/latest/api/generated/compas_timber.connections.LButtJoint.restore_beams_from_keys.html index a9bad346b..de81e1010 100644 --- a/latest/api/generated/compas_timber.connections.LButtJoint.restore_beams_from_keys.html +++ b/latest/api/generated/compas_timber.connections.LButtJoint.restore_beams_from_keys.html @@ -509,12 +509,13 @@Compute a hash of the data for comparison during version control using the sha256 algorithm.
Returns the volume to be subtracted from the cross beam.
# TODO: break this function into smaller more readable parts # TODO: BTLx related code here should end up in a LapFeature..
diff --git a/latest/api/generated/compas_timber.connections.LButtJoint.to_json.html b/latest/api/generated/compas_timber.connections.LButtJoint.to_json.html index 2dbf2c27e..dcc0f6a41 100644 --- a/latest/api/generated/compas_timber.connections.LButtJoint.to_json.html +++ b/latest/api/generated/compas_timber.connections.LButtJoint.to_json.html @@ -509,12 +509,13 @@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.
The data is the raw data that can be used to construct an object of this type with the classmethod __from_data__.
Converts the instance to a string.
This method exists for .NET compatibility. When using IronPython, the implicit string conversion that usually takes place in CPython diff --git a/latest/api/generated/compas_timber.connections.LHalfLapJoint.add_extensions.html b/latest/api/generated/compas_timber.connections.LHalfLapJoint.add_extensions.html index adddbec21..c7b6ddb01 100644 --- a/latest/api/generated/compas_timber.connections.LHalfLapJoint.add_extensions.html +++ b/latest/api/generated/compas_timber.connections.LHalfLapJoint.add_extensions.html @@ -509,12 +509,13 @@
Calculates and adds the necessary extensions to the beams.
This method is automatically called when joint is created by the call to Joint.create().
Adds the features defined by this joint to affected beam(s).
Make an independent copy of the data object.
Creates an instance of this joint and creates the new connection in model.
beams are expected to have been added to model before calling this method.
This code does not verify that the given beams are adjacent and/or lie in a topology which allows connecting diff --git a/latest/api/generated/compas_timber.connections.LHalfLapJoint.from_json.html b/latest/api/generated/compas_timber.connections.LHalfLapJoint.from_json.html index 63647bd70..a44130cd1 100644 --- a/latest/api/generated/compas_timber.connections.LHalfLapJoint.from_json.html +++ b/latest/api/generated/compas_timber.connections.LHalfLapJoint.from_json.html @@ -509,12 +509,13 @@
Construct an object of this type from a JSON file.
Construct an object of this type from a JSON string.
Of all the faces of beam_b, returns the one whose normal is most orthogonal to beam_a.
This is done by calculating the inner-product of beam_a’s centerline which each of the face normals of beam_b. The face with the result closest to 0 is chosen.
diff --git a/latest/api/generated/compas_timber.connections.LHalfLapJoint.get_face_most_towards_beam.html b/latest/api/generated/compas_timber.connections.LHalfLapJoint.get_face_most_towards_beam.html index 93eb249ca..b6dfac8ef 100644 --- a/latest/api/generated/compas_timber.connections.LHalfLapJoint.get_face_most_towards_beam.html +++ b/latest/api/generated/compas_timber.connections.LHalfLapJoint.get_face_most_towards_beam.html @@ -509,12 +509,13 @@Of all the faces of beam_b, returns the one whose normal most faces beam_a.
This is done by calculating the inner-product of beam_a’s centerline which each of the face normals of beam_b. The face with the result closest to 1 is chosen.
diff --git a/latest/api/generated/compas_timber.connections.LHalfLapJoint.get_main_cutting_frame.html b/latest/api/generated/compas_timber.connections.LHalfLapJoint.get_main_cutting_frame.html index a11aaf944..180972a0a 100644 --- a/latest/api/generated/compas_timber.connections.LHalfLapJoint.get_main_cutting_frame.html +++ b/latest/api/generated/compas_timber.connections.LHalfLapJoint.get_main_cutting_frame.html @@ -509,12 +509,13 @@Bases: LapJoint
Represents a L-Lap type joint which joins the ends of two beams, trimming the main beam.
diff --git a/latest/api/generated/compas_timber.connections.LHalfLapJoint.restore_beams_from_keys.html b/latest/api/generated/compas_timber.connections.LHalfLapJoint.restore_beams_from_keys.html index 952297819..5371cefde 100644 --- a/latest/api/generated/compas_timber.connections.LHalfLapJoint.restore_beams_from_keys.html +++ b/latest/api/generated/compas_timber.connections.LHalfLapJoint.restore_beams_from_keys.html @@ -509,12 +509,13 @@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.
The data is the raw data that can be used to construct an object of this type with the classmethod __from_data__.
Converts the instance to a string.
This method exists for .NET compatibility. When using IronPython, the implicit string conversion that usually takes place in CPython diff --git a/latest/api/generated/compas_timber.connections.LMiterJoint.add_extensions.html b/latest/api/generated/compas_timber.connections.LMiterJoint.add_extensions.html index a2f81c38a..c1952aeb3 100644 --- a/latest/api/generated/compas_timber.connections.LMiterJoint.add_extensions.html +++ b/latest/api/generated/compas_timber.connections.LMiterJoint.add_extensions.html @@ -509,12 +509,13 @@
Calculates and adds the necessary extensions to the beams.
This method is automatically called when joint is created by the call to Joint.create().
Make an independent copy of the data object.
Creates an instance of this joint and creates the new connection in model.
beams are expected to have been added to model before calling this method.
This code does not verify that the given beams are adjacent and/or lie in a topology which allows connecting diff --git a/latest/api/generated/compas_timber.connections.LMiterJoint.from_json.html b/latest/api/generated/compas_timber.connections.LMiterJoint.from_json.html index d8385c12e..5dd9d517e 100644 --- a/latest/api/generated/compas_timber.connections.LMiterJoint.from_json.html +++ b/latest/api/generated/compas_timber.connections.LMiterJoint.from_json.html @@ -509,12 +509,13 @@
Construct an object of this type from a JSON file.
Construct an object of this type from a JSON string.
Of all the faces of beam_b, returns the one whose normal is most orthogonal to beam_a.
This is done by calculating the inner-product of beam_a’s centerline which each of the face normals of beam_b. The face with the result closest to 0 is chosen.
diff --git a/latest/api/generated/compas_timber.connections.LMiterJoint.get_face_most_towards_beam.html b/latest/api/generated/compas_timber.connections.LMiterJoint.get_face_most_towards_beam.html index aea449937..a0b647920 100644 --- a/latest/api/generated/compas_timber.connections.LMiterJoint.get_face_most_towards_beam.html +++ b/latest/api/generated/compas_timber.connections.LMiterJoint.get_face_most_towards_beam.html @@ -509,12 +509,13 @@Of all the faces of beam_b, returns the one whose normal most faces beam_a.
This is done by calculating the inner-product of beam_a’s centerline which each of the face normals of beam_b. The face with the result closest to 1 is chosen.
diff --git a/latest/api/generated/compas_timber.connections.LMiterJoint.html b/latest/api/generated/compas_timber.connections.LMiterJoint.html index 5e5659856..60d17c3c4 100644 --- a/latest/api/generated/compas_timber.connections.LMiterJoint.html +++ b/latest/api/generated/compas_timber.connections.LMiterJoint.html @@ -509,12 +509,13 @@Bases: Joint
Represents an L-Miter type joint which joins two beam in their ends, trimming them with a plane at the bisector angle between the beams’ centerlines.
diff --git a/latest/api/generated/compas_timber.connections.LMiterJoint.restore_beams_from_keys.html b/latest/api/generated/compas_timber.connections.LMiterJoint.restore_beams_from_keys.html index 57890a743..3a1019df6 100644 --- a/latest/api/generated/compas_timber.connections.LMiterJoint.restore_beams_from_keys.html +++ b/latest/api/generated/compas_timber.connections.LMiterJoint.restore_beams_from_keys.html @@ -509,12 +509,13 @@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.
The data is the raw data that can be used to construct an object of this type with the classmethod __from_data__.
Converts the instance to a string.
This method exists for .NET compatibility. When using IronPython, the implicit string conversion that usually takes place in CPython diff --git a/latest/api/generated/compas_timber.connections.LapJoint.add_extensions.html b/latest/api/generated/compas_timber.connections.LapJoint.add_extensions.html index 27eb27d30..cba4fd1aa 100644 --- a/latest/api/generated/compas_timber.connections.LapJoint.add_extensions.html +++ b/latest/api/generated/compas_timber.connections.LapJoint.add_extensions.html @@ -509,12 +509,13 @@
Adds the extensions defined by this joint to affected beam(s). This is optional and should only be implemented by joints that require it.
Adds the features defined by this joint to affected beam(s).
Make an independent copy of the data object.
Creates an instance of this joint and creates the new connection in model.
beams are expected to have been added to model before calling this method.
This code does not verify that the given beams are adjacent and/or lie in a topology which allows connecting diff --git a/latest/api/generated/compas_timber.connections.LapJoint.from_json.html b/latest/api/generated/compas_timber.connections.LapJoint.from_json.html index 1acd109f2..d11e7e8f0 100644 --- a/latest/api/generated/compas_timber.connections.LapJoint.from_json.html +++ b/latest/api/generated/compas_timber.connections.LapJoint.from_json.html @@ -509,12 +509,13 @@
Construct an object of this type from a JSON file.
Construct an object of this type from a JSON string.
Of all the faces of beam_b, returns the one whose normal is most orthogonal to beam_a.
This is done by calculating the inner-product of beam_a’s centerline which each of the face normals of beam_b. The face with the result closest to 0 is chosen.
diff --git a/latest/api/generated/compas_timber.connections.LapJoint.get_face_most_towards_beam.html b/latest/api/generated/compas_timber.connections.LapJoint.get_face_most_towards_beam.html index ef953c3bf..a7b37d8c1 100644 --- a/latest/api/generated/compas_timber.connections.LapJoint.get_face_most_towards_beam.html +++ b/latest/api/generated/compas_timber.connections.LapJoint.get_face_most_towards_beam.html @@ -509,12 +509,13 @@Of all the faces of beam_b, returns the one whose normal most faces beam_a.
This is done by calculating the inner-product of beam_a’s centerline which each of the face normals of beam_b. The face with the result closest to 1 is chosen.
diff --git a/latest/api/generated/compas_timber.connections.LapJoint.get_main_cutting_frame.html b/latest/api/generated/compas_timber.connections.LapJoint.get_main_cutting_frame.html index 17af8fba6..d77fed360 100644 --- a/latest/api/generated/compas_timber.connections.LapJoint.get_main_cutting_frame.html +++ b/latest/api/generated/compas_timber.connections.LapJoint.get_main_cutting_frame.html @@ -509,12 +509,13 @@Bases: Joint
Abstract Lap type joint with functions common to L-Lap, T-Lap, and X-Lap Joints.
Do not instantiate directly. Please use **LapJoint.create() to properly create an instance of lap sub-class and associate it with an model.
diff --git a/latest/api/generated/compas_timber.connections.LapJoint.restore_beams_from_keys.html b/latest/api/generated/compas_timber.connections.LapJoint.restore_beams_from_keys.html index 3b6f4fbed..e22296caa 100644 --- a/latest/api/generated/compas_timber.connections.LapJoint.restore_beams_from_keys.html +++ b/latest/api/generated/compas_timber.connections.LapJoint.restore_beams_from_keys.html @@ -509,12 +509,13 @@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.
The data is the raw data that can be used to construct an object of this type with the classmethod __from_data__.
Converts the instance to a string.
This method exists for .NET compatibility. When using IronPython, the implicit string conversion that usually takes place in CPython diff --git a/latest/api/generated/compas_timber.connections.TButtJoint.add_extensions.html b/latest/api/generated/compas_timber.connections.TButtJoint.add_extensions.html index bc0c953f6..a9ef6dcd2 100644 --- a/latest/api/generated/compas_timber.connections.TButtJoint.add_extensions.html +++ b/latest/api/generated/compas_timber.connections.TButtJoint.add_extensions.html @@ -509,12 +509,13 @@
Calculates and adds the necessary extensions to the beams.
This method is automatically called when joint is created by the call to Joint.create().
Calculate the parameters for a birdsmouth joint.
# TODO: break this function into smaller more readable parts # TODO: this is BTLx only code, it should move some where else diff --git a/latest/api/generated/compas_timber.connections.TButtJoint.copy.html b/latest/api/generated/compas_timber.connections.TButtJoint.copy.html index b84fc18b2..eb8f3d8e0 100644 --- a/latest/api/generated/compas_timber.connections.TButtJoint.copy.html +++ b/latest/api/generated/compas_timber.connections.TButtJoint.copy.html @@ -509,12 +509,13 @@
Make an independent copy of the data object.
Creates an instance of this joint and creates the new connection in model.
beams are expected to have been added to model before calling this method.
This code does not verify that the given beams are adjacent and/or lie in a topology which allows connecting diff --git a/latest/api/generated/compas_timber.connections.TButtJoint.from_json.html b/latest/api/generated/compas_timber.connections.TButtJoint.from_json.html index b500b3d26..044d68369 100644 --- a/latest/api/generated/compas_timber.connections.TButtJoint.from_json.html +++ b/latest/api/generated/compas_timber.connections.TButtJoint.from_json.html @@ -509,12 +509,13 @@
Construct an object of this type from a JSON file.
Construct an object of this type from a JSON string.
Of all the faces of beam_b, returns the one whose normal is most orthogonal to beam_a.
This is done by calculating the inner-product of beam_a’s centerline which each of the face normals of beam_b. The face with the result closest to 0 is chosen.
diff --git a/latest/api/generated/compas_timber.connections.TButtJoint.get_face_most_towards_beam.html b/latest/api/generated/compas_timber.connections.TButtJoint.get_face_most_towards_beam.html index 4d869d20b..df4c927fe 100644 --- a/latest/api/generated/compas_timber.connections.TButtJoint.get_face_most_towards_beam.html +++ b/latest/api/generated/compas_timber.connections.TButtJoint.get_face_most_towards_beam.html @@ -509,12 +509,13 @@Of all the faces of beam_b, returns the one whose normal most faces beam_a.
This is done by calculating the inner-product of beam_a’s centerline which each of the face normals of beam_b. The face with the result closest to 1 is chosen.
diff --git a/latest/api/generated/compas_timber.connections.TButtJoint.get_main_cutting_plane.html b/latest/api/generated/compas_timber.connections.TButtJoint.get_main_cutting_plane.html index 143ce1635..6303ba20c 100644 --- a/latest/api/generated/compas_timber.connections.TButtJoint.get_main_cutting_plane.html +++ b/latest/api/generated/compas_timber.connections.TButtJoint.get_main_cutting_plane.html @@ -509,12 +509,13 @@Bases: ButtJoint
Represents a T-Butt type joint which joins the end of a beam along the length of another beam, trimming the main beam.
diff --git a/latest/api/generated/compas_timber.connections.TButtJoint.restore_beams_from_keys.html b/latest/api/generated/compas_timber.connections.TButtJoint.restore_beams_from_keys.html index d64365abd..3f94e35db 100644 --- a/latest/api/generated/compas_timber.connections.TButtJoint.restore_beams_from_keys.html +++ b/latest/api/generated/compas_timber.connections.TButtJoint.restore_beams_from_keys.html @@ -509,12 +509,13 @@Compute a hash of the data for comparison during version control using the sha256 algorithm.
Returns the volume to be subtracted from the cross beam.
# TODO: break this function into smaller more readable parts # TODO: BTLx related code here should end up in a LapFeature..
diff --git a/latest/api/generated/compas_timber.connections.TButtJoint.to_json.html b/latest/api/generated/compas_timber.connections.TButtJoint.to_json.html index b795cf495..c26572ccd 100644 --- a/latest/api/generated/compas_timber.connections.TButtJoint.to_json.html +++ b/latest/api/generated/compas_timber.connections.TButtJoint.to_json.html @@ -509,12 +509,13 @@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.
The data is the raw data that can be used to construct an object of this type with the classmethod __from_data__.
Converts the instance to a string.
This method exists for .NET compatibility. When using IronPython, the implicit string conversion that usually takes place in CPython diff --git a/latest/api/generated/compas_timber.connections.THalfLapJoint.add_extensions.html b/latest/api/generated/compas_timber.connections.THalfLapJoint.add_extensions.html index a2447a8bc..1aba6bf8b 100644 --- a/latest/api/generated/compas_timber.connections.THalfLapJoint.add_extensions.html +++ b/latest/api/generated/compas_timber.connections.THalfLapJoint.add_extensions.html @@ -509,12 +509,13 @@
Calculates and adds the necessary extensions to the beams.
This method is automatically called when joint is created by the call to Joint.create().
Adds the features defined by this joint to affected beam(s).
Make an independent copy of the data object.
Creates an instance of this joint and creates the new connection in model.
beams are expected to have been added to model before calling this method.
This code does not verify that the given beams are adjacent and/or lie in a topology which allows connecting diff --git a/latest/api/generated/compas_timber.connections.THalfLapJoint.from_json.html b/latest/api/generated/compas_timber.connections.THalfLapJoint.from_json.html index f4656b3f0..7561cfe91 100644 --- a/latest/api/generated/compas_timber.connections.THalfLapJoint.from_json.html +++ b/latest/api/generated/compas_timber.connections.THalfLapJoint.from_json.html @@ -509,12 +509,13 @@
Construct an object of this type from a JSON file.
Construct an object of this type from a JSON string.
Of all the faces of beam_b, returns the one whose normal is most orthogonal to beam_a.
This is done by calculating the inner-product of beam_a’s centerline which each of the face normals of beam_b. The face with the result closest to 0 is chosen.
diff --git a/latest/api/generated/compas_timber.connections.THalfLapJoint.get_face_most_towards_beam.html b/latest/api/generated/compas_timber.connections.THalfLapJoint.get_face_most_towards_beam.html index c36c3eb38..7f9803890 100644 --- a/latest/api/generated/compas_timber.connections.THalfLapJoint.get_face_most_towards_beam.html +++ b/latest/api/generated/compas_timber.connections.THalfLapJoint.get_face_most_towards_beam.html @@ -509,12 +509,13 @@Of all the faces of beam_b, returns the one whose normal most faces beam_a.
This is done by calculating the inner-product of beam_a’s centerline which each of the face normals of beam_b. The face with the result closest to 1 is chosen.
diff --git a/latest/api/generated/compas_timber.connections.THalfLapJoint.get_main_cutting_frame.html b/latest/api/generated/compas_timber.connections.THalfLapJoint.get_main_cutting_frame.html index 31c014ce8..910aafac7 100644 --- a/latest/api/generated/compas_timber.connections.THalfLapJoint.get_main_cutting_frame.html +++ b/latest/api/generated/compas_timber.connections.THalfLapJoint.get_main_cutting_frame.html @@ -509,12 +509,13 @@Bases: LapJoint
Represents a T-Lap type joint which joins the end of a beam along the length of another beam, trimming the main beam.
diff --git a/latest/api/generated/compas_timber.connections.THalfLapJoint.restore_beams_from_keys.html b/latest/api/generated/compas_timber.connections.THalfLapJoint.restore_beams_from_keys.html index a35a66edb..ce973b6a0 100644 --- a/latest/api/generated/compas_timber.connections.THalfLapJoint.restore_beams_from_keys.html +++ b/latest/api/generated/compas_timber.connections.THalfLapJoint.restore_beams_from_keys.html @@ -509,12 +509,13 @@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.
The data is the raw data that can be used to construct an object of this type with the classmethod __from_data__.
Converts the instance to a string.
This method exists for .NET compatibility. When using IronPython, the implicit string conversion that usually takes place in CPython diff --git a/latest/api/generated/compas_timber.connections.XHalfLapJoint.add_extensions.html b/latest/api/generated/compas_timber.connections.XHalfLapJoint.add_extensions.html index d6f9c5439..fe9a3270b 100644 --- a/latest/api/generated/compas_timber.connections.XHalfLapJoint.add_extensions.html +++ b/latest/api/generated/compas_timber.connections.XHalfLapJoint.add_extensions.html @@ -509,12 +509,13 @@
Adds the extensions defined by this joint to affected beam(s). This is optional and should only be implemented by joints that require it.
Adds the features defined by this joint to affected beam(s).
Make an independent copy of the data object.
Creates an instance of this joint and creates the new connection in model.
beams are expected to have been added to model before calling this method.
This code does not verify that the given beams are adjacent and/or lie in a topology which allows connecting diff --git a/latest/api/generated/compas_timber.connections.XHalfLapJoint.from_json.html b/latest/api/generated/compas_timber.connections.XHalfLapJoint.from_json.html index 209dd50cd..0ed89ab2c 100644 --- a/latest/api/generated/compas_timber.connections.XHalfLapJoint.from_json.html +++ b/latest/api/generated/compas_timber.connections.XHalfLapJoint.from_json.html @@ -509,12 +509,13 @@
Construct an object of this type from a JSON file.
Construct an object of this type from a JSON string.
Of all the faces of beam_b, returns the one whose normal is most orthogonal to beam_a.
This is done by calculating the inner-product of beam_a’s centerline which each of the face normals of beam_b. The face with the result closest to 0 is chosen.
diff --git a/latest/api/generated/compas_timber.connections.XHalfLapJoint.get_face_most_towards_beam.html b/latest/api/generated/compas_timber.connections.XHalfLapJoint.get_face_most_towards_beam.html index 36e1b1f37..72f8f19e9 100644 --- a/latest/api/generated/compas_timber.connections.XHalfLapJoint.get_face_most_towards_beam.html +++ b/latest/api/generated/compas_timber.connections.XHalfLapJoint.get_face_most_towards_beam.html @@ -509,12 +509,13 @@Of all the faces of beam_b, returns the one whose normal most faces beam_a.
This is done by calculating the inner-product of beam_a’s centerline which each of the face normals of beam_b. The face with the result closest to 1 is chosen.
diff --git a/latest/api/generated/compas_timber.connections.XHalfLapJoint.get_main_cutting_frame.html b/latest/api/generated/compas_timber.connections.XHalfLapJoint.get_main_cutting_frame.html index f81717150..55dad0b19 100644 --- a/latest/api/generated/compas_timber.connections.XHalfLapJoint.get_main_cutting_frame.html +++ b/latest/api/generated/compas_timber.connections.XHalfLapJoint.get_main_cutting_frame.html @@ -509,12 +509,13 @@Bases: LapJoint
Represents a X-Lap type joint which joins the end of a beam along the length of another beam, trimming the main beam.
diff --git a/latest/api/generated/compas_timber.connections.XHalfLapJoint.restore_beams_from_keys.html b/latest/api/generated/compas_timber.connections.XHalfLapJoint.restore_beams_from_keys.html index 8cd8883b1..b21e881d6 100644 --- a/latest/api/generated/compas_timber.connections.XHalfLapJoint.restore_beams_from_keys.html +++ b/latest/api/generated/compas_timber.connections.XHalfLapJoint.restore_beams_from_keys.html @@ -509,12 +509,13 @@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.
The data is the raw data that can be used to construct an object of this type with the classmethod __from_data__.
Finds neighboring pairs of beams in the given list of beams, using R-tree search.
The inputs to the R-tree algorithm are the axis-aligned bounding boxes of the beams (beam.aabb), enlarged by the inflate_by amount. The returned elements are sets containing pairs of Beam objects.
diff --git a/latest/api/generated/compas_timber.elements.Beam.ToString.html b/latest/api/generated/compas_timber.elements.Beam.ToString.html index 098c307d1..8bd081675 100644 --- a/latest/api/generated/compas_timber.elements.Beam.ToString.html +++ b/latest/api/generated/compas_timber.elements.Beam.ToString.html @@ -509,12 +509,13 @@Converts the instance to a string.
This method exists for .NET compatibility. When using IronPython, the implicit string conversion that usually takes place in CPython diff --git a/latest/api/generated/compas_timber.elements.Beam.add_blank_extension.html b/latest/api/generated/compas_timber.elements.Beam.add_blank_extension.html index 2b6eb866e..83d115e30 100644 --- a/latest/api/generated/compas_timber.elements.Beam.add_blank_extension.html +++ b/latest/api/generated/compas_timber.elements.Beam.add_blank_extension.html @@ -509,12 +509,13 @@
Adds a blank extension to the beam.
The amount by which the start of the beam should be extended.
diff --git a/latest/api/generated/compas_timber.elements.Beam.add_feature.html b/latest/api/generated/compas_timber.elements.Beam.add_feature.html index 4cae76e92..3df5db77b 100644 --- a/latest/api/generated/compas_timber.elements.Beam.add_feature.html +++ b/latest/api/generated/compas_timber.elements.Beam.add_feature.html @@ -509,12 +509,13 @@Add a feature to the list of features of the lement.
Adds one or more features to the beam.
Computes the Axis Aligned Bounding Box (AABB) of the element.
Computes the collision geometry of the element.
Compute the geometry of the element.
Computes the Oriented Bounding Box (OBB) of the element.
Compute the transformation to world coordinates of this element based on its position in the spatial hierarchy of the model.
Make an independent copy of the data object.
Returns which endpoint of the centerline of the beam is closer to the given point.
Returns the amount by which to extend the beam in each direction using metric units.
TODO: verify this is true The extension is the minimum amount which allows all long faces of the beam to pass through diff --git a/latest/api/generated/compas_timber.elements.Beam.from_centerline.html b/latest/api/generated/compas_timber.elements.Beam.from_centerline.html index 6160be7c0..66ecfd095 100644 --- a/latest/api/generated/compas_timber.elements.Beam.from_centerline.html +++ b/latest/api/generated/compas_timber.elements.Beam.from_centerline.html @@ -509,12 +509,13 @@
Define the beam from its centerline.
Creates a Beam from the given endpoints.
Construct an object of this type from a JSON file.
Construct an object of this type from a JSON string.
Bases: Element
A class to represent timber beams (studs, slats, etc.) with rectangular cross-sections.
Removes a blank extension from the beam.
Removes a feature from the beam.
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.
Transforms the element.
Creates a transformed copy of the element.
Validate the data against the object’s data schema.
The data is the raw data that can be used to construct an object of this type with the classmethod __from_data__.
Bases: object
Class representing a BTLx object.
BTLx is a format used for representing timber fabrication data.
diff --git a/latest/api/generated/compas_timber.fabrication.BTLx.process_model.html b/latest/api/generated/compas_timber.fabrication.BTLx.process_model.html index ca0ada164..c9d319982 100644 --- a/latest/api/generated/compas_timber.fabrication.BTLx.process_model.html +++ b/latest/api/generated/compas_timber.fabrication.BTLx.process_model.html @@ -509,12 +509,13 @@Registers a joint type and its corresponding factory.
Bases: object
BTLxFrenchRidgeLap represents a fabrication process for creating a French Ridge Lap joint.
Bases: object
Represents a jack cut process for timber fabrication.
Bases: object
Generic class for BTLx processings.
This should be instantiated and appended to BTLxPart.processings in a specific btlx_process class (eg BTLxJackCut)
diff --git a/latest/api/generated/compas_timber.fabrication.FrenchRidgeFactory.apply_processings.html b/latest/api/generated/compas_timber.fabrication.FrenchRidgeFactory.apply_processings.html index 7a0d1d3fc..69696cf15 100644 --- a/latest/api/generated/compas_timber.fabrication.FrenchRidgeFactory.apply_processings.html +++ b/latest/api/generated/compas_timber.fabrication.FrenchRidgeFactory.apply_processings.html @@ -509,12 +509,13 @@Apply processings to the joint and parts.
Bases: object
Factory class for creating French ridge joints.
Methods
diff --git a/latest/api/generated/compas_timber.fabrication.LButtFactory.apply_processings.html b/latest/api/generated/compas_timber.fabrication.LButtFactory.apply_processings.html index 22e030510..098daadd2 100644 --- a/latest/api/generated/compas_timber.fabrication.LButtFactory.apply_processings.html +++ b/latest/api/generated/compas_timber.fabrication.LButtFactory.apply_processings.html @@ -509,12 +509,13 @@Apply processings to the joint and its associated parts.
Bases: object
Factory class for creating L-Butt joints.
Methods
diff --git a/latest/api/generated/compas_timber.fabrication.LMiterFactory.apply_processings.html b/latest/api/generated/compas_timber.fabrication.LMiterFactory.apply_processings.html index e8b5018d0..485c71709 100644 --- a/latest/api/generated/compas_timber.fabrication.LMiterFactory.apply_processings.html +++ b/latest/api/generated/compas_timber.fabrication.LMiterFactory.apply_processings.html @@ -509,12 +509,13 @@Apply processings to the parts involved in the L-Miter joint.
Bases: object
Factory class for creating L-Miter joints.
Methods
diff --git a/latest/api/generated/compas_timber.fabrication.TButtFactory.apply_processings.html b/latest/api/generated/compas_timber.fabrication.TButtFactory.apply_processings.html index 4e14d01ac..512c06b9f 100644 --- a/latest/api/generated/compas_timber.fabrication.TButtFactory.apply_processings.html +++ b/latest/api/generated/compas_timber.fabrication.TButtFactory.apply_processings.html @@ -509,12 +509,13 @@Apply processings to the joint and its associated parts.
Bases: object
Factory class for creating T-Butt joints.
Methods
diff --git a/latest/api/generated/compas_timber.model.TimberModel.ToString.html b/latest/api/generated/compas_timber.model.TimberModel.ToString.html index 9c8db1dff..e511e7c1a 100644 --- a/latest/api/generated/compas_timber.model.TimberModel.ToString.html +++ b/latest/api/generated/compas_timber.model.TimberModel.ToString.html @@ -509,12 +509,13 @@Converts the instance to a string.
This method exists for .NET compatibility. When using IronPython, the implicit string conversion that usually takes place in CPython diff --git a/latest/api/generated/compas_timber.model.TimberModel.add_element.html b/latest/api/generated/compas_timber.model.TimberModel.add_element.html index e12124314..e7c7b8b03 100644 --- a/latest/api/generated/compas_timber.model.TimberModel.add_element.html +++ b/latest/api/generated/compas_timber.model.TimberModel.add_element.html @@ -509,12 +509,13 @@
Add an element to the model.
Add multiple elements to the model.
Add a group to the model.
Add an interaction between two elements of the model.
Add a joint object to the model.
Add a material to the model.
Assign a material to an element or a list of elements.
Get a beam by its unique identifier.
Compute the axis-aligned bounding box of the datastructure.
Compute the oriented bounding box of the datastructure.
Make an independent copy of the data object.
Yield all the elements contained in the model.
Find groups of elements connected by a specific type of interaction.
Construct an object of this type from a JSON file.
Construct an object of this type from a JSON string.
Returns True if the model contains the given element.
Returns True if two elements have an interaction set between them.
Verify that the model contains a specific material.
Bases: Model
Represents a timber model containing different elements such as walls, beams and joints.
The timber model allows expressing the hierarchy and interactions between the different elements it contains.
diff --git a/latest/api/generated/compas_timber.model.TimberModel.interactions.html b/latest/api/generated/compas_timber.model.TimberModel.interactions.html index 847b58583..da00ef84a 100644 --- a/latest/api/generated/compas_timber.model.TimberModel.interactions.html +++ b/latest/api/generated/compas_timber.model.TimberModel.interactions.html @@ -509,12 +509,13 @@Yield all interactions between all elements in the model.
Yield all the materials contained in the model.
Process the joinery of the model. This methods instructs all joints to add their extensions and features.
The sequence is important here since the feature parameters must be calculated based on the extended blanks. For this reason, the first iteration will only extend the beams, and the second iteration will add the features.
diff --git a/latest/api/generated/compas_timber.model.TimberModel.remove_element.html b/latest/api/generated/compas_timber.model.TimberModel.remove_element.html index 8f89de9fe..2f293effc 100644 --- a/latest/api/generated/compas_timber.model.TimberModel.remove_element.html +++ b/latest/api/generated/compas_timber.model.TimberModel.remove_element.html @@ -509,12 +509,13 @@Remove an element from the model.
Remove the interaction between two elements.
Removes this joint object from the model.
Rotate the datastructure.
Returns a rotated copy of this geometry.
Scale the datastructure.
Returns a scaled copy of this geometry.
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.
Transform the model and all that it contains.
Transforms the data structure.
Returns a transformed copy of this data structure.
Returns a transformed copy of this data structure.
Translate the datastructure.
Returns a translated copy of this geometry.
Validate the data against the object’s data schema.
The data is the raw data that can be used to construct an object of this type with the classmethod __from_data__.
Returns the string representation of given actor value.
For use in logging.
Bases: object
Enum representing the types of actor which could execute an model instruction.
Methods
diff --git a/latest/api/generated/compas_timber.planning.BuildingPlan.ToString.html b/latest/api/generated/compas_timber.planning.BuildingPlan.ToString.html index c6e0d3271..6a513926c 100644 --- a/latest/api/generated/compas_timber.planning.BuildingPlan.ToString.html +++ b/latest/api/generated/compas_timber.planning.BuildingPlan.ToString.html @@ -509,12 +509,13 @@Converts the instance to a string.
This method exists for .NET compatibility. When using IronPython, the implicit string conversion that usually takes place in CPython diff --git a/latest/api/generated/compas_timber.planning.BuildingPlan.add_step.html b/latest/api/generated/compas_timber.planning.BuildingPlan.add_step.html index 8dfb6cad2..603417254 100644 --- a/latest/api/generated/compas_timber.planning.BuildingPlan.add_step.html +++ b/latest/api/generated/compas_timber.planning.BuildingPlan.add_step.html @@ -509,12 +509,13 @@
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.
Bases: Data
Container for building steps, each steps is a collection of instructions which can be visualized
Methods
diff --git a/latest/api/generated/compas_timber.planning.BuildingPlan.sha256.html b/latest/api/generated/compas_timber.planning.BuildingPlan.sha256.html index 2cae2c809..72f9518b7 100644 --- a/latest/api/generated/compas_timber.planning.BuildingPlan.sha256.html +++ b/latest/api/generated/compas_timber.planning.BuildingPlan.sha256.html @@ -509,12 +509,13 @@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.
The data is the raw data that can be used to construct an object of this type with the classmethod __from_data__.
Bases: object
Generates a simple sequence of steps, one step per element. Order of steps is the same as order of elements in model.
diff --git a/latest/api/generated/compas_timber.planning.Step.ToString.html b/latest/api/generated/compas_timber.planning.Step.ToString.html index df4eed259..ed66f7742 100644 --- a/latest/api/generated/compas_timber.planning.Step.ToString.html +++ b/latest/api/generated/compas_timber.planning.Step.ToString.html @@ -509,12 +509,13 @@Converts the instance to a string.
This method exists for .NET compatibility. When using IronPython, the implicit string conversion that usually takes place in CPython diff --git a/latest/api/generated/compas_timber.planning.Step.copy.html b/latest/api/generated/compas_timber.planning.Step.copy.html index d3c829b8b..7bafb6891 100644 --- a/latest/api/generated/compas_timber.planning.Step.copy.html +++ b/latest/api/generated/compas_timber.planning.Step.copy.html @@ -509,12 +509,13 @@
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.
Bases: Data
Container for building instructions which assemble a single element
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.
The data is the raw data that can be used to construct an object of this type with the classmethod __from_data__.
Uses the Rhino.Geometry.RTree implementation of RTree to find neighboring beams.
COMPAS TIMBER for Grasshopper is an easy-to-use tool to design timber frame structures from simple centerline input. +
COMPAS Timber for Grasshopper is an easy-to-use tool to design timber frame structures from simple centerline input. It provides tools to automate the process of creating timber frame structures with simple joints, bake the geometry with fibre-aligned box-mapping for texturing/rendering, add boolean-style features like planar cuts or holes, and some more.
-The plugin is built on top of the COMPAS TIMBER python library and provides additional functionalities that might be useful for design in Grasshopper.
-
+The plugin is built on top of the COMPAS Timber python library and provides additional functionalities that might be useful for design in Grasshopper.
+
Note
-You can also use the COMPAS TIMBER python library in Grasshopper using the -ghPython componenent. -See COMPAS TIMBER API Reference and Examples for more details.
+You can also use the COMPAS Timber python library in Grasshopper using the ghPython componenent. +See COMPAS Timber API Reference and Examples for more details.
To get an overall idea how to use it, start with Workflow. Then, the following sections explain in detail the concepts and tools:
:) as a separator between a key and a value of each entry,
and an underscore (_)
to separate entries (for example: attr1name:attr1value_attr2name:attr2value)
-There are four standard attributes, corresponding to the inputs in the Beam components: Width, Height, Category or ZVector.
-SetStandardAttributes - sets the standard attributes’ values, e.g. writes them to the source object.
ReadStandardAttributes - reads the standard attributes from the source object. Group attribute refers to indices of groups if source objects were grouped.
CheckStandardAttributes - checks if the standard attributes are set and/or correctly formatted, and displays errors or missing values.
There are four standard attributes, corresponding to the inputs in the Beams components: Width, Height, Category or ZVector.
+SetStandardAttributes - sets the standard attributes’ values, e.g. writes them to the source object. +GetStandardAttributes - gets the standard attributes from the source object. Group attribute refers to indices of groups if source objects were grouped.
+
+
+It is also possible to set and retrieve custom, user-defined attributes. This may be useful if later the source objects need to be filtered according to additional criteria. These attributes are only set to source objects, not the beams created from them.
-DeleteAttributes - removes the given attribute and its value from the source object.
SetCustomAttributes - sets a custom attribute and its value to the source object.
ReadAllAttributes - reads all attributes from the source object.
SetCustomAttributes - sets a custom attribute and its value to the source object. +GetCustomAttributes - gets all attributes from the source object.
+
+
+CheckStandardAttributes - checks if the standard attributes are set and/or correctly formatted, and displays errors or missing values.
+
+DeleteAttributes - removes the given attribute and its value from the source object.
+
+
+Fabrication components are used to create Data for machining Compas Timber Models.
+Writes a BTLx File from a Compas Timber Model.
+
+
+Inputs:
+Model : the Compas Timber Model.
Path : a File Path where to save the BTLx File.
Write : Writes the File if the Input is True.
Outputs:
+BTLx : the BTLx Content as xml text.
Features are additional geometric operations on beams:
+
+
+BrepSubtractionFeature is a boolean operation to subtract any Brep geometry from a beam.
Beam : the beam to be subtracted from
Brep : the Brep geometry to subtract as a Brep
BrepDrillHoleFeature is a boolean operation to subtract a hole from a beam.
Beam : the beam to be drilled
Line : the axis of the hole as a Line
Diameter : the diameter of the hole
TrimFeature cuts a beam with a Plane. The part of the beam lying on the z-positive side of the plane will be removed.
Beam : the beam to be trimmed
Plane : the plane to trim the beam as a surface
The output Feature is to be used as input for the Assembly component. See Assembly.
-
-
+The output Feature is to be used as input for the Model component. See Model.
+Tools for previewing, inspecting and extracting geometry and data from the assembly.
-ShowBeamFaces : display the faces of the beams.
ShowBeamIndex : display the index of the beams. Based on a global list of the beams in the assembly.
+
+Displays the indexes of the Beams. Based on a global list of the Beams in the assembly.
ShowFeatureErrors :
ShowJoiningErrors :
+
+Displays the indexes of the Beam faces.
ShowJointTypes : display the type names of each joints in the assembly.
ShowTopologyTypes : display the type names of each joints in the assembly.
Displays all Beams of one selected type from the surface model.
+
+
+Shows information useful for debugging feature application errors.
+
+Shows information useful for debugging errors occured while attempting to join Beams.
+
+
+Displays the type names of each joints in the assembly.
+
+
+Displays the topologies (L, T or X) that Compas Timber recognizes at each Joint
MapSize parameter serve to scale the BoxMap to adjusted it to size of the beam objects and image ratio of the texturing bitmap.
For documentation on BoxMapping in Rhino see here.
-
+
diff --git a/latest/tutorials/grasshopper/workflow.html b/latest/tutorials/grasshopper/workflow.html
index bd54422c1..d2087f92a 100644
--- a/latest/tutorials/grasshopper/workflow.html
+++ b/latest/tutorials/grasshopper/workflow.html
@@ -59,7 +59,7 @@
-
+
@@ -505,12 +505,13 @@
To build a timber frame Assembly, you need to:
+To build a timber frame Model in Grasshopper, you need to:
create Beams
define Joints between these beams and Rules how the joints are applied.
define other Features (optional)
create Beams.
define Joint Rules for the interactions between the Beams.
optional: define other Features.
Based on this, Assembly takes care of generating the final geometry of the structure.
-
+Based on this, the Model component takes care of generating the final geometry of the structure.
+
Example:
-
+
Note
Important!
There are three Types of Joint Rules 1. By Topology, 2. by Category and 3. Direct Joints. In this order, they will be applied to the Assembly. Direct Joints will overwrite Category Rules, Category Rules will overwrite Topology Rules. See Joint Rules.
You can add any number of Joint Rules, but there is a hierarchy of how they are applied:
There are three Types of Joint Rules 1. By Topology, 2. by Category and 3. Direct Joints. Direct Joints will overwrite Category Rules, Category Rules will overwrite Topology Rules.
The Joints are processed first, then Features.