Basic object to be used with augmented reality. More...

Inheritance diagram for com.beyondar.android.world.BeyondarObject:

Collaboration diagram for com.beyondar.android.world.BeyondarObject:

Public Member Functions
	BeyondarObject (long id)
	Create an instance of a BeyondarObject with an unique ID. More...

	BeyondarObject ()
	Create an instance of a BeyondarObject with an unique ID. More...

long	getId ()
	Get the unique id of the BeyondarObject.

void	addPlugin (BeyondarObjectPlugin plugin)

boolean	removePlugin (BeyondarObjectPlugin plugin)

void	removeAllPlugins ()

BeyondarObjectPlugin	getFirstPlugin (Class<?extends BeyondarObjectPlugin > pluginClass)

boolean	containsAnyPlugin (Class<?extends BeyondarObjectPlugin > pluginClass)

boolean	containsPlugin (BeyondarObjectPlugin plugin)

List< BeyondarObjectPlugin >	getAllPugins (Class<?extends BeyondarObjectPlugin > pluginClass)

List< BeyondarObjectPlugin >	getAllPlugins (Class<?extends BeyondarObjectPlugin > pluginClass, List< BeyondarObjectPlugin > result)

List< BeyondarObjectPlugin >	getAllPlugins ()
	Get a List copy of the added plugins. More...

Point3	getAngle ()
	Get the used angle for rendering the BeyondarObject. More...

void	setAngle (float x, float y, float z)
	Set the used angle for rendering the BeyondarObject. More...

void	setAngle (Point3 newAngle)
	Set the used angle for rendering the BeyondarObject. More...

Point3	getPosition ()
	Get the position where the BeyondarObject is being rendered. More...

void	setPosition (Point3 newPos)
	Get the position where the BeyondarObject is being rendered. More...

void	setPosition (float x, float y, float z)
	Set the position where the BeyondarObject is being rendered. More...

Texture	getTexture ()
	Get the Texture used to render the BeyondarObject. More...

void	setTexturePointer (int texturePointer)
	Set the texture pointer of the BeyondarObject. More...

void	setTexture (Texture texture)
	Set the Texture used to render the BeyondarObject.

Renderable	getOpenGLObject ()
	Get Renderable that renders the BeyondarObject. More...

void	setRenderable (Renderable renderable)
	Set a custom Renderable for the BeyondarObject. More...

String	getImageUri ()
	The the image uri used to represent the BeyondarObject. More...

void	faceToCamera (boolean faceToCamera)
	Define if the BeyondarObject should face the camera. More...

boolean	isFacingToCamera ()
	Check if the BeyondarObject is facing the camera. More...

void	setVisible (boolean visible)
	Set the visibility of this object. More...

boolean	isVisible ()
	Check the visibility of the BeyondarObject. More...

void	setName (String name)
	Set the name of the BeyondarObject. More...

String	getName ()
	Get the name of the BeyondarObject. More...

void	setImageUri (String uri)
	Set the image uri. More...

void	setImageResource (int resId)
	Set an image resource for the BeyondarObject. More...

int	getWorldListType ()
	Get the list type of the BeyondarObject. More...

double	getDistanceFromUser ()
	Get the Distance from the user in meters. More...

void	setDistanceFromUser (double distance)
	Set how far is the object from the user (meters). More...

Point3	getScreenPositionBottomLeft ()
	Get the bottom left screen position of the BeyondarObject on the screen. More...

Point3	getScreenPositionTopLeft ()
	Get the top left screen position of the BeyondarObject on the screen. More...

Point3	getScreenPositionTopRight ()
	Get the top right screen position of the BeyondarObject on the screen. More...

Point3	getScreenPositionBottomRight ()
	Get the bottom right screen position of the BeyondarObject on the screen. More...

Point3	getScreenPositionCenter ()
	Get the center screen position of the BeyondarObject on the screen. More...

Point3	getTopLeft ()
	Get the top left of the BeyondarObject on the 3D world. More...

Point3	getBottomLeft ()
	Get the bottom left of the BeyondarObject on the 3D world. More...

Point3	getBottomRight ()
	Get the bottom right of the BeyondarObject on the 3D world. More...

