com.here.android.mpa.ar

Class ARObject

java.lang.Object

com.here.android.mpa.ar.ARObject

Direct Known Subclasses:

ARIconObject

public abstract class ARObject
extends java.lang.Object

Represents a base class for all AR related objects that users can add to a ARController.

This class serves as a generalization (or abstract base) for more specified object types (such as ARIconObject), bundling their common properties.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ARObject.IconType Icon types used by ARObject

Field Summary

Fields

Modifier and Type	Field and Description
protected com.nokia.maps.ARObjectImpl	m_basePimpl

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ARObject(com.nokia.maps.ARObjectImpl impl) Internal Constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
android.graphics.RectF	getBoundingBox() Get bounding box limiting where the ARObject can travel on screen.
GeoCoordinate	getCoordinate() Gets the current GeoCoordinate for the ARObject.
Image	getIcon(ARObject.IconType type) Gets the icon image for the ARObject
android.graphics.PointF	getIconAnchor(ARObject.IconType type) Get down icon's anchor point represented as halfs of width and height of the icon.
float	getIconSizeScale(ARObject.IconType type) Gets icon's size scaling factor
float	getMaxViewAngle() Get item's max view angle when the item is on the right or left from line of sight.
float	getOpacity() Get item's opacity.
ARController.ProjectionType	getProjectionType() Get Camera view ARController.ProjectionType
long	getUid() Get unique identifier.
int	hashCode()
boolean	isInfoExtended() Checks if info portion of the ARObject is extended
void	setBoundingBox(android.graphics.RectF box) Set bounding box to limit travel on the screen.
void	setCoordinate(GeoCoordinate coordinate) Sets a GeoCoordinate for the ARObject.
void	setIcon(ARObject.IconType type, android.graphics.Bitmap icon) Sets an icon image for the ARObject.
void	setIcon(ARObject.IconType type, Image icon) Sets an icon image for the ARObject.
void	setIcon(ARObject.IconType type, android.view.View icon) Sets an icon image for the ARObject.
void	setIconAnchor(ARObject.IconType type, android.graphics.PointF anchor) Set icon's anchor point represented as halfs of width and height of the icon.
void	setIconSizeScale(ARObject.IconType type, float scale) Sets icon's size scaling factor
void	setIconTexture(ARObject.IconType type, int texture, int width, int height) Sets an OpenGL texture name for the specified icon in the ARObject.
void	setInfoMaxHeight(int height) Sets maximum height for the ARObject's info portion of the icon
void	setInfoMaxWidth(int width) Sets maximum width for the ARObject's info portion of the icon
void	setMaxViewAngle(float angleDeg) Set item max view angle when the item is on the right or left from line of sight.
void	setOpacity(float value) Set item's opacity.
void	setProjectionType(ARController.ProjectionType type) Set Camera view ARController.ProjectionType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_basePimpl

protected com.nokia.maps.ARObjectImpl m_basePimpl

Audience:

internal

Constructor Detail

ARObject

protected ARObject(com.nokia.maps.ARObjectImpl impl)

Internal Constructor

Parameters:

impl - The impl object to be constructed of.

Audience:

internal

Method Detail

getUid

public long getUid()

Get unique identifier. Helper method to accommodate faster mapping of the ARObject and application specific objects (Example: items "radar" implementation)

Returns:

Unique object identifier

setCoordinate

public void setCoordinate(GeoCoordinate coordinate)

Sets a GeoCoordinate for the ARObject.

Parameters:

coordinate - Desired GeoCoordinate for ARObject

getCoordinate

public GeoCoordinate getCoordinate()

Gets the current GeoCoordinate for the ARObject.

Returns:

The current GeoCoordinate

setIconTexture

public void setIconTexture(ARObject.IconType type,
                           int texture,
                           int width,
                           int height)

Sets an OpenGL texture name for the specified icon in the ARObject. Previously set image (using ARObject.setIcon(ARObject.IconType, Image) for example) is not disposed and can be used when texture is cleaned. Texture can be cleaned by passing -1 for texture parameter (i.e. setIconTexture(IconType.FRONT, -1, 0, 0)).

Parameters:

type - An ARObject.IconType

texture - An OpenGL texture name corresponding to the icon type specified.

width - An OpenGL texture width

height - An OpenGL texture height

setIcon

