Lens Scripting API

    Class RectangleSetter

    Positions ScreenTransform according to a cropped region of a texture provided by CropTextureProvider.

    Used with Hand Segmentation texture and ML face effects.

    Crop Textures guide.

    //@input Asset.Texture cropTexture
    var setter = script.getSceneObject().createComponent('RectangleSetter');
    setter.cropTexture = script.cropTexture;

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    constructor

    Properties

    cropTexture enabled sceneObject uniqueIdentifier

    Methods

    destroy getSceneObject getTransform getTypeName isOfType isSame

    Constructors

    Properties

    cropTexture: Texture

    Cropped texture to match the screen region of. Should be a texture using a RectCropTextureProvider, such as a Screen Crop Texture or Face Crop Texture.

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    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