Point3	getTopRight ()
	Get the top right of the BeyondarObject on the 3D world. More...

MeshCollider	getMeshCollider ()
	Get the MeshCollider of the GeoObject. More...

Protected Member Functions
Renderable	createRenderable ()
	Override this method to change the default Renderable. More...

Protected Attributes
List< BeyondarObjectPlugin >	plugins
	This fields contains all the loaded plugins. More...

Object	lockPlugins = new Object()
	Use this lock to access the plugins field. More...

Detailed Description

Basic object to be used with augmented reality.

This class contains all the needed information to be used in the AR World.

Constructor & Destructor Documentation

com.beyondar.android.world.BeyondarObject.BeyondarObject ( long id )

Create an instance of a BeyondarObject with an unique ID.

Parameters

id Unique ID

com.beyondar.android.world.BeyondarObject.BeyondarObject ( )

Create an instance of a BeyondarObject with an unique ID.

The hash of the object will be used as the BeyondarObject unique id.

Member Function Documentation

Renderable com.beyondar.android.world.BeyondarObject.createRenderable ( )

protected

Override this method to change the default Renderable.

Returns: The new Renderable.

Here is the caller graph for this function:

void com.beyondar.android.world.BeyondarObject.faceToCamera ( boolean faceToCamera )

Define if the BeyondarObject should face the camera.

Parameters

faceToCamera true if it should face the camera, false otherwise.

List<BeyondarObjectPlugin> com.beyondar.android.world.BeyondarObject.getAllPlugins ( )

Get a List copy of the added plugins.

Adding/removing plugins to this list will not affect the added plugins

Returns

Point3 com.beyondar.android.world.BeyondarObject.getAngle ( )

Get the used angle for rendering the BeyondarObject.

Returns: The angle in degrees.

Here is the caller graph for this function:

Point3 com.beyondar.android.world.BeyondarObject.getBottomLeft ( )

Get the bottom left of the BeyondarObject on the 3D world.

Returns: bottom left 3D.

Here is the caller graph for this function:

Point3 com.beyondar.android.world.BeyondarObject.getBottomRight ( )

Get the bottom right of the BeyondarObject on the 3D world.

Returns: Bottom right 3D.

Here is the caller graph for this function:

double com.beyondar.android.world.BeyondarObject.getDistanceFromUser ( )

Get the Distance from the user in meters.

Returns: Distance in meters.

String com.beyondar.android.world.BeyondarObject.getImageUri ( )

The the image uri used to represent the BeyondarObject.

Returns

Here is the caller graph for this function:

MeshCollider com.beyondar.android.world.BeyondarObject.getMeshCollider ( )

Get the MeshCollider of the GeoObject.

Returns: Mesh collider.

Here is the call graph for this function:

String com.beyondar.android.world.BeyondarObject.getName ( )

Get the name of the BeyondarObject.

Returns: The name of the BeyondarObject.

Here is the caller graph for this function:

Renderable com.beyondar.android.world.BeyondarObject.getOpenGLObject ( )

Get Renderable that renders the BeyondarObject.

Returns: The Renderable used for rendering.

Here is the call graph for this function:

Point3 com.beyondar.android.world.BeyondarObject.getPosition ( )

Get the position where the BeyondarObject is being rendered.

Returns: The 3D position.

Here is the caller graph for this function:

Point3 com.beyondar.android.world.BeyondarObject.getScreenPositionBottomLeft ( )

Get the bottom left screen position of the BeyondarObject on the screen.

use the Z axis to check if the object is in front (z<1) or behind (z>1) the screen.

Returns: Bottom left screen position.

Point3 com.beyondar.android.world.BeyondarObject.getScreenPositionBottomRight ( )

Get the bottom right screen position of the BeyondarObject on the screen.

use the Z axis to check if the object is in front (z<1) or behind (z>1) the screen.

Returns: Bottom right screen position.

Point3 com.beyondar.android.world.BeyondarObject.getScreenPositionCenter ( )

Get the center screen position of the BeyondarObject on the screen.

use the Z axis to check if the object is in front (z<1) or behind (z>1) the screen.

Returns: Center screen position.

