Description

Clips visuals and Interaction Component events within a tree hierarchy. Any Visual or Interaction Components will be clipped user defined 2D bounds. These 2D bounds are defined by a Screen Transform. Useful for clipping some screen transforms--for example a scroll view.

interface MaskingComponent {
    cornerRadius: number;
    enabled: boolean;
    extentsTarget: ScreenTransform;
    horizontalAlignment: HorizontalAlignment;
    meshShadowMode: MeshShadowMode;
    shadowColor: vec4;
    shadowDensity: number;
    stretchMode: StretchMode;
    uniqueIdentifier: string;
    verticalAlignment: VerticalAlignment;
    destroy(): void;
    getRenderOrder(): number;
    getSceneObject(): SceneObject;
    getTransform(): Transform;
    getTypeName(): string;
    isOfType(type): boolean;
    isSame(other): boolean;
    localAabbMax(): vec3;
    localAabbMin(): vec3;
    setRenderOrder(value): void;
    snap(camera): void;
    worldAabbMax(): vec3;
    worldAabbMin(): vec3;
}

Hierarchy (view full)

Properties

cornerRadius: number

Description

The radius of the mask's corner.

enabled: boolean

Description

If disabled, the Component will stop enacting its behavior.

extentsTarget: ScreenTransform

Description

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

Description

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

meshShadowMode: MeshShadowMode

Description

None = 0, Caster = 1, Receiver = 2

shadowColor: vec4

Description

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

Description

Density of shadows cast by this MeshVisual.

stretchMode: StretchMode

Description

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

Description

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

Methods

  • Returns number

    Description

    Returns the order of this Visual in the render queue.

  • Returns string

    Description

    Returns the name of this object's type.

  • Parameters

    • type: string

    Returns boolean

    Description

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

  • Parameters

    Returns boolean

    Description

    Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

  • Parameters

    • value: number

    Returns void

    Description

    Sets the order of this Visual in the render queue.

  • Parameters

    Returns void

    Description

    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.

Generated using TypeDoc