[Note] RESideMenu

第一次读别人的代码选择了这个比较小巧的sidemenu框架。地址在这里：https://github.com/romaonthego/RESideMenu ，有demo很明白地展示框架作用。
我采用的读代码顺序是从外向内，从应用到内部实现。笔记比较详细繁琐一点。

---

RESideMenuExample Folder

这里面是举例来说明框架的用法。
在AppDelegate里初始化了sideMenuViewController。初始化需要用到三个VC，中左右分别是navigationController （fistViewController embedded），leftMenuViewController, rightMenuViewController。然后设置了sideMenuViewController的一些属性。还有更多的属性可以设置，这里采用的是default的设置，也就是在sideMenu的viewDidLoad方法里给了各个属性的默认值。
FirstVC和SecondVC的写法类似。其中navBar的左右按钮的调用方法是写在UIViewController+RESideMenu里。
SecondVC中加了个Button，buttonType设置的UIButtonTypeRoundedRect没见过，运行也没看到roundedRect，点进去发现已经废弃了，现在用的是UIButtonTypeSystem。
LeftMenuVC和RightMenuVC写法类似，都是tableVC实现菜单。tableView不是填充整个VC的，按cell个数算好了大小。

---

ReSideMenu Folder

UIViewController+RESideMenu

这里为UIViewController类多添加了sideMenuViewController属性，并且是只读的。所以刚才LeftMenuVC和RightMenuVC里才能出现self.sideMenuViewController。getter方法的写法就是从树的任何一个节点往上寻根的写法。找到最顶层的RESideMenu为止。

RECommonFunctions

这里定义的是一个c语言函数，第一眼没认出来_(:з」∠)_ dispatch_once保证了内容在程序运行时只调用一次，函数目的是为了检测UIKit 是在flat mode还是legacy mode，是通过window的tintColor来确定的。

---

RESideMenu

单独列出来这个最核心的类。

//RESideMenu.h

首先是好多好多属性。爆炸。而且都是readwrite的，给用户很大的自由度。
很多属性有IBInspectable attribute。这是IB的一个便民措施。Swift这里的关键字比较整齐，@IBDesignable和@IBInspectable，在OC中对应的就是IB_DESIGNABLE和IBInspectable。
IB_DESIGNABLE可以用于自定义view。这样就可以在IB canvas随时看到改动的实际效果。
IBInspectable是用于属性和变量，也是为了当改变这些属性值的时候，可以在canvas里面所见即所得。
代理就没什么好说的，监听一下三个view的出现和消失。


//RESideMenu.m

先看属性。
visible我理解就是leftMenuVisible || rightMenuVisible，表示的是menu的visible与否。
originalPoint是用在滑动手势计算偏移量上。
contentButton是加到contentVC上覆盖整个contentVC的一个隐形Button。在addContentButton方法中可知这个button只会存在一个。点击时调用hideMenuViewController，也就是回到主页面。

# Instance lifecycle
commonInit把可以自定义的属性做了个default赋值。

# Public methods
setContentViewController:animated:
这个方法是点击菜单后，回到主页面时调用的。显示的主view做了一个淡入的处理。首先调用hideViewController:方法把contentViewContainer里面原本装的内容移除了，赋值了新的contentVC，这样也就可以满足点击菜单不同项进入不同的内容。 然后调用了didMoveToParentViewController:方法，此方法是需要在VC被添加到containerVC或被移除后调用的。

# View life cycle
viewDidLoad
添加三个VC的过程是：三个VC都添加为self的childVC，两个菜单VC的view都添加到menuViewContainer的subView，主view添加到contentViewContainer的subview，然后各自调用didMoveToParentViewController:方法。
初始化后三个View重叠在一起。

# Private methods
presentMenuViewContainerWithMenuViewController:
这个是显示左右view之前做的一个预处理。做了一下menuViewContainer的transform和星空背景的伸缩。这里是先对menu做了一个放大的处理，所以出现过程中，是menu由大变正常，主view由正常变小的过程，比突兀地直接按原大小出现更赏心悦目。

showLeftMenuViewController
beginAppearanceTransition:方法是通知子控制器自己要出现或消失了。对应的，在completion block里调用了endAppearanceTransition:方法。在自定义container controller时应采取调用这两个方法，而不是viewWillAppear等。
contentViewContainer直接用transform做了缩小和移动。scale和移动值都是有属性可以自定义的。

hideViewController:
首先调用didMoveToParentViewController:，参数传nil表示操作是移除。然后移除view的从属关系，再移除VC的从属关系。

hideMenuViewControllerAnimated:
这里主view要出现了，contentButton可以去掉了。
这里定义了两个block，并注意了用定义weakSelf的方式来避免retain cycle。
animationBlock是把contentViewContainer的大小等变回到全屏时的状态。
completionBlock里是状态改变时调用代理方法。
这样把block抽出来定义的好处是，因为animated参数传入值不定，需要判断。这样写能使代码简洁易懂。

updateContentViewShadow
在contentViewContainer.layer上对shadow的属性做一些自定义。是一个定义view的shadow的范例。不看代码还真没注意到还有shadow效果，效果做得还蛮精细的。

resetContentViewScale
第一次仔细看CGAffineTransform是怎么实现的。是采用[x y 1] * A的形式。A在文档里有就不写了（其实是不会在markdown里写矩阵啊_(:з」∠)_）。但是这个函数的意义我不是特别明了。这里打印以后发现是单位矩阵，frame前后也没有变。这个函数是在showLeftMenuViewController和showRightMenuViewController里面调用的，调用完后对contentViewContainer进行了缩小和平移操作。所以这个函数似乎是个确保contentViewContainer在原位的函数。那为什么还要特意取出scale做一个伸缩呢，而且这个伸缩在实际运行中就是保持原样的效果。不太理解。

# iOS 7 Motion Effects
addMenuViewControllerMotionEffects
addContentViewControllerMotionEffects
这两个方法写的是当device的视角倾斜时界面做的一点中心点的位置调整。是比较精致有趣的设计，是在iOS7扁平化设计后才出现的效果。以前没有遇到过，不过看了UIInterpolatinMotionEffect的文档还是比较好懂。

# UIGestureRecognizer delegate
gestureRecognizer:shouldReceiveTouch:
是系统提供的代理方法。对手势做了两个限制。一个是如果contentVC作为navVC而且包含多个VC，则禁用滑动，因为会和系统的swipe to navigate功能冲突。第二是限制了一下手势位置，只有在靠近左边和靠近右边的位置开始滑动才判断有效。

# Pan gesture recognizer
panGestureRecognized:
处理滑动手势的一个函数。比较长。
首先是得到手势的起始点。然后是在滑动过程中计算delta。delta的计算在主view滑出和滑进还有一点小区别。滑出时delta计算的是手指移动距离在屏宽中占比。滑进时函数中定义的point.x是负值，delta计算的是手指移动距离在主view划出后偏移量中占比。在滑动过程中，所有view的scale变化都是与delta线性相关，是一个很平均平稳的过程。作者很细心地处理了一些边界情况，比如scale过大等。
在手势完成的部分，根据当前主view的位置，设置threshold做了一个归位处理。设定滑到一定程度停止的话，可以自动完成剩下的滑到规定位置的过程。
这个函数值得以后再好好看看，手势关联的动画处理还是比较有趣的。

# ViewController Rotation Handler
这里做的是如果device横屏了，contentViewContainer的位置需要再偏移得多一些。计算是简单用offset直接加上的。