ViroReact

The Viro Developer Hub

Welcome to the Viro developer hub. You'll find comprehensive guides and sample code to help you start working with Viro as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

ViroSpinner

Suggest Edits

A composite component that provides an animated spinner that can be used for providing feedback to the user while assets are loading.

Example use:
<ViroSpinner 
    type='light'
    position={[0, 0, -2]}
 />

Props

Optional Props

PropKeyPropType
animationPropTypes.shape({
name: PropTypes.string,
delay: PropTypes.number,
loop: PropTypes.bool,
onStart: PropTypes.func,
onFinish: PropTypes.func,
run: PropTypes.bool,
})

A collection of parameters that determine if this component should animate. For more information on animated components please see our Animation Guide.
dragPlanePropTypes.shape({
planePoint:PropTypes.arrayOf(PropTypes.number),
planeNormal:PropTypes.arrayOf(PropTypes.number),
maxDistance:PropTypes.number
})


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).
dragTypePropTypes.oneOf(["FixedDistance", "FixedToWorld"])

Determines the behavior of drag if onDrag is specified.

|Value|Description|
|:- -----|:- ---------:|
|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.|

The default value is "FixedDistance".
ignoreEventHandlingPropTypes.bool

When set to true, this control will ignore events and not prevent controls behind it from receiving event callbacks.

The default value is false.
materialsPropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string),PropTypes.string])

An array of strings that each represent a material that was created via ViroMaterials.createMaterials().
onClickReact.PropTypes.func

Called when an object has been clicked.

