summaryrefslogtreecommitdiff
path: root/graphics/pstricks/contrib/pst-optic/doc/pst-optic-doc.tex
diff options
context:
space:
mode:
Diffstat (limited to 'graphics/pstricks/contrib/pst-optic/doc/pst-optic-doc.tex')
-rw-r--r--graphics/pstricks/contrib/pst-optic/doc/pst-optic-doc.tex65
1 files changed, 50 insertions, 15 deletions
diff --git a/graphics/pstricks/contrib/pst-optic/doc/pst-optic-doc.tex b/graphics/pstricks/contrib/pst-optic/doc/pst-optic-doc.tex
index 275db43b5a..5ec11a0297 100644
--- a/graphics/pstricks/contrib/pst-optic/doc/pst-optic-doc.tex
+++ b/graphics/pstricks/contrib/pst-optic/doc/pst-optic-doc.tex
@@ -1,4 +1,4 @@
-%% $Id: pst-optic-doc.tex 717 2023-05-07 18:46:46Z herbert $
+%% $Id: pst-optic-doc.tex 903 2024-06-02 06:16:43Z herbert $
\DocumentMetadata{}
\documentclass[11pt,english,bibliography=totoc,parskip=false,headings=small,
@@ -10,6 +10,7 @@
\let\belowcaptionskip\abovecaptionskip
%
%\usepackage[style=dtk]{biblatex}
+%\addbibresource[location=remote]{https://mirror.ctan.org/biblio/ctan-bibdata/ctan.bib}
\addbibresource{\jobname.bib}
\begin{document}
@@ -44,7 +45,8 @@ of having older versions, go to \url{http://www.CTAN.org/} and load the newest v
\vfill\noindent
Thanks to: \\
Jean-C\^ome Charpentier,
-Arnaud Schmittbuhl.
+Arnaud Schmittbuhl,
+Keno Wehr
\end{abstract}
\section{General Options}
@@ -129,10 +131,35 @@ It can be overwritten in the same way with \Lcs{newpsstyle}.
There are macros for the convergent and divergent lens
\begin{BDef}
\Lcs{lens}\OptArgs\\
-\Lcs{lensCVG}\OptArgs\% \textbf{C}on\textbf{v}er\textbf{g}ent (Collecting lens ) -- default\\
-\Lcs{lensDVG}\OptArgs\% \textbf{D}i\textbf{v}er\textbf{g}ent (Scatter lens )
+\Lcs{lensCVG} \% \textbf{C}on\textbf{v}er\textbf{g}ent (Collecting lens ) -- default\\
+\Lcs{lensDVG} \% \textbf{D}i\textbf{v}er\textbf{g}ent (Scatter lens )\\
+\Lcs{pslensCVG}\OptArgs \Largb{lens width}\Largb{lens height}\\
+\Lcs{pslensDVG}\OptArgs \Largb{lens width}\Largb{lens height}\\
\end{BDef}
+
+% \psscalebox{\psk@optic@lensScale}{%
+% \pscustom[linewidth=0.75\pslinewidth]{%
+% \pslensCVG{\psk@optic@lensWidth}{\psk@optic@lensHeight}
+% \fill[fillstyle=solid,fillcolor=BleuVerre]
+
+
+The predefined options for \Lcs{lens} are \texttt{xLeft=-7.5, xRight=7.5, yBottom=-3, yTop=3}.
+
+
+\subsection{Short forms}
+The two macros \Lcs{lensCVG} and \Lcs{lensDVG} draw some more rays as the main macro \Lcs{lens}
+with the setting \Lkeyval{lensType}\texttt{=CVG|DVG}.
+The only valid arguments are \Lkeyword{lensScale}, \Lkeyword{lensWidth}, and \Lkeyword{lensHeight},
+which must be set by \Lcs{psset}.
+
+%\begin{verbatim}
+%lensType=CVG, OA=-7, lensHeight=6, lensWidth=1.5, refractB=2
+%\end{verbatim}
+
+The two macros \Lcs{pslensCVG} and \Lcs{pslensDVG} have two mandatory
+arguments: lens width and lens height.
+
\subsection{The Coordinates of the predefined Nodes}
The following figure shows the coordinates of the predefined nodes (see Table~\ref{tab:generalOptions}).
@@ -157,6 +184,9 @@ The following figure shows the coordinates of the predefined nodes (see Table~\r
\end{pspicture*}}
\captionof{figure}{Coodinates of the predefined Nodes}\label{fig:nodes}
+
+\clearpage
+
\subsection{The Lens Type}
\begin{LTXexample}[wide=false]
@@ -171,7 +201,7 @@ The following figure shows the coordinates of the predefined nodes (see Table~\r
\vspace*{-2ex}
\captionof{figure}{Plan Collecting lens}
-\enlargethispage{2ex}
+%\enlargethispage{2ex}
\begin{LTXexample}[wide=false]
\psscalebox{0.75}{\lens[lensType=DVG,focus=-2,spotAi=270,spotBi=90]}
@@ -185,7 +215,7 @@ The following figure shows the coordinates of the predefined nodes (see Table~\r
\vspace*{-2ex}
\captionof{figure}{Plan Scatter lens}
-\clearpage
+%\clearpage
Using \Lcs{lens}\OptArg{\Lkeyword{lensType}=\ldots} gives the in figures \ref{fig:defaultCVG} and
\ref{fig:defaultDVG} shown lenses with the default values from Table~\ref{tab:defaultLens}.
@@ -204,17 +234,18 @@ Using \Lcs{lens}\OptArg{\Lkeyword{lensType}=\ldots} gives the in figures \ref{fi
Lense height in cm & \Lkeyword{lensHeight} & 5cm\\
Lense width in cm & \Lkeyword{lensWidth} & 0.5cm\footnotemark\\
vertical scale (obsolet) & \Lkeyword{lensScale} & 1\\
- View the lens & \Lkeyword{lensGlass} & \false\\
- show onyl the rays & \Lkeyword{onlyrays} & \false\\
+ View the lens & \Lkeyword{lensGlass} & \true\\
+ show only the rays & \Lkeyword{onlyrays} & \false\\
Second lens & \Lkeyword{lensTwo} & \false\\
Focus in cm & \Lkeyword{focus} & 2\\
- Distance $\mathrm{\overline{OA}}$& \Lkeyword{OA} & -4\\
- Distance $\mathrm{\overline{AB}}$& \Lkeyword{AB} & 1.5\\
- Lens color & \Lkeyword{lenscolor} & \black\\
- Arrow length in cm & \Lkeyword{lensarrowsize} & 0.2\\
- Arrow inset in cm & \Lkeyword{lensarrowinset} & 0.5\\
+ Distance $\mathrm{\overline{OA}}$& \Lkeyword{OA} & -3\\
+ Distance $\mathrm{\overline{AB}}$& \Lkeyword{AB} & 1\\
+ Lens color & \Lkeyword{lenscolor}\footnotemark & \black\\
+ Arrow length in cm & \Lkeyword{lensArrowSize}${}^2$ & 0.2\\
+ Arrow inset in cm & \Lkeyword{lensArrowInset}${}^2$ & 0.5\\
\end{tabular}
\footnotetext{\textsuperscript{1} only for \Lkeyset{lensGlass=true}, otherwise set to \texttt{2\textbackslash pslinewidth}}
+\footnotetext{\textsuperscript{2} only for \Lkeyset{lensGlass=false}}
\end{minipage}
\end{table}
@@ -515,7 +546,11 @@ The macro doesn't draw any lines, only the coordinates of the new point are save
\subsection{\nxLcs{symPlan}}
-\verb|\symPlan| allows to mirroring complete plain graphical objects along a virtual center line. Figure \ref{fig:symPlan} shows that this mirroring is a mathematical one and not a physical one. For more examples look at \cite{pstoptic:2001}. The syntax is:
+\verb|\symPlan| allows to mirroring complete plain graphical objects along a virtual
+center line. Figure \ref{fig:symPlan}
+shows that this mirroring is a mathematical one and not a physical one.
+%For more examples look at \cite{pstoptic:2001}.
+The syntax is:
\begin{BDef}
\Lcs{symPlan}\Largr{node1}\Largr{node2}\Largb{graphic object}
@@ -1071,7 +1106,7 @@ Syntax:
\begin{BDef}
\Lcs{eye}
\end{BDef}
-There are no Options for this symbol of an human eye (Figure~\ref{fig:auge}).
+There are no Options for this symbol of an human eye.
Use the \Lcs{rput}-macro to put the eye elsewhere.
\begin{LTXexample}[width=2cm,pos=l,wide=false]