summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/generic/xypic/xyps-r.doc
blob: a329cce379a8b15eda374083bf01e5b9352c4679 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
%% $Id: xyps-r.doc,v 3.7 1999/02/16 15:12:50 krisrose Exp $
%%
%% Xy-pic ``PostScript Rotations and Scaling''.
%% Copyright (c) 1993-1996	Ross Moore	<ross@mpce.mq.edu.au>
%%
%% This file is part of the Xy-pic package for graphs and diagrams in TeX.
%% See the companion README and INSTALL files for further information.
%% Copyright (c) 1991-1996	Kristoffer H. Rose	<krisrose@brics.dk>
%%
%% The Xy-pic package is free software; you can redistribute it and/or modify
%% it under the terms of the GNU General Public License as published by the
%% Free Software Foundation; either version 2 of the License, or (at your
%% option) any later version.
%%
%% The Xy-pic package is distributed in the hope that it will be useful, but
%% WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
%% or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
%% for more details.
%%
%% You should have received a copy of the GNU General Public License along
%% with this package; if not, write to the Free Software Foundation, Inc.,
%% 675 Mass Ave, Cambridge, MA 02139, USA.
%%
%% As a special exception, you may use this file and all files derived
%% from it without restrictions.  This special exception was added with
%% version 3.7 of Xy-pic.
%%
\expandafter\ifx\csname xyps-rloaded\endcsname\empty
 \message{not reloaded}\endinput \fi
\expandafter\let\csname xyps-rloaded\endcsname=\empty \xycatcodes

\DOCMODE2%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\paragraph*{Header:}\leavevmode
\DOCHEADER

\DOCMODE3%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\subsection{Rotations and scaling}

The included file |xyps-r.tex| (version \stripRCS$Revision: 3.7 $) provides 
\PS\ support for the effects defined in the |rotate| extension described
in~\S??g[:rotate].

\DOCMODE2%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

The \PS\ style methods are required, so ensure that they are loaded.

\DOCMODE(
\expandafter\ifx\csname xyps-sloaded\endcsname\empty\else
 \xyinputorelse@{xyps-s}{\xyerror@{Could not load xyps-s}{}}%
 \xycatcodes\fi
\DOCMODE)

\DOCMODE3%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

This file is loaded and its effects are activated automatically whenever
|\xyoption{rotate}| is requested and the current <driver> supports 
\PS\ rotations. Should there be any need to turn off this support,
the following commands are available; they obey usual \TeX\ groupings.
%
\begin{defs}
|\NoPSrotate| & remove \PS\ support\kern-50pt\cr
|\UsePSrotate| & reinstate \PS.
\end{defs}
%
Without \PS\ support diagrams can be expected to be displayed unrotated
and unscaled.  
These commands are provided primarily for testing and trouble-shooting; 
\eg~with <driver> configurations untested by the authors of \Xy-pic, 
who should be notified of persistent difficulties. 

\DOCMODE2%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\paragraph*{Installation}

Call the following macro to allow the \PS\ mechanisms to be used.

\DOCMODE(
\xydef@\installPSrotscale@{\installPSstyle@
 \let\xyRotate@@=\xyPSrotate@@
% \let\xySpecialRotate@@=\xyPSspecialRotate@
 \let\doSpecialRotate@@=\doPSspecialRotate@@
% \let\xyRotnamed@=\xyPSpsxy@
% \let\xyRot@named@=\xyPSrot@named@@
 \let\xyscale@@=\xyPSscale@@
 \xyPSshapes@true
 \xyuncatcodes }

\xydef@\UsePSrotate{\installPSrotscale@}
\xydef@\NoPSrotate{\UnloadRotate@\relax}
\DOCMODE)

\DOCMODE2%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

All effects defined in the |rotate| extension can be implemented using a \PS\ 
<driver>. However different <driver>s need not handle things in the same way; 
different \PS\ code may be required to match the specific environment used
by the <driver>. 

This file provides generic \PS\ code which is known to work correctly with 
most drivers. It is written so as to indicate where modifications may be 
made to accomodate specific <driver>s. For such driver-specific variations, 
consult the appropriate <driver>-file, called |xy|<driver>|.doc|.

\DOCMODE2%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\paragraph*{Transform lists}

