OverlayInterface

class Sc.OverlayInterface()

Methods

• destroy()

• maxIndex()

• setCamera()

• setViewport()

• setVisible()

---

Methods

destroy

OverlayInterface.destroy(viewKey, index)

Arguments

• viewKey (ViewKey()) – None

• index (number()) – None

Return type

void

maxIndex

OverlayInterface.maxIndex()

Return type

number

setCamera

OverlayInterface.setCamera(viewKey, index, Camera)

Arguments

• viewKey (ViewKey()) – None

• index (number()) – None

• Camera (Camera()) – None

Return type

void

setViewport

OverlayInterface.setViewport(viewKey, index, anchor, xOffset, xUnit, yOffset, yUnit, width, widthUnit, height, heightUnit)

Arguments

• viewKey (ViewKey()) – None

• index (number()) – None

• anchor (OverlayAnchor()) – None

• xOffset (number()) – None

• xUnit (OverlayUnit()) – None

• yOffset (number()) – None

• yUnit (OverlayUnit()) – None

• width (number()) – None

• widthUnit (OverlayUnit()) – None

• height (number()) – None

• heightUnit (OverlayUnit()) – None

Return type

void

setVisible

OverlayInterface.setVisible(viewKey, index, visibility)

Arguments

• viewKey (ViewKey()) – None

• index (number()) – None

• visibility (boolean()) – None

Return type

void