ObjectTrackingNormalsTextureProvider
ClassClass in the Lens Scripting API.
- Available on all platforms
Since Lens Scripting v201
Index
Properties
Methods
Extends
Properties
inputTexture
inputTexture:
Texture
Input texture to crop.
Default Value
null
Inherited from
ObjectTrackingMaskedTextureProvider.inputTexture
objectIndex
objectIndex:
number
Since
Lens Scripting Version 201
Default Value
0
Inherited from
ObjectTrackingMaskedTextureProvider.objectIndex
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
ObjectTrackingMaskedTextureProvider.ensureLoaded
getAspect()
getAspect():
number
Returns the texture's aspect ratio, which is calculated as width / height.
Returns
number
Inherited from
ObjectTrackingMaskedTextureProvider.getAspect
getHeight()
getHeight():
number
Returns the height of the texture in pixels.
Returns
number
Inherited from
ObjectTrackingMaskedTextureProvider.getHeight
getLoadStatus()
getLoadStatus():
LoadStatus
Returns
Inherited from
ObjectTrackingMaskedTextureProvider.getLoadStatus
getTypeName()
staticgetTypeName():TypeName<ObjectTrackingNormalsTextureProvider>
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<ObjectTrackingNormalsTextureProvider>
Since
Lens Scripting Version 201
Overrides
ObjectTrackingMaskedTextureProvider.getTypeName
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
ObjectTrackingMaskedTextureProvider.getTypeName
getWidth()
getWidth():
number
Returns the width of the texture in pixels.
Returns
number
Inherited from
ObjectTrackingMaskedTextureProvider.getWidth
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
ObjectTrackingMaskedTextureProvider.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
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean