Giter VIP home page Giter VIP logo

react-native-360's Introduction

Looking for maintainers

open an issue and tag me @tiero

react-native-360

A React Native wrapper for Google VR Cardboard SDK.

Android version in this repo needs to be polished and merged here

Index

  1. Description
  2. Installation
  3. Usage
  4. Credits
  5. Roadmap
  6. License

1. Description

React Native 360 exploits Google VR Cardboard SDK to load and display 360-degree panoramic photos and to define a view that renders a 360 video using OpenGL

The iOS Google VR SDK works only with a real device #3

2. Installation

You can pull in react-native-360 via github:

npm install https://github.com/tiero/react-native-360.git

in ios folder create a Podfile

target 'myProject' do
  pod 'GVRSDK'
  # Your 'node_modules' directory is probably in the root of your project,
  # but if not, adjust the `:path` accordingly
  pod 'React', :path => '../node_modules/react-native', :subspecs => [
    'Core',

    'RCTActionSheet',
    'RCTAnimation',
    'RCTGeolocation',
    'RCTImage',
    'RCTLinkingIOS',
    'RCTNetwork',
    'RCTSettings',
    'RCTText',
    'RCTVibration',
    'RCTWebSocket',
    'BatchedBridge',

  
    'DevSupport' # Include this to enable In-App Devmenu if RN >= 0.43
    
    # Add any other subspecs you want to use in your project
  ]
  
    # Explicitly include Yoga if you are using RN >= 0.42.0
  pod 'Yoga', :path => '../node_modules/react-native/ReactCommon/yoga'
end

Still in ios folder install pods locally

pod install 
pod update
  • Open myProject.xcworkspace and under myProject > Build Settings under Build Options set ENABLE BITCODE to NO
  • Drag the folder RNGoogleVR from node_modules/react-native-360/ios under your myProject and be sure to check Copy items if needed and Create groups

3. Usage

Video Example

import { VideoView } from 'react-native-360';
<VideoView 
    style={{height:200,width:width}}
    video={{ uri:'https://raw.githubusercontent.com/googlevr/gvr-ios-sdk/master/Samples/VideoWidgetDemo/resources/congo.mp4',
             type: 'stereo'}}
    displayMode={'embedded'}
    volume={1}
    enableFullscreenButton
    enableCardboardButton
    enableTouchTracking
    hidesTransitionView
    enableInfoButton={false}              
/>            

Panorama Example

import { PanoramaView } from 'react-native-360';
<PanoramaView 
    style={{height:200,width:width}}
    image={require('./andes.jpg')}
    displayMode={'embedded'}
    enableFullscreenButton
    enableCardboardButton
    enableTouchTracking
    hidesTransitionView
    enableInfoButton={false}              
/>   

API

VideoView

Prop Type Description Values
volume number Defines a volume multiplier between 0.0f and 1.0f on the media audio playback 1
video object Load a local or remote video from a url and start playing {uri:'https://uri-example.com', type: 'stereo','mono'}
enableFullscreenButton bool Displays a button that allows the user to transition to fullscreen mode.
enableCardboardButton bool Displays a button that allows the user to transition to fullscreen Cardboard VR mode.
enableTouchTracking bool Enables touch gesture detection for manual heading control.
enableInfoButton bool Displays a button that allows the user to get more information about VRView
hidesTransitionView bool Hides the transition view when entering VR mode
displayMode string Controls the current GVRWidgetDisplayMode of the widget view 'fullscreen','cardboard', 'embedded'

PanoramaView

Prop Type Description Values
image Image.propTypes.source Load a 360-Panorama image from UIImage of type stereo. require('./image360.jpg')
enableFullscreenButton bool Displays a button that allows the user to transition to fullscreen mode.
enableCardboardButton bool Displays a button that allows the user to transition to fullscreen Cardboard VR mode.
enableTouchTracking bool Enables touch gesture detection for manual heading control.
enableInfoButton bool Displays a button that allows the user to get more information about VRView
hidesTransitionView bool Hides the transition view when entering VR mode
displayMode string Controls the current GVRWidgetDisplayMode of the widget view 'fullscreen','cardboard', 'embedded'

4. Credits

This Native UI component leverages the Google VR Android SDK and the Google VR iOS SDK for all the heavy liftings.

5. Roadmap

  • iOS
    • PanoramaView
    • VideoView
  • Android
    • PanoramaView
    • VideoView

TODO

  • [iOS] Load 360 image from network

6. License

MIT License

Copyright (c) 2017 Marco Argentieri

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

react-native-360's People

Contributors

davvidbaker avatar ermankuruoglu avatar richardlindhout avatar stereodenis avatar tiero avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.