_DBrowser Class Reference

Inherits from UIView
Conforms to CLLocationManagerDelegate
UIGestureRecognizerDelegate
renderProtocol
Declared in 3DBrowser.h

Overview

3D Browser main class

  delegate

3D Browser delegate instance

@property (weak, nonatomic) id<EDBrowserProtocol> delegate

Declared In

3DBrowser.h

– initBrowser:withKey:setDebug:representation:

Init 3D Browser instance

- (id)initBrowser:(CGRect)frame withKey:(NSString *)key setDebug:(BOOL)isDebug representation:(poiRepresentation)representation

Parameters

frame

3D Browser frame
key

license key provided
isDebug

display debug logs
representation

POI representation

Return Value

3D Browser instance

Declared In

3DBrowser.h

– setUrlConnections:displayLoading:

Set the connection type to retrieve selection and non selection textures

- (void)setUrlConnections:(connType)connectionType displayLoading:(BOOL)loading

Parameters

connectionType

SYNC or ASYNC. Default ASYNC.
loading

Whether to display or not a loading while loading the textures ASYNC. Default NO.

Declared In

3DBrowser.h

– add:

Adds POI

- (NSInteger)add:(Poi *)poi

Parameters

poi

POI to be added

Return Value

uId of the Poi added

Declared In

3DBrowser.h

– add:withId:

Adds POI

- (BOOL)add:(Poi *)poi withId:(NSInteger)uId

Parameters

poi

POI to be added
uId

unique ID of the Poi to be added

Return Value

YES if Poi successfuly added and the ID is unique.

Declared In

3DBrowser.h

– updateLocation:

Update user location in order to display the POIs accordingly

- (void)updateLocation:(CLLocation *)newuserLocation

Parameters

newuserLocation

New user location

Declared In

3DBrowser.h

– updateUserLocation:

Update user cardinal location in order to display the POIs accordingly

- (void)updateUserLocation:(CGPoint)newuserLocationc

Parameters

newuserLocationc

New user location

Declared In

3DBrowser.h

– setMotionManager:

Set motion manager

- (void)setMotionManager:(CMMotionManager *)m

Parameters

m

motion manager instance

Declared In

3DBrowser.h

– remove:

Remove POI

- (BOOL)remove:(Poi *)poi

Parameters

poi

POI to be removed

Return Value

YES if Poi successfuly removed

Declared In

3DBrowser.h

– removePoiWithId:

Remove POI

- (BOOL)removePoiWithId:(NSInteger)uId

Parameters

uId

unique ID of the Poi to be removed

Return Value

YES if Poi successfuly removed

Declared In

3DBrowser.h

– removeAllPois

Remove all POIs

- (void)removeAllPois

Declared In

3DBrowser.h

– getPoi:

Get POI

- (Poi *)getPoi:(NSInteger)uId

Parameters

uId

Unique id of the POI to retrieve

Return Value

Poi

Declared In

3DBrowser.h

– addPoleIcons

Add reference icons in the 4 main cardinal points

- (void)addPoleIcons

Declared In

3DBrowser.h

– removePoleIcons

Remove cardinal points reference icons

- (BOOL)removePoleIcons

Return Value

YES if successfully remove, NO otherwise

Declared In

3DBrowser.h

– setPoiSize:

Set POI size

- (void)setPoiSize:(Poi *)inPoi

Parameters

inPoi

poi to change size.

Declared In

3DBrowser.h

– refreshPoiTextures:

Refresh poi texture Use this function to change the texture on run time.

- (void)refreshPoiTextures:(Poi2D *)inPoi

Parameters

inPoi

poi to refresh texture.

Declared In

3DBrowser.h

– refreshPoiAlpha:

Refresh poi alpha Use this function to change the alpha of a poi on run time.

- (void)refreshPoiAlpha:(Poi2D *)inPoi

Parameters

inPoi

poi to refresh texture.

Declared In

3DBrowser.h

– spin3DPOI:

Rotate 3D POI

- (void)spin3DPOI:(UIPanGestureRecognizer *)recognizer

Parameters

recognizer

pan gesture

Declared In

3DBrowser.h

– setPoiSelectionModel:withPOICamera:withAnimMode:withAnimSpeed:followPath:

Set a selection model. he selection model is a POI that moves from the old selected POI to the new selected one.

- (BOOL)setPoiSelectionModel:(NSString *)modelPath withPOICamera:(poi_camera)poiCam withAnimMode:(animationMode)animMode withAnimSpeed:(NSInteger)animSpeed followPath:(BOOL)followPath

Parameters

modelPath

3D POI model path
poiCam

@link poi_camera type
animMode

@link animationMode type
animSpeed

animation speed
followPath

if YES, the transition POI follows the 3D rect between old and new selected POIs. If NO, just moves from old POI’s position to new POI’s position.

Return Value

BOOL YES if selection POI properly configured, NO otherwise.

Declared In

3DBrowser.h

– removePoiSelectionModel

Remove selection model

- (BOOL)removePoiSelectionModel

Return Value

BOOL: YES if selection POI properly removed, NO otherwise

Declared In

3DBrowser.h

– setSelectionAnimationMode:

Set selection POI animation Mode

- (void)setSelectionAnimationMode:(animationMode)animMode

Parameters

animMode

@link animationMode type

Declared In

3DBrowser.h

– setSelectionPoiCam:

Set selection POI camera Mode

- (void)setSelectionPoiCam:(poi_camera)poiCam

Parameters

poiCam

@link poi_camera type

Declared In

3DBrowser.h

– setSelectionPoiSpeed:

Set selection POI speed

- (void)setSelectionPoiSpeed:(NSInteger)animSpeed

Parameters

animSpeed

from fast (1) to slow (10)

Declared In

3DBrowser.h

– setSelectionPoiFollowPath:

Set whether the selection POI follows the 3D rect (path) between POIs

- (void)setSelectionPoiFollowPath:(BOOL)followPath

Parameters

followPath

YES to follow the path, NO otherwise

Declared In

3DBrowser.h

– stopAnimation:

Stop 3D POI animation

- (void)stopAnimation:(Poi3D *)inPoi

Parameters

inPoi

poi

Declared In

3DBrowser.h

– playAnimation:withName:

Play 3D POI animation

- (void)playAnimation:(Poi3D *)inPoi withName:(NSString *)animName

Parameters

inPoi

poi
animName

animation name

Declared In

3DBrowser.h

– releaseBrowser

Release Browser

- (void)releaseBrowser

Declared In

3DBrowser.h