ViroAnimatedImage
A component used to display plays animated GIF images from local or remote sources.
Example use:
<ViroAnimatedImage
height={2}
width={2}
placeholderSource={require("./res/local_spinner.jpg")}
source={{ uri: "https://myGIFImage.jpg" }}
/>
Props
source (*required)
| Type | Description |
|---|---|
| ImageSourcePropType | The image source, a remote URL or a local file resource. PNG and JPG images accepted. |
// use remote URL
<ViroAnimatedImage
height={2}
width={2}
placeholderSource={require("./res/local_spinner.jpg")}
source={{ uri: "https://myGIFImage.jpg" }}
/>
// use file in bundle
<ViroAnimatedImage
height={2}
width={2}
placeholderSource={require("./res/local_spinner.jpg")}
source={require('../res/emoji.vrx')}
/>
animation
| Type | Description |
|---|---|
| ViroAnimationProps | A collection of parameters that determine if this component should animate. For more information on animated components please see our Animation Guide. |
dragPlane
| Type | Description |
|---|---|
| ViroDragPlane | When a drag type of "FixedToPlane" is given, dragging is limited to a user defined plane. The dragging behavior is then configured by this property (specified by a point on the plane and its normal vector). You can also limit the maximum distance the dragged object is allowed to travel away from the camera/controller (useful for situations where the user can drag an object towards infinity). |
dragType
| Type | Description |
|---|---|
| "FixedDistance" | "FixedToWorld" | "FixedDistanceOrigin" | "FixedToPlane" | Determines the behavior of drag if onDrag is specified. The default value is "FixedDistance". FixedDistance: Dragging is limited to a fixed radius around the user, dragged from the point at which the user has grabbed the geometry containing this draggable node FixedDistanceOrigin: Dragging is limited to a fixed radius around the user, dragged from the point of this node's position in world space. FixedToWorld: Dragging is based on intersection with real world objects. Available only in AR FixedToPlane: Dragging is limited to a fixed plane around the user. The configuration of this plane is defined by the dragPlane property. |
format
| Type | Description |
|---|---|
| 'RGBA8' | 'RGBA4' | 'RGB565' | Image texture formats for storage on the GPU. RGBA8: Each pixel is described with 32-bits, using eight bits per channel RGBA4: Each pixel is described with 16 bits, using four bits per channel RGB565: Formats the picture into 16 bit color values without alpha |
height
| Type | Description |
|---|---|
| number | The height of the image in 3D space. Default value is 1. |
highAccuracyEvents
| Type | Description |
|---|---|
| boolean | True if events should use the geometry of the object to determine if the user is interacting with this object. If false, the object's axis-aligned bounding box will be used instead. Enabling this is more accurate but takes more processing power, so it is set to false by default. |
ignoreEventHandling
| Type | Description |
|---|---|
| boolean | When set to true, this control will ignore events and not prevent controls behind it from receiving event callbacks. The default value is false. |
imageClipMode
| Type | Description |
|---|---|
| 'None' | 'ClipToBounds' | Defaults to clipToBounds. If ClipToBounds is set, image is cropped if it overshoots with ScaleToFill. Setting to None does not crop image if it overshoots bounds. |
lightReceivingBitMask
| Type | Description |
|---|---|
| number | A bit mask that is bitwise and-ed (&) with each light's influenceBitMask. If the result is > 0, then the light will illuminate this object. For more information please see the Lighting and Materials Guide. |
loop
| Type | Description |
|---|---|
| boolean | Set to true to loop the animation. This is set to false by default. |
materials
| Type | Description |
|---|---|
| string | string[] | An array of strings that each represent a material that was created via ViroMaterials.createMaterials(). ViroImage takes 1 material. The diffuseTexture of the material will be the image shown unless a source prop is specified. The other material properties will preserve as the source prop changes. |
mipmap
| Type | Description |
|---|---|
| boolean | If true, we dynamically generate mipmaps for the source of this given image. |
onClick
See ViroNode onClick.
onClickState
onCollision
See ViroNode onCollision.
onDrag
See ViroNode onDrag.
onFuse
See ViroNode onFuse.
onHover
See ViroNode onHover.
onError
| Type | Description |
|---|---|
| (event) => void | Callback invoked when the Image fails to load. The error message is contained in event.nativeEvent.error |
onLoadStart
| Type | Description |
|---|---|
| () => void | Callback triggered when we are processing the image to be displayed as specified by the source prop. |
onLoadEnd
| Type | Description |
|---|---|
| Callback triggered when we have finished loading the image to be displayed. Whether or not the image was loaded and displayed properly will be indicated by the parameter "success". |
<ViroAnimatedImage
source={require('./path/to/your/image.png')}
onLoadEnd={(event) => {
if (event.nativeEvent.success) {
// image successfully loaded
}
} />
onPinch
See ViroNode onPinch.
onRotate
See ViroNode onRotate.
onScroll
See ViroNode onScroll.
onSwipe
See ViroNode onSwipe.
onTouch
See ViroNode onTouch.
onTransformUpdate
See ViroNode onTransformUpdate.
opacity
| Type | Description |
|---|---|
| number | A number from 0 to 1 that specifies the opacity of the object. A value of 1 translates into a fully opaque object while 0 represents full transparency. |
paused
| Type | Description |
|---|---|
| boolean | Set to true to pause the GIF animation. This is set to false by default. |
placeholderSource
| Type | Description |
|---|---|
| ImageSourcePropType | A static placeholder image that is shown until the source image is loaded it. It not specified, nothing will show until the source image is finished loading. PNG and JPG images accepted. |
position
| Type | Description |
|---|---|
| [number, number, number] | Cartesian position in 3D space, stored as [x, y, z]. |
physicsBody
| Type | Description |
|---|---|
| Physics Body | Creates and binds a physics body that is configured with the provided collection of physics properties associated with this control.For more information on physics components, please see the Physics. |
resizeMode
| Type | Description |
|---|---|
| 'ScaleToFill' | 'ScaleToFit' | 'StretchToFill' | If not specified, the default value is stretchToFill. scaleToFill: Scale the image up to fit the component width or height. Aspect ratio is preserved. scaleToFit: Scale the image down to fit the component width or height. Aspect ratio is preserved. stretchToFill: Stretch the image to fit on the entire surface of the ViroImage component. Aspect ratio is not preserved.| |
rotation
| Type | Description |
|---|---|
| [number, number, number] | The rotation of the box around it's local axis specified as Euler angles [x, y, z]. Units for each angle are specified in degrees. |
rotationPivot
| Type | Description |
|---|---|
| [number, number, number] | Cartesian position in [x,y,z] about which rotation is applied relative to the component's position. |
scale
| Type | Description |
|---|---|
| [number, number, number] | The scale of the box in 3D space, specified as [x,y,z]. A scale of 1 represents the current size of the box. A scale value of < 1 will make the box proportionally smaller while a value >1 will make the box proportionally bigger along the specified axis. |
scalePivot
| Type | Description |
|---|---|
| [number, number, number] | Cartesian position in [x,y,z] from which scale is applied relative to the component's position. |
shadowCastingBitMask
| Type | Description |
|---|---|
| number | A bit mask that is bitwise and-ed (&) with each light's influenceBitMask. If the result is > 0, then this object will cast shadows from the light. For more information please see the Lighting and Materials Guide. |
stereoMode
| Type | Description |
|---|---|
| 'leftRight' | 'rightLeft' | 'topBottom' | 'bottomTop' | 'none' | Specifies the alignment mode of the provided stereo image in source. The image will be rendered in the given order, the first being the left eye, the next the right eye.For example, leftRight will render the left half of the image to the left eye, and the right half of the image to the right eye. Similarly, topBottom will render the top half of the image to the left eye, and the bottom half of the image to the right eye. Defaults to none. Note: There's a known issue with stereoscopic images of the format RGB565 (the fix is on the roadmap). |
style
| Type | Description |
|---|---|
| Styles | Style properties determine the position and scale of the component within a ViroFlexView. Please see the UI Controls & Flexbox guide and Styles reference for more information. |
transformBehaviors
| Type | Description |
|---|---|
| string[] | An array of transform constraints that affect the transform of the object. For example, putting the value "billboard" will ensure the box is facing the user as the user rotates their head on any axis. This is useful for icons or text where you'd like the box to always face the user at a particular rotation. Allowed values(values are case sensitive): "billboard": Billboard object on x,y,z axis "billboardX": Billboard object on the x axis "billboardY": Billboard object on the y axis "billboardZ": Billboard object on the z axis |
viroTag
| Type | Description |
|---|---|
| string | A tag given to other components when their physics body collides with this component's physics body. Refer to physics for more information. |
visible
| Type | Description |
|---|---|
| boolean | False if the container should be hidden. By default the container is visible and this value is true. |
width
| Type | Description |
|---|---|
| The width of the image in 3D space. Default value is 1. |
Methods
async getBoundingBoxAsync()
Async function that returns the component's bounding box in world coordinates. Returns a Promise that will be completed with the following object:
{
"boundingBox": {
"minX": number,
"maxX": number,
"minY": number,
"maxY": number,
"minZ": number,
"maxZ": number
}
}
async getTransformAsync()
Async function that returns the component's transform (position, scale and rotation).
Returns a transform object that contains "position", "scale" and "rotation" keys which point to number arrays
applyImpulse(force: number[], position: number[])
A function used with physics to apply an impulse (instantaneous) force to an object with a physics body.
| Parameter | Description |
|---|---|
| force | an array of magnitudes to be applied as force (N) to the object in the positive x, y and z directions |
| position | a position relative to the object from which to apply the given force |
applyTorqueImpulse(torque: number[], position: number[])
A function used with physics to apply an impulse (instantaneous) torque to an object with a physics body.
| Parameter | Description |
|---|---|
| torque | an array of magnitudes to be applied as a torque (N * m) to the object in the positive x, y and z directions at the given position |
| position | a position relative to the object from which to apply the given torque |
setVelocity(velocity: number[])
A function used with physics to set the velocity of an object with a physics body.
| Parameter | Description |
|---|---|
| velocity | an array of numbers corresponding to x, y, and z velocity |
setNativeProps(nativeProps)
A wrapper function around the native component's setNativeProps which allow users to set values on the native component without changing state/setting props and re-rendering. Refer to the React Native documentation on Direct Manipulation for more information.
| Parameter | Description |
|---|---|
| nativeProps | an object where the keys are the properties to set and the values are the values to set |
componentRef.setNativeProps({ position: [0, 0, -1] });
Static Methods
evictFromCache(source: ImageSourcePropType)
The given source will be purged from the memory and local storage cache of the device. On Android, Viro, like React-Native, uses the Fresco image library to load and cache images and this is required if the given source reference (uri, etc) is the same, but the image data changes.
Android Only
Updated over 2 years ago