com.panframe.android.lib

Interface PFView

public interface PFView

An interface to the view which is rendering an PFAsset, representing panoramic content

Method Summary

Modifier and Type	Method and Description
PFHotspot	createHotspot(Bitmap image) Create a hotspot object with an image
PFHotspot	createHotspot(View image) Create a hotspot object with a view
void	displayAsset(PFAsset asset) Set the PFAsset to be displayed on the view
float	getHorizontalDegrees() Get the horizontal rotation
float[]	getOrientation() Get orientation in yaw, pitch and roll
float	getVerticalDegrees() Get the horizontal rotation
View	getView() Get the View object to insert into your application
void	handleOrientationChange() Inform the view to adapt to orientation changes.
void	injectImage(Bitmap image) Inject a spherical image into the panoramic view
void	injectImageFromResource(int resourceid) Inject a spherical image into the panoramic view from resource id
void	release() Release the view
void	removeHotspot(PFHotspot hotspot) Remove a hotspot object
void	setBlindSpotImage(Bitmap image) Set a blindspot image to use with the display of the asset
void	setBlindSpotPosition(int position) Set a blindspot image position to use with the display of the asset
void	setBlindSpotScale(float scale) Set a blindspot image scale to use with the display of the asset
void	setFieldOfView(float fov) Set the view Field of View in degrees.
void	setFormat(int format) Set the format of the image
void	setHitOnFocus(boolean focus) Enable hitting of hotspots on focus (center)
void	setMode(int mode, float aspect) Set display mode and optional aspect ratio of content
void	setNavigationMode(PFNavigationMode mode) Sets the navigation mode to use for navigating the panoramic view
void	setViewRotation(float rotation) Set the view rotation manually
void	setViewRotationOffsetX(float rotation) Set the view rotation manually on X
boolean	supportsNavigationMode(PFNavigationMode mode) Checks if a navigation mode is supported by the device

Method Detail

getView

View getView()

Get the View object to insert into your application

displayAsset

void displayAsset(PFAsset asset)

Set the PFAsset to be displayed on the view

Parameters:

asset - The asset to be displayed

supportsNavigationMode

boolean supportsNavigationMode(PFNavigationMode mode)

Checks if a navigation mode is supported by the device

Parameters:

mode - The navigation mode which can be either motion or touch

Returns:

True if the mode is supported, false otherwise.

setNavigationMode

void setNavigationMode(PFNavigationMode mode)

Sets the navigation mode to use for navigating the panoramic view

Parameters:

mode - The navigation mode which can be either motion or touch

setViewRotation

void setViewRotation(float rotation)

Set the view rotation manually

Parameters:

rotation - The rotation in degrees

setViewRotationOffsetX

void setViewRotationOffsetX(float rotation)

Set the view rotation manually on X

Parameters:

rotation - The rotation in degrees

setFieldOfView

void setFieldOfView(float fov)

Set the view Field of View in degrees. Defaults to 75.

Parameters:

fov - The field of view in degrees

handleOrientationChange

void handleOrientationChange()

Inform the view to adapt to orientation changes.

setBlindSpotImage

void setBlindSpotImage(Bitmap image)

Set a blindspot image to use with the display of the asset

Parameters:

image - A bitmap image representing the image

setBlindSpotPosition

void setBlindSpotPosition(int position)

Set a blindspot image position to use with the display of the asset

Parameters:

position - The position for the blindspot image to appear. 0: none, 1: bottom, 2: top.

setBlindSpotScale

void setBlindSpotScale(float scale)

Set a blindspot image scale to use with the display of the asset

Parameters:

scale - The scale for the blindspot image to appear.

createHotspot

PFHotspot createHotspot(Bitmap image)

Create a hotspot object with an image

Parameters:

image - The image to visualize the hotspot

createHotspot

PFHotspot createHotspot(View image)

Create a hotspot object with a view

Parameters:

view - The view to visualize the hotspot

removeHotspot

void removeHotspot(PFHotspot hotspot)

Remove a hotspot object

Parameters:

hotspot - The hotspot to be removed

release

void release()

Release the view

injectImage

void injectImage(Bitmap image)

Inject a spherical image into the panoramic view

Parameters:

image - A spherical bitmap image

injectImageFromResource

void injectImageFromResource(int resourceid)

Inject a spherical image into the panoramic view from resource id

Parameters:

image - A bitmap resource id

setMode

void setMode(int mode,
             float aspect)

Set display mode and optional aspect ratio of content

Parameters:

mode - Select 0 for spherical, 1 for flat display, 2 for stereo side-by-side

aspect - The aspect ratio of the content in flat view mode

setFormat

void setFormat(int format)

Set the format of the image

Parameters:

format - Select 0 for regular spherical panorama and 1 for top-down formatted spherical panorama

getOrientation

float[] getOrientation()

Get orientation in yaw, pitch and roll

getHorizontalDegrees

float getHorizontalDegrees()

Get the horizontal rotation

getVerticalDegrees

float getVerticalDegrees()

Get the horizontal rotation

setHitOnFocus

void setHitOnFocus(boolean focus)

Enable hitting of hotspots on focus (center)

Parameters:

focus - Set true for hit on focus, false to interact only with touch.