Swiftgram/Source/TextKit/ASTextKitShadower.h
appleguy 465abb1ded [License] Simplify the Texture license to be pure Apache 2 (removing ASDK-Licenses). (#1077)
* [License] Simplify the Texture license to be pure Apache 2 (removing ASDK-Licenses)

With permission of the Facebook Open Source team, we are simplifying the Texture
license so that clients can rely on the Apache 2 terms that most of Texture is
already covered by. This means that code originally forked from AsyncDisplayKit
will be re-licensed from "BSD 3-clause + PATENTS v2" to Apache 2 without a
PATENTS file.

After getting confirmation that the updates to these core files look good, we'll
propagate this new license header to all files (in this same PR) and get sign-off
from all parties before landing.

* [License] Update all Texture source files to be pure Apache 2.

* Changelog entry for Apache 2 license update.

* Revert "[License] Update all Texture source files to be pure Apache 2."

This reverts commit ffa0fbbba9717d871dd16c4b07539f2f8208fc2b.

* [License] Update all Texture source files to be pure Apache 2, maintaining copyrights.

* [License] Update CONTRIBUTING, README, Podspec & Dangerfile.
2018-08-28 07:39:18 -07:00

72 lines
2.3 KiB
Objective-C

//
// ASTextKitShadower.h
// Texture
//
// Copyright (c) Facebook, Inc. and its affiliates. All rights reserved.
// Changes after 4/13/2017 are: Copyright (c) Pinterest, Inc. All rights reserved.
// Licensed under Apache 2.0: http://www.apache.org/licenses/LICENSE-2.0
//
#import <UIKit/UIKit.h>
#import <AsyncDisplayKit/ASBaseDefines.h>
/**
* @abstract an immutable class for calculating shadow padding drawing a shadowed background for text
*/
AS_SUBCLASSING_RESTRICTED
@interface ASTextKitShadower : NSObject
+ (ASTextKitShadower *)shadowerWithShadowOffset:(CGSize)shadowOffset
shadowColor:(UIColor *)shadowColor
shadowOpacity:(CGFloat)shadowOpacity
shadowRadius:(CGFloat)shadowRadius;
/**
* @abstract The offset from the top-left corner at which the shadow starts.
* @discussion A positive width will move the shadow to the right.
* A positive height will move the shadow downwards.
*/
@property (nonatomic, readonly) CGSize shadowOffset;
//! CGColor in which the shadow is drawn
@property (nonatomic, copy, readonly) UIColor *shadowColor;
//! Alpha of the shadow
@property (nonatomic, readonly) CGFloat shadowOpacity;
//! Radius, in pixels
@property (nonatomic, readonly) CGFloat shadowRadius;
/**
* @abstract The edge insets which represent shadow padding
* @discussion Each edge inset is less than or equal to zero.
*
* Example:
* CGRect boundsWithoutShadowPadding; // Large enough to fit text, not large enough to fit the shadow as well
* UIEdgeInsets shadowPadding = [shadower shadowPadding];
* CGRect boundsWithShadowPadding = UIEdgeInsetsRect(boundsWithoutShadowPadding, shadowPadding);
*/
- (UIEdgeInsets)shadowPadding;
- (CGSize)insetSizeWithConstrainedSize:(CGSize)constrainedSize;
- (CGRect)insetRectWithConstrainedRect:(CGRect)constrainedRect;
- (CGSize)outsetSizeWithInsetSize:(CGSize)insetSize;
- (CGRect)outsetRectWithInsetRect:(CGRect)insetRect;
- (CGRect)offsetRectWithInternalRect:(CGRect)internalRect;
- (CGPoint)offsetPointWithInternalPoint:(CGPoint)internalPoint;
- (CGPoint)offsetPointWithExternalPoint:(CGPoint)externalPoint;
/**
* @abstract draws the shadow for text in the provided CGContext
* @discussion Call within the text node's +drawRect method
*/
- (void)setShadowInContext:(CGContextRef)context;
@end