Introduction
In this tutorial you will learn how to create a simple AR(Augmented Reality) scene, at first appearance this code is a little hairy but you don’t have to understand every part of it to use it.
Requirements
1. Web Camera
2. Adobe Flash CS4
Try or Buy
3. Flex Builder
Try or Buy
4. Blender
Download
5. PV 3D
Download
6. Augmented Reality
Download
7. Marker File
Download
8. Pattern
Download
Pre-Requesites
It would be useful for you if you are familiar with PV3D. It would be good to know 3d modeling with Blender and other 3d modeling program
Save a Pattern
First of all, this is not a tutorial for beginers, but I will try to explain very well all the steps that must be taken to obtain the final result.
Well, download the Marker File. You will see a AIR file, this AIR file will help ous to save a pattern for our Augmented Reality project. Instal the Marker File…on the desktop you will see a ARToolKit Marker Generator AIR file.
Open it, in the same time you Web Camera will start, than you need to save a pattern, you will see a button named Save Pattern and same red lines walking there, those lines will try to find a pattern. Well, now you need to show a paper with a pattern.
A exemple of pattern:
While, you show the paper, on the camera you will see that the red linis are around the pattern.Like in this picture:
In that moment click the save button and save the pattern. In this tutorial my pattern is named pattern.pat.
That was the first step.
3D Model
For designers, this is maybe the most important step, but I’m not a designer ao something like that. I’m only a ActionScript developer, and I will analyze the step from my point of view. For this step you can use Blender, Swift 3D or another modeling program, but unse only the program able to export in Collada. First if you are a beginer in 3d (like me), you can draw a cube or something. If you are use Blender, and have already the made 3d model. Go to File->Export->Collada 1.4(dae).
After exporting you will have a file named something.dae. This file contains our 3d model that we use in PV3D.
If you are useing Swift 3D, the first thing again is draw you model, and export to PV3D. In Swift 3D, we use other option caled Export Selected object To Papervision3D…. Like in this picture:
After that you will have a .swf file , a .fla file, and the most important thing a .dae file. Well now we have the pattern and the 3d model. Is time to do same develop work with ActionScript 3.0 .
Final step 2
Make a new project
If you use Flex Builder just create a new ActionScript 3.0 Project and called augmentedReality. If you unse Flash CS3 or CS4 create a Flash File(ActionScript 3.0), you can give what name you want. At this file create a class called augmentedReality.as. The Flash File and the class must be in the same folder.
For Flex:
And if you are useing flash, there is a simple pictutre to help you:
Well, now we are ready to write the code.
Final step 3.
Start to write the code
package
{
import flash.display.Sprite;
public class augmentedReality extends Sprite
{
public function augmentedReality()
{
}
}
}Here we have the augmentedReality class copy this in Flash, if you are useing flash.
Same imports thing
package
{
import flash.display.BitmapData;
import flash.display.Sprite;
import flash.events.Event;
import flash.media.Camera;
import flash.media.Video;
import flash.utils.ByteArray;
import org.libspark.flartoolkit.core.FLARCode;
import org.libspark.flartoolkit.core.param.FLARParam;
import org.libspark.flartoolkit.core.raster.rgb.FLARRgbRaster_BitmapData;
import org.libspark.flartoolkit.core.transmat.FLARTransMatResult;
import org.libspark.flartoolkit.detector.FLARSingleMarkerDetector;
import org.libspark.flartoolkit.pv3d.FLARBaseNode;
import org.libspark.flartoolkit.pv3d.FLARCamera3D;
import org.papervision3d.objects.parsers.Collada;
import org.papervision3d.render.BasicRenderEngine;
import org.papervision3d.scenes.Scene3D;
import org.papervision3d.view.Viewport3D;
[SWF(width="640", height="480", frameRate="30", backgroundColor="#FFFFFF")]
public class augmentedReality extends Sprite
{
public function augmentedReality()
{
}
}
}Well, here we need the Papervision 3d library, and the Augmented Reality library.
Private Variables and Embled files
Now we need to embled the pattern and a most important file the camera_para.dat This file is in the Augmented Reality lib . You don’t need to know want is in this file just embled this file.
package
{
import flash.display.BitmapData;
import flash.display.Sprite;
import flash.events.Event;
import flash.media.Camera;
import flash.media.Video;
import flash.utils.ByteArray;
import org.libspark.flartoolkit.core.FLARCode;
import org.libspark.flartoolkit.core.param.FLARParam;
import org.libspark.flartoolkit.core.raster.rgb.FLARRgbRaster_BitmapData;
import org.libspark.flartoolkit.core.transmat.FLARTransMatResult;
import org.libspark.flartoolkit.detector.FLARSingleMarkerDetector;
import org.libspark.flartoolkit.pv3d.FLARBaseNode;
import org.libspark.flartoolkit.pv3d.FLARCamera3D;
import org.papervision3d.objects.parsers.Collada;
import org.papervision3d.render.BasicRenderEngine;
import org.papervision3d.scenes.Scene3D;
import org.papervision3d.view.Viewport3D;
[SWF(width="640", height="480", frameRate="30", backgroundColor="#FFFFFF")]
public class augmentedReality extends Sprite
{
[Embed(source="pattern.pat", mimeType="application/octet-stream")]
private var pattern:Class;
[Embed(source="camera_para.dat", mimeType="application/octet-stream")]
private var params:Class;
private var FlarParams:FLARParam;
private var FlarCode:FLARCode;
private var vid:Video;
private var camera:Camera;
private var FlarCamera:FLARCamera3D;
private var bmd:BitmapData;
private var FlarRaster:FLARRgbRaster_BitmapData;
private var FlarDetector:FLARSingleMarkerDetector;
private var container:FLARBaseNode;
private var viewPort:Viewport3D;
private var scene:Scene3D;
private var renderEngine:BasicRenderEngine;
private var TransMatResult:FLARTransMatResult;
public function augmentedReality()
{
setFLAR();
setCamera();
setBitmap();
setPV3D();
addEventListener(Event.ENTER_FRAME, loop);
}
}
}In the constructor we have same function that we will have to explain, in the following steps.
We have the setFLAR(); function. In this function we will load the camera_para, and the pattern.
In the setCamera(); function, we will set the option for the Web Camera.. the resolution, the fps.
Well in the setBitmap(); function, we will do a bitmap data for our FLARRgbRaster_BitmapData. And we will draw the bitmap to the video.
And here at the setPV3D(); function, we will add the 3d model.
Private Methods
private function setFLAR():void
{
FlarParams = new FLARParam();
FlarParams.loadARParam(new params() as ByteArray);
FlarCode = new FLARCode(16,16);
FlarCode.loadARPatt(new pattern());
}
private function setCamera():void
{
vid = new Video(640,480);
camera = Camera.getCamera();
camera.setMode(640,480,31);
vid.attachCamera(camera);
addChild(vid);
}
private function setBitmap():void
{
bmd = new BitmapData(640,480,true);
bmd.draw(vid);
FlarRaster = new FLARRgbRaster_BitmapData(bmd);
FlarDetector = new FLARSingleMarkerDetector(FlarParams,FlarCode,80);
}
private function setPV3D():void
{
scene = new Scene3D();
FlarCamera = new FLARCamera3D(FlarParams);
container = new FLARBaseNode();
scene.addChild(container);
var obj:Collada = new Collada("tank.dae");
container.addChild(obj);
renderEngine = new BasicRenderEngine();
TransMatResult = new FLARTransMatResult();
FlarCamera.z = 0;
viewPort = new Viewport3D();
addChild(viewPort);
obj.rotationY += 20;
obj.rotationX += 10;
}Well,for a better understanding about this private methods. I will explain again what deals they have.
private function setFLAR():void
{
FlarParams = new FLARParam();
FlarParams.loadARParam(new params() as ByteArray);
FlarCode = new FLARCode(16,16);
FlarCode.loadARPatt(new pattern());
}In setFLAR we have a FlarParams instance, and we load the params in this instance. And because the params are a binary file, we load this params as a ByteArray. And in the FLARCode instance we load the pattern file, and give a resolution, in this case 16×16.
private function setCamera():void
{
vid = new Video(640,480);
camera = Camera.getCamera();
camera.setMode(640,480,31);
vid.attachCamera(camera);
addChild(vid);
}The setCamera function set up the option for our camera. Well, I set up the resolution 640×480, but if you have a more performance camera, give a larger resolution. And I think 31 fps is good for all kind of camera. And after that we attach the camera on the Video instance. And of course we addChild the vid(Video).
Well, after you set this part of code, if you run you project, ypu will see, samething like that:
And if you click Allow, your camera will start.
private function setBitmap():void
{
bmd = new BitmapData(640,480,true);
bmd.draw(vid);
FlarRaster = new FLARRgbRaster_BitmapData(bmd);
FlarDetector = new FLARSingleMarkerDetector(FlarParams,FlarCode,80);
}Well, now we have the setBitmap, here we create a BitmapData, give the same resolution as the camera. And we “draw” the vid that contains all the information about our camera.After that we have the FlarRaster and the FlarDetector. Well the FlarDetector, is a detector, which will see the pattern on the stage… 80 reprents the marker width.
private function setPV3D():void
{
scene = new Scene3D();
FlarCamera = new FLARCamera3D(FlarParams);
container = new FLARBaseNode();
scene.addChild(container);
var obj:Collada = new Collada("tank.dae");
container.addChild(obj);
renderEngine = new BasicRenderEngine();
TransMatResult = new FLARTransMatResult();
FlarCamera.z = 0;
viewPort = new Viewport3D();
addChild(viewPort);
obj.rotationY += 20;
obj.rotationX += 10;
}And finaly the setPV3D function. In this function I add the 3d model to the FLARBaseNode.
Final Code
package
{
import flash.display.BitmapData;
import flash.display.Sprite;
import flash.events.Event;
import flash.media.Camera;
import flash.media.Video;
import flash.utils.ByteArray;
import org.libspark.flartoolkit.core.FLARCode;
import org.libspark.flartoolkit.core.param.FLARParam;
import org.libspark.flartoolkit.core.raster.rgb.FLARRgbRaster_BitmapData;
import org.libspark.flartoolkit.core.transmat.FLARTransMatResult;
import org.libspark.flartoolkit.detector.FLARSingleMarkerDetector;
import org.libspark.flartoolkit.pv3d.FLARBaseNode;
import org.libspark.flartoolkit.pv3d.FLARCamera3D;
import org.papervision3d.objects.parsers.Collada;
import org.papervision3d.render.BasicRenderEngine;
import org.papervision3d.scenes.Scene3D;
import org.papervision3d.view.Viewport3D;
[SWF(width="640", height="480", frameRate="30", backgroundColor="#FFFFFF")]
public class augmentedReality extends Sprite
{
[Embed(source="pattern.pat", mimeType="application/octet-stream")]
private var pattern:Class;
[Embed(source="camera_para.dat", mimeType="application/octet-stream")]
private var params:Class;
private var FlarParams:FLARParam;
private var FlarCode:FLARCode;
private var vid:Video;
private var camera:Camera;
private var FlarCamera:FLARCamera3D;
private var bmd:BitmapData;
private var FlarRaster:FLARRgbRaster_BitmapData;
private var FlarDetector:FLARSingleMarkerDetector;
private var container:FLARBaseNode;
private var viewPort:Viewport3D;
private var scene:Scene3D;
private var renderEngine:BasicRenderEngine;
private var TransMatResult:FLARTransMatResult;
public function augmentedReality()
{
setFLAR();
setCamera();
setBitmap();
setPV3D();
addEventListener(Event.ENTER_FRAME, loop);
}
private function setFLAR():void
{
FlarParams = new FLARParam();
FlarParams.loadARParam(new params() as ByteArray);
FlarCode = new FLARCode(16,16);
FlarCode.loadARPatt(new pattern());
}
private function setCamera():void
{
vid = new Video(640,480);
camera = Camera.getCamera();
camera.setMode(640,480,31);
vid.attachCamera(camera);
addChild(vid);
}
private function setBitmap():void
{
bmd = new BitmapData(640,480,true);
bmd.draw(vid);
FlarRaster = new FLARRgbRaster_BitmapData(bmd);
FlarDetector = new FLARSingleMarkerDetector(FlarParams,FlarCode,80);
}
private function setPV3D():void
{
scene = new Scene3D();
FlarCamera = new FLARCamera3D(FlarParams);
container = new FLARBaseNode();
scene.addChild(container);
var obj:Collada = new Collada("tank.dae");
container.addChild(obj);
renderEngine = new BasicRenderEngine();
TransMatResult = new FLARTransMatResult();
FlarCamera.z = 0;
viewPort = new Viewport3D();
addChild(viewPort);
obj.rotationY += 20;
obj.rotationX += 10;
}
private function loop(e:Event):void
{
bmd.draw(vid);
try
{
if(FlarDetector.detectMarkerLite(FlarRaster, 80) && FlarDetector.getConfidence() > 0.5)
{
FlarDetector.getTransformMatrix(TransMatResult);
container.setTransformMatrix(TransMatResult);
renderEngine.renderScene(scene, FlarCamera, viewPort);
}
}
catch(e:Error){}
}
}
}And the final result must be something like that,my 3d model is a thank, and look how he is:
That was the Augmented Reality tutorial.
Cya next time
