GuidesChangelogDiscussions
GuidesIssuesSupportGet API Key

ViroPortalScene

A component that allows the set up of a sub-scene only rendered and accessible through the use of a ViroPortal component.

Example use:
<ViroScene>
  <ViroPortalScene position={[0, -1, 0]}>
    <ViroPortal position={[0, 0, -1]} scale={[.5, .5, .5]}>
      <Viro3DObject source={require('./res/portalFrame.obj')} type="OBJ"/>
    </ViroPortal>
    ...
  </ViroPortalScene>
  ...
</ViroScene>

Props

Optional Props

PropKey

PropType

animation

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.

dragPlane

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

dragType

PropTypes.oneOf(["FixedDistance", "FixedToWorld"])

Determines the behavior of drag if onDrag is specified.

ValueDescription
FixedDistanceDragging 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
FixedDistanceOriginDragging is limited to a fixed radius around the user, dragged from the point of this node's position in world space.
FixedToWorldDragging is based on intersection with real world objects. Available only in AR
FixedToPlaneDragging 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".

ignoreEventHandling

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

onClick

PropTypes.func

Called when an objeect has been clicked.

Example code:

_onClick(position, source)  {
    // user has clicked the object
}

onClickState

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 ValueDescription
1Click Down: Triggered when the user has performed a click down action while hovering on this control.
2Click Up: Triggered when the user has performed a click up action while hovering on this control.
3Clicked: 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.

onDrag

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

onFuse

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

React.PropTypes.func
Function to be invoked when the user hovers on or off the container view. If defined, this is only invoked if the child hovered upon doesn't have onHover defined.

For instance, let's say you have a that contains a few buttons and text. If none of them have a onHover handler defined, and they get hovered upon, then this function will invoke, effectively capturing the onHover event from it's children.

For example:

_onHover(isHovering, position, source)  {
    if(isHovering) {
        // user is hovering on the container view.
    } else {
        // user is no longer hovering on the container view.
    }
}

onPinch

React.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 ValueDescription
1Pinch Start: Triggered when the user has started a pinch gesture.
2Pinch Move: Triggered when the user has adjusted the pinch, moving both fingers.
3Pinch End: When the user has finishes the pinch gesture and released both touch points.

This event is only available in AR.

onPortalEnter

PropTypes.func

Called when the user enters into this ViroPortalScene through a ViroPortal.

onPortalExit

PropTypes.func

Called when the user exits this ViroPortalScene through any ViroPortal.

onRotate

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 ValueDescription
1Rotation Start: Triggered when the user has started a rotation gesture.
2Rotation Move: Triggered when the user has adjusted the rotation, moving both fingers.
3Rotation End: When the user has finishes the rotation gesture and released both touch points.

This event is only available in AR.

onScroll

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)

onSwipe

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)

onTouch

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 ValueDescription
1Touch Down: Triggered when the user makes physical contact with the touch pad on the controller.
2Touch Down Move: Called when the user moves around the touch pad immediately after having performed a Touch Down action.
3Touch 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

PropTypes.func

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

opacity

PropTypes.number

A number from 0 to 1 that specifies the opacity of the container. A value of 1 translates into a fully opaque node while 0 represents full transparency.

passable

PropTypes.bool

If true, then user is able to enter this ViroPortalScene through its ViroPortal.

position

PropTypes.arrayOf(PropTypes.number)

Cartesian position in 3D space, stored as [x, y, z].

rotation

PropTypes.arrayOf(PropTypes.number)

The rotation of the container around it's local axis specified as Euler angles [x, y, z]. Units for each angle are specified in degrees.

rotationPivot

PropTypes.arrayOf(PropTypes.number)

Cartesian position in [x,y,z] about which rotation is applied relative to the component's position.

scale

PropTypes.arrayOf(PropTypes.number)

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

scalePivot

PropTypes.arrayOf(PropTypes.number)

Cartesian position in [x,y,z] from which scale is applied relative to the component's position.

transformBehaviors

PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.string),PropTypes.string])

An array of transform constraints that affect the transform of the container. For example, putting the value "billboard" will ensure the container is facing the user as the user rotates their head on any axis. This is useful for having the container always face the user on a particular axis.

Allowed values(values are case sensitive):

ValueDescription
billboardBillboard object on x,y,z axis
billboardXBillboard object on the x axis
billboardYBillboard object on the y axis

visible

PropTypes.bool

False if the container should be hidden. By default the container is visible and this value is true.

renderingOrder

PropTypes.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 valueDescription
transforman object that contains "position", "scale" and "rotation" keys which point to number arrays

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.

ParameterDescription
nativePropsan 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]
});