-
Notifications
You must be signed in to change notification settings - Fork 87
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
Ibrahim5aad
wants to merge
4
commits into
buildingSMART:master
Choose a base branch
from
Ibrahim5aad:fix/sine-cosine-spiral-docs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
669d13c
Fixed documentations of sine and cosine spiral curves
10a588f
Update docs/schemas/resource/IfcGeometryResource/Entities/IfcCosineSp…
Ibrahim5aad e1987a6
Update docs/schemas/resource/IfcGeometryResource/Entities/IfcSineSpir…
Ibrahim5aad b190184
Update docs/schemas/resource/IfcGeometryResource/Entities/IfcSineSpir…
Ibrahim5aad File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
16 changes: 12 additions & 4 deletions
16
docs/schemas/resource/IfcGeometryResource/Entities/IfcCosineSpiral.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
*IfcCosineSpiral* is a type of spiral curve for which the curvature change is dependent on the cosine function. | ||
<!-- end of short definition --> | ||
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*. | ||
|
||
The curvature is defined as: | ||
**Heading Angle:** | ||
|
||
K = K0/2 (Constant - cos&pi s/CosineTerm) | ||
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 | ||
|
21 changes: 14 additions & 7 deletions
21
docs/schemas/resource/IfcGeometryResource/Entities/IfcSineSpiral.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
*IfcSineSpiral* is a type of spiral curve for which the curvature change is dependent on the sine function. | ||
<!-- end of short definition --> | ||
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*. | ||
|
||
The curvature is defined as: | ||
**Heading Angle:** | ||
|
||
K = K0 (s LinearTerm - 1/2&pi sin2&pi/SineTerm) | ||
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. | ||
|
||
## Attributes | ||
|
||
### 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)$$ | ||
|
||
**Curvature:** | ||
|
||
### LinearTerm | ||
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 | ||
|
||
### ConstantTerm | ||
### SineTerm | ||
|
||
### LinearTerm | ||
|
||
### ConstantTerm |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the nice latex, but currently inline math no longer works like that in mathjax https://docs.mathjax.org/en/latest/input/tex/delimiters.html
I couldn't get their suggestion to override
inlineMath
to work either.Could you change your inline math to the following below? I know it doesn't read as pretty in plain text.. We need double backslash because we first do a conversion from md to html btw.