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.

Sign up for GitHub

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

Links to class-template members in docs #926

Merged
merged 1 commit into from
Feb 13, 2024
Merged

Links to class-template members in docs #926

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 8 additions & 6 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,8 +171,9 @@ achieve same marker position and joint angle output.
are now used for both simple and 3-element muscle models.

* MoCap marker protocols: Users must now explicitly specify a coordinate system
relative to which markers are placed on the segment using the `PlaceMarkerAt` argument
in the class template. Previously, this defaulted to the `AnatomicalFrame` of
relative to which markers are placed on the segment using the
[`PlaceMarkerAt`](#MoCap.Markers.CreateMarkerDriverClass.CreateMarkerDriver:PlaceMarkerAt)
argument in the class template. Previously, this defaulted to the `AnatomicalFrame` of
the segment.

* The organization of segmental scaling functions was reworked and now configured
Expand Down Expand Up @@ -214,9 +215,10 @@ achieve same marker position and joint angle output.
This new structure allows for overwriting the complete set of muscle volumes with
an alternative dataset.

* The `MarkerName` argument in the `CreateMarkerDriver` template for MoCap models is no
longer necessary. The argument can still be used if the marker class and data
entry in the C3D file differ.
* The [`MarkerName`](#MoCap.Markers.CreateMarkerDriverClass.CreateMarkerDriver:MarkerName)
argument in the [`CreateMarkerDriver`](#MoCap.Markers.CreateMarkerDriverClass.CreateMarkerDriver)
template for MoCap models is no longer necessary. The argument can still be used
if the marker class and data entry in the C3D file differ.

* Updated the implementation of muscle parameters section in models to use the new
`??=` (optional assignment) operator introduced in AnyBody 7.4.1. This allows
Expand Down Expand Up @@ -244,7 +246,7 @@ achieve same marker position and joint angle output.
better clarity.

* The `CameraClassTemplate.any` include file in model utilities has been renamed to
`VideoLookAtCamera.any` to have the same name as the class template it
[`VideoLookAtCamera.any`](#Video-tools.Video.VideoLookAtCamera.any) to have the same name as the class template it
contains.

### 🧹 Removed:
Expand Down
3 changes: 3 additions & 0 deletions Docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,9 @@ maintained by AnyBody Technology who ensure that various body part models can be
used together as a full body, scalable musculoskeletal model.


[testlink](#MoCap.Markers.CreateMarkerDriverClass.CreateMarkerDriver.sRelOpt)



[anybody modeling system]: https://www.anybodytech.com/software/anybodymodelingsystem/

Expand Down
4 changes: 4 additions & 0 deletions Docs/tools/class-template.md.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@

:\_\_CLASS\_\_: `{{classt.type}}`{l=AnyScriptDoc}
{% for arg in args_in_documentation %}
({{ file_target }}.{{classname}}:{{arg.name}})=
:{{arg.name}}:
{{arg.docs}} {%if arg.value %} (Default: {{arg.value}}) {%else%} (Required) {%endif%}
{% endfor %}
Expand Down Expand Up @@ -104,7 +105,9 @@

:::::{grid} 1
{% for member in required_members %}

::::{grid-item-card}
({{ file_target }}.{{classname}}.{{member.name}})=
```{code-block} AnyScriptDoc
{{member.name}} = §<Required>§;
```
Expand All @@ -127,6 +130,7 @@
:::::{grid} 1
{% for member in optional_members %}
::::{grid-item}
({{ file_target }}.{{classname}}.{{member.name}})=
:::{dropdown} `{{member.name}} = {{member.value}};`{l=AnyScriptDoc}
:margin: 0
:color: white
Expand Down