Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed documentation of IfcSineSpiral and IfcCosineSpiral #922

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,16 +1,24 @@
# IfcCosineSpiral

A type of spiral curve for which the curvature change is dependent on the cosine function.
<!-- end of short definition -->
*IfcCosineSpiral* is a type of spiral curve for which the curvature change is dependent on the cosine function.

The curvature is defined as:
The cosine spiral curve is parameterized by its curve length and for a given parameter $s$, the heading angle $\theta(s)$ and the curvature $\kappa(s)$ are defined as follows. Here, $A_0$ corresponds to the *ConstantTerm* and $A_1$ to the *CosineTerm*.

K = K0/2 (Constant - cos&pi s/CosineTerm)
**Heading Angle:**

The *Heading Angle* $\theta(s)$ represents the orientation of the tangent to the curve at a given arc length. It indicates the direction in which the curve is "pointing" at that point. As you move along the curve, $\theta(s)$ changes, showing how the curve’s direction evolves.

$$\theta(s) = \frac{1}{A_0} s \;+\; \frac{L}{\pi A_1} \sin\!\biggl(\frac{\pi}{L}s\biggr)$$

**Curvature:**

The *Curvature* $\kappa(s)$ describes how quickly the heading angle changes with respect to the arc length $s$. It reflects the "tightness" of the curve. Higher curvature values correspond to sharper bends, and lower curvature values correspond to straighter segments.

$$\kappa(s) = \frac{L}{A_0} \;+\; \frac{L}{A_1}\cos\!\biggl(\frac{\pi}{L}s\biggr)$$

## Attributes

### CosineTerm


### ConstantTerm

Original file line number Diff line number Diff line change
@@ -1,19 +1,26 @@
# IfcSineSpiral

A type of spiral curve for which the curvature change is dependent on the sine function. It is also known as the Klein curve.
<!-- end of short definition -->
*IfcSineSpiral* is a type of spiral curve for which the curvature change is dependent on the sine function.

The curvature is defined as:
The sine spiral curve is parameterized by its curve length and for a given parameter $s$, the heading angle $\theta(s)$ and the curvature $\kappa(s)$are defined as follows. Here, $A_0$ corresponds to the *ConstantTerm*, $A_1$ to the *LinearTerm*, and $A_2$ to the *SineTerm*.

K = K0 (s LinearTerm - 1/2&pi sin2&pi/SineTerm)
**Heading Angle:**

## Attributes
The *Heading Angle* $\theta(s)$ represents the orientation of the tangent to the curve at a given arc length. It indicates the direction in which the curve is "pointing" at that point. By following changes in $\theta(s)$ along the curve, one can understand how the curve rotates and changes direction as it progresses.

### SineTerm

$$\theta(s) = \frac{1}{A_0} s \;+\; \frac{1}{2}\left(\frac{A_1}{|A_1|}\right)\left(\frac{s}{|A_1|}\right)^2\;-\; \frac{L}{2\pi A_2}\biggl(\cos\bigl(\frac{2\pi}{L}s\bigr)-1\biggr)$$

### LinearTerm
**Curvature:**

The *Curvature* $\kappa(s)$ describes how quickly the heading angle changes with respect to the arc length. In other words, curvature indicates how "tight" a curve is turning at any point. A larger curvature corresponds to a sharper bend, while a smaller curvature corresponds to a straighter segment of the curve.

$$ \kappa(s) = \frac{L}{A_0} \;+\; \frac{A_1}{|A_1|}\left(\frac{L}{|A_1|}\right)^2 \frac{s}{L} \;+\; \frac{L}{A_2}\sin\left(\frac{2\pi}{L}s\right) $$

## Attributes

### SineTerm

### ConstantTerm
### LinearTerm

### ConstantTerm