Lens Scripting API

    Class SpriteVisual

    This class has been deprecated and replaced with the Image component.

    Represents a renderable 2D visual in Lens Studio.

    // Flip the Sprite upside down
    //@input Component.SpriteVisual sprite
    script.sprite.flipY = true;

    // Change the Sprite's fill mode to "stretch"
    //@input Component.SpriteVisual sprite
    script.sprite.fillMode = 2;

    // Change the Sprite's pivot point to top right corner
    //@input Component.SpriteVisual sprite
    script.sprite.pivot = new vec2(1,1);

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    constructor

    Properties

    enabled extentsTarget fillMode flipX flipY horizontalAlignment mainMaterial mainPass mainPassOverrides materials meshShadowMode pivot propertyOverrides sceneObject shadowColor shadowDensity stretchMode uniqueIdentifier verticalAlignment

    Methods

    addMaterial clearMaterials destroy getMaterial getMaterialsCount getMeshSize getRenderOrder getSceneObject getTransform getTypeName isOfType isSame localAabbMax localAabbMin setRenderOrder snap worldAabbMax worldAabbMin

    Constructors

    Properties

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    extentsTarget: ScreenTransform

    When a ScreenTransform is present on this SceneObject, and extentsTarget is a child of this SceneObject, extentsTarget will be repositioned to match the exact area this MeshVisual is being rendered. Very useful for Image and Text components.

    fillMode: number

    Which type of fill the sprite uses.

    Possible values:

    Fit = 0 Fill = 1 Stretch = 2

    flipX: boolean

    Whether the sprite is flipped over the Y-axis (sideways).

    flipY: boolean

    Whether the sprite is flipped over the X-axis (upside-down).

    horizontalAlignment: HorizontalAlignment

    When a ScreenTransform is attached to the same SceneObject, this controls how the mesh will be positioned horizontally depending on stretchMode.

    mainMaterial: Material

    Returns the first Material.

    mainPass: Pass

    Returns the mainPass of the mainMaterial.

    mainPassOverrides: any

    Overrides the mainPass on the material, without affecting other visuals referencing the same material.

    materials: Material[]

    Get the array of materials used by the MaterialMeshVisual.

    meshShadowMode: MeshShadowMode

    None = 0, Caster = 1, Receiver = 2

    pivot: vec2

    The location of the sprite's pivot point relative to its boundaries. The pivot's x value is a relative horizontal position, -1 being the sprite's left border and 1 being the sprite's right border. Similarly, the y value is a relative vertical position, -1 being the sprite's bottom border and 1 being the sprite's top border.

    propertyOverrides: PropertyOverrides

    Overrides the property on the material, without affecting other visuals referencing the same material.

    sceneObject: SceneObject

    The scene object this component is on.

    shadowColor: vec4

    Affects the color of shadows being cast by this MeshVisual. The color of the cast shadow is a mix between shadowColor and the material's base texture color. The alpha value of shadowColor controls the mixing of these two colors, with 0 = shadowColor and 1 = shadowColor * textureColor.

    shadowDensity: number

    Density of shadows cast by this MeshVisual.

    stretchMode: StretchMode

    When a ScreenTransform is attached to the same SceneObject, this controls how the mesh will be stretched relative to the ScreenTransform's boundaries.

    uniqueIdentifier: string
    verticalAlignment: VerticalAlignment

    When a ScreenTransform is attached to the same SceneObject, this controls how the mesh will be positioned vertically depending on stretchMode.

    Methods

    • Returns the width and height of the mesh the SpriteVisual is applied to.

      Returns vec2

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

      Parameters

      • type: string

      Returns boolean

    • Sets the order of this Visual in the render queue.

      Parameters

      • value: number

      Returns void

    • Projects screen positions from camera's view onto the mesh's UVs. If the MeshVisual's material uses the same texture as the camera input, the MeshVisual will look identical to the part of the screen it covers.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    MMNEPVFCICPMFPCPTTAAATR