Lens Scripting API
    Preparing search index...

    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)

    Index

    Properties

    cropTexture enabled isEnabledInHierarchy sceneObject uniqueIdentifier

    Methods

    destroy getSceneObject getTransform getTypeName isOfType isSame

    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.

    isEnabledInHierarchy: boolean

    Returns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.

    sceneObject: SceneObject

    The SceneObject 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

    Properties
    Methods