korge/korlibs.korge.view/Views

Views

class Views(val coroutineContext: CoroutineContext, val ag: AG, val injector: Injector = Injector(), val input: Input = Input(), val timeProvider: TimeProvider = TimeProvider, val stats: Stats = Stats(), val gameWindow: GameWindow, val gameId: String = "korgegame", val settingsFolder: String? = null, val batchMaxQuads: Int = BatchBuilder2D.DEFAULT_BATCH_QUADS, val bp: BoundsProvider = BoundsProvider.Base(), val stageBuilder: (Views) -> Stage = { Stage(it) }) : BaseEventListener, Extra, CoroutineScope, ViewsContainer, BoundsProvider, DialogInterfaceProvider, Closeable, ResourcesContainer, InvalidateNotifier, DeviceDimensionsProvider

Heavyweight singleton object within the application that contains information about the Views. It contains information about the coroutineContext, the gameWindow, the injector, the input and contains a reference to the root view.

Constructors

constructor(gameWindow: GameWindow)

constructor(coroutineContext: CoroutineContext, ag: AG, injector: Injector = Injector(), input: Input = Input(), timeProvider: TimeProvider = TimeProvider, stats: Stats = Stats(), gameWindow: GameWindow, gameId: String = "korgegame", settingsFolder: String? = null, batchMaxQuads: Int = BatchBuilder2D.DEFAULT_BATCH_QUADS, bp: BoundsProvider = BoundsProvider.Base(), stageBuilder: (Views) -> Stage = { Stage(it) })

Types

data class SaveEvent(val action: String, val view: View?)

Properties

val actualHeight: Int

actualVirtualBottom

open override val actualVirtualBottom: Double

actualVirtualBounds

open override var actualVirtualBounds: Rectangle

actualVirtualHeight

open override val actualVirtualHeight: Int

actualVirtualLeft

open override val actualVirtualLeft: Int

actualVirtualRight

open override val actualVirtualRight: Double

actualVirtualTop

open override val actualVirtualTop: Int

actualVirtualWidth

open override val actualVirtualWidth: Int

val actualWidth: Int

val ag: AG

val ViewsContainer.ag: AG

agBitmapTextureManager

val ~~agBitmapTextureManager~~: AgBitmapTextureManager

agBufferManager

val ~~agBufferManager~~: AgBufferManager

androidActivity

val Views.androidActivity: KorgwActivity

androidActivityOrNull

val Views.androidActivityOrNull: KorgwActivity?

val Views.androidContext: Context

val batchMaxQuads: Int

val bp: BoundsProvider

clampElapsedTimeTo

var clampElapsedTimeTo: Duration

var clearColor: RGBA

var clearEachFrame: Boolean

var clipBorders: Boolean

completedEditing

val completedEditing: Signal<Unit>

computedPixelRatio

open override val computedPixelRatio: Double

coroutineContext

open override val coroutineContext: CoroutineContext

var currentVfs: VfsFile

lateinit var debugBmpFont: BitmapFont

var debugFontColor: RGBA

debugFontExtraScale

var debugFontExtraScale: Double

val debugHandlers: FastArrayList<Views.(RenderContext) -> Unit>

debugHighlighters

val debugHighlighters: Signal<View?>

debugHightlightViewLogger

val debugHightlightViewLogger: Logger

debugSavedHandlers

val debugSavedHandlers: Signal<Views.SaveEvent>

var debugViews: Boolean

devicePixelRatio

open override val devicePixelRatio: Double

dialogInterface

open override val dialogInterface: DialogInterface

var editingMode: Boolean

eventListenerParent

var eventListenerParent: BaseEventListener?

open override var extra: ExtraType

forceRenderEveryFrame

var forceRenderEveryFrame: Boolean

val gameId: String

val gameIdFolder: String

val gameWindow: GameWindow

val globalMousePos: Vector2D

Mouse coordinates relative to the Stage singleton

globalResources

val globalResources: Resources

globalToWindowMatrix

open override var globalToWindowMatrix: Matrix

globalToWindowScale

open override val globalToWindowScale: Scale

globalToWindowScaleAvg

open override val globalToWindowScaleAvg: Double

globalToWindowScaleX

open override val globalToWindowScaleX: Double

globalToWindowScaleY

open override val globalToWindowScaleY: Double

globalToWindowTransform

open override var globalToWindowTransform: MatrixTransform

val Views.hapticFeedback: HapticFeedback

var imageFormats: ImageFormatsMutable

val injector: Injector

val input: Input

val keys: InputKeys

var lastTime: DateTime

var name: String?

val nativeHeight: Int

Native height in pixels (in retina displays this will be twice the window height). Use virtualHeight instead

val nativeWidth: Int

Native width in pixels (in retina displays this will be twice the window width). Use virtualWidth instead

val onAfterRender: Signal<RenderContext>

val onBeforeRender: Signal<RenderContext>

var Views.openedComboBox: UIComboBox<*>?

open override val pixelsPerCm: Double

Approximate on iOS

open override val pixelsPerInch: Double

Approximate on iOS

pixelsPerLogicalInchRatio

open override val pixelsPerLogicalInchRatio: Double

var printRendering: Boolean

val propsTriggers: HashMap<String, (View, String, String) -> Unit>

var quality: GameWindow.Quality

realSettingsFolder

val realSettingsFolder: String

registerFilterSerialization

var Views.registerFilterSerialization: Boolean

val renderContext: RenderContext

open override val resources: Resources

rethrowRenderError

var rethrowRenderError: Boolean

val root: Stage

Reference to the root node Stage (alias)

var scaleAnchor: Anchor2D

var scaleMode: ScaleMode

val settingsFolder: String? = null

val stage: Stage

Reference to the root node Stage

val stageBuilder: (Views) -> Stage

val stats: Stats

val Views.storage: NativeStorage

val ViewsContainer.storage: NativeStorage

supportTogglingDebug

var supportTogglingDebug: Boolean

var targetFps: Double

val timeProvider: TimeProvider

updatedSinceFrame

var updatedSinceFrame: Int

val Views.vibration: NativeVibration

val viewFactories: ArrayList<ViewFactory>

open override val views: Views

open override val virtualBottom: Double

var virtualHeight: Int

The defined virtual height

virtualHeightDouble

var virtualHeightDouble: Double

open override val virtualLeft: Double

virtualPixelsPerCm

val virtualPixelsPerCm: Double

virtualPixelsPerInch

val virtualPixelsPerInch: Double

open override val virtualRight: Double

virtualSizeDouble

var virtualSizeDouble: Size

open override val virtualTop: Double

var virtualWidth: Int

The defined virtual width

virtualWidthDouble

var virtualWidthDouble: Double

val windowMousePos: Point

Mouse coordinates relative to the native window. Can't be used directly. Use globalMousePos instead

windowToGlobalMatrix

open override var windowToGlobalMatrix: Matrix

windowToGlobalScale

open override val windowToGlobalScale: Scale

windowToGlobalScaleAvg

open override val windowToGlobalScaleAvg: Double

windowToGlobalScaleX

open override val windowToGlobalScaleX: Double

windowToGlobalScaleY

open override val windowToGlobalScaleY: Double

windowToGlobalTransform

open override var windowToGlobalTransform: MatrixTransform

Functions

addDebugRenderer

fun addDebugRenderer(block: Views.(RenderContext) -> Unit)

suspend fun DialogInterfaceProvider.alert(message: String)

suspend fun DialogInterfaceProvider.alertError(e: Throwable)

suspend fun DialogInterfaceProvider.browse(url: URL)

fun clearEvents()

fun <T : BEvent> clearEvents(type: EventType<T>)

open override fun close()

suspend fun closeSuspend()

suspend fun DialogInterfaceProvider.confirm(message: String): Boolean

debugHightlightView

fun debugHightlightView(viewToHightlight: View?, onlyIfDebuggerOpened: Boolean = false)

fun debugSaveView(e: Views.SaveEvent)

fun debugSaveView(action: String, view: View?)

override fun <T : BEvent> dispatch(event: T): Boolean

