Interface RenderMeshVisual

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;
    sceneObject: SceneObject;
    shadowColor: vec4;
    shadowDensity: number;
    stretchMode: StretchMode;
    uniqueIdentifier: string;
    verticalAlignment: VerticalAlignment;
    addMaterial(material: Material): void;
    clearBlendShapeWeights(): void;
    clearMaterials(): void;
    destroy(): void;
    getBlendShapeNames(): string[];
    getBlendShapeWeight(name: string): number;
    getMaterial(index: number): Material;
    getMaterialsCount(): number;
    getRenderOrder(): number;
    getSceneObject(): SceneObject;
    getTransform(): Transform;
    getTypeName(): string;
    hasBlendShapeWeight(name: string): boolean;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
    localAabbMax(): vec3;
    localAabbMin(): vec3;
    setBlendShapeWeight(name: string, weight: number): void;
    setRenderOrder(value: number): void;
    setSkin(value: Skin): void;
    snap(camera: Camera): void;
    unsetBlendShapeWeight(name: string): void;
    worldAabbMax(): vec3;
    worldAabbMin(): vec3;
}

Hierarchy (view full)

Properties

blendNormals blendShapesEnabled emitter enabled extentsTarget horizontalAlignment mainMaterial mainPass materials mesh meshShadowMode receiver sceneObject 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

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

blendShapesEnabled

blendShapesEnabled: boolean

If enabled, blend shapes will affect the component.

emitter

emitter: boolean

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

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

extentsTarget

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

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

mainMaterial

mainMaterial: Material

Returns the first Material.

mainPass

mainPass: Pass

Returns the mainPass of the mainMaterial.

materials

materials: Material[]

Get the array of materials used by the MaterialMeshVisual.

mesh

mesh: RenderMesh

The RenderMesh asset to render.

meshShadowMode

meshShadowMode: MeshShadowMode

None = 0, Caster = 1, Receiver = 2

receiver

receiver: boolean

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

ReadonlysceneObject

sceneObject: SceneObject

shadowColor

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

shadowDensity: number

Density of shadows cast by this MeshVisual.

stretchMode

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.

ReadonlyuniqueIdentifier

uniqueIdentifier: string

verticalAlignment

verticalAlignment: VerticalAlignment

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

  • Resets all blend shape weights on the component.

    Returns void

clearMaterials

destroy

getBlendShapeNames

  • getBlendShapeNames(): string[]

  • Returns the names of the blend shapes on this RenderMeshVisual.

    Returns string[]

getBlendShapeWeight

  • getBlendShapeWeight(name): number

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

    Parameters

    • name: string

    Returns number

getMaterial

getMaterialsCount

getRenderOrder

getSceneObject

getTransform

getTypeName

hasBlendShapeWeight

  • hasBlendShapeWeight(name): boolean

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

    Parameters

    • name: string

    Returns boolean

isOfType

  • isOfType(type): boolean

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

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): 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

localAabbMax

localAabbMin

setBlendShapeWeight

  • setBlendShapeWeight(name, weight): void

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

    Parameters

    • name: string
    • weight: number

    Returns void

setRenderOrder

  • setRenderOrder(value): void

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

    Parameters

    • value: number

    Returns void

setSkin

  • setSkin(value): void

  • Sets the Skin to use for rendering this mesh.

    Parameters

    Returns void

snap

  • snap(camera): 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

unsetBlendShapeWeight

  • unsetBlendShapeWeight(name): void

  • Clears the blend shape with the matching name.

    Parameters

    • name: string

    Returns void

worldAabbMax

worldAabbMin

Settings

Member Visibility

On This Page

Properties
Methods