Lens Scripting API

    Class Label

    Displays text in the scene. This is now deprecated in favor of Text. See the Text guide for more information.

    // Set a label's text

    //@input Component.Label label

    script.label.text = "My New Text";

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    constructor

    Properties

    enabled extentsTarget fillMode flipX flipY fontAsset horizontalAlignment mainMaterial mainPass mainPassOverrides materials meshShadowMode outlineColor outlineSize pivot propertyOverrides sceneObject shadowColor shadowDensity shadowOffset size stretchMode text textColor uniqueIdentifier useDropshadow useOutline verticalAlignment

    Methods

    addMaterial clearMaterials destroy getMaterial getMaterialsCount getMeshSize getRenderOrder getSceneObject getTransform getTypeName isOfType isSame localAabbMax localAabbMin measureText 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).

    fontAsset: Font

    The font used to display text.

    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

    outlineColor: vec4

    The color used for the outline effect.

    outlineSize: number

    The strength of the outline effect.

    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

    The color used for dropshadow.

    shadowDensity: number

    Density of shadows cast by this MeshVisual.

    shadowOffset: vec2

    The horizontal and vertical offset used for dropshadow.

    size: number

    The font size being used.

    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.

    text

    text: string

    The text displayed by the Label.

    textColor: vec4

    The color used for drawing text.

    uniqueIdentifier: string
    useDropshadow: boolean

    If enabled, adds a dropshadow to the text.

    useOutline: boolean

    If enabled, adds an outline around the text.

    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 order of this Visual in the render queue.

      Returns number

    • 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

    • Returns the potential width and height of the Label if it were to display the input text.

      Parameters

      • text: string

      Returns vec2

    • 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