diff options
author | Karl Berry <karl@freefriends.org> | 2024-05-20 20:13:23 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2024-05-20 20:13:23 +0000 |
commit | ce2c9e3e56915c73ac0087618fd4bb7e83337d3c (patch) | |
tree | 4cd1342f896355ea6c6d193a1199ed4ba8e99e47 /Master/texmf-dist/doc | |
parent | 8755084f90f69c83a9244d6a7437da1e72dbd156 (diff) |
liftarm (20may24)
git-svn-id: svn://tug.org/texlive/trunk@71309 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/latex/liftarm/README.md | 12 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/liftarm/liftarm.pdf | bin | 2004786 -> 2192283 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/liftarm/liftarm.tex | 689 |
3 files changed, 405 insertions, 296 deletions
diff --git a/Master/texmf-dist/doc/latex/liftarm/README.md b/Master/texmf-dist/doc/latex/liftarm/README.md index 27594587175..af687942b75 100644 --- a/Master/texmf-dist/doc/latex/liftarm/README.md +++ b/Master/texmf-dist/doc/latex/liftarm/README.md @@ -1,20 +1,20 @@ -# liftarm +# `liftarm` -Draw liftarms with TikZ +## Geometric constructions with liftarms using Ti*k*Z and LaTeX3 -Version 2.0 (2022/04/07) +Version 3.0 (2024/05/20) -This package is based on the package TikZ and can be used to draw liftarms with TikZ. It provides several options for the appearance of the liftarms, a command which connects two liftarms, an environment to describe a construction and a method to animate a construction with one or more traces. +This package is based on the package [Ti*k*Z](https://ctan.org/pkg/pgf) and can be used to draw geometric constructions with liftarms using Ti*k*Z. There are several options for the appearance of the liftarms. It provides an environment to connect multiple liftarms using the Newton-Raphson method and LU decomposition. It also provides an environment to describe a construction and a method to animate a construction with one or more traces. %% README.md %% Copyright 2022 Matthias Floré % % This work may be distributed and/or modified under the -% conditions of the LaTeX Project Public License, either version 1.3 +% conditions of the LaTeX Project Public License, either version 1.3c % of this license or (at your option) any later version. % The latest version of this license is in % http://www.latex-project.org/lppl.txt -% and version 1.3 or later is part of all distributions of LaTeX +% and version 1.3c or later is part of all distributions of LaTeX % version 2005/12/01 or later. % % This work has the LPPL maintenance status `maintained'. diff --git a/Master/texmf-dist/doc/latex/liftarm/liftarm.pdf b/Master/texmf-dist/doc/latex/liftarm/liftarm.pdf Binary files differindex d428d1f7af2..eddb6d4f1da 100644 --- a/Master/texmf-dist/doc/latex/liftarm/liftarm.pdf +++ b/Master/texmf-dist/doc/latex/liftarm/liftarm.pdf diff --git a/Master/texmf-dist/doc/latex/liftarm/liftarm.tex b/Master/texmf-dist/doc/latex/liftarm/liftarm.tex index b45bb85793d..a7719fc9264 100644 --- a/Master/texmf-dist/doc/latex/liftarm/liftarm.tex +++ b/Master/texmf-dist/doc/latex/liftarm/liftarm.tex @@ -1,12 +1,12 @@ %% liftarm.tex -%% Copyright 2022 Matthias Floré +%% Copyright 2022-2024 Matthias Floré % % This work may be distributed and/or modified under the -% conditions of the LaTeX Project Public License, either version 1.3 +% conditions of the LaTeX Project Public License, either version 1.3c % of this license or (at your option) any later version. % The latest version of this license is in % http://www.latex-project.org/lppl.txt -% and version 1.3 or later is part of all distributions of LaTeX +% and version 1.3c or later is part of all distributions of LaTeX % version 2005/12/01 or later. % % This work has the LPPL maintenance status `maintained'. @@ -20,37 +20,42 @@ \usepackage{graphicx} \usepackage[a4paper,left=2.25cm,right=2.25cm,top=2.5cm,bottom=2.5cm,nohead]{geometry} \usepackage{parskip} +\usepackage{iftex} +\ifluatex +\else \usepackage[T1]{fontenc} \usepackage[utf8]{inputenc} +\fi \usepackage{mathtools} \usepackage{amssymb} \allowdisplaybreaks -\usepackage{multicol} +\usepackage{pdflscape} \usepackage{animate} \usepackage{liftarm} \input{pgfmanual-en-macros.tex} -\usepackage[page]{totalcount} +\usepackage{codehigh} \usepackage{fancyhdr} \pagestyle{fancy} \renewcommand{\headrulewidth}{0pt} -\cfoot{\iftotalpages\begin{tikzpicture}\liftarm[mark holes=\thepage-1]{0,0}{\totalpages-2}{0}\end{tikzpicture}\fi}%\liftarm{0,0}{\thepage}{0} \fancyhead{} +\fancyfoot[C]{\IfRefUndefinedExpandable{Thesourcecode}{}{\begin{tikzpicture}\liftarm[mark holes=\thepage -1]{0,0}{\getpagerefnumber{Thesourcecode}-2}{0}\end{tikzpicture}}}%\liftarm{0,0}{\thepage}{0} +\usepackage[nottoc]{tocbibind} \usepackage{imakeidx} \makeindex[program=makeindex,columns=2,intoc=true] \indexsetup{othercode={\thispagestyle{fancy}}} \usepackage[linktoc=all,pdfstartview=FitH,colorlinks=true,linkcolor=Mahogany,citecolor=ForestGreen,urlcolor=MidnightBlue,bookmarksnumbered=true]{hyperref} -\hypersetup{pdftitle={The liftarm package},pdfauthor={Matthias Flor\'e},pdfsubject={Manual},pdfkeywords={liftarm}} +\hypersetup{pdftitle={The liftarm package},pdfauthor={Matthias Floré},pdfsubject={Manual},pdfkeywords={liftarm}} \setcounter{tocdepth}{2} \setcounter{secnumdepth}{2} \DeclareMathOperator{\atan}{atan} -\title{The \texttt{liftarm} package\\[12pt]\large Draw liftarms with \tikzname} -\author{Matthias Flor\'e} -\date{Version 2.0 (2022/04/07)}%\\[12pt] +\title{The \texttt{liftarm} package\\[12pt]\large Geometric constructions with liftarms using \tikzname{} and \LaTeX3} +\author{Matthias Floré} +\date{Version 3.0 (2024/05/20)}%\\[12pt] \begin{document} \maketitle \thispagestyle{fancy} \begin{abstract} -\noindent This package is based on the package |tikz| (see \cite{TtTaPGFp}) and can be used to draw liftarms with \tikzname. It provides several options for the appearance of the liftarms, a command which connects two liftarms, an environment to describe a construction and a method to animate a construction with one or more traces.% This is the manual for version . +\noindent This package is based on the package |tikz| (see \cite{TtTaPGFp}) and can be used to draw geometric constructions with liftarms using \tikzname. There are several options for the appearance of the liftarms. It provides an environment to connect multiple liftarms using the Newton-Raphson method and LU decomposition. It also provides an environment to describe a construction and a method to animate a construction with one or more traces.% This is the manual for version . \end{abstract} \tableofcontents \section{Usage} @@ -58,7 +63,7 @@ The package |liftarm| can be used by putting the following in the preamble. \begin{codeexample}[code only] \usepackage{liftarm} \end{codeexample} -The package |liftarm| loads the packages |etoolbox|, |xcolor| with the option |dvipsnames|, |tikz| and the \tikzname{} library |calc|. Since |xcolor| is loaded with the option |dvipsnames|, packages such as |pgfplots| and |tcolorbox| must be loaded \emph{after} |liftarm|. +The package |liftarm| loads the package |xcolor| with the option |dvipsnames|, the package |tikz| and the \tikzname{} library |calc|. Since |xcolor| is loaded with the option |dvipsnames|, packages such as |pgfplots| and |tcolorbox| must be loaded \emph{after} |liftarm|. \section{Drawing liftarms} \begin{command}{\liftarm\opt{\oarg{options}}\marg{point}\marg{length}\marg{angle}} This command can be placed inside a |tikzpicture| environment. It draws a liftarm of \meta{length} starting at \meta{point}. The angle between the liftarm and the $x$-axis can be specified by \meta{angle} in degrees. The distance between the holes is $1$. @@ -84,53 +89,25 @@ If true, a brick will be drawn instead of a liftarm. \end{tikzpicture} \end{codeexample} \end{key} -\begin{key}{/liftarm/color=\marg{name}} -This key defines the color of the liftarm. The color can also be specified without key. -\begin{codeexample}[width=10cm] -\begin{tikzpicture} -\liftarm[color=Green]{0,1}{4}{0} -\liftarm[Blue]{0,2}{3}{0} -\end{tikzpicture} -\end{codeexample} -\end{key} -\begin{key}{/liftarm/color 0=\marg{name} (initially Gray)} -\end{key} -\begin{key}{/liftarm/color 1=\marg{name} (initially darkgray)} -\end{key} -\begin{key}{/liftarm/color 2=\marg{name} (initially Yellow)} -\end{key} -\begin{key}{/liftarm/color 3=\marg{name} (initially Orange)} -\end{key} -\begin{key}{/liftarm/color 4=\marg{name} (initially Red)} -\end{key} -\begin{key}{/liftarm/color 5=\marg{name} (initially Green)} -\end{key} -\begin{key}{/liftarm/color 6=\marg{name} (initially Blue)} -\end{key} -\begin{key}{/liftarm/color 7=\marg{name} (initially Brown)} -These keys define the colors of the liftarms which have as their length the number following |color|. +\begin{key}{/liftarm/color=\marg{number}\marg{color}} +This key defines the color of liftarms of length \meta{number}. + +Initially, the colors |Gray|, |darkgray|, |Yellow|, |Orange|, |Red|, |Green|, |Blue| and |Brown| are defined for respectively the lengths |0| till |7|. \end{key} \begin{key}{/liftarm/color modulo=\marg{number} (initially 8)} -The default colors of the liftarms are determined by computing the length of the liftarm modulo the value of this key and selecting the color from the previous keys. -\begin{codeexample}[width=10cm] -\begin{tikzpicture}[scale=0.5] -\foreach\n in {0,...,16}{ - \liftarm{0,-\n}{\n}{0} -} -\end{tikzpicture} -\end{codeexample} +The default colors of the liftarms are determined by computing the length of the liftarm modulo the value of this key and selecting the color defined by the key |color|. \begin{codeexample}[width=10cm] \begin{tikzpicture}[scale=0.5] \pgfkeys{ - /liftarm, - color 0=Yellow, - color 1=Red, - color 2=Green, - color 3=Blue, - color modulo=4 + /liftarm, + color={0}{Yellow}, + color={1}{Red}, + color={2}{Green}, + color={3}{Blue}, + color modulo=4 } \foreach\n in {0,...,8}{ - \liftarm{0,-\n}{\n}{0} + \liftarm{0,-\n}{\n}{0} } \end{tikzpicture} \end{codeexample} @@ -144,12 +121,28 @@ If true, a contour will be drawn around the liftarm. \end{tikzpicture} \end{codeexample} \end{key} -\begin{key}{/liftarm/coordinate=\marg{number 1/name 1}\dots} +\begin{stylekey}{/liftarm/contour style=\marg{options} (initially \normalfont empty)} +The style of the contour is determined as follows. First, the color is defined as \meta{initial color of the liftarm}|!75!black|. Then the option |ultra thick| is added. Thereafter, the style of the key |contour style| is added. + +The style |contour style| only applies to the border of the liftarm. The style |liftarm style| also applies to the holes of the liftarm. +\begin{codeexample}[width=10cm] +\begin{tikzpicture} +\liftarm[ + contour, + contour style={dashed,black} +]{0,1}{4}{0} +\liftarm[ + liftarm style={draw=black,thick} +]{0,2}{4}{0} +\end{tikzpicture} +\end{codeexample} +\end{stylekey} +\begin{key}{/liftarm/coordinate=\marg{number 1/name 1,\dots}} This key defines coordinates with name \meta{name i} at hole \meta{number i} of the liftarm. \begin{codeexample}[width=10cm] \begin{tikzpicture} \liftarm[ - coordinate={1/A,3/B} + coordinate={1/A,3/B} ]{0,1}{6}{40} \liftarm{A}{3}{0} \liftarm{B}{2}{180} @@ -164,40 +157,46 @@ The \meta{value} of this key, multiplied with the \meta{value} of the key |scale \end{tikzpicture} \end{codeexample} \end{key} +\begin{stylekey}{/liftarm/liftarm style=\marg{options} (initially \normalfont empty)} +The style of the liftarm is determined as follows. First, the color is defined by the keys |color| and |color modulo|. Thereafter, the style of the key |liftarm style| is added. +\end{stylekey} \begin{key}{/liftarm/liftarm thickness=\marg{value} (initially 0.92)} The \meta{value} of this key, multiplied with the \meta{value} of the key |scalefactor| defines the thickness of the liftarm. \begin{codeexample}[width=10cm] \begin{tikzpicture} \liftarm[ - hole radius=0.1, - liftarm thickness=0.3 + hole radius=0.1, + liftarm thickness=0.3 ]{0,0}{5}{0} \end{tikzpicture} \end{codeexample} \end{key} -\begin{key}{/liftarm/mark color=\marg{name} (initially Black)} -\end{key} \begin{key}{/liftarm/mark holes=\marg{values}} -The key |mark holes| defines the holes in the liftarm which will be marked. The key |mark color| defines the color of these marks. +\end{key} +\begin{key}{/liftarm/mark radius=\marg{factor} (initially 1)} +\end{key} +\begin{stylekey}{/liftarm/mark style=\marg{options} (initially \normalfont empty)} +The key |mark holes| defines the holes in the liftarm which will be marked. The radius is the product of the \meta{factor} given to the key |mark radius| and the value of the key |hole radius|. The style of these marks is determined as follows. First, the color is set to |black|. Thereafter, the style of the key |mark style| is added. \begin{codeexample}[width=10cm] \begin{tikzpicture} \liftarm[ - mark holes={0,1,3} + mark holes={0,1,3} ]{0,0}{5}{0} \liftarm[ - mark holes={1,2,4}, - mark color=Blue + mark holes={1,2,4}, + mark radius=2/3, + mark style=Blue ]{0,1}{4}{0} \end{tikzpicture} \end{codeexample} -\end{key} +\end{stylekey} \begin{key}{/liftarm/origin=\marg{number} (initially 0)} This key defines the number of the hole which will be placed at the coordinate given as argument to the liftarm. \begin{codeexample}[width=10cm] \begin{tikzpicture} \liftarm{-2,0}{4}{0} -\liftarm[origin=1]{0,0}{6}{30} -\liftarm[origin=2]{0,0}{5}{60} +\liftarm[origin=1]{0,0}{3}{30} +\liftarm[origin=2]{0,0}{5}{-20} \end{tikzpicture} \end{codeexample} \end{key} @@ -210,216 +209,254 @@ The \meta{value} of this key defines the factor which scales the thickness of th \end{tikzpicture} \end{codeexample} \end{key} -\begin{key}{/liftarm/screw color=\marg{name} (initially Black)} +\begin{key}{/liftarm/screw angle=\marg{angle} (initially 10)} \end{key} \begin{key}{/liftarm/screw holes=\marg{values}} \end{key} -\begin{key}{/liftarm/screw holes angle=\marg{angle} (initially 45)} -The key |screw holes| defines the holes in the liftarm where a screw will be drawn. The key |screw color| defines the color of these screws. The key |screw holes angle| defines the angle in degrees around which the screws are drawn. +\begin{key}{/liftarm/screw radius=\marg{factor} (initially 0.8)} +\end{key} +\begin{stylekey}{/liftarm/screw style=\marg{options} (initially \normalfont empty)} +The key |screw holes| defines the holes in the liftarm where a screw will be drawn. The angle of these screws is determined by the key |screw angle| which is an angle in degrees. The radius is the product of the \meta{factor} given to the key |screw radius| and the value of the key |hole radius|. The style of these screws is determined as follows. First, the color is set to |black|. Then the option |rotate=45| is added. Thereafter, the style of the key |screw style| is added. \begin{codeexample}[width=10cm] \begin{tikzpicture} \liftarm[ - screw holes={0,1,3} + screw holes={0,1,3} ]{0,0}{5}{0} \liftarm[ - screw holes={1,2,4}, - screw color=Blue, - screw holes angle=0 + screw angle=15, + screw holes={1,2,4}, + screw radius=0.7, + screw style={Blue,rotate=-45} ]{0,1}{4}{0} \end{tikzpicture} \end{codeexample} +\end{stylekey} +\begin{key}{/liftarm/type=\mchoice{liftarm,line segment} (initially liftarm)} +\begin{description} +\item[\texttt{liftarm}] In this case, the command |\liftarm| draws a liftarm. +\item[\texttt{line segment}] In this case, the command |\liftarm| draws a line segment. +\end{description} \end{key} \end{command} \section{Connecting liftarms} -\begin{command}{\liftarmconnect\opt{\oarg{options}}\marg{point1}\marg{length1}\marg{point2}\marg{length2}} -This command can be placed inside a |tikzpicture| environment. It draws a liftarm of \meta{length1} starting at \meta{point1} and a liftarm of \meta{length2} starting at \meta{point2} in such a way that their last holes have the same coordinate in case that such a point exists. If such a point does not exist then nothing is drawn. In case that there exist 2 such points then this point is chosen counterclockwise. In that case, the other configuration of the 2 liftarms can be obtained by simply swapping \marg{point1}\marg{length1} and \marg{point2}\marg{length2}. The keys for the command |\liftarm| can be given to the \meta{options}. In this case these keys will be passed to both liftarms. -\begin{codeexample}[width=9cm] +\begin{environment}{{liftarmconnect}\opt{\oarg{options}}} +This environment can be placed inside a |tikzpicture| environment. It can be used to connect liftarms where the angles are computed automatically. The \meta{options} can be a list of keys from the liftarm key family. + +The contents should consist only of commands |\liftarm| and spaces. + +The conditions to connect the liftarms are specified by the key |coordinate|. The resulting equations are determined automatically by the environment |liftarmconnect|. The number of liftarms needs to be equal to the number of equations. In the example below, there are 2 liftarms and 1 condition specified with the coordinate |A| resulting in 2 equations. +\begin{codeexample}[width=10cm] \begin{tikzpicture} -\coordinate (A) at (0,0); -\coordinate (B) at (4,2); -\coordinate (C) at (1,-3); -\coordinate (D) at (5,-1); -\liftarmconnect[Yellow]{A}{2}{B}{3} -\liftarmconnect[Red]{B}{3}{A}{2} -\liftarmconnect[Green]{C}{3}{D}{2} -\liftarmconnect[Blue]{D}{2}{C}{3} -\foreach\coord in {A,B,C,D}{ - \node at (\coord) {{\small $\coord$}}; -} +\coordinate (X) at (5,0); +\begin{liftarmconnect} + \liftarm[coordinate=4/A]{0,0}{4}{60} + \liftarm[coordinate=4/A]{X}{4}{120} +\end{liftarmconnect} \end{tikzpicture} \end{codeexample} -Additionally, the \meta{options} can be given with the following keys. -\begin{key}{/liftarm/connect coordinate=\marg{name}} -This key defines a coordinate with name \meta{name} at the connection point of both liftarms. -\begin{codeexample}[width=10cm] +The similar code below does not work because the coordinate |A| is used as the starting point of the second liftarm but is unknown since it is used in a condition for the first liftarm and furthermore, there is no liftarm to complement the condition involving |A| in the first liftarm. +\begin{codeexample}[code only] \begin{tikzpicture} -\liftarm{-3,0}{5}{0} -\liftarmconnect[ - connect coordinate=A -]{2,0}{2}{-2,0}{3} -\liftarm{A}{4}{180} +\coordinate (X) at (5,0); +\begin{liftarmconnect} + \liftarm[coordinate=4/A]{0,0}{4}{60} + \liftarm[coordinate=4/X]{A}{4}{-60} +\end{liftarmconnect} \end{tikzpicture} \end{codeexample} +If the environment |liftarmconnect| consists of 2 liftarms then the law of cosines is used to compute the angles. + +If there are more than 2 liftarms then the set of equations is solved with the Newton-Raphson method. The initial values for the angles are given by the last arguments of the commands |\liftarm|. The Jacobian matrix is defined by the environment |liftarmconnect|. The resulting set of linear equations is solved with LU decomposition. The iteration stops if the condition determined by the key |connect stop| is satisfied. + +Since the \emph{let operation} from the \tikzname{} library |calc| is used, it is not possible to use the variable names |\n|, |\p|, |\x| and |\y| inside the starting point of a command |\liftarm| which is used in the environment |liftarmconnect|. +\begin{key}{/liftarm/connect stop=\mchoice{1-norm,2-norm,iterations} (initially 1-norm)} +\begin{description} +\item[\texttt{1-norm}] In this case, the iteration stops if the 1-norm is smaller than the value given to this key. Its default value is $0.001$. +\item[\texttt{2-norm}] In this case, the iteration stops if the 2-norm is smaller than the value given to this key. Its default value is $0.001$. +\item[\texttt{iterations}] In this case, a number of iterations is executed where the number is the one given to this key. Its default value is $10$. +\end{description} \end{key} -\begin{key}{/liftarm/connect reverse=\opt{\meta{boolean}} (default true, initially false)} -If true, the first liftarm of |\liftarmconnect| will be drawn second and the second liftarm will be drawn first. This option can be used to change the appearance at the connection point of both liftarms. \begin{codeexample}[width=10cm] \begin{tikzpicture} -\liftarmconnect{2,0}{1}{0,0}{2} -\liftarmconnect[ - connect reverse -]{5,0}{1}{3,0}{2} +\begin{liftarmconnect} + \liftarm[coordinate=2/A]{0,0}{2}{70} + \liftarm[coordinate=3/A]{4,0}{3}{120} +\end{liftarmconnect} +\begin{liftarmconnect} + \liftarm[coordinate=4/B]{4,0}{4}{200} + \liftarm[coordinate=1/B]{0,0}{1}{-90} +\end{liftarmconnect} +\node at (A) {\small $A$}; +\node at (B) {\small $B$}; \end{tikzpicture} \end{codeexample} -\end{key} -\begin{stylekey}{/liftarm/liftarm 1=\marg{options} (initially \normalfont empty)} -\end{stylekey} -\begin{stylekey}{/liftarm/liftarm 2=\marg{options} (initially \normalfont empty)} -These keys accept a list of keys which will be applied to the first respectively second liftarm. These lists of keys accept the same options as the command |\liftarm|. Additionally, the key |connect| below can be given. -\begin{key}{/liftarm/connect=\marg{number}} -This key defines the number of the hole which will be connected to the matching liftarm. If this key is not given then the last hole of the liftarm is taken as the connecting point. -\begin{codeexample}[width=10cm] +The example below shows the regular pentagon from \cite{Tmm1}. In the first environment |liftarmconnect| there are $4$ liftarms and $2$ conditions resulting in $4$ equations. Hence the Jacobian matrix has size $4\times 4$. +\begin{codeexample}[width=7cm] +\begin{tikzpicture}[scale=0.5] +\pgfkeys{/liftarm,liftarm style={draw=black},scalefactor=1} +\liftarm{0,0}{3}{0} +\begin{liftarmconnect} + \liftarm[coordinate={3/A,4/B,12/C}]{0,0}{12}{100} + \liftarm[coordinate={3/D,4/E,12/F}]{3,0}{12}{80} + \liftarm[coordinate=11/F]{B}{11}{60} + \liftarm[coordinate=11/C]{E}{11}{120} +\end{liftarmconnect} +\begin{liftarmconnect} + \liftarm[coordinate=3/G]{A}{3}{30} + \liftarm[coordinate=3/G]{D}{3}{150} +\end{liftarmconnect} +\end{tikzpicture} +\end{codeexample} +The example below shows iterations $0$ till $3$ of a construction with $6$ liftarms and $3$ conditions resulting in $6$ equations. Hence the Jacobian matrix has size $6\times 6$. +\begin{codeexample}[] \begin{tikzpicture} -\liftarm{0,-7}{10}{90} -\liftarmconnect[ - connect coordinate=A, - liftarm 1={ - origin=1, - connect=5 - }, - liftarm 2={ - origin=2, - connect=6 - } -]{0,2}{6}{0,0}{7} -\liftarmconnect[ - liftarm 1={ - origin=2, - connect=8 - }, - liftarm 2={ - origin=1, - connect=5, - coordinate=4/B - } -]{A}{9}{0,-6}{6} -\liftarm[origin=1]{B}{4}{70} +\liftarm{0,0}{15}{0} +\liftarm{0,5}{15}{0} +\foreach\k in {0,...,3}{ + \begin{scope}[shift={(\k*4,0)}] + \begin{liftarmconnect}[connect stop={iterations=\k},liftarm style=ultra thick,type=line segment] + \liftarm[coordinate=3/A]{1,0}{3}{90} + \liftarm[coordinate=3/B]{3,0}{3}{90} + \liftarm[coordinate=1/B]{A}{1}{0} + \liftarm[coordinate=1/C]{A}{1}{70} + \liftarm[coordinate=1/C]{B}{1}{110} + \liftarm[coordinate=2/C]{0,5}{2}{0} + \end{liftarmconnect} + \node at (1.5,-1) {\texttt{iterations=\k}}; + \end{scope} +} \end{tikzpicture} \end{codeexample} -\end{key} -\end{stylekey} -\end{command} +The example below shows the regular heptagon from \cite{Tmm1}. In the first environment |liftarmconnect| there are $8$ liftarms and $4$ conditions resulting in $8$ equations. Hence the Jacobian matrix has size $8\times 8$. +\begin{codeexample}[width=8cm] +\begin{tikzpicture}[scale=0.4] +\pgfkeys{/liftarm,scalefactor=1} +\liftarm{-4,0}{8}{0} +\begin{liftarmconnect} + \liftarm[coordinate={1/A,7/B,8/G}]{-4,0}{8}{135} + \liftarm[coordinate=11/F]{A}{11}{50} + \liftarm[coordinate=11/F]{B}{11}{20} + \liftarm[coordinate={1/C,7/D,8/H}]{4,0}{8}{45} + \liftarm[coordinate=11/E]{C}{11}{130} + \liftarm[coordinate=11/E]{D}{11}{160} + \liftarm[coordinate=8/E]{G}{8}{30} + \liftarm[coordinate=8/F]{H}{8}{150} +\end{liftarmconnect} +\begin{liftarmconnect} + \liftarm[coordinate=8/I]{E}{8}{70} + \liftarm[coordinate=8/I]{F}{8}{110} +\end{liftarmconnect} +\begin{liftarmconnect} + \liftarm[coordinate=8/J]{G}{8}{70} + \liftarm[coordinate=8/J]{I}{8}{210} +\end{liftarmconnect} +\begin{liftarmconnect} + \liftarm[coordinate=8/K]{H}{8}{110} + \liftarm[coordinate=8/K]{I}{8}{-30} +\end{liftarmconnect} +\end{tikzpicture} +\end{codeexample} +\end{environment} \section{Describing a construction} -If a construction involves many liftarms then it is convenient to describe this construction in separate steps and |tikzpicture|s. Then the content of previous |tikzpicture|s would need to be copied in each new |tikzpicture|. This process can be automated by using the |liftarmconstruction| environment and the command |\liftarmconstruct| below. -\begin{environment}{{liftarmconstruction}\opt{\oarg{options}}} -This environment is in fact an |enumerate| environment with the addition that it resets the content of the |tikzpicture| which is displayed by the command |\liftarmconstruct| below. Thus in particular, |\item| can be used inside the |liftarmconstruction| environment. The \meta{options} will be passed to each |tikzpicture| drawn by the command |\liftarmconstruct| inside this environment. The following command can be used inside this environment. -\begin{command}{\liftarmconstruct\opt{\oarg{options}}\marg{text}\marg{commands}} -This command starts an |\item| and shows \meta{text}. Then it displays a |tikzpicture| containing \meta{commands} and also the \meta{commands} of previous |\liftarmconstruct| commands inside the same |liftarmconstruction| environment. The \meta{options} will be added to this |tikzpicture| but \emph{only} in the current step. +If a construction involves many liftarms then it is convenient to describe this construction in separate steps. Then the content of previous steps would need to be copied in each new step. This process can be automated by using the command |\liftarmconstruct| below. +\begin{command}{\liftarmconstruct\marg{commands}} +This command appends \meta{commands} to an internal token list. Then it uses this token list. +\end{command} +\begin{command}{\liftarmconstructclear} +This command clears the token list which is used by the command |\liftarmconstruct|. As an example, we describe below the construction of a regular pentagon from \cite{Tmm1}. -\begin{codeexample}[width=10cm] -\begin{minipage}{0.5\linewidth}%only for -%usage in this manual%\linewidth-6pt -%\begin{multicols}{2}%only for -%usage in this manual -\begin{liftarmconstruction}[scale=0.75] -\liftarmconstruct[ - {\node[left,align=left] - at (-0.5,-1.3) - {Rectangular triangle.\\ - This text is only\\ - visible in this step.};} -]{ - We start with 3 liftarms to form - a rectangular triangle. -}{ -\liftarm{-3,0}{4}{0} -\liftarmconnect[ - liftarm 1={ - origin=2, - mark holes={2,6} - }, - liftarm 2={ - mark holes=0 - } -]{0,0}{6}{-3,0}{5}} -\item An |\item| can be added since this - is an |enumerate| environment. +\begin{codeexample}[width=7cm] +\begin{minipage}{5.5cm}%only for usage in this manual +\liftarmconstructclear +\begin{enumerate} +\item First we form a rectangular triangle with 3 liftarms. +\begin{center} +\begin{tikzpicture}[scale=0.7] \liftarmconstruct{ - Now we add 2 liftarms of length $3$. -}{\liftarmconnect[ - connect coordinate=A, - liftarm 1={ - mark holes={0,3} - }, - liftarm 2={ - mark holes=0 - } -]{0,-2}{3}{0,2}{3}} + \liftarm[mark holes=3]{-3,0}{4}{0} + \begin{liftarmconnect} + \liftarm[coordinate=6/A,origin=2]{0,0}{6}{90} + \liftarm[coordinate=5/A,mark holes={0,5}]{-3,0}{5}{60} + \end{liftarmconnect} +} +\end{tikzpicture} +\end{center} +\item Then we add 2 liftarms of length $3$. +\begin{center} +\begin{tikzpicture}[scale=0.7] \liftarmconstruct{ - In this step we construct the first - side of the regular pentagon. -}{\liftarmconnect[ - connect coordinate=B, - liftarm 2={ - mark holes={0,2} - } -]{A}{2}{1,0}{2}} + \begin{liftarmconnect} + \liftarm[coordinate=3/B,mark holes={0,3}]{0,-2}{3}{45} + \liftarm[coordinate=3/B,mark holes=0]{0,2}{3}{-45} + \end{liftarmconnect} +} +\end{tikzpicture} +\end{center} +\item Here appears the first side of the regular pentagon. +\begin{center} +\begin{tikzpicture}[scale=0.7] \liftarmconstruct{ - Now we finish the construction - of the regular pentagon. -}{\liftarmconnect[ - liftarm 2={ - mark holes={0,2} - } -]{B}{2}{-1,0}{2} -\liftarmconnect[ - liftarm 1={ - mark holes=2 - } -]{-1,0}{2}{A}{2}} -\end{liftarmconstruction} -%\end{multicols} + \begin{liftarmconnect} + \liftarm[coordinate=2/C]{B}{2}{100} + \liftarm[coordinate=2/C,mark holes={0,2}]{1,0}{2}{80} + \end{liftarmconnect} +} +\end{tikzpicture} +\end{center} +\item Now we end the construction of the regular pentagon. +\begin{center} +\begin{tikzpicture}[scale=0.7] +\liftarmconstruct{ + \begin{liftarmconnect} + \liftarm[coordinate=2/D]{C}{2}{180} + \liftarm[coordinate=2/D,mark holes={0,2}]{-1,0}{2}{80} + \end{liftarmconnect} + \begin{liftarmconnect} + \liftarm[coordinate=2/E,mark holes=2]{-1,0}{2}{-80} + \liftarm[coordinate=2/E]{B}{2}{210} + \end{liftarmconnect} +} +\end{tikzpicture} +\end{center} +\end{enumerate} \end{minipage} \end{codeexample} \end{command} -\end{environment} \section{Animations} \begin{command}{\liftarmanimate\opt{\oarg{options}}\marg{frame rate}\marg{list}\marg{command}} -This command shows an animation using the |animateinline| environment of the package |animate|. The package |animate| is \emph{not} loaded by default and needs to be loaded to use the command |\liftarmanimate|. The \meta{options} are passed to the |animateinline| environment. The \meta{frame rate} of the animation is described in the documentation of the package |animate|. The \meta{command} must be a previously defined command with one mandatory argument. The \meta{list} is passed to a |\foreach| loop. The frames of the animation consist of the \meta{command} evaluated one by one in the result of the |\foreach| loop. The command |\liftarmanimate| creates a timeline which is used in the |animateinline| environment. This timeline is stored in the file |liftarm|\meta{number of the animation in the document}|.tln|. It requires two compiler runs to create and use this timeline correctly. +This command shows an animation using the |animateinline| environment of the package |animate|. The package |animate| is \emph{not} loaded by default and needs to be loaded to use the command |\liftarmanimate|. The \meta{options} are passed to the |animateinline| environment. The \meta{frame rate} of the animation is described in the documentation of the package |animate|. The \meta{command} must be a previously defined command with one mandatory argument. The \meta{list} is passed to a |\foreach| loop. The frames of the animation consist of the \meta{command} evaluated one by one in the result of the |\foreach| loop. The command |\liftarmanimate| creates a timeline which is used in the |animateinline| environment. This timeline is stored in the file \meta{job name}\meta{number of the animation in the document}|.tln|. It requires two compiler runs to create and use this timeline correctly. \begin{key}{/liftarm/trace=\marg{number/number of frames/code}\dots} This key draws \meta{code} at hole \meta{number} of the liftarm on the frames of the animation determined by \meta{number of frames}. If \meta{number of frames} is 0 then the \meta{code} is drawn starting at the current frame until the end of the animation. If \meta{number of frames} is an integer greater than or equal to 1 then the \meta{code} is drawn starting at the current frame and remaining during the next frames determined by \meta{number of frames}. If \meta{number of frames} is left empty then the \meta{code} is drawn starting at the beginning of the animation until the end of the animation. -The \meta{code} can be some \tikzname{} code. In this \meta{code}, $(0,0)$ is positioned at hole \meta{number} of the liftarm. If \meta{code} is left empty then the following code is used. -\begin{codeexample}[code only] -\fill[Black] (0,0) circle[radius=0.66*\liftarm@holeradius]; -\end{codeexample} +The \meta{code} can be some \tikzname{} code. In this \meta{code}, $(0,0)$ is positioned at hole \meta{number} of the liftarm. If \meta{code} is left empty then a black circle with radius $\frac{2}{3}$ times the |hole radius| is used. + A list of multiple triples \meta{number/number of frames/code} can be given to the key |trace|. \begin{codeexample}[width=10cm,preamble={\usepackage{animate}}] \newcommand{\exampleliftarmanimate}[1]{ - \liftarm[ - origin=1, - mark holes=1, - trace={ - 2/0/, - 3//, - 4/3/{\fill[Blue] (0,0) - circle[radius=0.15];} - } - ]{0,0}{4}{#1} + \liftarm[ + origin=1, + mark holes=1, + trace={ + 2/0/, + 3//, + 4/3/{\fill[Blue] (0,0) + circle[radius=0.15];} + } + ]{0,0}{4}{#1} } \liftarmanimate[ - autoplay, - controls, - loop, - begin={ - \begin{tikzpicture} - \useasboundingbox (-4,-4) - rectangle (4,4); - }, - end={\end{tikzpicture}} + autoplay, + controls, + loop, + begin={ + \begin{tikzpicture} + \useasboundingbox (-4,-4) + rectangle (4,4); + }, + end={\end{tikzpicture}} ] {5} {0,30,...,330} @@ -429,11 +466,14 @@ A list of multiple triples \meta{number/number of frames/code} can be given to t \end{command} \section{Additional examples} The following example shows a regular hexagon. -\begin{codeexample}[width=9cm] +\begin{codeexample}[width=8cm] \begin{tikzpicture} \def\r{3} -\foreach\n in {1,...,6}{ - \liftarmconnect{0,0}{\r}{\n*60:\r}{\r} +\foreach\m in {1,...,6}{ + \begin{liftarmconnect} + \liftarm[coordinate=\r/A]{0,0}{\r}{(\m+1)*60} + \liftarm[coordinate=\r/A]{\m*60:\r}{\r}{(\m+2)*60} + \end{liftarmconnect} } \end{tikzpicture} \end{codeexample} @@ -448,18 +488,6 @@ The following example illustrates that $2\atan(\frac{1}{2})=\atan(\frac{4}{3})$. \liftarm{2,1}{1}{90+atan(4/3)} \end{tikzpicture} \end{codeexample} -Below is an example of an angled liftarm. -\begin{codeexample}[width=9cm] -\begin{tikzpicture} -\pgfkeys{ - /liftarm, - scalefactor=1, - Blue -} -\liftarm[axle holes=0]{0,0}{3}{0} -\liftarm[axle holes=5]{3,0}{5}{atan(4/3)} -\end{tikzpicture} -\end{codeexample} The following example illustrates an angle bisection. \begin{codeexample}[width=9cm] \begin{tikzpicture} @@ -468,26 +496,45 @@ The following example illustrates an angle bisection. \liftarm[mark holes={0,\r}]{0,0}{2*\r}{0} \liftarm[mark holes=\r]{0,0}{2*\r}{\ang} \liftarm[ - mark holes=\r, - mark color=Red + mark holes=\r, + mark style=Red ]{\r,0}{\r}{\ang} \liftarm{\ang:\r}{\r}{0} \end{tikzpicture} \end{codeexample} +The following example illustrates that $7^{2}=3^{2}+8^{2}-2\cdot 3\cdot 8\cos(\frac{\pi}{3})$. +\begin{codeexample}[width=9cm] +\begin{tikzpicture} +\begin{liftarmconnect} + \liftarm[coordinate=3/A]{0,0}{3}{80} + \liftarm[coordinate=3/A]{3,0}{3}{100} +\end{liftarmconnect} +\begin{liftarmconnect} + \liftarm[coordinate=8/B]{0,0}{8}{0} + \liftarm[coordinate=7/B]{A}{7}{0} +\end{liftarmconnect} +\end{tikzpicture} +\end{codeexample} The following example illustrates that $7^{2}+4^{2}=8^{2}+1^{2}$. \begin{codeexample}[width=9cm] -\begin{tikzpicture}[scale=0.75] +\begin{tikzpicture} \def\a{4} \def\b{7} \def\c{1} \def\d{8} %\liftarm{0,0}{\b}{0} %\liftarm{\b,0}{\a}{90} -\liftarmconnect{0,0}{\b}{\b,\a}{\a} +\begin{liftarmconnect} + \liftarm[coordinate=\b/A]{0,0}{\b}{0} + \liftarm[coordinate=\a/A]{\b,\a}{\a}{-90} +\end{liftarmconnect} \liftarm{4,0}{3}{90} %\liftarm{\b,\a}{1}{atan(\a/\b)+atan(\c/\d)+90} %\liftarm{0,0}{\d}{atan(\a/\b)+atan(\c/\d)} -\liftarmconnect{\b,\a}{\c}{0,0}{\d} +\begin{liftarmconnect} + \liftarm[coordinate=\d/B]{0,0}{\d}{45} + \liftarm[coordinate=\c/B]{\b,\a}{\c}{135} +\end{liftarmconnect} \end{tikzpicture} \end{codeexample} Below is an animation of the Peaucellier-Lipkin linkage, see e.g.~\cite{Koagmopermbl}. @@ -497,31 +544,35 @@ Below is an animation of the Peaucellier-Lipkin linkage, see e.g.~\cite{Koagmope \def\a{3} \def\b{4} \def\c{9} -\pgfmathsetmacro{\x}{ - 2*\a+((\c^2-\b^2-(2*\a)^2)/(2*\a)) +\edef\l{ + \fpeval{2*\a+(\c^2-\b^2-(2*\a)^2)/(2*\a)} } \useasboundingbox (-0.23,-6) rectangle - ({\x+0.23},6); -\draw (\x,-5)--(\x,5); + (\l+0.23,6); +\draw (\l,-5)--(\l,5); \liftarm{0,0}{\a}{0} \liftarm[coordinate=\a/A]{\a,0}{\a}{#1} -\liftarmconnect[ - connect coordinate=B, - connect reverse -]{A}{\b}{0,0}{\c} -\liftarmconnect[ - connect coordinate=C -]{0,0}{\c}{A}{\b} -\liftarmconnect{C}{\b}{B}{\b} +\begin{liftarmconnect} + \liftarm[coordinate=\c/B]{0,0}{\c}{0} + \liftarm[coordinate=\b/B]{A}{\b}{90} +\end{liftarmconnect} +\begin{liftarmconnect} + \liftarm[coordinate=\c/C]{0,0}{\c}{0} + \liftarm[coordinate=\b/C]{A}{\b}{-90} +\end{liftarmconnect} +\begin{liftarmconnect} + \liftarm[coordinate=\b/D]{C}{\b}{0} + \liftarm[coordinate=\b/D]{B}{\b}{0} +\end{liftarmconnect} \end{tikzpicture} } \begin{animateinline}[ - autoplay, - controls, - palindrome + autoplay, + controls, + palindrome ]{30} \multiframe{80}{rAng=-40+1}{ - \PLlinkage{\rAng} + \PLlinkage{\rAng} } \end{animateinline} \end{codeexample} @@ -534,13 +585,19 @@ Below is an animation of Kempe's trisector, as shown in \cite{Tmm3}. \liftarm[coordinate=12/B]{0,0}{27}{180-(#1)} \liftarm[coordinate=18/C]{0,0}{27}{180-2*(#1)} \liftarm[coordinate=27/D]{0,0}{27}{180-3*(#1)} -\liftarmconnect{C}{27}{D}{18} -\liftarmconnect[liftarm 2={connect=8}]{A}{12}{B}{18} +\begin{liftarmconnect} + \liftarm[coordinate=27/E]{C}{27}{0} + \liftarm[coordinate=18/E]{D}{18}{0} +\end{liftarmconnect} +\begin{liftarmconnect} + \liftarm[coordinate=12/F]{A}{12}{0} + \liftarm[coordinate=8/F]{B}{18}{0} +\end{liftarmconnect} \end{tikzpicture} } \begin{animateinline}[autoplay,controls,palindrome]{5} \multiframe{20}{rAng=15+1}{ -\trisector{\rAng} + \trisector{\rAng} } \end{animateinline} \end{codeexample} @@ -549,40 +606,85 @@ Below is an animation of Chebyshev's Lambda Mechanism. \newcommand{\CL}[1]{ \liftarm{0,0}{4*\r}{0} \liftarm[ - mark holes={0,2*\r} + mark holes={0,2*\r} ]{0,0}{2*\r}{#1} -\liftarmconnect[ - liftarm 1={mark holes={0,5*\r}}, - liftarm 2={ - connect=5*\r, - mark holes=10*\r, - mark color=Red, - trace={6*\r/0/,10*\r//} - } -]{4*\r,0}{5*\r}{#1:2*\r}{10*\r} +\begin{liftarmconnect} + \liftarm[ + coordinate=5*\r/A, + mark holes={0,5*\r} + ]{4*\r,0}{5*\r}{90} + \liftarm[ + coordinate=5*\r/A, + mark holes=10*\r, + mark style=Red, + trace={6*\r/0/,10*\r//} + ]{#1:2*\r}{10*\r}{90} +\end{liftarmconnect} } \liftarmanimate[ - autoplay, - controls, - loop, - begin={ - \begin{tikzpicture}[scale=0.8] - \def\r{1} - \useasboundingbox - (-2*\r-0.5,-2*\r-0.5) - rectangle - (10*\r-0.5,10*\r+0.5); - }, - end={\end{tikzpicture}} + autoplay, + controls, + loop, + begin={ + \begin{tikzpicture}[scale=0.8] + \def\r{1} + \useasboundingbox + (-2*\r-0.5,-2*\r-0.5) + rectangle + (10*\r-0.5,10*\r+0.5); + }, + end={\end{tikzpicture}} ] {20} {0,5,...,355} {\CL} \end{codeexample} +Below is an animation of a multilink steering mechanism. +\begin{codeexample}[preamble={\usepackage{animate}}] +\newcommand{\multilink}[1]{ +\begin{tikzpicture}[scale=0.9] +\useasboundingbox (-8.5,-0.5) rectangle (8.5,5.7); +\liftarm[brick,screw holes={0,6}]{-3,0}{6}{0} +\liftarm[brick,screw holes={0,6}]{-3,3}{6}{0} +\liftarm[coordinate={0/X,6/Y},screw holes={0,6}]{{-3+(#1)*0.1},4}{6}{0} +\begin{liftarmconnect} + \liftarm[coordinate=3/A]{-3,0}{3}{160} + \liftarm[coordinate=3/B]{-3,3}{3}{200} + \liftarm[coordinate={1/B,4/C},screw holes={0,1,4}]{A}{4}{90} + \liftarm[coordinate=3/C]{X}{3}{180} +\end{liftarmconnect} +\begin{liftarmconnect} + \liftarm[coordinate=3/D]{3,0}{3}{20} + \liftarm[coordinate=3/E]{3,3}{3}{-20} + \liftarm[coordinate={1/E,4/F},screw holes={0,1,4}]{D}{4}{90} + \liftarm[coordinate=3/F]{Y}{3}{0} +\end{liftarmconnect} +\end{tikzpicture} +} +\begin{animateinline}[autoplay,controls,palindrome]{10} +\multiframe{41}{rAng=-20+1}{ + \multilink{\rAng} +} +\end{animateinline} +\end{codeexample} \section{Version history} \begin{itemize} \item[] \textbf{Version 1.0 (2022/03/08)} First version. -\item[] \textbf{Version 2.0 (2022/04/07)} Removed some redundant |;| in the code.\footnote{Thanks to Denis Bitouz\'e for pointing this out.} Added the command |\liftarmanimate| and the key |trace|. +\item[] \textbf{Version 2.0 (2022/04/07)} Removed some redundant |;| in the code.\footnote{Thanks to Denis Bitouzé for pointing this out.} Added the command |\liftarmanimate| and the key |trace|. +\item[] \textbf{Version 3.0 (2024/05/20)} +\begin{itemize} +\item The package now mainly uses \LaTeX3 syntax. The package |etoolbox| is not loaded anymore. +\item Improved the code for the key |axle holes|. In particular, the combinations with the keys |contour| and |hole radius| are fixed. +\item Improved the path for the shape of a liftarm if the key |brick| is used. +\item Changed the key |color| to accept two arguments. The color can no longer be specified without a key. +\item Removed the keys |color 0|, |color 1|, |color 2|, |color 3|, |color 4|, |color 5|, |color 6| and |color 7|. +\item In v2.0, the colors could only be defined up to length $7$. In v3.0, this is not a restriction anymore. +\item Changed some initial colors from |Black| to |black|. +\item Added the keys |contour style| and |liftarm style|. +\item Removed the keys |mark color|, |screw color| and |screw holes angle|. Added the keys |mark radius|, |mark style|, |screw angle|, |screw radius| and |screw style|. +\item Improved the algorithm to connect liftarms in multiple ways. In v2.0, transformations such as |x={(0.8,0.5)},y={(-0.6,1.2)}| were not taken into account correctly. This is fixed in v3.0. In v2.0, only 2 liftarms could be connected automatically. In v3.0, this is not a restriction anymore. Therefore the command |\liftarmconnect| and the keys |connect|, |connect coordinate|, |connect reverse|, |liftarm 1| and |liftarm 2| are removed. Instead, the environment |liftarmconnect| and the key |connect stop| were added in v3.0. +\item Changed the command |\liftarmconstruct| to allow more customization. Removed the environment |liftarmconstruction| and added the command |\liftarmconstructclear|. +\end{itemize} \end{itemize} \begin{thebibliography}{9} \bibitem{Tmm1} @@ -607,9 +709,16 @@ Alfred Bray Kempe, \bibitem{TtTaPGFp} Till Tantau, \emph{The \tikzname{} and {\upshape\pgfname} Packages}, -Manual for version 3.1.9a, +Manual for version 3.1.10, \url{https://ctan.org/pkg/pgf}, -2021. +2023. \end{thebibliography} \printindex +\newgeometry{left=2.25cm,right=2.25cm,top=2.25cm,bottom=2.25cm} +\pagestyle{plain} +\appendix +\begin{landscape} +\section{The source code}\label{Thesourcecode} +\dochighinput[language=latex/latex3]{liftarm.sty} +\end{landscape} \end{document}
\ No newline at end of file |