public void setIcon(ARObject.IconType type,
                    Image icon)

Sets an icon image for the ARObject.

Parameters:

type - An ARObject.IconType.

icon - An Image representing the icon type.

setIcon

public void setIcon(ARObject.IconType type,
                    android.view.View icon)

Sets an icon image for the ARObject.

Parameters:

type - An ARObject.IconType.

icon - An View representing the icon type.

setIcon

public void setIcon(ARObject.IconType type,
                    android.graphics.Bitmap icon)

Sets an icon image for the ARObject.

Parameters:

type - An ARObject.IconType.

icon - An Bitmap representing the icon type.

getIcon

public Image getIcon(ARObject.IconType type)

Gets the icon image for the ARObject

Parameters:

type - An ARObject.IconType.

Returns:

An Image representing the front icon

setIconAnchor

public void setIconAnchor(ARObject.IconType type,
                          android.graphics.PointF anchor)

Set icon's anchor point represented as halfs of width and height of the icon. Example: value of (1, 1) means that the center of the icon corresponds to the actual geo position. Value (1,2) means that half width and bottom of the icon corresponds to the actual geo position. Default value is (1, 1).

Parameters:

type - An ARObject.IconType.

anchor - X and Y offset coefficients represented as halfs of the icon width and height. Range is 0 to 2.0f. 0 --- 1 --- 2 | | | 1 --- x --- x | | | 2 --- x --- x

getIconAnchor

public android.graphics.PointF getIconAnchor(ARObject.IconType type)

Get down icon's anchor point represented as halfs of width and height of the icon.

Parameters:

type - An ARObject.IconType.

Returns:

down icon's opacity.

setInfoMaxWidth

public void setInfoMaxWidth(int width)

Sets maximum width for the ARObject's info portion of the icon

Parameters:

width - A maximum width of the ARObject info portion on the screen

setInfoMaxHeight

public void setInfoMaxHeight(int height)

Sets maximum height for the ARObject's info portion of the icon

Parameters:

height - A maximum height of the ARObject info portion on the screen

isInfoExtended

public boolean isInfoExtended()

Checks if info portion of the ARObject is extended

Returns:

True, if object has expended info portion of the icon.

setIconSizeScale

public void setIconSizeScale(ARObject.IconType type,
                             float scale)

Sets icon's size scaling factor

Parameters:

type - ARObject.IconType

scale - A size scaling factor

getIconSizeScale

public float getIconSizeScale(ARObject.IconType type)

Gets icon's size scaling factor

Parameters:

type - ARObject.IconType

Returns:

scale A size scaling factor

setBoundingBox

public void setBoundingBox(android.graphics.RectF box)

Set bounding box to limit travel on the screen. Left, top, right and bottom values are the ratios of the view's height and width. Value of 0 for left an top and 1 for right and bottom indicate that there are no boundaries are actually used. Values > 0 and < 1 are used to set absolute screen boundaries.

Parameters:

box - RectF Item's bounding box. If null, bounding box is set to {0, 0, 1, 1}.

getBoundingBox

public android.graphics.RectF getBoundingBox()

Get bounding box limiting where the ARObject can travel on screen.

Returns:

The android.graphics.RectF representing the bounding box.

setMaxViewAngle

public void setMaxViewAngle(float angleDeg)

Set item max view angle when the item is on the right or left from line of sight.

Parameters:

angleDeg - The view angle of the item. The range is: -angleDeg to +angleDeg.

getMaxViewAngle

public float getMaxViewAngle()

Get item's max view angle when the item is on the right or left from line of sight.

Returns:

The view angle of the item. The range is: -angleDeg to +angleDeg.

setProjectionType

public void setProjectionType(ARController.ProjectionType type)

Set Camera view ARController.ProjectionType

Parameters:

type - A value of ProjectionType.

getProjectionType

public ARController.ProjectionType getProjectionType()

Get Camera view ARController.ProjectionType

Returns:

A value of ProjectionType

setOpacity

public void setOpacity(float value)

Set item's opacity. Setting item's opacity overrides the calculated value. Setting negative value resets previous setting to the default - calculated one.

Parameters:

value - A value of the opacity.

getOpacity

public float getOpacity()

Get item's opacity. NOTE: Setting item's opacity overrides calculated value.

Returns:

A value of the opacity.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

Override:

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

Override: