Fork me
BeyondAR
Augmented Reality Framework for Android
 All Classes Functions Variables
com.beyondar.android.plugin.WorldPlugin Interface Reference

Base interface to create a plugin for a World. More...

Inheritance diagram for com.beyondar.android.plugin.WorldPlugin:
Collaboration diagram for com.beyondar.android.plugin.WorldPlugin:

Public Member Functions

void onDetached ()
 This method is invoked when the plugin is removed.
 
boolean isAttached ()
 Check if the plugin is attached. More...
 
void setup (World world)
 Setup the plugin according to the world. More...
 
void onBeyondarObjectAdded (BeyondarObject beyondarObject, BeyondarObjectList beyondarObjectList)
 This method is invoked when a new BeyondarObject is added to the world. More...
 
void onBeyondarObjectRemoved (BeyondarObject beyondarObject, BeyondarObjectList beyondarObjectList)
 This method is invoked when a BeyondarObject is removed from the world. More...
 
void onBeyondarObjectListCreated (BeyondarObjectList beyondarObjectList)
 This method is invoked when a new BeyondarObjectList is created.
 
void onWorldCleaned ()
 This method is invoked when the world is cleaned.
 
void onGeoPositionChanged (double latitude, double longitude, double altitude)
 This method is invoked when the position is changed. More...
 
void onDefaultImageChanged (String uri)
 This method is invoked when the default image for all the BeyondarObject is set. More...
 
void onPause ()
 Called when the activity has been paused.
 
void onResume ()
 Called when the activity has been resumed.
 

Detailed Description

Base interface to create a plugin for a World.

Member Function Documentation

boolean com.beyondar.android.plugin.WorldPlugin.isAttached ( )

Check if the plugin is attached.

Returns
void com.beyondar.android.plugin.WorldPlugin.onBeyondarObjectAdded ( BeyondarObject  beyondarObject,
BeyondarObjectList  beyondarObjectList 
)

This method is invoked when a new BeyondarObject is added to the world.

Use this method to add specific plugin's to the BeyondarObject.

Parameters
beyondarObject
beyondarObjectList
void com.beyondar.android.plugin.WorldPlugin.onBeyondarObjectRemoved ( BeyondarObject  beyondarObject,
BeyondarObjectList  beyondarObjectList 
)

This method is invoked when a BeyondarObject is removed from the world.

Use this method to remove the plugin's that are not needed.

Parameters
beyondarObject
beyondarObjectList
void com.beyondar.android.plugin.WorldPlugin.onDefaultImageChanged ( String  uri)

This method is invoked when the default image for all the BeyondarObject is set.

Parameters
uri
void com.beyondar.android.plugin.WorldPlugin.onGeoPositionChanged ( double  latitude,
double  longitude,
double  altitude 
)

This method is invoked when the position is changed.

Parameters
latitude
longitude
altitude
void com.beyondar.android.plugin.WorldPlugin.setup ( World  world)

Setup the plugin according to the world.

Parameters
worldThe world that loads the plugin

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