forked from core-plot/core-plot
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCPTLineCap.m
More file actions
581 lines (464 loc) · 19.2 KB
/
CPTLineCap.m
File metadata and controls
581 lines (464 loc) · 19.2 KB
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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
#import "CPTLineCap.h"
#import "CPTDefinitions.h"
#import "CPTFill.h"
#import "CPTLineStyle.h"
#import "NSCoderExtensions.h"
#import <tgmath.h>
/// @cond
@interface CPTLineCap()
@property (nonatomic, readwrite, assign) CGPathRef cachedLineCapPath;
-(CGPathRef)newLineCapPath;
@end
/// @endcond
#pragma mark -
/**
* @brief End cap decorations for lines.
*/
@implementation CPTLineCap
/** @property CGSize size;
* @brief The symbol size when the line is drawn in a vertical direction.
**/
@synthesize size;
/** @property CPTLineCapType lineCapType
* @brief The line cap type.
**/
@synthesize lineCapType;
/** @property CPTLineStyle *lineStyle
* @brief The line style for the border of the line cap.
* If @nil, the border is not drawn.
**/
@synthesize lineStyle;
/** @property CPTFill *fill
* @brief The fill for the interior of the line cap.
* If @nil, the symbol is not filled.
**/
@synthesize fill;
/** @property CGPathRef customLineCapPath
* @brief The drawing path for a custom line cap. It will be scaled to size before being drawn.
**/
@synthesize customLineCapPath;
/** @property BOOL usesEvenOddClipRule
* @brief If @YES, the even-odd rule is used to draw the line cap, otherwise the non-zero winding number rule is used.
* @see <a href="http://developer.apple.com/documentation/GraphicsImaging/Conceptual/drawingwithquartz2d/dq_paths/dq_paths.html#//apple_ref/doc/uid/TP30001066-CH211-TPXREF106">Filling a Path</a> in the Quartz 2D Programming Guide.
**/
@synthesize usesEvenOddClipRule;
@synthesize cachedLineCapPath;
#pragma mark -
#pragma mark Init/Dealloc
/// @name Initialization
/// @{
/** @brief Initializes a newly allocated CPTLineCap object.
*
* The initialized object will have the following properties:
* - @ref size = (@num{5.0}, @num{5.0})
* - @ref lineCapType = #CPTLineCapTypeNone
* - @ref lineStyle = a new default line style
* - @ref fill = @nil
* - @ref customLineCapPath = @NULL
* - @ref usesEvenOddClipRule = @NO
*
* @return The initialized object.
**/
-(instancetype)init
{
if ( (self = [super init]) ) {
size = CPTSizeMake(5.0, 5.0);
lineCapType = CPTLineCapTypeNone;
lineStyle = [[CPTLineStyle alloc] init];
fill = nil;
cachedLineCapPath = NULL;
customLineCapPath = NULL;
usesEvenOddClipRule = NO;
}
return self;
}
/// @}
/// @cond
-(void)dealloc
{
CGPathRelease(cachedLineCapPath);
CGPathRelease(customLineCapPath);
}
/// @endcond
#pragma mark -
#pragma mark NSCoding Methods
/// @cond
-(void)encodeWithCoder:(NSCoder *)coder
{
[coder encodeCPTSize:self.size forKey:@"CPTLineCap.size"];
[coder encodeInteger:self.lineCapType forKey:@"CPTLineCap.lineCapType"];
[coder encodeObject:self.lineStyle forKey:@"CPTLineCap.lineStyle"];
[coder encodeObject:self.fill forKey:@"CPTLineCap.fill"];
[coder encodeCGPath:self.customLineCapPath forKey:@"CPTLineCap.customLineCapPath"];
[coder encodeBool:self.usesEvenOddClipRule forKey:@"CPTLineCap.usesEvenOddClipRule"];
// No need to archive these properties:
// cachedLineCapPath
}
-(instancetype)initWithCoder:(NSCoder *)coder
{
if ( (self = [super init]) ) {
size = [coder decodeCPTSizeForKey:@"CPTLineCap.size"];
lineCapType = (CPTLineCapType)[coder decodeIntegerForKey : @"CPTLineCap.lineCapType"];
lineStyle = [coder decodeObjectForKey:@"CPTLineCap.lineStyle"];
fill = [coder decodeObjectForKey:@"CPTLineCap.fill"];
customLineCapPath = [coder newCGPathDecodeForKey:@"CPTLineCap.customLineCapPath"];
usesEvenOddClipRule = [coder decodeBoolForKey:@"CPTLineCap.usesEvenOddClipRule"];
cachedLineCapPath = NULL;
}
return self;
}
/// @endcond
#pragma mark -
#pragma mark Accessors
/// @cond
-(void)setSize:(CGSize)newSize
{
if ( !CGSizeEqualToSize(newSize, size) ) {
size = newSize;
self.cachedLineCapPath = NULL;
}
}
-(void)setLineCapType:(CPTLineCapType)newType
{
if ( newType != lineCapType ) {
lineCapType = newType;
self.cachedLineCapPath = NULL;
}
}
-(void)setCustomLineCapPath:(CGPathRef)newPath
{
if ( customLineCapPath != newPath ) {
CGPathRelease(customLineCapPath);
customLineCapPath = CGPathRetain(newPath);
self.cachedLineCapPath = NULL;
}
}
-(CGPathRef)cachedLineCapPath
{
if ( !cachedLineCapPath ) {
cachedLineCapPath = [self newLineCapPath];
}
return cachedLineCapPath;
}
-(void)setCachedLineCapPath:(CGPathRef)newPath
{
if ( cachedLineCapPath != newPath ) {
CGPathRelease(cachedLineCapPath);
cachedLineCapPath = CGPathRetain(newPath);
}
}
/// @endcond
#pragma mark -
#pragma mark Factory methods
/** @brief Creates and returns a new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeNone.
* @return A new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeNone.
**/
+(instancetype)lineCap
{
CPTLineCap *lineCap = [[self alloc] init];
lineCap.lineCapType = CPTLineCapTypeNone;
return lineCap;
}
/** @brief Creates and returns a new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeOpenArrow.
* @return A new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeOpenArrow.
**/
+(instancetype)openArrowPlotLineCap
{
CPTLineCap *lineCap = [[self alloc] init];
lineCap.lineCapType = CPTLineCapTypeOpenArrow;
return lineCap;
}
/** @brief Creates and returns a new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeSolidArrow.
* @return A new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeSolidArrow.
**/
+(instancetype)solidArrowPlotLineCap
{
CPTLineCap *lineCap = [[self alloc] init];
lineCap.lineCapType = CPTLineCapTypeSolidArrow;
return lineCap;
}
/** @brief Creates and returns a new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeSweptArrow.
* @return A new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeSweptArrow.
**/
+(instancetype)sweptArrowPlotLineCap
{
CPTLineCap *lineCap = [[self alloc] init];
lineCap.lineCapType = CPTLineCapTypeSweptArrow;
return lineCap;
}
/** @brief Creates and returns a new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeRectangle.
* @return A new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeRectangle.
**/
+(instancetype)rectanglePlotLineCap
{
CPTLineCap *lineCap = [[self alloc] init];
lineCap.lineCapType = CPTLineCapTypeRectangle;
return lineCap;
}
/** @brief Creates and returns a new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeEllipse.
* @return A new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeEllipse.
**/
+(instancetype)ellipsePlotLineCap
{
CPTLineCap *lineCap = [[self alloc] init];
lineCap.lineCapType = CPTLineCapTypeEllipse;
return lineCap;
}
/** @brief Creates and returns a new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeDiamond.
* @return A new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeDiamond.
**/
+(instancetype)diamondPlotLineCap
{
CPTLineCap *lineCap = [[self alloc] init];
lineCap.lineCapType = CPTLineCapTypeDiamond;
return lineCap;
}
/** @brief Creates and returns a new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypePentagon.
* @return A new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypePentagon.
**/
+(instancetype)pentagonPlotLineCap
{
CPTLineCap *lineCap = [[self alloc] init];
lineCap.lineCapType = CPTLineCapTypePentagon;
return lineCap;
}
/** @brief Creates and returns a new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeHexagon.
* @return A new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeHexagon.
**/
+(instancetype)hexagonPlotLineCap
{
CPTLineCap *lineCap = [[self alloc] init];
lineCap.lineCapType = CPTLineCapTypeHexagon;
return lineCap;
}
/** @brief Creates and returns a new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeBar.
* @return A new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeBar.
**/
+(instancetype)barPlotLineCap
{
CPTLineCap *lineCap = [[self alloc] init];
lineCap.lineCapType = CPTLineCapTypeBar;
return lineCap;
}
/** @brief Creates and returns a new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeCross.
* @return A new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeCross.
**/
+(instancetype)crossPlotLineCap
{
CPTLineCap *lineCap = [[self alloc] init];
lineCap.lineCapType = CPTLineCapTypeCross;
return lineCap;
}
/** @brief Creates and returns a new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeSnow.
* @return A new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeSnow.
**/
+(instancetype)snowPlotLineCap
{
CPTLineCap *lineCap = [[self alloc] init];
lineCap.lineCapType = CPTLineCapTypeSnow;
return lineCap;
}
/** @brief Creates and returns a new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeCustom.
* @param aPath The bounding path for the custom line cap.
* @return A new CPTLineCap instance initialized with a line cap type of #CPTLineCapTypeCustom.
**/
+(instancetype)customLineCapWithPath:(CGPathRef)aPath
{
CPTLineCap *lineCap = [[self alloc] init];
lineCap.lineCapType = CPTLineCapTypeCustom;
lineCap.customLineCapPath = aPath;
return lineCap;
}
#pragma mark -
#pragma mark NSCopying Methods
/// @cond
-(id)copyWithZone:(NSZone *)zone
{
CPTLineCap *copy = [[[self class] allocWithZone:zone] init];
copy.size = self.size;
copy.lineCapType = self.lineCapType;
copy.usesEvenOddClipRule = self.usesEvenOddClipRule;
copy.lineStyle = [self.lineStyle copy];
copy.fill = [self.fill copy];
if ( self.customLineCapPath ) {
CGPathRef pathCopy = CGPathCreateCopy(self.customLineCapPath);
copy.customLineCapPath = pathCopy;
CGPathRelease(pathCopy);
}
return copy;
}
/// @endcond
#pragma mark -
#pragma mark Drawing
/** @brief Draws the line cap into the given graphics context centered at the provided point.
* @param context The graphics context to draw into.
* @param center The center point of the line cap.
* @param direction The direction the line is pointing.
**/
-(void)renderAsVectorInContext:(CGContextRef)context atPoint:(CGPoint)center inDirection:(CGPoint)direction
{
CGPathRef theLineCapPath = self.cachedLineCapPath;
if ( theLineCapPath ) {
CPTLineStyle *theLineStyle = nil;
CPTFill *theFill = nil;
switch ( self.lineCapType ) {
case CPTLineCapTypeSolidArrow:
case CPTLineCapTypeSweptArrow:
case CPTLineCapTypeRectangle:
case CPTLineCapTypeEllipse:
case CPTLineCapTypeDiamond:
case CPTLineCapTypePentagon:
case CPTLineCapTypeHexagon:
case CPTLineCapTypeCustom:
theLineStyle = self.lineStyle;
theFill = self.fill;
break;
case CPTLineCapTypeOpenArrow:
case CPTLineCapTypeBar:
case CPTLineCapTypeCross:
case CPTLineCapTypeSnow:
theLineStyle = self.lineStyle;
break;
default:
break;
}
if ( theLineStyle || theFill ) {
CGContextSaveGState(context);
CGContextTranslateCTM(context, center.x, center.y);
CGContextRotateCTM( context, atan2(direction.y, direction.x) - CPTFloat(M_PI_2) ); // standard symbol points up
if ( theFill ) {
// use fillRect instead of fillPath so that images and gradients are properly centered in the symbol
CGSize symbolSize = self.size;
CGSize halfSize = CPTSizeMake( symbolSize.width / CPTFloat(2.0), symbolSize.height / CPTFloat(2.0) );
CGRect bounds = CPTRectMake(-halfSize.width, -halfSize.height, symbolSize.width, symbolSize.height);
CGContextSaveGState(context);
if ( !CGPathIsEmpty(theLineCapPath) ) {
CGContextBeginPath(context);
CGContextAddPath(context, theLineCapPath);
if ( self.usesEvenOddClipRule ) {
CGContextEOClip(context);
}
else {
CGContextClip(context);
}
}
[theFill fillRect:bounds inContext:context];
CGContextRestoreGState(context);
}
if ( theLineStyle ) {
[theLineStyle setLineStyleInContext:context];
CGContextBeginPath(context);
CGContextAddPath(context, theLineCapPath);
[theLineStyle strokePathInContext:context];
}
CGContextRestoreGState(context);
}
}
}
#pragma mark -
#pragma mark Private methods
/// @cond
/** @internal
* @brief Creates and returns a drawing path for the current line cap type.
* The path is standardized for a line direction of @quote{up}.
* @return A path describing the outline of the current line cap type.
**/
-(CGPathRef)newLineCapPath
{
CGFloat dx, dy;
CGSize lineCapSize = self.size;
CGSize halfSize = CPTSizeMake( lineCapSize.width / CPTFloat(2.0), lineCapSize.height / CPTFloat(2.0) );
CGMutablePathRef lineCapPath = CGPathCreateMutable();
switch ( self.lineCapType ) {
case CPTLineCapTypeNone:
// empty path
break;
case CPTLineCapTypeOpenArrow:
CGPathMoveToPoint(lineCapPath, NULL, -halfSize.width, -halfSize.height);
CGPathAddLineToPoint( lineCapPath, NULL, CPTFloat(0.0), CPTFloat(0.0) );
CGPathAddLineToPoint(lineCapPath, NULL, halfSize.width, -halfSize.height);
break;
case CPTLineCapTypeSolidArrow:
CGPathMoveToPoint(lineCapPath, NULL, -halfSize.width, -halfSize.height);
CGPathAddLineToPoint( lineCapPath, NULL, CPTFloat(0.0), CPTFloat(0.0) );
CGPathAddLineToPoint(lineCapPath, NULL, halfSize.width, -halfSize.height);
CGPathCloseSubpath(lineCapPath);
break;
case CPTLineCapTypeSweptArrow:
CGPathMoveToPoint(lineCapPath, NULL, -halfSize.width, -halfSize.height);
CGPathAddLineToPoint( lineCapPath, NULL, CPTFloat(0.0), CPTFloat(0.0) );
CGPathAddLineToPoint(lineCapPath, NULL, halfSize.width, -halfSize.height);
CGPathAddLineToPoint( lineCapPath, NULL, CPTFloat(0.0), -lineCapSize.height * CPTFloat(0.375) );
CGPathCloseSubpath(lineCapPath);
break;
case CPTLineCapTypeRectangle:
CGPathAddRect( lineCapPath, NULL, CPTRectMake( -halfSize.width, -halfSize.height, halfSize.width * CPTFloat(2.0), halfSize.height * CPTFloat(2.0) ) );
break;
case CPTLineCapTypeEllipse:
CGPathAddEllipseInRect( lineCapPath, NULL, CPTRectMake( -halfSize.width, -halfSize.height, halfSize.width * CPTFloat(2.0), halfSize.height * CPTFloat(2.0) ) );
break;
case CPTLineCapTypeDiamond:
CGPathMoveToPoint(lineCapPath, NULL, CPTFloat(0.0), halfSize.height);
CGPathAddLineToPoint( lineCapPath, NULL, halfSize.width, CPTFloat(0.0) );
CGPathAddLineToPoint(lineCapPath, NULL, CPTFloat(0.0), -halfSize.height);
CGPathAddLineToPoint( lineCapPath, NULL, -halfSize.width, CPTFloat(0.0) );
CGPathCloseSubpath(lineCapPath);
break;
case CPTLineCapTypePentagon:
CGPathMoveToPoint(lineCapPath, NULL, CPTFloat(0.0), halfSize.height);
CGPathAddLineToPoint( lineCapPath, NULL, halfSize.width * CPTFloat(0.95105651630), halfSize.height * CPTFloat(0.30901699437) );
CGPathAddLineToPoint( lineCapPath, NULL, halfSize.width * CPTFloat(0.58778525229), -halfSize.height * CPTFloat(0.80901699437) );
CGPathAddLineToPoint( lineCapPath, NULL, -halfSize.width * CPTFloat(0.58778525229), -halfSize.height * CPTFloat(0.80901699437) );
CGPathAddLineToPoint( lineCapPath, NULL, -halfSize.width * CPTFloat(0.95105651630), halfSize.height * CPTFloat(0.30901699437) );
CGPathCloseSubpath(lineCapPath);
break;
case CPTLineCapTypeHexagon:
dx = halfSize.width * CPTFloat(0.86602540378); // sqrt(3.0) / 2.0;
dy = halfSize.height / CPTFloat(2.0);
CGPathMoveToPoint(lineCapPath, NULL, CPTFloat(0.0), halfSize.height);
CGPathAddLineToPoint(lineCapPath, NULL, dx, dy);
CGPathAddLineToPoint(lineCapPath, NULL, dx, -dy);
CGPathAddLineToPoint(lineCapPath, NULL, CPTFloat(0.0), -halfSize.height);
CGPathAddLineToPoint(lineCapPath, NULL, -dx, -dy);
CGPathAddLineToPoint(lineCapPath, NULL, -dx, dy);
CGPathCloseSubpath(lineCapPath);
break;
case CPTLineCapTypeBar:
CGPathMoveToPoint( lineCapPath, NULL, halfSize.width, CPTFloat(0.0) );
CGPathAddLineToPoint( lineCapPath, NULL, -halfSize.width, CPTFloat(0.0) );
break;
case CPTLineCapTypeCross:
CGPathMoveToPoint(lineCapPath, NULL, -halfSize.width, halfSize.height);
CGPathAddLineToPoint(lineCapPath, NULL, halfSize.width, -halfSize.height);
CGPathMoveToPoint(lineCapPath, NULL, halfSize.width, halfSize.height);
CGPathAddLineToPoint(lineCapPath, NULL, -halfSize.width, -halfSize.height);
break;
case CPTLineCapTypeSnow:
dx = halfSize.width * CPTFloat(0.86602540378); // sqrt(3.0) / 2.0;
dy = halfSize.height / CPTFloat(2.0);
CGPathMoveToPoint(lineCapPath, NULL, CPTFloat(0.0), halfSize.height);
CGPathAddLineToPoint(lineCapPath, NULL, CPTFloat(0.0), -halfSize.height);
CGPathMoveToPoint(lineCapPath, NULL, dx, -dy);
CGPathAddLineToPoint(lineCapPath, NULL, -dx, dy);
CGPathMoveToPoint(lineCapPath, NULL, -dx, -dy);
CGPathAddLineToPoint(lineCapPath, NULL, dx, dy);
break;
case CPTLineCapTypeCustom:
{
CGPathRef customPath = self.customLineCapPath;
if ( customPath ) {
CGRect oldBounds = CGPathGetBoundingBox(customPath);
CGFloat dx1 = lineCapSize.width / oldBounds.size.width;
CGFloat dy1 = lineCapSize.height / oldBounds.size.height;
CGAffineTransform scaleTransform = CGAffineTransformScale(CGAffineTransformIdentity, dx1, dy1);
scaleTransform = CGAffineTransformConcat( scaleTransform,
CGAffineTransformMakeTranslation(-halfSize.width, -halfSize.height) );
CGPathAddPath(lineCapPath, &scaleTransform, customPath);
}
}
break;
}
return lineCapPath;
}
/// @endcond
@end