\DOCMODE(
\xydef@\xyPSpretransform@{\xyPSrawA@{\preXYtransform@@}}
\xydef@\xyPSposttransform@{\xyPSrawZ@{\postXYtransform@@}}

\let\preXYtransform@=\xyPSpretransform@
\let\postXYtransform@=\xyPSposttransform@

\xydef@\xyPSrotSplit@{%
 \expandafter\def\expandafter\preShape@@\expandafter{\xyPSpre@}%
 \expandafter\def\expandafter\postShape@@\expandafter{\xyPSpost@}}
\DOCMODE)

\DOCMODE2%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\paragraph*{Rescaling}

\DOCMODE(
\xydef@\xyPSscale@@#1#2{%
 \xyPSsplitPS@{\xyscale@start(#1,#2)}{\xyscale@end}%
 \xyPSrotSplit@\xyPSpsxy@ }
\DOCMODE)

\DOCMODE2%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\paragraph*{Rotations}

\DOCMODE(
\xydef@\xyPSrotate@@#1{% 
 \xyPSsplitPS@{\xyrot@start(#1 xyd)}{\xyrot@end}%
 \xyPSrotSplit@\xyPSpsxy@ }

\xydef@\xyPSspecialRotate@#1{%
 \xyPSsplitPS@{\xyrot@start(#1)}{\xyrot@end}\xyPSrotSplit@\xyPSpsxy@ }

\xydef@\doPSspecialRotate@@#1@@{\xyPSspecialRotate@{#1}}
\DOCMODE)

The \PS\ operator |xyr| is defined in |xyps-ps.doc|, to store the given
parameter as a rotation angle.

\DOCMODE2%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\paragraph*{Shearing}

This feature is not implemented yet.

\DOCMODE2%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\paragraph*{PostScript commands}

The \PS\ codes to start the rotation or scaling are given as functions, 
|xyrot@start| and |xyscale@start| with arguments to include a specification 
of the rotation-angle or scaling factors. 

\DOCMODE(
\xydef@\xyRotScale@@{%
 \def\xyrot@start(##1){{xyt ##1\space xyr}}%
 \def\xyscale@start(##1,##2){{xyt ##1\space##2\space xys}}%
 \def\xyrot@end{}\def\xyscale@end{}}
\DOCMODE)

These strings are placed using |\xyPSsplitPS@| so as to correctly
occur before and after the code for the actual <object> being typeset.
This is always followed by |\xyPSpsxy@|, which results in \PS\ code
to identify the current position, storing it with keys |xyXpos| and |xyYpos|
so as to be accessible to the code for the rotation or scaling.

A specific <driver> must either call |\xyRotScale@@| to use this default
mechanism, or define its own macro to be called at installation time, 
which sets alternative expansions to |\xyrot@start(#1)|, 
|\xyscale@start(#1,#2)|, |\xyrot@end| and |\xyscale@end|.

\DOCMODE2%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\paragraph*{The end \& Log}\leavevmode

\DOCMODE(
\endinput

% $Log: xyps-r.doc,v $
% Revision 3.7  1999/02/16 15:12:50  krisrose
% Interim release (Y&Y fonts now free).
%
% Revision 3.3  1996/12/18  10:05:50  ross
% minor improvements to file-loading commands
%
% Revision 3.1  1995/09/05  20:36:33  ross
% Release!
%
% Revision 3.0  1995/07/07  20:13:19  ross
% Major release w/new User's Guide!
%
% Revision 2.13  1995/07/04  15:04:51  ross
% Ready for release of v3.
%
% Revision 2.9  1994/06/09  14:38:56  ross
% Release 3beta.
% Includes support for special effects: Rotations, Scaling, Line-width, Colour.
% Back-ends are separated into separate files.
% More back-ends are supported, experimentally --- needs testing.
%
% Revision 2.9  1994/06/09  14:38:56  ross
% Release 3beta.
% Includes support for special effects: Rotations, Scaling, Line-width, Colour.
% Back-ends are separated into separate files.
% More back-ends are supported, experimentally --- needs testing.
%
% NEW for version 2.9 by by Ross Moore.
\DOCMODE)

\DOCMODE3%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% Tell Emacs that this is a LaTeX document and how it is formatted:
% Local Variables:
% mode:latex
% fill-column:77
% fill-prefix:""
% End: