ArelXMLHelper
 All Data Structures Functions Variables Pages
Static Public Member Functions | Data Fields
ArelXMLHelper Class Reference

More...

Static Public Member Functions

static createLocationBasedModel3D ($id, $title, $model, $texture, $location, $scale, $rotation, $icon=NULL)
 Create a basic Location Based 3D Model.
 
static createLocationBasedModel3DFromMovie ($id, $title, $moviePath, $location, $scale, $rotation, $icon=NULL)
 Create a basic Location Based 3D Movie Texture.
 
static createLocationBasedModel3DFromImage ($id, $title, $imagePath, $location, $scale, $rotation, $icon=NULL)
 Create a basic Location Based 3D Image.
 
static createLocationBasedPOI ($id, $title, $location, $thumbnail, $icon, $description, $buttons)
 Create a basic Location Based POI (Textual representation with default design)
 
static create360Object ($id, $model, $texture, $translation, $scale, $rotation, $renderPosition=NULL)
 Create a 360 degree Object (3D Model)
 
static createGLUEModel3D ($id, $model, $texture, $translation, $scale, $rotation, $coordinateSystemID)
 Create a basic Glue 3D Model.
 
static createGLUEModel3DFromMovie ($id, $moviePath, $translation, $scale, $rotation, $coordinateSystemID)
 Create a Glue Movie Texture (Movie overlaid a real world object)
 
static createGLUEModel3DFromImage ($id, $imagePath, $translation, $scale, $rotation, $coordinateSystemID)
 Create a Glue Movie Texture (Movie overlaid a real world object)
 
static createScreenFixedModel3D ($id, $model, $texture, $screenAnchor, $scale, $rotation)
 Create a screen fixed 3D Model, meaning it is always stuck to the devices screen.
 
static start ($resourcesPath=NULL, $arelPath=NULL, $trackingXML=null)
 Start output to junaio.
 
static end ()
 End the XML output to junaio.
 
static outputObject ($oObject)
 Create the XML output of the AREL Object and send it to the junaio server.
 

Data Fields

const TRACKING_GPS = "GPS"
 Tracking type GPS.
 
const TRACKING_LLA_MARKER = "LLA"
 Tracking type LLA Marker.
 
const TRACKING_BARCODE_QR = "Code"
 Tracking type bar code and QR codes.
 

Detailed Description

All rights reserved.

Author
metaio GmbH

A helper class to create correct junaio AREL output (XML).

Member Function Documentation

static create360Object (   $id,
  $model,
  $texture,
  $translation,
  $scale,
  $rotation,
  $renderPosition = NULL 
)
static

Create a 360 degree Object (3D Model)

Parameters
String$idId of the AREL Object
String$modelPath to the model of the Object or to the zip package holding all the information
String$texturePath to the texture of the Object (jpg or png file)
Array$translationAn array given all translation parameters x,y,z
Array$scaleAn array providing scale values along three axis (x, y, z)
ArelRotation$rotationProvides the rotation information. Can be defined as euler (rad / deg), quaternion, axisangle or matrix
Int$renderPositionIf you have multiple 360Objects created with transparencies
static createGLUEModel3D (   $id,
  $model,
  $texture,
  $translation,
  $scale,
  $rotation,
  $coordinateSystemID 
)
static

Create a basic Glue 3D Model.

Parameters
String$idId of the AREL Object
String$modelPath to the model of the Object or to the zip package holding all the information
String$texturePath to the texture of the Object (jpg or png file)
Array$translationAn array given all translation parameters x,y,z
Array$scaleAn array providing scale values along three axis (x, y, z)
ArelRotation$rotationProvides the rotation information. Can be defined as euler (rad / deg), quaternion, axisangle or matrix
Int$coordinateSystemIDID of the corrdinateSystem the model shall be attached to
static createGLUEModel3DFromImage (   $id,
  $imagePath,
  $translation,
  $scale,
  $rotation,
  $coordinateSystemID 
)
static

Create a Glue Movie Texture (Movie overlaid a real world object)

Parameters
String$idId of the AREL Object
String$imagePathPath to the JPG or PNG image that shall be displayed in the real world
Array$translationAn array given all translation parameters x,y,z
Array$scaleAn array providing scale values along three axis (x, y, z)
ArelRotation$rotationProvides the rotation information. Can be defined as euler (rad / deg), quaternion, axisangle or matrix
Int$coordinateSystemIDID of the corrdinateSystem the model shall be attached to
static createGLUEModel3DFromMovie (   $id,
  $moviePath,
  $translation,
  $scale,
  $rotation,
  $coordinateSystemID 
)
static

Create a Glue Movie Texture (Movie overlaid a real world object)

Parameters
String$idId of the AREL Object
String$moviePathPath to the 3G2 movie that shall be displayed on the reference (coordinate system)
Array$translationAn array given all translation parameters x,y,z
Array$scaleAn array providing scale values along three axis (x, y, z)
ArelRotation$rotationProvides the rotation information. Can be defined as euler (rad / deg), quaternion, axisangle or matrix
Int$coordinateSystemIDID of the corrdinateSystem the model shall be attached to
static createLocationBasedModel3D (   $id,
  $title,
  $model,
  $texture,
  $location,
  $scale,
  $rotation,
  $icon = NULL 
)
static

Create a basic Location Based 3D Model.

Parameters
String$idId of the AREL Object
String$titleTitle of the AREL Object to be displayed in the popup (if added) as well as list and map
String$modelPath to the model of the Object or to the zip package holding all the information
String$texturePath to the texture of the Object (jpg or png file)
Array$locationAn array given all location parameters (latitude, longitude and altitude)
Array$scaleAn array providing scale values along three axis (x, y, z)
ArelRotation$rotationProvides the rotation information. Can be defined as euler (rad / deg), quaternion, axisangle or matrix
String$iconprovides an icon how the model will be displayed on a map (optional)
static createLocationBasedModel3DFromImage (   $id,
  $title,
  $imagePath,
  $location,
  $scale,
  $rotation,
  $icon = NULL 
)
static

Create a basic Location Based 3D Image.

Parameters
String$idId of the AREL Object
String$titleTitle of the AREL Object to be displayed in the popup (if added) as well as list and map
String$imagePathPath to the JPG or PNG image that shall be displayed in the real world
Array$locationAn array given all location parameters (latitude, longitude and altitude)
Array$scaleAn array providing scale values along three axis (x, y, z)
ArelRotation$rotationProvides the rotation information. Can be defined as euler (rad / deg), quaternion, axisangle or matrix
String$iconprovides an icon how the model will be displayed on a map (optional)
static createLocationBasedModel3DFromMovie (   $id,
  $title,
  $moviePath,
  $location,
  $scale,
  $rotation,
  $icon = NULL 
)
static

Create a basic Location Based 3D Movie Texture.

Parameters
String$idId of the AREL Object
String$titleTitle of the AREL Object to be displayed in the popup (if added) as well as list and map
String$moviePathPath to the 3G2 movie that shall be displayed in the real world
Array$locationAn array given all location parameters (latitude, longitude and altitude)
Array$scaleAn array providing scale values along three axis (x, y, z)
ArelRotation$rotationProvides the rotation information. Can be defined as euler (rad / deg), quaternion, axisangle or matrix
String$iconprovides an icon how the model will be displayed on a map (optional)
static createLocationBasedPOI (   $id,
  $title,
  $location,
  $thumbnail,
  $icon,
  $description,
  $buttons 
)
static

Create a basic Location Based POI (Textual representation with default design)

Parameters
String$idId of the AREL Object
String$titleTitle of the AREL Object to be displayed in the popup (if added) as well as list and map
Array$locationAn array given all location parameters (latitude, longitude and altitude)
String$thumbnailprovides an thumbnail to be displayed in the liveview and on the list
String$iconprovides an icon how the model will be displayed on a map (optional)
String$descriptionThe description to be written in the pop up or the additional information
Array$buttonsAn array defining buttons to be shown in the pop up / detail display
static createScreenFixedModel3D (   $id,
  $model,
  $texture,
  $screenAnchor,
  $scale,
  $rotation 
)
static

Create a screen fixed 3D Model, meaning it is always stuck to the devices screen.

Parameters
String$idId of the AREL Object
String$modelPath to the model of the Object or to the zip package holding all the information
String$texturePath to the texture of the Object (jpg or png file)
int$screenAnchorA constant defining the screen anchor
See Also
ArelAnchor.
Parameters
Array$scaleAn array providing scale values along three axis (x, y, z)
ArelRotation$rotationProvides the rotation information. Can be defined as euler (rad / deg), quaternion, axisangle or matrix
Returns
ArelObjectModel3D The object created
static outputObject (   $oObject)
static

Create the XML output of the AREL Object and send it to the junaio server.

Parameters
ArelObject$oObjectObject to be sent out
static start (   $resourcesPath = NULL,
  $arelPath = NULL,
  $trackingXML = null 
)
static

Start output to junaio.

Parameters
string$resourcesPathPath to a zip holding all resources (models, images, shader, materials) [NOT SUPPORTED AT THE MOMENT)
string$arelPathPath to a an HTML defining the GUI and hosting the arel JS
string$trackingXMLPath to the tracking xml or identifier of what shall be done (LLA Marker, Barcode / QR code). If nothing is provided, GPS is assumed.

The documentation for this class was generated from the following file: