BodyRenderObjectProvider
ClassProvider for full Body Mesh render object.
- Available on all platforms
Since Lens Scripting v146
Index
Properties
Methods
Extends
Properties
bodyGeometryEnabled
bodyGeometryEnabled:
boolean
Enable main Body Mesh geometry.
Since
Lens Scripting Version 148
Default Value
false
bodyIndex
bodyIndex:
number
Index of body in scene to track.
Since
Lens Scripting Version 146
Default Value
0
handTrackingEnabled
handTrackingEnabled:
boolean
When true, hand tracking will be enabled.
Since
Lens Scripting Version 356
Default Value
true
headGeometryEnabled
headGeometryEnabled:
boolean
Enable head mesh.
Since
Lens Scripting Version 148
Default Value
false
leftHandGeometryEnabled
leftHandGeometryEnabled:
boolean
Enable left hand mesh.
Since
Lens Scripting Version 148
Default Value
false
rightHandGeometryEnabled
rightHandGeometryEnabled:
boolean
Enable right hand mesh.
Since
Lens Scripting Version 148
Default Value
false
trackingScope
trackingScope:
PersonTrackingScope
The tracking context this effect is being applied to.
Since
Lens Scripting Version 309
Default Value
null
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
RenderObjectProvider.ensureLoaded
getLoadStatus()
getLoadStatus():
LoadStatus
Returns
Inherited from
RenderObjectProvider.getLoadStatus
getTypeName()
staticgetTypeName():TypeName<BodyRenderObjectProvider>
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<BodyRenderObjectProvider>
Since
Lens Scripting Version 146
Overrides
RenderObjectProvider.getTypeName
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
RenderObjectProvider.getTypeName
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
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
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean