Skip to main content

WorldRenderObjectProvider

Class

Provider for RenderMesh data representing the estimated shape of real world objects generated from depth information.

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

Provider for RenderMesh data representing the estimated shape of real world objects generated from depth information. Only available when world mesh tracking is supported and enabled.

Index

Example

//@input Component.RenderMeshVisual worldMesh

var provider = script.worldMesh.mesh.control;
provider.meshClassificationFormat = MeshClassificationFormat.PerVertexFast;
provider.useNormals = true;

Extends

Properties

enableWorldMeshesTracking

enableWorldMeshesTracking: boolean

Enable or disable world mesh tracking.

Default Value

true

faceCount

readonly faceCount: number

Returns the number of faces of the mesh.


meshClassificationFormat

meshClassificationFormat: MeshClassificationFormat

Mesh classification format being used.

Default Value

MeshClassificationFormat.None

useNormals

useNormals: boolean

Enable or disable normal direction usage.

Default Value

false

vertexCount

readonly vertexCount: number

Returns the number of vertices of the mesh.

Methods

ensureLoaded()

ensureLoaded(): Promise<void>

Returns a Promise that resolves once this Provider has finished loading its resource.

Returns

Promise<void>

Remarks

If the Provider is already loaded when ensureLoaded() is called, the returned Promise resolves immediately. Otherwise it resolves once loading completes.

Completion is determined by the Provider's load status (see Provider.getLoadStatus). Some Providers only become loaded once supporting runtime data is available — for example, a Provider whose resource depends on tracking will not report loaded until the relevant tracking data has arrived — so the returned Promise stays pending until that data is produced.

This method is useful when Lens script needs to await a Provider before reading its data — for example, waiting for a remote-asset Provider to finish downloading before sampling it.

Since

Lens Scripting Version 370

Example

Fetch a Texture at runtime via RemoteMediaModule and wait for its Provider to finish loading before using it:

const internetModule = require("LensStudio:InternetModule");
const remoteMediaModule = require("LensStudio:RemoteMediaModule");

function loadImageTexture(url) {
const resource = internetModule.makeResourceFromUrl(url);
return new Promise((resolve, reject) => {
remoteMediaModule.loadResourceAsImageTexture(resource, resolve, reject);
});
}

const texture = await loadImageTexture("https://example.com/image.png");

// Wait until the fetched Texture's Provider has finished loading before using it.
await texture.control.ensureLoaded();
print("Texture ready, loadStatus: " + texture.control.getLoadStatus());

Inherited from

MeshRenderObjectProvider.ensureLoaded


getLoadStatus()

getLoadStatus(): LoadStatus

Returns

LoadStatus

Inherited from

MeshRenderObjectProvider.getLoadStatus


getTypeName()

static getTypeName(): TypeName<WorldRenderObjectProvider>

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<WorldRenderObjectProvider>

Overrides

MeshRenderObjectProvider.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

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

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

MeshRenderObjectProvider.isSame