Lens Scripting API
    Preparing search index...

    Class BaseMeshVisual

    Base for all mesh rendering components.

    Comparable to the former MeshVisual class, which was split into the classes:

    Used By: InteractionComponent#addMeshVisual, InteractionComponent#removeMeshVisual, PinToMeshComponent#target

    Hierarchy (View Summary)

    Index

    Properties

    enabled extentsTarget horizontalAlignment isEnabledInHierarchy meshShadowMode renderOrder sceneObject shadowColor shadowDensity stretchMode uniqueIdentifier verticalAlignment

    Methods

    destroy getRenderOrder getSceneObject getTransform getTypeName isOfType isSame localAabbMax localAabbMin setRenderOrder snap worldAabbMax worldAabbMin

    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.

    horizontalAlignment: HorizontalAlignment

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

    isEnabledInHierarchy: boolean

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

    meshShadowMode: MeshShadowMode

    None = 0, Caster = 1, Receiver = 2

    renderOrder: number

    The order in which the visual should be rendered.

    sceneObject: SceneObject

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

    • Destroys the component.

      Returns void

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

      Returns number

    • 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

    • Range maximum of the local-space axis-aligned bounding box (AABB) of the visual.

      Returns vec3

    • Range minimum of the local-space axis-aligned bounding box (AABB) of the visual.

      Returns vec3

    • 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

    • Range maximum of the world-space axis-aligned bounding box (AABB) of the visual.

      Returns vec3

    • Range minimum of the world-space axis-aligned bounding box (AABB) of the visual.

      Returns vec3

    Settings

    Member Visibility

    On This Page

    Properties
    Methods