Point3 com.beyondar.android.world.BeyondarObject.getScreenPositionTopLeft ( )

Get the top left screen position of the BeyondarObject on the screen.

use the Z axis to check if the object is in front (z<1) or behind (z>1) the screen.

Returns: top left screen position.

Point3 com.beyondar.android.world.BeyondarObject.getScreenPositionTopRight ( )

Get the top right screen position of the BeyondarObject on the screen.

use the Z axis to check if the object is in front (z<1) or behind (z>1) the screen.

Returns: Top right screen position.

Texture com.beyondar.android.world.BeyondarObject.getTexture ( )

Get the Texture used to render the BeyondarObject.

Returns: Texture object in use.

Here is the caller graph for this function:

Point3 com.beyondar.android.world.BeyondarObject.getTopLeft ( )

Get the top left of the BeyondarObject on the 3D world.

Returns: Top left 3D.

Here is the caller graph for this function:

Point3 com.beyondar.android.world.BeyondarObject.getTopRight ( )

Get the top right of the BeyondarObject on the 3D world.

Returns: Top right 3D.

Here is the caller graph for this function:

int com.beyondar.android.world.BeyondarObject.getWorldListType ( )

Get the list type of the BeyondarObject.

Returns: The list type.

boolean com.beyondar.android.world.BeyondarObject.isFacingToCamera ( )

Check if the BeyondarObject is facing the camera.

Returns: True if it is facing.

Here is the caller graph for this function:

boolean com.beyondar.android.world.BeyondarObject.isVisible ( )

Check the visibility of the BeyondarObject.

Returns: True if it is visible, false otherwise.

Here is the caller graph for this function:

void com.beyondar.android.world.BeyondarObject.setAngle	(	float	x,
		float	y,
		float	z
	)

Set the used angle for rendering the BeyondarObject.

Parameters

x	The angle in degrees for x.
y	The angle in degrees for y.
z	The angle in degrees for z.

void com.beyondar.android.world.BeyondarObject.setAngle ( Point3 newAngle )

Set the used angle for rendering the BeyondarObject.

Parameters

newAngle The angle in degrees.

void com.beyondar.android.world.BeyondarObject.setDistanceFromUser ( double distance )

Set how far is the object from the user (meters).

This method is used by the ARRenderer to set this value.

Parameters

distance Distance in meters.

void com.beyondar.android.world.BeyondarObject.setImageResource ( int resId )

Set an image resource for the BeyondarObject.

Parameters

resId The resource id.

Here is the call graph for this function:

void com.beyondar.android.world.BeyondarObject.setImageUri ( String uri )

Set the image uri.

Parameters

uri	The image uri that represents the BeyondarObject.

Here is the call graph for this function:

Here is the caller graph for this function:

void com.beyondar.android.world.BeyondarObject.setName ( String name )

Set the name of the BeyondarObject.

Parameters

name	Name of the BeyondarObject.

void com.beyondar.android.world.BeyondarObject.setPosition ( Point3 newPos )

Get the position where the BeyondarObject is being rendered.

Parameters

newPos New position.

void com.beyondar.android.world.BeyondarObject.setPosition	(	float	x,
		float	y,
		float	z
	)

Set the position where the BeyondarObject is being rendered.

Parameters

newPos New position.

void com.beyondar.android.world.BeyondarObject.setRenderable ( Renderable renderable )

Set a custom Renderable for the BeyondarObject.

Parameters

renderable

void com.beyondar.android.world.BeyondarObject.setTexturePointer ( int texturePointer )

Set the texture pointer of the BeyondarObject.

Parameters

texturePointer The new texture pointer.

void com.beyondar.android.world.BeyondarObject.setVisible ( boolean visible )

Set the visibility of this object.

if it is false, the engine will not render it.

Parameters

visible True to set it visible, false to don't render it.

Here is the caller graph for this function:

Member Data Documentation

Object com.beyondar.android.world.BeyondarObject.lockPlugins = new Object()

protected

Use this lock to access the plugins field.

List<BeyondarObjectPlugin> com.beyondar.android.world.BeyondarObject.plugins

protected

This fields contains all the loaded plugins.

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

src/com/beyondar/android/world/BeyondarObject.java

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation