Skip to content

Commit

Permalink
Merge branch 'UpdatedDocs' of https://github.com/gramaziokohler/compa…
Browse files Browse the repository at this point in the history
…s_timber into UpdatedDocs
  • Loading branch information
gheyselinck committed Feb 20, 2024
2 parents 90243dd + 15cc222 commit 6183b32
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 10 deletions.
4 changes: 2 additions & 2 deletions docs/tutorials/grasshopper/beam.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The *origin* is located at the start of the centerline.

.. image:: ../images/beam_01png.png
:width: 40%
|

Beams are created with the component :code:`Beam` - to create a beam from a Grasshopper `Line` or `LineCurve`, or from a `Guid` of a `Line` object referenced from an active Rhino document.
The latter is intended for a design workflow, where the input geometry (centerlines, etc.) is drawn or stored in a Rhino document instead of generated within the Grasshopper environment.

Expand All @@ -36,7 +36,7 @@ Outputs:

.. image:: ../images/gh_beam.png
:width: 40%
|

Once a :code:`Beam` is created, it can be used as an input for the :doc:`assembly` component or the following components:

* **DecomposeBeam** : extracts the frame, centreline, box, width and height from a beam.
Expand Down
8 changes: 4 additions & 4 deletions docs/tutorials/grasshopper/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,23 @@ Features are additional geometric operations on beams:

.. image:: ../images/diagram_features.png
:width: 75%
|

**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 :doc:`assembly`.

.. image:: ../images/gh_features.png
Expand Down
13 changes: 10 additions & 3 deletions docs/tutorials/grasshopper/rules.rst
Original file line number Diff line number Diff line change
@@ -1,36 +1,43 @@
********
***********
Joint Rules
********
***********

.. image:: ../images/gh_joint_rules.png
:width: 75%
|

The joints between beams are defined by rules. There are three different levels of rules, where each of them overrides any lower-priority rule. The rules are listed hereafter from lowest to highest level of priority:


1. **Topological Joint Rules** - the lowest-priority-level rule, applied on the entire assembly. It automatically recognises the joint topology (L, T or X) between each beam and applies joint type corresponding to the joint topology. See also :doc:`joints`

Inputs:

* `L` - joint type to be applied to L topology. Default type is L-Miter.
* `T` - joint type to be applied to T topology. Default type is T-Butt.
* `X` - joint type to be applied to X topology. Default type is X-HalfLap.

|
1. **Category Joint Rules** - the second level, defines a single joint type for a specific topology between two categories of beams. The categories are assigned through the string-input `Category` in the component :code:`Beam` and added to the rhino lines.

Inputs:

* `JointOptions` - joint type to be applied to a combination of specific categories of beams.
* `CatA` - category of the first beam.
* `CatB` - category of the second beam.

|
3. **Direct Joint Rules** - the highest level, assigns a joint type directly to specific beams. The beams can be selected using the component :code:`Find Beam By Rhino GUID` See also :doc:`beam`.

Inputs:

* `JointOptions` - joint type to be applied to a combination of specific categories of beams.
* `MainBeam` - first beam.
* `SecondaryBeam` - second beam.

|
.. note::

Each rule overrides any lower rule, i.e., `Direct Joint Rules` override `Category Joint Rules` as well as `Topological Joint Rules`. `Category Joint Rules` override `Topological Joint Rules`.
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/grasshopper/workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ Based on this, **Assembly** takes care of generating the final geometry of the s

**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 :doc:`Joint Rules`.
* 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 :doc:`rules`.
* The **Joints** are processed first, then **Features**.

0 comments on commit 6183b32

Please sign in to comment.