Skip to content

Commit

Permalink
Add option to link to members in the class template docs (#926)
Browse files Browse the repository at this point in the history
  • Loading branch information
melund authored Feb 13, 2024
1 parent 6c5b72e commit c9bcf19
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 6 deletions.
14 changes: 8 additions & 6 deletions CHANGELOG.md
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
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
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

0 comments on commit c9bcf19

Please sign in to comment.