[dali_2.3.21] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / dali-physics / third-party / chipmunk2d / objectivec / include / ObjectiveChipmunk / ObjectiveChipmunk.h
1 /* Copyright (c) 2013 Scott Lembcke and Howling Moon Software
2  * 
3  * Permission is hereby granted, free of charge, to any person obtaining a copy
4  * of this software and associated documentation files (the "Software"), to deal
5  * in the Software without restriction, including without limitation the rights
6  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7  * copies of the Software, and to permit persons to whom the Software is
8  * furnished to do so, subject to the following conditions:
9  * 
10  * The above copyright notice and this permission notice shall be included in
11  * all copies or substantial portions of the Software.
12  * 
13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19  * SOFTWARE.
20  */
21
22 #import <Foundation/Foundation.h>
23
24 #if __has_feature(objc_arc)
25         #define CP_DATA_POINTER_TYPE __unsafe_unretained id
26         #define CP_GROUP_TYPE __unsafe_unretained id
27         #define CP_COLLISION_TYPE_TYPE __unsafe_unretained id
28 #else
29         #define CP_DATA_POINTER_TYPE id
30         #define CP_GROUP_TYPE id
31         #define CP_COLLISION_TYPE_TYPE id
32 #endif
33
34 #ifdef CP_ALLOW_PRIVATE_ACCESS
35         #import "chipmunk/chipmunk_private.h"
36 #else
37         #import "chipmunk/chipmunk.h"
38         #import "chipmunk/chipmunk_structs.h"
39 #endif
40
41 /**
42         Allows you to add composite objects to a space in a single method call.
43         The easiest way to implement the ChipmunkObject protocol is to add a @c chipmunkObjects instance variable with a type of @c NSArray* to your class,
44         create a synthesized property for it, and initialize it with the ChipmunkObjectFlatten() function.
45 */
46 @protocol ChipmunkObject
47
48 /// Returns a list of ChipmunkBaseObject objects.
49 - (id <NSFastEnumeration>)chipmunkObjects;
50
51 @end
52
53
54 /// A category to have NSArray implement the ChipmunkObject protocol.
55 /// They make for very easy containers.
56 @interface NSArray(ChipmunkObject) <ChipmunkObject>
57 @end
58
59
60 @class ChipmunkSpace;
61
62 /**
63         This protocol is implemented by objects that know how to add themselves to a space.
64         It's used internally as part of the ChipmunkObject protocol. You should never need to implement it yourself.
65 */
66 @protocol ChipmunkBaseObject <ChipmunkObject>
67
68 - (void)addToSpace:(ChipmunkSpace *)space;
69 - (void)removeFromSpace:(ChipmunkSpace *)space;
70
71 @end
72
73 #import "ChipmunkBody.h"
74 #import "ChipmunkShape.h"
75 #import "ChipmunkConstraint.h"
76 #import "ChipmunkSpace.h"
77 #import "ChipmunkMultiGrab.h"