Home

This is the beginning of the process for documenting the android-3d-model-viewer app. If you would like to have documentation about some feature, please open an issue. The application inner workings are mostly documented in the code itself. You are invited to improve this documentation as well.

Scope

The initial scope of this wiki is to facilitate basic understanding of the design of this app. To understand how this app works, you would need at least to have a basic understanding of 3D maths and OpenGL. There is a lot of documentation out there about 3D and OpenGL. I will try however to document some basic stuff to help you getting started with 3D.

Usage

You can use this application in 2 ways:

• Play with the app: run, modify, add, delete... do whatever you like.
• Use the app engine in your own app: just build the engine and import the generated AAR package in your app. Check app module to learn how engine is used.

Modules

The application has 2 modules:

• engine: the 3d model engine (android library module)
• app: the 3d model viewer (android app module)

Engine

The engine is an android library module and has the following packages:

• animation: animation engine
• collision: collision detection engine
• drawer: OpenGL renderer
• model: 3D objects
• services: 3D file loader

App

The app is an android application that serves as demo. It has the following packages:

• controller: touch controller to move the camera
• demo: scene implementation
• view:
  • DemoActivity: loads the ExampleSceneLoader with many different models
  • MenuActivity: application menu (load, about, exit, etc)
  • ModelActivity: activity to show 3d model
  • ModelRenderer: Android OpenGL renderer used by OpenGL view
  • ModelSurfaceView: Android OpenGL view that uses OpenGL renderer
• MainActivity: application entry point