Example code:
_onClick(position, source) { // user has clicked the object }
onClickStateReact.PropTypes.func

Called for each click state an object goes through as it is clicked. Supported click states and their values are the following:

|State Value|Description|
|:- -----|:- ---------:|
|1| Click Down: Triggered when the user has performed a click down action while hovering on this control.|
|2| Click Up: Triggered when the user has performed a click up action while hovering on this control.|
|3| Clicked: Triggered when the user has performed both a click down and click up action on this control sequentially, thereby having "Clicked" the object.|

Example code:
_onClickState(stateValue, position, source) { if(stateValue == 1) { // Click Down } else if(stateValue == 2) { // Click Up } else if(stateValue == 3) { // Clicked } }
For the mapping of sources to controller inputs, see the Events section.
onCollisionReact.PropTypes.func

Called when this component's physics body collides with another component's physics body. Also invoked by ViroScene/ViroARScene's findCollisions... functions.

|Return Value | Description |
|- --|- --|
|viroTag | the given viroTag (string) of the collided component |
|collidedPoint | an array of numbers representing the position, in world coordinates, of the point of collision|
|collidedNormal | an array representing the normal of the collision in world coordinates. |
onDragReact.PropTypes.func

Called when the view is currently being dragged. The dragToPos parameter provides the current 3D location of the dragged object.

Example code:
_onDrag(dragToPos, source) { // dragtoPos[0]: x position // dragtoPos[1]: y position // dragtoPos[2]: z position }
For the mapping of sources to controller inputs, see the Events section.

Unsupported VR Platforms: Cardboard iOS
onFusePropTypes.oneOfType
PropTypes.oneOfType([ React.PropTypes.shape({ callback: React.PropTypes.func.isRequired, timeToFuse: PropTypes.number }), React.PropTypes.func, ])
As shown above, onFuse takes one of the types - either a callback, or a dictionary with a callback and duration.

It is called after the user hovers onto and remains hovered on the control for a certain duration of time, as indicated in timeToFuse that represents the duration of time in milliseconds.

While hovering, the reticle will display a count down animation while fusing towards timeToFuse.

Note that timeToFuse defaults to 2000ms.

For example:
_onFuse(source){ // User has hovered over object for timeToFuse milliseconds }
For the mapping of sources to controller inputs, see the Events section.
onHoverReact.PropTypes.func

Called when the user hovers on or off the control.

For example:
_onHover(isHovering, position, source) { if(isHovering) { // user is hovering over the box } else { // user is no longer hovering over the box } }
For the mapping of sources to controller inputs, see the Events section.
onPinchReact.PropTypes.func

Called when the user performs a pinch gesture on the control. When the pinch starts, the scale factor is set to 1 is relative to the points of the two touch points.

For example:
_onPinch(pinchState, scaleFactor, source) { if(pinchState == 3) { // update scale of obj by multiplying by scaleFactor when pinch ends. return; } //set scale using native props to reflect pinch. }
pinchState can be the following values:

|State Value|Description|
|:- -----|:- ---------:|
|1| Pinch Start: Triggered when the user has started a pinch gesture.|
|2| Pinch Move: Triggered when the user has adjusted the pinch, moving both fingers. |
|3| Pinch End: When the user has finishes the pinch gesture and released both touch points. |

This event is only available in AR.
onRotateReact.PropTypes.func

Called when the user performs a rotation touch gesture on the control. Rotation factor is returned in degrees.

When setting rotation, the rotation should be relative to it's current rotation, not set to the absolute value of the given rotationFactor.

For example:

_onRotate(rotateState, rotationFactor, source) { if (rotateState == 3) { //set to current rotation - rotationFactor. return; } //update rotation using setNativeProps },
rotationFactor can be the following values:

|State Value|Description|
|:- -----|:- ---------:|
|1| Rotation Start: Triggered when the user has started a rotation gesture.|
|2| Rotation Move: Triggered when the user has adjusted the rotation, moving both fingers. |
|3| Rotation End: When the user has finishes the rotation gesture and released both touch points. |

This event is only available in AR.
onScrollReact.PropTypes.func

Called when the user performs a scroll action, while hovering on the control.

For example:
_onScroll(scrollPos, source) { // scrollPos[0]: x scroll position from 0.0 to 1.0. // scrollPos[1]: y scroll position from 0.0 to 1.0. }
For the mapping of sources to controller inputs, see the Events section.

Unsupported VR Platforms: Cardboard(Android and iOS)
onSwipeReact.PropTypes.func

Called when the user performs a swipe gesture on the physical controller, while hovering on this control.

For example:
_onSwipe(state, source) { if(state == 1) { // Swiped up } else if(state == 2) { // Swiped down } else if(state == 3) { // Swiped left } else if(state == 4) { // Swiped right } }
For the mapping of sources to controller inputs, see the Events section.

Unsupported VR Platforms: Cardboard(Android and iOS)
onTransformUpdatePropTypes.func

A function that is invoked when the component moves and provides an array of numbers representing the component's position in world coordinates.
onTouchReact.PropTypes.func

Called when the user performs a touch action, while hovering on the control. Provides the touch state type, and the x/y coordinate at which this touch event has occurred.

|State Value|Description|
|:- -----|:- ---------:|
|1| Touch Down: Triggered when the user makes physical contact with the touch pad on the controller. |
|2| Touch Down Move: Called when the user moves around the touch pad immediately after having performed a Touch Down action. |
|3| Touch Up: Triggered after the user is no longer in physical contact with the touch pad after a Touch Down action. |

For example:
_onTouch(state, touchPos, source) { var touchX = touchPos[0]; var touchY = touchPos[1]; if(state == 1) { // Touch Down } else if(state == 2) { // Touch Down Move } else if(state == 3) { // Touch Up } }
For the mapping of sources to controller inputs, see the Events section.

Unsupported VR Platforms: Cardboard(Android and iOS).
opacityPropTypes.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.
physicsBodyPropTypes.shape({..physics.api..}),

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.api.
positionPropTypes.arrayOf(PropTypes.number)

Cartesian position of the spinner in 3D world space, specified as [x, y, z].
rotationPropTypes.arrayOf(PropTypes.number)

The rotation of the spinner around it's local axis specified as Euler angles [x, y, z]. Units for each angle are specified in degrees.
rotationPivotPropTypes.arrayOf(PropTypes.number)

Cartesian position in [x,y,z] about which rotation is applied relative to the component's position.
scalePropTypes.arrayOf(PropTypes.number)

The scale of the spinner in 3D space, specified as [x,y,z]. A scale of 1 represents the current size of the spinner. A scale value of < 1 will make the spinner proportionally smaller while a value >1 will make the spinner proportionally bigger along the specified axis.
scalePivotPropTypes.arrayOf(PropTypes.number)

Cartesian position in [x,y,z] from which scale is applied relative to the component's position.
transformBehaviorsPropTypes.arrayOf(PropTypes.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):

|Value|Description|
|:- -----|:- ---------:|
|billboard| Billboard object on x,y,z axis |
|billboardX| Billboard object on the x axis|
|billboardY| Billboard object on the y axis|
typeReact.PropTypes.oneOf(['dark','light'])

Spinner visual type for either a light or dark theme. This defaults to dark.
viroTagPropTypes.string

A tag given to other components when their physics body collides with this component's physics body. Refer to physics for more information.
visiblePropTypes.bool

False if the spinner should be hidden. By default the spinner is visible and this value is true.
renderingOrderPropTypes.number

This determines the order in which this Node is rendered relative to other Nodes. Nodes with greater rendering orders are rendered last. The default rendering order is zero. For example, setting a Node's rendering order to -1 will cause the Node to be rendered before all Nodes with rendering orders greater than or equal to 0.

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

|Return value | Description|
|- --|- --|
| transform | an object that contains "position", "scale" and "rotation" keys which point to number arrays |
applyImpulse(force: arrayOf(number), position: arrayOf(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|
applyTorqueImpulse(torque: arrayOf(number), position: arrayOf(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: arrayOf(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: object)
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 |

For example, setting position natively would look like this:

componentRef.setNativeProps({ position : [0, 0, -1] });

Updated 2 years ago

ViroSpinner

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.