AnimatedTextureFileProvider
ClassProvider for animated texture resource.
- Available on all platforms
Index
Properties
Methods
Remarks
Can be accessed from Texture.Control on an animated texture.
Example
// Plays an animated sprite
//@input Component.SpriteVisual spriteVisual
var loops = 100;
var offset = 0.0;
var provider = script.spriteVisual.mainPass.baseTex.control;
provider.play(loops, offset);
Extends
Properties
duration
duration:
number
Length of the animation in seconds.
Since
Lens Scripting Version 163
isAutoplay
isAutoplay:
boolean
Returns whether the animation was set to automatically play and loop.
Default Value
false
isPingPong
isPingPong:
boolean
If enabled, the animation will alternate between normal and reverse each time it loops.
Default Value
false
isReversed
isReversed:
boolean
Whether the animation plays in reverse.
Default Value
false
Methods
clone()
clone():
AnimatedTextureFileProvider
Duplicates the AnimatedTextureFileProvider and returns the new copy. Can be used for playing the same animation at different offsets.
Returns
AnimatedTextureFileProvider
Since
Lens Scripting Version 148
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
getAspect()
getAspect():
number
Returns the texture's aspect ratio, which is calculated as width / height.
Returns
number
Inherited from
getCurrentPlayingFrame()
getCurrentPlayingFrame():
number
Returns the index of the frame that is currently playing.
Returns
number
getFramesCount()
getFramesCount():
number
Returns the number of frames in the animation.
Returns
number
getHeight()
getHeight():
number
Returns the height of the texture in pixels.
Returns
number
Inherited from
getLoadStatus()
getLoadStatus():
LoadStatus
Returns
Inherited from
getTypeName()
staticgetTypeName():TypeName<AnimatedTextureFileProvider>
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<AnimatedTextureFileProvider>
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
getWidth()
getWidth():
number
Returns the width of the texture in pixels.
Returns
number
Inherited from
isFinished()
isFinished():
boolean
Returns whether the animation is finished playing.
Returns
boolean
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
isPaused()
isPaused():
boolean
Returns whether the animation is currently paused.
Returns
boolean
isPlaying()
isPlaying():
boolean
Returns whether the animation is currently playing.
Returns
boolean
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
Inherited from
pause()
pause():
void
Pauses the animation.
Returns
void
pauseAtFrame()
pauseAtFrame(
frameIndex):void
Pauses the animation at frame frameIndex.
Parameters
| Parameter | Type |
|---|---|
frameIndex | number |
Returns
void
play()
play(
loops,offset):void
Plays the animation loops times, starting with an offset of offset seconds.
Parameters
| Parameter | Type |
|---|---|
loops | number |
offset | number |
Returns
void
playFromFrame()
playFromFrame(
frameIndex,loops):void
Start playing the animation from frame frameIndex, loops times.
Parameters
| Parameter | Type |
|---|---|
frameIndex | number |
loops | number |
Returns
void
resume()
resume():
void
Resumes a paused animation from the frame that was last played.
Returns
void
setOnFinish()
setOnFinish(
eventCallback):void
Sets the callback function to be called whenever the animation stops playing.
Parameters
| Parameter | Type |
|---|---|
eventCallback | (animatedTexture) => void |
Returns
void
stop()
stop():
void
Stops the animation.
Returns
void