override fun <T : BEvent> dispatch(type: EventType<T>, event: T, result: EventResult?): Boolean

open override fun <T : BEvent> dispatch(type: EventType<T>, event: T, result: EventResult?, up: Boolean, down: Boolean): Boolean

Dispatched a event of type that will execute all the handlers registered with onEvents in this object and its children.

dispatchChildren

open fun <T : BEvent> dispatchChildren(type: EventType<T>, event: T, result: EventResult?)

open fun <T : BEvent> dispatchDown(type: EventType<T>, event: T, result: EventResult? = null): Boolean

fun <T : BEvent> EventListener.dispatchDown(event: T): Boolean

open fun <T : BEvent> dispatchParent(type: EventType<T>, event: T, result: EventResult?)

open fun <T : BEvent> dispatchUp(type: EventType<T>, event: T, result: EventResult? = null): Boolean

fun <T : BEvent> EventListener.dispatchUp(event: T): Boolean

dispatchWithResult

override fun <T : BEvent> dispatchWithResult(event: T, out: EventResult): EventResult

fun dumpStats()

frameUpdateAndRender

fun frameUpdateAndRender(fixedSizeStep: TimeSpan = TimeSpan.NIL, forceRender: Boolean = false, doUpdate: Boolean = true, doRender: Boolean = true)

getSelfEventCount

fun getSelfEventCount(type: EventType<*>): Int

globalToWindowBounds

open override fun globalToWindowBounds(bounds: Rectangle): Rectangle

globalToWindowCoords

open override fun globalToWindowCoords(pos: Point): Point

suspend fun init()

installMouseDebugExtensionOnce

fun ViewsContainer.installMouseDebugExtensionOnce()

invalidatedView

open override fun invalidatedView(view: BaseView?)

fun mouseUpdated()

fun onClose(callback: suspend () -> Unit)

Adds a callback to be executed when the game is closed in normal circumstances.

override fun <T : BEvent> onEvent(type: EventType<T>, handler: (T) -> Unit): CloseableCancellable

Registers a handler block to be executed when an event of type is dispatched

override fun onEventCount(type: EventType<*>): Int

open fun <T : BEvent> onEvents(vararg etypes: EventType<out T>, handler: (T) -> Unit): Closeable

override fun onEventsCount(): FastIdentityMap<EventType<*>, Int>?

suspend fun DialogInterfaceProvider.openFileDialog(filter: String? = null, write: Boolean = false, multi: Boolean = false): List<VfsFile>

suspend fun DialogInterfaceProvider.openFileDialog(filter: FileFilter? = null, write: Boolean = false, multi: Boolean = false, currentDir: VfsFile? = null): List<VfsFile>

suspend fun DialogInterfaceProvider.prompt(message: String, default: String = ""): String

registerFilterSerialization

fun ViewsContainer.registerFilterSerialization()

registerPropertyTrigger

fun registerPropertyTrigger(propName: String, gen: (View, String, String) -> Unit)

registerPropertyTriggerSuspend

fun registerPropertyTriggerSuspend(propName: String, gen: suspend (View, String, String) -> Unit)

registerStageComponent

fun Views.registerStageComponent(view: View)

Enables the use of StageComponent components.

fun render()

fun renderNew(frameBuffer: AGFrameBuffer = ag.mainFrameBuffer)

fun resized(width: Int, height: Int)

fun BoundsProvider.setBoundsInfo(reqVirtualSize: Size, actualSize: Size, scaleMode: ScaleMode = ScaleMode.FILL, anchor: Anchor = Anchor.CENTER, virtualSize: Ref<SizeInt> = Ref(), targetSize: Ref<SizeInt> = Ref())

fun setVirtualSize(width: Int, height: Int)

simulateRenderFrame

fun Views.simulateRenderFrame(view: View, posterize: Int = 0, includeBackground: Boolean = true, useTexture: Boolean = true): Bitmap32

fun startFrame()

fun <T : View?> undoable(action: String, view: T, block: (T) -> Unit)

fun update(elapsed: TimeSpan)

windowToGlobalCoords

open override fun windowToGlobalCoords(pos: Point): Point