Documenting Vector, Matrix, Rotation & Placement Expressions

Have some feature requests, feedback, cool stuff to share, or want to know where FreeCAD is going? This is the place.
Forum rules
Be nice to others! Read the FreeCAD code of conduct!
User avatar
adrianinsaval
Veteran
Posts: 5541
Joined: Thu Apr 05, 2018 5:15 pm

Re: Documenting Vector, Matrix, Rotation & Placement Expressions

Post by adrianinsaval »

realthunder's explanation of this stuff: https://forum.freecadweb.org/viewtopic. ... 74#p330713
User avatar
gbroques
Posts: 167
Joined: Thu Jan 23, 2020 3:28 am
Location: St. Louis, Missouri

Re: Documenting Vector, Matrix, Rotation & Placement Expressions

Post by gbroques »

Thanks for the interest and feedback all.

I made an attempt to document the create function, and tuple / list functions on the Expressions page.

Additionally, I made mention of this on the Placement page under the "Using Placement in expressions" section.

I still plan to document Matrix Functions (i.e. mscale and minvert).
chrisb
Veteran
Posts: 53945
Joined: Tue Mar 17, 2015 9:14 am

Re: Documenting Vector, Matrix, Rotation & Placement Expressions

Post by chrisb »

Thanks; good solution with the reference.
A Sketcher Lecture with in-depth information is available in English, auf Deutsch, en français, en español.
User avatar
gbroques
Posts: 167
Joined: Thu Jan 23, 2020 3:28 am
Location: St. Louis, Missouri

Re: Documenting Vector, Matrix, Rotation & Placement Expressions

Post by gbroques »

I made one more pass at the Expressions page with the following changes:

  • Documented mscale and minvert matrix functions.
  • Documented hypot and cath trig functions.
  • Added a couple links to the v0.19.2 FreeCAD source code in case the Wiki page and code ever gets out of sync. It may be easier to reconcile them.
User avatar
M4x
Veteran
Posts: 1474
Joined: Sat Mar 11, 2017 9:23 am
Location: Germany

Re: Documenting Vector, Matrix, Rotation & Placement Expressions

Post by M4x »

Thank you very much!
User avatar
gbroques
Posts: 167
Joined: Thu Jan 23, 2020 3:28 am
Location: St. Louis, Missouri

Re: Documenting Vector, Matrix, Rotation & Placement Expressions

Post by gbroques »

M4x wrote: Tue Oct 19, 2021 4:36 pm Thank you very much!
Sure, I hope the changes to the Wiki will help the next person!

These features were too helpful to go undocumented! :D

Thanks for your input on this thread.

---

P.S. max is documented under "Statistical / aggregate functions".
User avatar
M4x
Veteran
Posts: 1474
Joined: Sat Mar 11, 2017 9:23 am
Location: Germany

Re: Documenting Vector, Matrix, Rotation & Placement Expressions

Post by M4x »

gbroques wrote: Tue Oct 19, 2021 10:49 pm P.S. max is documented under "Statistical / aggregate functions".
8-)
User avatar
Roy_043
Veteran
Posts: 8455
Joined: Thu Dec 27, 2018 12:28 pm

Re: Documenting Vector, Matrix, Rotation & Placement Expressions

Post by Roy_043 »

gbroques wrote: Tue Oct 19, 2021 12:24 am [*]Added a couple links to the v0.19.2 FreeCAD source code in case the Wiki page and code ever gets out of sync. It may be easier to reconcile them.
I suspect that this V0.19.2 code is more or less static as we are currently developing V0.20. So I do not fully understand the logic behind these links.
User avatar
gbroques
Posts: 167
Joined: Thu Jan 23, 2020 3:28 am
Location: St. Louis, Missouri

Re: Documenting Vector, Matrix, Rotation & Placement Expressions

Post by gbroques »

Roy_043 wrote: Wed Oct 20, 2021 9:03 am
gbroques wrote: Tue Oct 19, 2021 12:24 am [*]Added a couple links to the v0.19.2 FreeCAD source code in case the Wiki page and code ever gets out of sync. It may be easier to reconcile them.
I suspect that this V0.19.2 code is more or less static as we are currently developing V0.20. So I do not fully understand the logic behind these links.
Yes, the links are pinned to the latest release, the static v0.19.2 version, and should not ever change.

If you link to code that changes, like the master branch, then your links may become out of date, or bad in the future as the code changes.

Knowing where these are defined in the source code for v0.19.2 can help people track down where these will be defined in the code for future releases like v0.20.0.

For example, if more predefined functions are added, but not documented.

---

P.S. It looks like a new str function will be avaliable in the next release (see here).

(This link with line numbers included, may not be good in the future as master changes over time.)
Post Reply