Interface RenderMeshVisual

Description

Renders a RenderMesh asset in the scene. Comparable to the former class "MeshVisual", which was split into the classes: BaseMeshVisual, MaterialMeshVisual, and RenderMeshVisual.

interface RenderMeshVisual {
    blendNormals: boolean;
    blendShapesEnabled: boolean;
    emitter: boolean;
    enabled: boolean;
    extentsTarget: ScreenTransform;
    horizontalAlignment: HorizontalAlignment;
    mainMaterial: Material;
    mainPass: Pass;
    materials: Material[];
    mesh: RenderMesh;
    meshShadowMode: MeshShadowMode;
    receiver: boolean;
    shadowColor: vec4;
    shadowDensity: number;
    stretchMode: StretchMode;
    uniqueIdentifier: string;
    verticalAlignment: VerticalAlignment;
    addMaterial(material): void;
    clearBlendShapeWeights(): void;
    clearMaterials(): void;
    destroy(): void;
    getBlendShapeNames(): string[];
    getBlendShapeWeight(name): number;
    getMaterial(index): Material;
    getMaterialsCount(): number;
    getRenderOrder(): number;
    getSceneObject(): SceneObject;
    getTransform(): Transform;
    getTypeName(): string;
    hasBlendShapeWeight(name): boolean;
    isOfType(type): boolean;
    isSame(other): boolean;
    localAabbMax(): vec3;
    localAabbMin(): vec3;
    setBlendShapeWeight(name, weight): void;
    setRenderOrder(value): void;
    setSkin(value): void;
    snap(camera): void;
    unsetBlendShapeWeight(name): void;
    worldAabbMax(): vec3;
    worldAabbMin(): vec3;
}

Hierarchy (view full)

Properties

blendNormals blendShapesEnabled emitter enabled extentsTarget horizontalAlignment mainMaterial mainPass materials mesh meshShadowMode receiver shadowColor shadowDensity stretchMode uniqueIdentifier verticalAlignment

Methods

addMaterial clearBlendShapeWeights clearMaterials destroy getBlendShapeNames getBlendShapeWeight getMaterial getMaterialsCount getRenderOrder getSceneObject getTransform getTypeName hasBlendShapeWeight isOfType isSame localAabbMax localAabbMin setBlendShapeWeight setRenderOrder setSkin snap unsetBlendShapeWeight worldAabbMax worldAabbMin

Properties

blendNormals

blendNormals: boolean

Description

If enabled, normal directions are also blended by blend shapes.

blendShapesEnabled

blendShapesEnabled: boolean

Description

If enabled, blend shapes will affect the component.

emitter

emitter: boolean

Description

If enabled, rays are generated from this object during raytracing so that it can receive ray-traced reflections.

enabled

enabled: boolean

Description

If disabled, the Component will stop enacting its behavior.

extentsTarget

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: HorizontalAlignment

Description

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

mainMaterial

mainMaterial: Material

Description

Returns the first Material.

mainPass

mainPass: Pass

Description

Returns the mainPass of the mainMaterial.

materials

materials: Material[]

Description

Get the array of materials used by the MaterialMeshVisual.

mesh

mesh: RenderMesh

Description

The RenderMesh asset to render.

meshShadowMode

meshShadowMode: MeshShadowMode

Description

None = 0, Caster = 1, Receiver = 2

receiver

receiver: boolean

Description

If enabled, rays can hit this object during raytracing so that it may be visible in ray-traced reflections.

shadowColor

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

shadowDensity: number

Description

Density of shadows cast by this MeshVisual.

stretchMode

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.

Readonly uniqueIdentifier

uniqueIdentifier: string

verticalAlignment

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

addMaterial

clearBlendShapeWeights

  • clearBlendShapeWeights(): void

  • Returns void

    Description

    Resets all blend shape weights on the component.

clearMaterials

destroy

getBlendShapeNames

  • getBlendShapeNames(): string[]

  • Returns string[]

    Description

    Returns the names of the blend shapes on this RenderMeshVisual.

getBlendShapeWeight

  • getBlendShapeWeight(name): number

  • Parameters

    • name: string

    Returns number

    Description

    Returns the weight of the blend shape with the matching name.

getMaterial

getMaterialsCount

getRenderOrder

getSceneObject

getTransform

getTypeName

hasBlendShapeWeight

  • hasBlendShapeWeight(name): boolean

  • Parameters

    • name: string

    Returns boolean

    Description

    Returns whether this component has a weight for the blend shape with matching name.

isOfType

  • isOfType(type): boolean

  • Parameters

    • type: string

    Returns boolean

    Description

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

isSame

  • isSame(other): boolean

  • 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.

localAabbMax

localAabbMin

setBlendShapeWeight

  • setBlendShapeWeight(name, weight): void

  • Parameters

    • name: string
    • weight: number

    Returns void

    Description

    Sets the weight of the blend shape with the matching name.

setRenderOrder

  • setRenderOrder(value): void

  • Parameters

    • value: number

    Returns void

    Description

    Sets the order of this Visual in the render queue.

setSkin

  • setSkin(value): void

  • Parameters

    Returns void

    Description

    Sets the Skin to use for rendering this mesh.

snap

  • snap(camera): void

  • 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.

unsetBlendShapeWeight

  • unsetBlendShapeWeight(name): void

  • Parameters

    • name: string

    Returns void

    Description

    Clears the blend shape with the matching name.

worldAabbMax

worldAabbMin

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc