OverlayInterface

class Sc.OverlayInterface()

Index

Methods

• destroy
• maxIndex
• setCamera
• setViewport
• setVisible

Methods

Sc.OverlayInterface.destroy()

destroy(viewKey: ViewKey, index: number): void

Parameters

viewKey: ViewKey

index: number

Returns: void

Sc.OverlayInterface.maxIndex()

maxIndex(): number

Returns: number

Sc.OverlayInterface.setCamera()

setCamera(viewKey: ViewKey, index: number, Camera: Camera): void

Parameters

viewKey: ViewKey

index: number

Camera: Camera

Returns: void

Sc.OverlayInterface.setViewport()

setViewport(viewKey: ViewKey, index: number, anchor: OverlayAnchor, xOffset: number, xUnit: OverlayUnit, yOffset: number, yUnit: OverlayUnit, width: number, widthUnit: OverlayUnit, height: number, heightUnit: OverlayUnit): void

Parameters

viewKey: ViewKey

index: number

anchor: OverlayAnchor

xOffset: number

xUnit: OverlayUnit

yOffset: number

yUnit: OverlayUnit

width: number

widthUnit: OverlayUnit

height: number

heightUnit: OverlayUnit

Returns: void

Sc.OverlayInterface.setVisible()

setVisible(viewKey: ViewKey, index: number, visibility: boolean): void

Parameters

viewKey: ViewKey

index: number

visibility: boolean

Returns: void