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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
// A macro that creates transformation functions. The created functions require the containing
// impl block to contain a private transform_impl() function. Both the specification of self and the
// data type of the return value of transform_impl() can be passed as parameters into this macro.
// This offers more flexibility than defining a trait; for instance, this macro can create functions
// that operate on either &mut self or self, whereas a trait cannot.
#[doc(hidden)]
#[macro_export]
macro_rules! create_transform_setters {
($self_:ty, $ret_:ty, $doc_ref_:literal, $doc_ref_period_:literal, $doc_ref_comma_:literal, $custom_doc_:literal) => {
/// Applies the given transformation, expressed as six values representing the six configurable
/// elements of a nine-element 3x3 PDF transformation matrix, to
#[doc = $doc_ref_period_ ]
///
#[doc = $custom_doc_ ]
///
/// To move, scale, rotate, or skew
#[doc = $doc_ref_comma_ ]
/// consider using one or more of
/// the following functions. Internally they all use [Self::transform()], but are
/// probably easier to use (and certainly clearer in their intent) in most situations.
///
/// * [Self::translate()]: changes the position of
#[doc = $doc_ref_period_ ]
/// * [Self::scale()]: changes the size of
#[doc = $doc_ref_period_ ]
/// * [Self::flip_horizontally()]:
/// flips
#[doc = $doc_ref_ ]
/// horizontally around its origin.
/// * [Self::flip_vertically()]:
/// flips
#[doc = $doc_ref_ ]
/// vertically around its origin.
/// * [Self::rotate_clockwise_degrees()], [Self::rotate_counter_clockwise_degrees()],
/// [Self::rotate_clockwise_radians()], [Self::rotate_counter_clockwise_radians()]:
/// rotates
#[doc = $doc_ref_ ]
/// around its origin.
/// * [Self::skew_degrees()], [Self::skew_radians()]: skews
#[doc = $doc_ref_ ]
/// relative to its axes.
///
/// **The order in which transformations are applied is significant.**
/// For example, the result of rotating _then_ translating an object may be vastly different
/// from translating _then_ rotating the same object.
///
/// An overview of PDF transformation matrices can be found in the PDF Reference Manual
/// version 1.7 on page 204; a detailed description can be founded in section 4.2.3 on page 207.
#[inline]
pub fn transform(
self: $self_,
a: PdfMatrixValue,
b: PdfMatrixValue,
c: PdfMatrixValue,
d: PdfMatrixValue,
e: PdfMatrixValue,
f: PdfMatrixValue,
) -> $ret_ {
self.transform_impl(a, b, c, d, e, f)
}
/// Applies the values in the given [PdfMatrix] to
#[doc = $doc_ref_period_ ]
///
#[doc = $custom_doc_ ]
#[inline]
pub fn set_matrix(self: $self_, matrix: PdfMatrix) -> $ret_ {
self.transform(
matrix.a(),
matrix.b(),
matrix.c(),
matrix.d(),
matrix.e(),
matrix.f(),
)
}
/// Moves the origin of
#[doc = $doc_ref_ ]
/// by the given horizontal and vertical delta distances.
///
#[doc = $custom_doc_ ]
#[inline]
pub fn translate(self: $self_, delta_x: PdfPoints, delta_y: PdfPoints) -> $ret_ {
self.transform(1.0, 0.0, 0.0, 1.0, delta_x.value, delta_y.value)
}
/// Changes the size of
#[doc = $doc_ref_comma_ ]
/// scaling it by the given horizontal and vertical scale factors.
///
#[doc = $custom_doc_ ]
#[inline]
pub fn scale(
self: $self_,
horizontal_scale_factor: PdfMatrixValue,
vertical_scale_factor: PdfMatrixValue,
) -> $ret_ {
self.transform(
horizontal_scale_factor,
0.0,
0.0,
vertical_scale_factor,
0.0,
0.0,
)
}
/// Flips
#[doc = $doc_ref_ ]
/// horizontally around its origin by applying a horizontal scale factor of -1.
///
#[doc = $custom_doc_ ]
#[inline]
pub fn flip_horizontally(self: $self_) -> $ret_ {
self.scale(-1.0, 1.0)
}
/// Flips
#[doc = $doc_ref_ ]
/// vertically around its origin by applying a vertical scale factor of -1.
///
#[doc = $custom_doc_ ]
#[inline]
pub fn flip_vertically(self: $self_) -> $ret_ {
self.scale(1.0, -1.0)
}
/// Reflects
#[doc = $doc_ref_ ]
/// by flipping it both horizontally and vertically around its origin.
///
#[doc = $custom_doc_ ]
#[inline]
pub fn reflect(self: $self_) -> $ret_ {
self.scale(-1.0, -1.0)
}
/// Rotates
#[doc = $doc_ref_ ]
/// counter-clockwise by the given number of degrees.
///
#[doc = $custom_doc_ ]
#[inline]
pub fn rotate_counter_clockwise_degrees(self: $self_, degrees: PdfMatrixValue) -> $ret_ {
self.rotate_counter_clockwise_radians(degrees.to_radians())
}
/// Rotates
#[doc = $doc_ref_ ]
/// clockwise by the given number of degrees.
///
#[doc = $custom_doc_ ]
#[inline]
pub fn rotate_clockwise_degrees(self: $self_, degrees: PdfMatrixValue) -> $ret_ {
self.rotate_counter_clockwise_degrees(-degrees)
}
/// Rotates
#[doc = $doc_ref_ ]
/// counter-clockwise by the given number of radians.
///
#[doc = $custom_doc_ ]
#[inline]
pub fn rotate_counter_clockwise_radians(self: $self_, radians: PdfMatrixValue) -> $ret_ {
let cos_theta = radians.cos();
let sin_theta = radians.sin();
self.transform(cos_theta, sin_theta, -sin_theta, cos_theta, 0.0, 0.0)
}
/// Rotates
#[doc = $doc_ref_ ]
/// clockwise by the given number of radians.
///
#[doc = $custom_doc_ ]
#[inline]
pub fn rotate_clockwise_radians(self: $self_, radians: PdfMatrixValue) -> $ret_ {
self.rotate_counter_clockwise_radians(-radians)
}
/// Skews the axes of
#[doc = $doc_ref_ ]
/// by the given angles in degrees.
///
#[doc = $custom_doc_ ]
#[inline]
pub fn skew_degrees(
self: $self_,
x_axis_skew: PdfMatrixValue,
y_axis_skew: PdfMatrixValue,
) -> $ret_ {
self.skew_radians(x_axis_skew.to_radians(), y_axis_skew.to_radians())
}
/// Skews the axes of
#[doc = $doc_ref_ ]
/// by the given angles in radians.
///
#[doc = $custom_doc_ ]
#[inline]
pub fn skew_radians(
self: $self_,
x_axis_skew: PdfMatrixValue,
y_axis_skew: PdfMatrixValue,
) -> $ret_ {
self.transform(1.0, x_axis_skew.tan(), y_axis_skew.tan(), 1.0, 0.0, 0.0)
}
};
($self_:ty, $ret_:ty, $doc_ref_:literal, $doc_ref_period_:literal, $doc_ref_comma_:literal) => {
create_transform_setters!(
$self_,
$ret_,
$doc_ref_,
$doc_ref_period_,
$doc_ref_comma_,
"" // No custom documentation for this set of setter functions.
);
};
}
// A macro that creates functions that read the current transformation matrix. The created functions
// require the containing impl block to contain a private get_matrix_impl() -> Result<PdfMatrix, PdfiumError>
// function. This could be implemented as a trait, but for the sake of consistency with the
// create_transform_setters!() macro (which could _not_ be implemented as a trait), we stick with
// using a macro.
#[doc(hidden)]
#[macro_export]
macro_rules! create_transform_getters {
($doc_ref_:literal, $doc_ref_period_:literal, $doc_ref_comma_:literal) => {
/// Returns the transformation matrix currently applied to
#[doc = $doc_ref_period_ ]
#[inline]
pub fn matrix(&self) -> Result<PdfMatrix, PdfiumError> {
self.get_matrix_impl()
}
/// Returns the current horizontal and vertical translation of the origin of
#[doc = $doc_ref_period_ ]
#[inline]
pub fn get_translation(&self) -> (PdfPoints, PdfPoints) {
(
self.get_horizontal_translation(),
self.get_vertical_translation(),
)
}
/// Returns the current horizontal translation of the origin of
#[doc = $doc_ref_period_ ]
#[inline]
pub fn get_horizontal_translation(&self) -> PdfPoints {
self.matrix()
.map(|matrix| PdfPoints::new(matrix.e()))
.unwrap_or(PdfPoints::ZERO)
}
/// Returns the current vertical translation of the origin of
#[doc = $doc_ref_period_ ]
#[inline]
pub fn get_vertical_translation(&self) -> PdfPoints {
self.matrix()
.map(|matrix| PdfPoints::new(matrix.f()))
.unwrap_or(PdfPoints::ZERO)
}
/// Returns the current horizontal and vertical scale factors applied to
#[doc = $doc_ref_period_ ]
#[inline]
pub fn get_scale(&self) -> (PdfMatrixValue, PdfMatrixValue) {
(self.get_horizontal_scale(), self.get_vertical_scale())
}
/// Returns the current horizontal scale factor applied to
#[doc = $doc_ref_period_ ]
#[inline]
pub fn get_horizontal_scale(&self) -> PdfMatrixValue {
self.matrix().map(|matrix| matrix.a()).unwrap_or(0.0)
}
/// Returns the current vertical scale factor applied to
#[doc = $doc_ref_period_ ]
#[inline]
pub fn get_vertical_scale(&self) -> PdfMatrixValue {
self.matrix().map(|matrix| matrix.d()).unwrap_or(0.0)
}
/// Returns the counter-clockwise rotation applied to
#[doc = $doc_ref_comma_ ]
/// in degrees.
///
/// If the object is both rotated and skewed, the return value of this function will reflect
/// the combined operation.
#[inline]
pub fn get_rotation_counter_clockwise_degrees(&self) -> PdfMatrixValue {
self.get_rotation_counter_clockwise_radians().to_degrees()
}
/// Returns the clockwise rotation applied to
#[doc = $doc_ref_comma_ ]
/// in degrees.
///
/// If the object is both rotated and skewed, the return value of this function will reflect
/// the combined operation.
#[inline]
pub fn get_rotation_clockwise_degrees(&self) -> PdfMatrixValue {
-self.get_rotation_counter_clockwise_degrees()
}
/// Returns the counter-clockwise rotation applied to
#[doc = $doc_ref_comma_ ]
/// in radians.
///
/// If the object is both rotated and skewed, the return value of this function will reflect
/// the combined operation.
#[inline]
pub fn get_rotation_counter_clockwise_radians(&self) -> PdfMatrixValue {
self.matrix()
.map(|matrix| matrix.b().atan2(matrix.a()))
.unwrap_or(0.0)
}
/// Returns the clockwise rotation applied to
#[doc = $doc_ref_comma_ ]
/// in radians.
///
/// If the object is both rotated and skewed, the return value of this function will reflect
/// the combined operation.
#[inline]
pub fn get_rotation_clockwise_radians(&self) -> PdfMatrixValue {
-self.get_rotation_counter_clockwise_radians()
}
/// Returns the current x axis and y axis skew angles applied to
#[doc = $doc_ref_comma_ ]
/// in degrees.
///
/// If the object is both rotated and skewed, the return value of this function will reflect
/// the combined operation.
#[inline]
pub fn get_skew_degrees(&self) -> (PdfMatrixValue, PdfMatrixValue) {
(
self.get_x_axis_skew_degrees(),
self.get_y_axis_skew_degrees(),
)
}
/// Returns the current x axis skew angle applied to
#[doc = $doc_ref_comma_ ]
/// in degrees.
///
/// If the object is both rotated and skewed, the return value of this function will reflect
/// the combined operation.
#[inline]
pub fn get_x_axis_skew_degrees(&self) -> PdfMatrixValue {
self.get_x_axis_skew_radians().to_degrees()
}
/// Returns the current y axis skew applied to
#[doc = $doc_ref_comma_ ]
/// in degrees.
///
/// If the object is both rotated and skewed, the return value of this function will reflect
/// the combined operation.
#[inline]
pub fn get_y_axis_skew_degrees(&self) -> PdfMatrixValue {
self.get_y_axis_skew_radians().to_degrees()
}
/// Returns the current x axis and y axis skew angles applied to
#[doc = $doc_ref_comma_ ]
/// in radians.
///
/// If the object is both rotated and skewed, the return value of this function will reflect
/// the combined operation.
#[inline]
pub fn get_skew_radians(&self) -> (PdfMatrixValue, PdfMatrixValue) {
(
self.get_x_axis_skew_radians(),
self.get_y_axis_skew_radians(),
)
}
/// Returns the current x axis skew applied to
#[doc = $doc_ref_comma_ ]
/// in radians.
///
/// If the object is both rotated and skewed, the return value of this function will reflect
/// the combined operation.
#[inline]
pub fn get_x_axis_skew_radians(&self) -> PdfMatrixValue {
self.matrix().map(|matrix| matrix.b().atan()).unwrap_or(0.0)
}
/// Returns the current y axis skew applied to
#[doc = $doc_ref_comma_ ]
/// in radians.
///
/// If the object is both rotated and skewed, the return value of this function will reflect
/// the combined operation.
#[inline]
pub fn get_y_axis_skew_radians(&self) -> PdfMatrixValue {
self.matrix().map(|matrix| matrix.c().atan()).unwrap_or(0.0)
}
};
() => {
create_transform_getters!("this object", "this object.", "this object,");
};
}