Guides

ViroButton

Suggest Edits

A component that displays a 2D Button that is positioned in 3D world space. The button will animate onTap and switch the button look based on its state.

Example use:
<ViroButton
    source={require("./res/button_base.jpg")}
    gazeSource={require("./res/button_on_gazing.jpg")}
    tapSource={require("./res/button_on_tap_pressed.jpg")}
    position={[1, 3, -5]}
    height={2}
    width={3}
    onTap={this._onButtonTap}
/>

Props

source (*required)

TypeDescription
ImageSourcePropTypeAn asset can be loaded by using require() or { uri: 'https://example.com/your-image.png' }
<ViroButton source={require("./res/myimage.png")}/>
// or
<Viro360Image source={{ uri: 'https://example.com/your-image.png' }} />

animation

TypeDescription
PropTypes.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.

clickSource

TypeDescription
PropTypes.oneOfType([ PropTypes.shape({ uri: PropTypes.string, }), // Opaque type returned by require('image-2.html') PropTypes.number, ])The image file, to be displayed when the user clicks the button.Accepts a remote URL or a local file resource. PNG and JPG images accepted.To invoke with remote url: {uri:"http://example.org/myimage.png"}To invoke with local source:require('image.html');

dragType

TypeDescription
PropTypes.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 |The default value is "FixedDistance".

gazeSource

TypeDescription
PropTypes.oneOfType([ PropTypes.shape({ uri: PropTypes.string,}) The image to display when on the button when the user is gazing over it. Accepts a remote URL or a local file resource. PNG and JPG images accepted.To invoke with remote url: {uri:"http://example.org/myimage.png"}To invoke with local source:require('image.html');

height

TypeDescription
PropTypes.numberThe height of the button in 3D space. Default value is 1.

hoverSource

TypeDescription
PropTypes.oneOfType([ PropTypes.shape({ uri: PropTypes.string, }), // Opaque type returned by require('image-2.html') PropTypes.number, ])The image file, to be displayed when the user is hovering over itAccepts a remote URL or a local file resource. PNG and JPG images accepted.To invoke with remote url: {uri:"http://example.org/myimage.png"}To invoke with local source:require('image.html');

ignoreEventHandling

TypeDescription
PropTypes.boolWhen set to true, this control will ignore events and not prevent controls behind it from receiving event callbacks.The default value is false.

materials

TypeDescription
PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string),PropTypes.string])An array of strings that each represent a material that was created via ViroMaterials.createMaterials(). ViroButton takes 1 material, where the material's properties, except the diffuseTexture, are applied to the source, gaze and tap images provided to this button.

onClick

TypeDescription
React.PropTypes.funcCalled when an objeect has been clicked.Example code: _onClick(position, source) { // user has clicked the object}The position parameter represents the button in world coordinates on the box where the click occurred. For the mapping of sources to controller inputs, see the Events section.

onClickState

TypeDescription
React.PropTypes.funcCalled 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 }}The position parameter represents the button in world coordinates on the box where the click occurred. For the mapping of sources to controller inputs, see the Events section.

onCollision

TypeDescription
React.PropTypes.funcCalled 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. |

onDrag

TypeDescription
React.PropTypes.funcCalled 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

onFuse

TypeDescription
PropTypes.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.

onHover

TypeDescription
React.PropTypes.funcCalled 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.

onPinch

TypeDescription
React.PropTypes.funcCalled 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.

onRotate

TypeDescription
React.PropTypes.funcCalled 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.

onScroll

TypeDescription
React.PropTypes.funcCalled 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)

onSwipe

TypeDescription
React.PropTypes.funcCalled 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)

onTouch

TypeDescription
React.PropTypes.funcCalled 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).

onTransformUpdate

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

opacity

TypeDescription
PropTypes.numberA number from 0 to 1 that specifies the opacity of the button. A value of 1 translates into a fully opaque button while 0 represents full transparency.

position

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

physicsBody

TypeDescription
PropTypes.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.

rotation

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

rotationPivot

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

scale

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

scalePivot

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

style

TypeDescription
stylePropTypeStyle 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.

tapSource

TypeDescription
PropTypes.oneOfType( [PropTypes.shape( {uri: PropTypes.string} ), PropTypes.number] )The image to display when on the button when the user taps the button. Accepts a remote URL or a local file resource. PNG and JPG images accepted.To invoke with remote url: {uri:"http://example.org/myimage.png"}To invoke with local source:require('image.html');

transformBehaviors

TypeDescription
PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string),PropTypes.string])An array of transform constraints that affect the transform of the button. For example, putting the value "billboard" will ensure the button is facing the user as the user rotates their head on any axis. This is useful for having the button always face the user on a particular axis.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|

viroTag

TypeDescription
PropTypes.stringA tag given to other components when their physics body collides with this component's physics body. Refer to physics for more information.

visible

TypeDescription
PropTypes.boolFalse if the button should be hidden. By default the button is visible and this value is true.

width

TypeDescription
PropTypes.numberThe width of the button in 3D space. Default value is 1.

renderingOrder

TypeDescription
PropTypes.numberThis 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 |

Updated over 2 years ago