UICollisionBehavior

//
//  UICollisionBehavior.h
//  UIKit
//
//  Copyright (c) 2012-2015 Apple Inc. All rights reserved.
//

#import <Foundation/Foundation.h>
#import <UIKit/UIView.h>
#import <UIKit/UIBezierPath.h>
#import <UIKit/UIDynamicBehavior.h>

NS_ASSUME_NONNULL_BEGIN

@class UICollisionBehavior;

// 碰撞的模式（碰撞边缘的类型）
typedef NS_OPTIONS(NSUInteger, UICollisionBehaviorMode) {
    UICollisionBehaviorModeItems        = 1 << 0,           // items 相互碰撞，没有指定碰撞的边界
    UICollisionBehaviorModeBoundaries   = 1 << 1,          // 指定了碰撞的边界，没有 items 的相互碰撞
    UICollisionBehaviorModeEverything   = NSUIntegerMax    // 指定了碰撞边界 和 items 的相互碰撞 （这个是默认值）
} NS_ENUM_AVAILABLE_IOS(7_0);



// 碰撞行为的代理
@protocol UICollisionBehaviorDelegate <NSObject>
@optional

// 处理 items 之间的碰撞
- (void)collisionBehavior:(UICollisionBehavior *)behavior beganContactForItem:(id <UIDynamicItem>)item1 withItem:(id <UIDynamicItem>)item2 atPoint:(CGPoint)p;
- (void)collisionBehavior:(UICollisionBehavior *)behavior endedContactForItem:(id <UIDynamicItem>)item1 withItem:(id <UIDynamicItem>)item2;


//  items 和   boundary 之间的碰撞
// The identifier of a boundary created with translatesReferenceBoundsIntoBoundary or setTranslatesReferenceBoundsIntoBoundaryWithInsets is nil
// 通过 translatesReferenceBoundsIntoBoundary 和 setTranslatesReferenceBoundsIntoBoundaryWithInsets 创建的碰撞边界的标识是 nil 
- (void)collisionBehavior:(UICollisionBehavior*)behavior beganContactForItem:(id <UIDynamicItem>)item withBoundaryIdentifier:(nullable id <NSCopying>)identifier atPoint:(CGPoint)p;
- (void)collisionBehavior:(UICollisionBehavior*)behavior endedContactForItem:(id <UIDynamicItem>)item withBoundaryIdentifier:(nullable id <NSCopying>)identifier;

@end

    


// 碰撞行为
NS_CLASS_AVAILABLE_IOS(7_0) @interface UICollisionBehavior : UIDynamicBehavior

// 通过一个 items 数组来实例化一个 碰撞行为
- (instancetype)initWithItems:(NSArray<id <UIDynamicItem>> *)items NS_DESIGNATED_INITIALIZER;

// 在实例化碰撞行为对象后 添加 items
- (void)addItem:(id <UIDynamicItem>)item;

// 移除已经存在的 items
- (void)removeItem:(id <UIDynamicItem>)item;

// 获取所有的 items
@property (nonatomic, readonly, copy) NSArray<id <UIDynamicItem>> *items;

// 碰撞行为的模式 （默认值 UICollisionBehaviorModeEverything ）
@property (nonatomic, readwrite) UICollisionBehaviorMode collisionMode;

// 转换 animator 引用的 View 的 bounds 作为碰撞的 bounds 。做的是一个简单的 激活操作
@property (nonatomic, readwrite) BOOL translatesReferenceBoundsIntoBoundary;

//  转换 animator 引用的 View 的 bounds 作为碰撞的 bounds , 并根据 View 的 bounds 设置内边距。（和上面的属性是一个效果，多了一个设置内边距的效果）
/*
使用这个方法会产生的影响：
1. animator 引用的 View 的 bounds, 碰撞范围是引用 view 的 bounds。
2. animator 引用的 collection view 的 bounds， collection view layout 的引用的 bounds
3. 引用的 item 的时候，是没有碰撞边距的。
*/
- (void)setTranslatesReferenceBoundsIntoBoundaryWithInsets:(UIEdgeInsets)insets;


// 通过指定一个贝塞尔路径的方式来添加碰撞边界
/*
*      * identifier：   碰撞边界的范围。
*      * bezierPath： 碰撞边界的路径
*      路径的原点和坐标系依靠的是实例化的 animator 
*/
- (void)addBoundaryWithIdentifier:(id <NSCopying>)identifier forPath:(UIBezierPath *)bezierPath;

// 通过两个点来确定碰撞边界 （这是一个方便的方法基于addBoundaryWithIdentifier:forPath:方法。）
/*
*     * fromPoint :  开始的点
*     * toPoint ： 结束点
*/
- (void)addBoundaryWithIdentifier:(id <NSCopying>)identifier fromPoint:(CGPoint)p1 toPoint:(CGPoint)p2;

// 通过一个 标识来获取边界的贝塞尔路径
- (nullable UIBezierPath *)boundaryWithIdentifier:(id <NSCopying>)identifier;

// 通过标识来移除贝塞尔路径
- (void)removeBoundaryWithIdentifier:(id <NSCopying>)identifier;

// 获取所有的碰撞路径的标识
@property (nullable, nonatomic, readonly, copy) NSArray<id <NSCopying>> *boundaryIdentifiers;

// 移除所有的碰撞路径
- (void)removeAllBoundaries;


// 碰撞路径的代理
@property (nullable, nonatomic, weak, readwrite) id <UICollisionBehaviorDelegate> collisionDelegate;

@end

NS_ASSUME_NONNULL_END