-
Notifications
You must be signed in to change notification settings - Fork 0
Files
#Native Code
##Cylon.h
"By your command," - Cylon Centurion
The Cylon header contains structure definitions for several container types, and is meant to be platform agnostic and duplicated across all platforms for the Final Five Project. For that reason, this header avoids utilizing any Windows specific class definitions or includes.
#com.mindaptiv.saul
##Cylon.java
Cylon.java contains the Java version of the native code cylonStruct structure found in Cylon.h. All variables are represented using Java versions of classes to allow for fast interface between this class and the Android/Java API's. The file also contains specific implementations of the methods listed in Saul.java that are tuned specifically to the Cylon class.
##Saul.java
"I'll save it for a special occasion," - Saul Tigh
Saul.java contains the public Saul interface, with a list of producer function names and a key event handler for other classes (like Cylon.java) to implement. Realistically this could all be relocated into Cylon.java, but a file with the name "Saul" was kept to stick with the Final Five naming convention with an actual source code file.
##Device.java Device.java contains the class declaration of a Java version of the deviceStruct found in Cylon.h, similar to how Cylon.java contains a Java version of cylonStruct. Multiple constructors are present to allow the building of a Device object based on different types of Android objects.
##Controller.java Controller.java contains the class translation of the pre-existing controllerStruct found in Cylon.h. In this context Controller refers exclusively to gamepads.
##Display.java Display.java contains the class translation of the pre-existing displayStruct found in Cylon.h.
##Mouse.java Mouse.java contains the class translation of the pre-existing mouseStruct found in Cylon.h. This file is currently unused.
##package-info.java Traditional package-info file that declares the name for com.mindaptiv.saul with some minor documentation explaining the purpose of the package, and the authorship.
#Saul
##README.md
"Why won't it read!?" - Steve Jobs, South Park
Standard Github generated readme file with a basic mission statement and links to documentation and contact information.
##LICENSE.txt Traditional MIT license file, added via addalicense.com
##.gitignore Traditional .gitignore for a Java/Android project.