ArDrone SDK 1.8 added

[mardrone] / mardrone / ARDrone_SDK_Version_1_8_20110726 / ControlEngine / iPhone / Release / ARDrone.h

diff --git a/mardrone/ARDrone_SDK_Version_1_8_20110726/ControlEngine/iPhone/Release/ARDrone.h b/mardrone/ARDrone_SDK_Version_1_8_20110726/ControlEngine/iPhone/Release/ARDrone.h
new file mode 100644 (file)
index 0000000..9f170d5
--- /dev/null
+++ b/mardrone/ARDrone_SDK_Version_1_8_20110726/ControlEngine/iPhone/Release/ARDrone.h
@@ -0,0 +1,91 @@
+/*! \mainpage ParrotBuild
+ 
+ 
+ <center><h1> ARDrone API documentation</h1></center>
+ <div align="center">
+ <hr>
+ </div>
+ 
+ <div><center>
+ This documentation provides an API for ARDrone host development and is still a work in progress.
+
+ The following schema explain the structure of the API.
+ 
+ <img alt="ARDrone API schema" src="ardrone_api.jpg">
+
+ A sample demo for Iphone can be found here:
+
+ https://projects.ardrone.org/repositories/browse/ardrone-api/Examples 
+
+ </center></div>
+ */
+ /**
+ * @file ARDrone.h
+ *
+ * Copyright 2009 Parrot SA. All rights reserved.
+ * @author D HAEYER Frederic
+ * @date 2009/10/26
+ */
+#import <Foundation/Foundation.h>
+#import <UIKit/UIKit.h>
+#import "ARDroneProtocols.h"
+
+/**
+ * Define HUD configuration structure
+ */
+typedef struct
+{
+       BOOL enableSwitchScreen;
+       BOOL enableBackToMainMenu;
+       BOOL enableBatteryPercentage;
+}
+ARDroneHUDConfiguration;
+
+/**
+ * Define a few methods to make it possible for the game engine to control the Parrot drone
+ */
+@interface ARDrone : NSObject <ARDroneProtocolIn>
+{
+       BOOL running;
+       UIView* view;
+}
+
+/**
+ * Boolean flag that indicates whether the library is running (YES) or paused (NO).<br/>
+ * Note: It is the library sole responsability to handle change of states and modify its behavior; basically, it should pause some of the threads when "paused" then resume everything back to normal when "running".
+ */
+@property (nonatomic, readonly) BOOL running;
+
+/**
+ * Pointer to an UIView, created by the Parrot library, which should be put on top of all the other views in order to make it possible for the library to capture touch events and/or display its own menu.
+ */
+@property (nonatomic, readonly) UIView* view;
+
+/**
+ * Initialize the Parrot library.<br/>
+ * Note: the library will clean-up everything it allocates by itself, when being destroyed (i.e. when its retain count reaches 0).
+ *
+ * @param frame Frame of parent view, used to create the library view (which shall cover the whole screen).
+ * @param inGame Initial state of the game at startup.
+ * @param uidelegate Pointer to the object that implements the Parrot protocol ("ARDroneProtocol"), which will be called whenever the library needs the game engine to change its state.
+ * @param hudconfiguration is a structure to define HUD properties (can be nil)
+ * @return Pointer to the newly initialized Parrot library instance.
+ */
+- (id) initWithFrame:(CGRect)frame withState:(BOOL)inGame withDelegate:(id <ARDroneProtocolOut>)uidelegate withHUDConfiguration:(ARDroneHUDConfiguration*)hudconfiguration;
+
+/**
+ * Set what shall be the orientation of the screen when rendering a frame.
+ *
+ * @param right Orientation of the screen: FALSE for "landscape left", TRUE for "landscape right".
+ */
+- (void)setScreenOrientationRight:(BOOL)right;
+
+/**
+ * Render a frame. Basically, the Parrot Library renders:<ul>
+ * <li> A full screen textured quad in the background (= the video sent by the drone);</li>
+ * <li> A set of elements in the foreground (=HUD).</li>
+ * </ul>
+ */
+- (void) render;
+
+@end