Lens Scripting API

    Class ScreenRegionComponent

    Overrides the settings on a local ScreenTransform to fit specific screen region on the device.

    Screen Transform guide.

    // @input Component.ScreenRegionComponent screenRegionComponent

    script.screenRegionComponent.region = ScreenRegionType.Capture;

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    constructor

    Properties

    enabled region sceneObject uniqueIdentifier

    Methods

    destroy getSceneObject getTransform getTypeName isOfType isSame

    Constructors

    Properties

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    region: ScreenRegionType

    The region of the screen the local ScreenTransform will be fit to.

    sceneObject: SceneObject

    The scene object this component is on.

    uniqueIdentifier: string

    Methods

    • Destroys the component.

      Returns void

    • Returns the name of this object's type.

      Returns string

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

      Parameters

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    MMNEPVFCICPMFPCPTTAAATR