Skip to content

Commit

Permalink
Deploy to GitHub pages
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] authored Nov 1, 2024
1 parent 0bf7aef commit 1878456
Show file tree
Hide file tree
Showing 126 changed files with 126 additions and 126 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -559,7 +559,7 @@
<h1>point_to_cadwork</h1>
<dl class="py function">
<dt class="sig sig-object py" id="compas_cadwork.conversions.point_to_cadwork">
<span class="sig-prename descclassname"><span class="pre">compas_cadwork.conversions.</span></span><span class="sig-name descname"><span class="pre">point_to_cadwork</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">point</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/81059e0/src/compas_cadwork/conversions/primitives.py#L10"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<span class="sig-prename descclassname"><span class="pre">compas_cadwork.conversions.</span></span><span class="sig-name descname"><span class="pre">point_to_cadwork</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">point</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/5ed62d9/src/compas_cadwork/conversions/primitives.py#L10"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>Convert a <a class="reference external" href="https://compas.dev/compas/latest/api/generated/compas.geometry.Point.html" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">compas.geometry.Point</span></code></a> to a cadwork point_3d object.</p>
<dl class="field-list">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -559,7 +559,7 @@
<h1>point_to_compas</h1>
<dl class="py function">
<dt class="sig sig-object py" id="compas_cadwork.conversions.point_to_compas">
<span class="sig-prename descclassname"><span class="pre">compas_cadwork.conversions.</span></span><span class="sig-name descname"><span class="pre">point_to_compas</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">point</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/81059e0/src/compas_cadwork/conversions/primitives.py#L42"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<span class="sig-prename descclassname"><span class="pre">compas_cadwork.conversions.</span></span><span class="sig-name descname"><span class="pre">point_to_compas</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">point</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/5ed62d9/src/compas_cadwork/conversions/primitives.py#L42"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>Convert a cadwork point_3d to a <a class="reference external" href="https://compas.dev/compas/latest/api/generated/compas.geometry.Point.html" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">compas.geometry.Point</span></code></a> object.</p>
<dl class="field-list">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -559,7 +559,7 @@
<h1>vector_to_cadwork</h1>
<dl class="py function">
<dt class="sig sig-object py" id="compas_cadwork.conversions.vector_to_cadwork">
<span class="sig-prename descclassname"><span class="pre">compas_cadwork.conversions.</span></span><span class="sig-name descname"><span class="pre">vector_to_cadwork</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vector</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/81059e0/src/compas_cadwork/conversions/primitives.py#L26"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<span class="sig-prename descclassname"><span class="pre">compas_cadwork.conversions.</span></span><span class="sig-name descname"><span class="pre">vector_to_cadwork</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vector</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/5ed62d9/src/compas_cadwork/conversions/primitives.py#L26"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>Convert a <a class="reference external" href="https://compas.dev/compas/latest/api/generated/compas.geometry.Vector.html" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">compas.geometry.Vector</span></code></a> to a cadwork point_3d object.</p>
<dl class="field-list">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -559,7 +559,7 @@
<h1>vector_to_compas</h1>
<dl class="py function">
<dt class="sig sig-object py" id="compas_cadwork.conversions.vector_to_compas">
<span class="sig-prename descclassname"><span class="pre">compas_cadwork.conversions.</span></span><span class="sig-name descname"><span class="pre">vector_to_compas</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vector</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/81059e0/src/compas_cadwork/conversions/primitives.py#L58"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<span class="sig-prename descclassname"><span class="pre">compas_cadwork.conversions.</span></span><span class="sig-name descname"><span class="pre">vector_to_compas</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vector</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/5ed62d9/src/compas_cadwork/conversions/primitives.py#L58"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>Convert a cadwork point_3d to a <a class="reference external" href="https://compas.dev/compas/latest/api/generated/compas.geometry.Point.html" title="(in COMPAS vlatest)"><code class="xref py py-class docutils literal notranslate"><span class="pre">compas.geometry.Point</span></code></a> obhect.</p>
<dl class="field-list">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -559,7 +559,7 @@
<h1>AnchorPoint</h1>
<dl class="py class">
<dt class="sig sig-object py" id="compas_cadwork.datamodel.AnchorPoint">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compas_cadwork.datamodel.</span></span><span class="sig-name descname"><span class="pre">AnchorPoint</span></span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/81059e0/src/compas_cadwork/datamodel/dimension.py#L20"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compas_cadwork.datamodel.</span></span><span class="sig-name descname"><span class="pre">AnchorPoint</span></span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/5ed62d9/src/compas_cadwork/datamodel/dimension.py#L20"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Anchor point of a cadwork measurement. There may me 2 or more anchor points in a measurement.</p>
<dl class="field-list simple">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -564,7 +564,7 @@
<h1>Dimension.from_element</h1>
<dl class="py method">
<dt class="sig sig-object py" id="compas_cadwork.datamodel.Dimension.from_element">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">Dimension.</span></span><span class="sig-name descname"><span class="pre">from_element</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">element</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/81059e0/src/compas_cadwork/datamodel/dimension.py#L129"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">Dimension.</span></span><span class="sig-name descname"><span class="pre">from_element</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">element</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/5ed62d9/src/compas_cadwork/datamodel/dimension.py#L129"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>Creates a dimension object from an element.</p>
<dl class="field-list">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -564,7 +564,7 @@
<h1>Dimension.from_id</h1>
<dl class="py method">
<dt class="sig sig-object py" id="compas_cadwork.datamodel.Dimension.from_id">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">Dimension.</span></span><span class="sig-name descname"><span class="pre">from_id</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">element_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/81059e0/src/compas_cadwork/datamodel/dimension.py#L110"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">Dimension.</span></span><span class="sig-name descname"><span class="pre">from_id</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">element_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/5ed62d9/src/compas_cadwork/datamodel/dimension.py#L110"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>Creates a dimension object from an element id.</p>
<p>This is an override of <a class="reference internal" href="compas_cadwork.datamodel.Element.from_id.html#compas_cadwork.datamodel.Element.from_id" title="compas_cadwork.datamodel.Element.from_id"><code class="xref py py-func docutils literal notranslate"><span class="pre">Element.from_id()</span></code></a>.</p>
<dl class="field-list simple">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -564,7 +564,7 @@
<h1>Dimension.from_selection</h1>
<dl class="py method">
<dt class="sig sig-object py" id="compas_cadwork.datamodel.Dimension.from_selection">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">Dimension.</span></span><span class="sig-name descname"><span class="pre">from_selection</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/81059e0/src/compas_cadwork/datamodel/element.py#L305"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">Dimension.</span></span><span class="sig-name descname"><span class="pre">from_selection</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/5ed62d9/src/compas_cadwork/datamodel/element.py#L305"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>Returns a generator containing Element objects for all currently activated Elements</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -564,7 +564,7 @@
<h1>Dimension.get_elements_in_contact</h1>
<dl class="py method">
<dt class="sig sig-object py" id="compas_cadwork.datamodel.Dimension.get_elements_in_contact">
<span class="sig-prename descclassname"><span class="pre">Dimension.</span></span><span class="sig-name descname"><span class="pre">get_elements_in_contact</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/81059e0/src/compas_cadwork/datamodel/element.py#L372"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<span class="sig-prename descclassname"><span class="pre">Dimension.</span></span><span class="sig-name descname"><span class="pre">get_elements_in_contact</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/5ed62d9/src/compas_cadwork/datamodel/element.py#L372"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>Returns a list of elements in contact with the current element</p>
<dl class="field-list simple">
</dl>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -564,7 +564,7 @@
<h1>Dimension.get_instruction_id</h1>
<dl class="py method">
<dt class="sig sig-object py" id="compas_cadwork.datamodel.Dimension.get_instruction_id">
<span class="sig-prename descclassname"><span class="pre">Dimension.</span></span><span class="sig-name descname"><span class="pre">get_instruction_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/81059e0/src/compas_cadwork/datamodel/element.py#L361"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<span class="sig-prename descclassname"><span class="pre">Dimension.</span></span><span class="sig-name descname"><span class="pre">get_instruction_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/5ed62d9/src/compas_cadwork/datamodel/element.py#L361"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>Returns the instruction ID of the Element</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -559,7 +559,7 @@
<h1>Dimension</h1>
<dl class="py class">
<dt class="sig sig-object py" id="compas_cadwork.datamodel.Dimension">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compas_cadwork.datamodel.</span></span><span class="sig-name descname"><span class="pre">Dimension</span></span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/81059e0/src/compas_cadwork/datamodel/dimension.py#L52"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compas_cadwork.datamodel.</span></span><span class="sig-name descname"><span class="pre">Dimension</span></span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/5ed62d9/src/compas_cadwork/datamodel/dimension.py#L52"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>Bases: <a class="reference internal" href="compas_cadwork.datamodel.Element.html#compas_cadwork.datamodel.Element" title="compas_cadwork.datamodel.element.Element"><code class="xref py py-class docutils literal notranslate"><span class="pre">Element</span></code></a></p>
<p>Represents a cadwork dimension</p>
<p class="rubric">Methods</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -564,7 +564,7 @@
<h1>Dimension.is_beam</h1>
<dl class="py method">
<dt class="sig sig-object py" id="compas_cadwork.datamodel.Dimension.is_beam">
<span class="sig-prename descclassname"><span class="pre">Dimension.</span></span><span class="sig-name descname"><span class="pre">is_beam</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/81059e0/src/compas_cadwork/datamodel/element.py#L279"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<span class="sig-prename descclassname"><span class="pre">Dimension.</span></span><span class="sig-name descname"><span class="pre">is_beam</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/5ed62d9/src/compas_cadwork/datamodel/element.py#L279"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><dl class="field-list simple">
</dl>
</dd></dl>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -564,7 +564,7 @@
<h1>Dimension.remove</h1>
<dl class="py method">
<dt class="sig sig-object py" id="compas_cadwork.datamodel.Dimension.remove">
<span class="sig-prename descclassname"><span class="pre">Dimension.</span></span><span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/81059e0/src/compas_cadwork/datamodel/element.py#L376"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<span class="sig-prename descclassname"><span class="pre">Dimension.</span></span><span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/5ed62d9/src/compas_cadwork/datamodel/element.py#L376"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>Removes the Element from the cadwork file</p>
</dd></dl>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -564,7 +564,7 @@
<h1>Dimension.remove_attribute</h1>
<dl class="py method">
<dt class="sig sig-object py" id="compas_cadwork.datamodel.Dimension.remove_attribute">
<span class="sig-prename descclassname"><span class="pre">Dimension.</span></span><span class="sig-name descname"><span class="pre">remove_attribute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/81059e0/src/compas_cadwork/datamodel/element.py#L330"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<span class="sig-prename descclassname"><span class="pre">Dimension.</span></span><span class="sig-name descname"><span class="pre">remove_attribute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/gramaziokohler/compas_cadwork/blob/5ed62d9/src/compas_cadwork/datamodel/element.py#L330"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
<dd><p>Removes an attribute from the Element</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand Down
Loading

0 comments on commit 1878456

Please sign in to comment.