Interface GaussianSplattingVisual

Description

Base class for all MeshVisual components using Materials to render. Comparable to the former class "MeshVisual", which was split into the classes: BaseMeshVisual, MaterialMeshVisual, and RenderMeshVisual.

Example

// @input Component.MaterialMeshVisual visual

// Set the material's main color to red
script.visual.mainPass.baseColor = new vec4(1, 0, 0, 1);
interface GaussianSplattingVisual {
    asset: GaussianSplattingAsset;
    enabled: boolean;
    extentsTarget: ScreenTransform;
    horizontalAlignment: HorizontalAlignment;
    mainMaterial: Material;
    mainPass: Pass;
    materials: Material[];
    meshShadowMode: MeshShadowMode;
    shadowColor: vec4;
    shadowDensity: number;
    stretchMode: StretchMode;
    uniqueIdentifier: string;
    verticalAlignment: VerticalAlignment;
    addMaterial(material): void;
    clearMaterials(): void;
    destroy(): void;
    getMaterial(index): Material;
    getMaterialsCount(): number;
    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

asset enabled extentsTarget horizontalAlignment mainMaterial mainPass materials meshShadowMode shadowColor shadowDensity stretchMode uniqueIdentifier verticalAlignment

Methods

addMaterial clearMaterials destroy getMaterial getMaterialsCount getRenderOrder getSceneObject getTransform getTypeName isOfType isSame localAabbMax localAabbMin setRenderOrder snap worldAabbMax worldAabbMin

Properties

asset

asset: GaussianSplattingAsset

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.

meshShadowMode

meshShadowMode: MeshShadowMode

Description

None = 0, Caster = 1, Receiver = 2

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

clearMaterials

destroy

getMaterial

getMaterialsCount

getRenderOrder

getSceneObject

getTransform

getTypeName

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

setRenderOrder

  • setRenderOrder(value): void

  • Parameters

    • value: number

    Returns void

    Description

    Sets the order of this Visual in the render queue.

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.

worldAabbMax

worldAabbMin

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc