Skip to main content

BaseMeshVisual

Class

Base for all mesh rendering components.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Index

Remarks

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

  • BaseMeshVisual: serves as the foundational class for all visual components that use meshes for rendering.
  • MaterialMeshVisual: inherits from BaseMeshVisual and provides access to the Material used in the rendering process.
  • RenderMeshVisual: extends MaterialMeshVisual, adding the capability to utilize specific RenderMesh assets to depict 3D models within a scene.

Extends

Extended by

Properties

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

Default Value

true

Inherited from

Visual.enabled


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.

Default Value

null

horizontalAlignment

horizontalAlignment: HorizontalAlignment

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

Default Value

HorizontalAlignment.Center

isBeingDestroyed

readonly isBeingDestroyed: boolean

Returns true if this Component is currently being destroyed. Becomes true as soon as destruction begins via Component#destroy or destruction of its owning SceneObject, before any OnDestroyEvent callbacks fire.

Since

Lens Scripting Version 364

Example

if (!script.isBeingDestroyed) {
// Component is still fully alive
}

Inherited from

Visual.isBeingDestroyed


isEnabledInHierarchy

readonly isEnabledInHierarchy: boolean

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

Inherited from

Visual.isEnabledInHierarchy


meshShadowMode

meshShadowMode: MeshShadowMode

None = 0, Caster = 1, Receiver = 2

Default Value

MeshShadowMode.None

renderOrder

renderOrder: number

The order in which the visual should be rendered.

Since

Lens Scripting Version 323

Default Value

0

Inherited from

Visual.renderOrder


sceneObject

readonly sceneObject: SceneObject

The SceneObject this component is on.

Inherited from

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

Default Value

(1, 1, 1, 1)

shadowDensity

shadowDensity: number

Density of shadows cast by this MeshVisual.

Default Value

1

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.

Default Value

StretchMode.Stretch

uniqueIdentifier

readonly uniqueIdentifier: string

Since

Lens Scripting Version 176

Inherited from

Visual.uniqueIdentifier


verticalAlignment

verticalAlignment: VerticalAlignment

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

Default Value

VerticalAlignment.Center

Methods

destroy()

destroy(): void

Destroys the component.

Returns

void

Inherited from

Visual.destroy


getRenderOrder()

getRenderOrder(): number

Returns the order of this Visual in the render queue.

Returns

number

Inherited from

Visual.getRenderOrder


getSceneObject()

getSceneObject(): SceneObject

Returns the SceneObject the component is attached to.

Returns

SceneObject

Inherited from

Visual.getSceneObject


getTransform()

getTransform(): Transform

Returns the Transform this component is attached to.

Returns

Transform

Inherited from

Visual.getTransform


getTypeName()

static getTypeName(): TypeName<BaseMeshVisual>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<BaseMeshVisual>

Overrides

Visual.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Visual.getTypeName


isOfType()

isOfType(type): boolean

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

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

Visual.isOfType


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

ParameterType
otherScriptObject

Returns

boolean

Inherited from

Visual.isSame


localAabbMax()

localAabbMax(): vec3

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

Returns

vec3

Since

Lens Scripting Version 156


localAabbMin()

localAabbMin(): vec3

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

Returns

vec3

Since

Lens Scripting Version 156


setRenderOrder()

setRenderOrder(value): void

Sets the order of this Visual in the render queue.

Parameters

ParameterType
valuenumber

Returns

void

Inherited from

Visual.setRenderOrder


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

ParameterType
cameraCamera

Returns

void


worldAabbMax()

worldAabbMax(): vec3

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

Returns

vec3

Since

Lens Scripting Version 156


worldAabbMin()

worldAabbMin(): vec3

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

Returns

vec3

Since

Lens Scripting Version 156