Maps SDK for Android/com.magiclane.sdk.d3scene/Screen

Screen

class Screen(address: Long) : GemNativeObj

Screen object. It supports rendering in an OpenGL context. It is possible to use the rendering in two ways:

Render on demand. The UI requests the screen to be rendered in the attached context.
Render automatically. For example when the map is scrolled or rotated the map is rendered automatically in the attached context and the UI is notified when finished. View objects require a Screen in order to be created. After creation a View will hold a strong pointer to its Screen.

Constructors

Screen

constructor(address: Long)

Types

Companion

object Companion

Screen companion

Properties

address

val address: Long

Address of native referenced object. nullptr if not referencing any native allocated object. Note native allocation will happen only once.

canvases

val canvases: ArrayList<Canvas>?

All canvases.

openGLContext

val openGLContext: IOpenGLContext?

Gets OpenGL Context

renderingRule

var renderingRule: ERenderRule

Rendering rule. Default value if ERR_OnDemand

viewport

val viewport: Rect?

Viewport

views

val views: ArrayList<MapView>?

All views.

Functions

finalize

fun finalize()

Overrides finalize that garbage collector will call when needed.

handleTouchEvent

fun handleTouchEvent(event: ETouchEvent, touchId: Int, tXy: Xy)

Handle a screen touch event with the given id, see TouchEvent for types

hitTestFloat

external fun hitTestFloat(xy: XyF): Canvas?

Hit test returns the map service under the given screen coordinates. With float type: coordinates are screen fraction ( 0 - 1.f )

hitTestInt

external fun hitTestInt(tXy: Xy): Canvas?

Hit test returns the map service under the given screen coordinates. With int type: coordinates are screen

isReference

fun isReference(): Boolean

True if keeps a reference to a C++ SDK object False if keeps a C++ SDK object

needsRender

external fun needsRender()

Mark screen with pending render request

not

operator fun not(): Boolean

Checks if this object is valid.

release

fun release()

Releases the native referenced value of this object if:

render

fun render()

This requests a redraw of the map. TRenderRule must be ERenderOnDemand

resetContext

external fun resetContext()

resetContextTrue

external fun resetContextTrue()

Reset screen context. The context is lost and the screen will reset all its resources Notifies screen that the attached OpenGLContext has changed. This will trigger updates in the SDK textures, font etc.

resize

external fun resize(size: Size)

Resize the screen

scrollEvent

external fun scrollEvent(delta: Int, tXy: Xy)

Handles a scroll event