├── .eslintignore ├── .prettierignore ├── commitlint.config.js ├── prettier.config.js ├── examples ├── assets │ ├── close.jpg │ ├── info.jpg │ ├── open.png │ ├── tony.jpg │ └── closed.png ├── basic │ └── index.html └── advanced │ └── index.html ├── .gitignore ├── .babelrc ├── lint-staged.config.js ├── .eslintrc.yml ├── webpack.config.js ├── tests ├── index.test.js ├── karma.conf.js ├── __init.test.js └── helpers.js ├── .travis.yml ├── .circleci └── config.yml ├── index.html ├── README.md ├── package.json ├── dist ├── aframe-dialog-popup-component.min.js └── aframe-dialog-popup-component.js ├── index.js └── LICENSE /.eslintignore: -------------------------------------------------------------------------------- 1 | dist 2 | *.min.js 3 | -------------------------------------------------------------------------------- /.prettierignore: -------------------------------------------------------------------------------- 1 | dist 2 | *.min.js 3 | -------------------------------------------------------------------------------- /commitlint.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | extends: ['@commitlint/config-angular'] 3 | }; 4 | -------------------------------------------------------------------------------- /prettier.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | singleQuote: true, 3 | trailingComma: 'none' 4 | }; 5 | -------------------------------------------------------------------------------- /examples/assets/close.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/EditVR/aframe-dialog-popup-component/HEAD/examples/assets/close.jpg -------------------------------------------------------------------------------- /examples/assets/info.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/EditVR/aframe-dialog-popup-component/HEAD/examples/assets/info.jpg -------------------------------------------------------------------------------- /examples/assets/open.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/EditVR/aframe-dialog-popup-component/HEAD/examples/assets/open.png -------------------------------------------------------------------------------- /examples/assets/tony.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/EditVR/aframe-dialog-popup-component/HEAD/examples/assets/tony.jpg -------------------------------------------------------------------------------- /examples/assets/closed.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/EditVR/aframe-dialog-popup-component/HEAD/examples/assets/closed.png -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .sw[ponm] 2 | examples/build.js 3 | examples/node_modules/ 4 | gh-pages 5 | node_modules/ 6 | npm-debug.log 7 | .component 8 | package-lock.json 9 | -------------------------------------------------------------------------------- /.babelrc: -------------------------------------------------------------------------------- 1 | { 2 | "presets": [ 3 | ["@babel/preset-env", { 4 | "targets": { 5 | "browsers": ["last 3 versions"] 6 | } 7 | }] 8 | ] 9 | } 10 | -------------------------------------------------------------------------------- /lint-staged.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | '**/*.{js,jsx,json,css}': ['prettier --write', 'git add'], 3 | '**/*.{js,jsx,json,css,html}': ['yarn dist', 'git add dist'] 4 | }; 5 | -------------------------------------------------------------------------------- /.eslintrc.yml: -------------------------------------------------------------------------------- 1 | extends: 2 | - airbnb-base 3 | - prettier 4 | env: 5 | es6: false 6 | browser: true 7 | globals: 8 | expect: true 9 | it: true 10 | describe: true 11 | Promise: true 12 | rules: 13 | strict: 0 14 | no-plusplus: 0 15 | -------------------------------------------------------------------------------- /webpack.config.js: -------------------------------------------------------------------------------- 1 | /** 2 | * @file webpack.config.js 3 | * Exports configuration for Webpack. 4 | */ 5 | 6 | const rules = []; 7 | rules.push({ 8 | test: /\.js|jsx$/, 9 | exclude: /node_modules/, 10 | use: 'babel-loader' 11 | }); 12 | 13 | module.exports = { 14 | module: { 15 | rules 16 | } 17 | }; 18 | -------------------------------------------------------------------------------- /tests/index.test.js: -------------------------------------------------------------------------------- 1 | /* global assert, setup, suite, test */ 2 | require('aframe'); 3 | require('../index.js'); 4 | const { entityFactory } = require('./helpers'); 5 | 6 | suite('dialog-popup component', () => { 7 | let el; 8 | 9 | setup(done => { 10 | el = entityFactory(); 11 | el.addEventListener('componentinitialized', evt => { 12 | if (evt.detail.name !== 'dialog-popup') { 13 | return; 14 | } 15 | done(); 16 | }); 17 | el.setAttribute('dialog-popup', {}); 18 | }); 19 | 20 | suite('foo property', () => { 21 | test('is good', () => { 22 | assert.equal(1, 1); 23 | }); 24 | }); 25 | }); 26 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | addons: 3 | firefox: 'latest' 4 | node_js: 5 | - '6.9' 6 | 7 | install: 8 | - npm install 9 | - ./node_modules/.bin/mozilla-download ./firefox/ --product firefox --branch mozilla-aurora 10 | - export FIREFOX_NIGHTLY_BIN="./firefox/firefox/firefox-bin" 11 | 12 | before_script: 13 | - export DISPLAY=:99.0 14 | - sh -e /etc/init.d/xvfb start 15 | 16 | script: 17 | - $CI_ACTION 18 | 19 | env: 20 | global: 21 | - TEST_SUITE=unit 22 | matrix: 23 | - CI_ACTION="npm run test" 24 | - CI_ACTION="npm run dist" 25 | # - CI_ACTION="npm run lint" 26 | 27 | branches: 28 | only: 29 | - master 30 | 31 | cache: 32 | directories: 33 | - node_modules 34 | -------------------------------------------------------------------------------- /tests/karma.conf.js: -------------------------------------------------------------------------------- 1 | // Karma configuration. 2 | module.exports = function karmaConfig(config) { 3 | config.set({ 4 | basePath: '../', 5 | browserify: { 6 | debug: true, 7 | paths: ['./'] 8 | }, 9 | browsers: ['Firefox', 'Chrome'], 10 | client: { 11 | captureConsole: true, 12 | mocha: { ui: 'tdd' } 13 | }, 14 | envPreprocessor: ['TEST_ENV'], 15 | files: [ 16 | // Define test files. 17 | { pattern: 'tests/**/*.test.js' }, 18 | // Serve test assets. 19 | { pattern: 'tests/assets/**/*', included: false, served: true } 20 | ], 21 | frameworks: [ 22 | 'mocha', 23 | 'sinon-chai', 24 | 'chai-shallow-deep-equal', 25 | 'browserify' 26 | ], 27 | preprocessors: { 'tests/**/*.js': ['browserify', 'env'] }, 28 | reporters: ['mocha'] 29 | }); 30 | }; 31 | -------------------------------------------------------------------------------- /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | jobs: 3 | build: 4 | docker: 5 | - image: circleci/node:10-stretch 6 | working_directory: ~/repo 7 | branches: 8 | ignore: 9 | - gh-pages 10 | 11 | steps: 12 | - checkout 13 | 14 | # Download and cache dependencies 15 | - restore_cache: 16 | keys: 17 | - v1-dependencies-{{ checksum "yarn.lock" }} 18 | # fallback to using the latest cache if no exact match is found 19 | - v1-dependencies- 20 | 21 | - run: yarn install 22 | 23 | - save_cache: 24 | paths: 25 | - node_modules 26 | key: v1-dependencies-{{ checksum "yarn.lock" }} 27 | 28 | - run: yarn lint 29 | - type: deploy 30 | name: Deploy and release. 31 | command: | 32 | if [ "${CIRCLE_BRANCH}" == "master" ]; then 33 | git config --global user.email "editvr@fourkitchens.com" 34 | git config --global user.name "EditVR Bot" 35 | git fetch --tags 36 | yarn semantic-release 37 | fi 38 | -------------------------------------------------------------------------------- /tests/__init.test.js: -------------------------------------------------------------------------------- 1 | /* global sinon, setup, teardown */ 2 | 3 | /** 4 | * __init.test.js is run before every test case. 5 | */ 6 | window.debug = true; 7 | const { AScene } = require('aframe'); 8 | 9 | navigator.getVRDisplays = function getVRDisplays() { 10 | const resolvePromise = Promise.resolve(); 11 | const mockVRDisplay = { 12 | requestPresent: resolvePromise, 13 | exitPresent: resolvePromise, 14 | getPose() { 15 | return { orientation: null, position: null }; 16 | }, 17 | requestAnimationFrame() { 18 | return 1; 19 | } 20 | }; 21 | return Promise.resolve([mockVRDisplay]); 22 | }; 23 | 24 | setup(function setup() { 25 | this.sinon = sinon.sandbox.create(); 26 | // Stubs to not create a WebGL context since Travis CI runs headless. 27 | this.sinon.stub(AScene.prototype, 'render'); 28 | this.sinon.stub(AScene.prototype, 'resize'); 29 | this.sinon.stub(AScene.prototype, 'setupRenderer'); 30 | }); 31 | 32 | teardown(function teardown() { 33 | // Clean up any attached elements. 34 | const attachedEls = ['canvas', 'a-assets', 'a-scene']; 35 | const els = document.querySelectorAll(attachedEls.join(',')); 36 | for (let i = 0; i < els.length; i++) { 37 | els[i].parentNode.removeChild(els[i]); 38 | } 39 | this.sinon.restore(); 40 | }); 41 | -------------------------------------------------------------------------------- /tests/helpers.js: -------------------------------------------------------------------------------- 1 | /* global suite */ 2 | 3 | /** 4 | * Helper method to create a scene, create an entity, add entity to scene, 5 | * add scene to document. 6 | * 7 | * @returns {object} An `` element. 8 | */ 9 | module.exports.entityFactory = function entityFactory(options) { 10 | const scene = document.createElement('a-scene'); 11 | const assets = document.createElement('a-assets'); 12 | const entity = document.createElement('a-entity'); 13 | scene.appendChild(assets); 14 | scene.appendChild(entity); 15 | 16 | const opts = options || {}; 17 | 18 | if (opts.assets) { 19 | opts.assets.forEach(asset => { 20 | assets.appendChild(asset); 21 | }); 22 | } 23 | 24 | document.body.appendChild(scene); 25 | return entity; 26 | }; 27 | 28 | /** 29 | * Creates and attaches a mixin element (and an `` element if necessary). 30 | * 31 | * @param {string} id - ID of mixin. 32 | * @param {object} obj - Map of component names to attribute values. 33 | * @param {Element} scene - Indicate which scene to apply mixin to if necessary. 34 | * @returns {object} An attached `` element. 35 | */ 36 | module.exports.mixinFactory = function mixinFactory(id, obj, scene) { 37 | const mixinEl = document.createElement('a-mixin'); 38 | mixinEl.setAttribute('id', id); 39 | Object.keys(obj).forEach(componentName => { 40 | mixinEl.setAttribute(componentName, obj[componentName]); 41 | }); 42 | 43 | const assetsEl = scene 44 | ? scene.querySelector('a-assets') 45 | : document.querySelector('a-assets'); 46 | assetsEl.appendChild(mixinEl); 47 | 48 | return mixinEl; 49 | }; 50 | 51 | /** 52 | * Test that is only run locally and is skipped on CI. 53 | */ 54 | module.exports.getSkipCISuite = function getSkipCISuite() { 55 | /* eslint-disable-next-line no-underscore-dangle */ 56 | if (window.__env__.TEST_ENV === 'ci') { 57 | return suite.skip; 58 | } 59 | return suite; 60 | }; 61 | -------------------------------------------------------------------------------- /examples/basic/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | A-Frame Simple Link Component - Basic 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | -------------------------------------------------------------------------------- /examples/advanced/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | A-Frame Simple Link Component - Advanced 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | A-Frame Simple Link Component 6 | 7 | 48 | 49 | 50 |

A-Frame Simple Link Component

51 | 52 |
    53 |
  • 54 | 55 |

    Basic

    56 |

    This is a basic example.

    57 |
    • 58 |
  • 59 | 60 |

    Advanced

    61 |

    This is a more advanced example.

    62 |
    • 63 |
64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 73 | 74 | 75 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## aframe-dialog-popup-component 2 | 3 | [![Version](http://img.shields.io/npm/v/@editvr/aframe-dialog-popup-component.svg?style=flat-square)](https://npmjs.org/package/aframe-dialog-popup-component) 4 | [![CircleCI](http://img.shields.io/circleci/project/github/EditVR/aframe-dialog-popup-component.svg?style=flat-square)](https://npmjs.org/package/@editvr/aframe-dialog-popup-component) 5 | [![License](http://img.shields.io/npm/l/@editvr/aframe-dialog-popup-component.svg?style=flat-square)](https://npmjs.org/package/aframe-dialog-popup-component) 6 | 7 | Provides a component that constructs a toggle-able dialog with a title, description, image, and close button. 8 | 9 | For [A-Frame](https://aframe.io). 10 | 11 | ### API 12 | 13 | | Property | Description | Default Value | 14 | | ---------------------- | --------------------------- | ----------------------------- | 15 | | title | String containing title. | New Dialog | 16 | | titleColor | Text color of title. | black | 17 | | titleFont | Title font. | mozillavr | 18 | | titleWrapCount | Title entity wrap count. | 24 | 19 | | body | String containing body. | This dialog has no body yet. | 20 | | bodyColor | Text color of body. | black | 21 | | bodyFont | Body font. | mozillavr | 22 | | bodyWrapCount | Body entity wrap count. | 30 | 23 | | openOn | Open/Close event. | click | 24 | | active | Turn dialog on/off. | true | 25 | | openIconImage | Icon image for open button. | None | 26 | | openIconRadius | Radius for open icon. | 0.3 | 27 | | openIconColor | Color for open icon. | white | 28 | | closeIconImage | Icon image for open button. | None | 29 | | closeIconRadius | Radius for close icon. | 0.3 | 30 | | closeIconColor | Color for close icon. | white | 31 | | image | Path to Dialog hero image. | None | 32 | | imageWidth | Dialog hero image width. | 2 | 33 | | imageHeight | Dialog hero image height. | 2 | 34 | | dialogBoxWidth | Dialog box width. | 4 | 35 | | dialogBoxHeight | Dialog box height. | 4 | 36 | | dialogBoxColor | Dialog box background color.| white | 37 | | dialogBoxPadding | Dialog box padding. | 0.2 | 38 | 39 | ### Installation 40 | 41 | #### Browser 42 | 43 | Install and use by directly including the [browser files](dist): 44 | 45 | ```html 46 | 47 | My A-Frame Scene 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | ``` 58 | 59 | #### npm 60 | 61 | Install via npm: 62 | 63 | ```bash 64 | npm install @editvr/aframe-dialog-popup-component 65 | ``` 66 | 67 | Then require and use. 68 | 69 | ```js 70 | require('aframe'); 71 | require('@editvr/aframe-dialog-popup-component'); 72 | ``` 73 | 74 | ## Example 75 | ### Closed 76 | ![Closed](https://github.com/EditVR/aframe-dialog-popup-component/raw/develop/examples/assets/closed.png) 77 | ### Opened 78 | ![Open](https://github.com/EditVR/aframe-dialog-popup-component/raw/develop/examples/assets/open.png) 79 | 80 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@editvr/aframe-dialog-popup-component", 3 | "version": "0.0.0-development", 4 | "description": "Provides a component that constructs a toggle-able dialog with a title, description, image, and close button.", 5 | "main": "dist/aframe-dialog-popup-component.js", 6 | "unpkg": "dist/aframe-dialog-popup-component.min.js", 7 | "scripts": { 8 | "build": "webpack index.js dist/aframe-dialog-popup-component.js", 9 | "dev": "budo index.js:dist/aframe-dialog-popup-component.min.js --port 7000 --live --open", 10 | "dist": "npm run build && uglifyjs dist/aframe-dialog-popup-component.js > dist/aframe-dialog-popup-component.min.js", 11 | "lint": "eslint --ext .jsx,.js .", 12 | "prepublishOnly": "npm run dist", 13 | "prettier": "prettier --write \"**/*.{js,jsx,json,css}\"", 14 | "precommit": "lint-staged -c lint-staged.config.js ; yarn lint ; yarn test:ci", 15 | "commitmsg": "commitlint -e $GIT_PARAMS", 16 | "ghpages": "ghpages", 17 | "start": "npm run dev", 18 | "semantic-release": "semantic-release", 19 | "test": "karma start ./tests/karma.conf.js", 20 | "test:ci": "karma start ./tests/karma.conf.js --single-run", 21 | "test:firefox": "karma start ./tests/karma.conf.js --browsers Firefox", 22 | "test:chrome": "karma start ./tests/karma.conf.js --browsers Chrome" 23 | }, 24 | "repository": { 25 | "type": "git", 26 | "url": "git+https://github.com/editvr/aframe-dialog-popup-component.git" 27 | }, 28 | "keywords": [ 29 | "aframe", 30 | "aframe-component", 31 | "aframe-vr", 32 | "vr", 33 | "webvr", 34 | "dialog-popup" 35 | ], 36 | "author": "Patrick Coffey ", 37 | "publishConfig": { 38 | "access": "public" 39 | }, 40 | "license": "GPL-3.0", 41 | "bugs": { 42 | "url": "https://github.com/editvr/aframe-dialog-popup-component/issues" 43 | }, 44 | "homepage": "https://github.com/editvr/aframe-dialog-popup-component#readme", 45 | "release": { 46 | "verifyConditions": [ 47 | "@semantic-release/npm", 48 | "@semantic-release/github" 49 | ], 50 | "publish": [ 51 | "@semantic-release/npm", 52 | "@semantic-release/github" 53 | ], 54 | "success": [ 55 | "@semantic-release/github" 56 | ], 57 | "fail": [ 58 | "@semantic-release/github" 59 | ] 60 | }, 61 | "devDependencies": { 62 | "@babel/core": "^7.0.0-beta.54", 63 | "@babel/preset-env": "^7.0.0-beta.54", 64 | "@commitlint/cli": "^7.0.0", 65 | "@semantic-release/github": "^4.2.18", 66 | "@semantic-release/npm": "^3.3.4", 67 | "aframe": "*", 68 | "babel-loader": "^8.0.0-beta", 69 | "browserify": "^13.0.0", 70 | "budo": "^8.2.2", 71 | "chai": "^3.4.1", 72 | "chai-shallow-deep-equal": "^1.3.0", 73 | "eslint": "^5.0.1", 74 | "eslint-config-airbnb-base": "^13.0.0", 75 | "eslint-config-prettier": "^2.9.0", 76 | "eslint-plugin-import": "^2.13.0", 77 | "ghpages": "^0.0.8", 78 | "husky": "^0.14.3", 79 | "karma": "^0.13.15", 80 | "karma-browserify": "^4.4.2", 81 | "karma-chai-shallow-deep-equal": "0.0.4", 82 | "karma-chrome-launcher": "2.0.0", 83 | "karma-env-preprocessor": "^0.1.1", 84 | "karma-firefox-launcher": "^0.1.7", 85 | "karma-mocha": "^0.2.1", 86 | "karma-mocha-reporter": "^1.1.3", 87 | "karma-sinon-chai": "^1.1.0", 88 | "lint-staged": "^7.2.0", 89 | "mocha": "^2.3.4", 90 | "prettier": "^1.13.7", 91 | "randomcolor": "^0.4.4", 92 | "semantic-release": "^15.6.0", 93 | "semistandard": "^8.0.0", 94 | "shelljs": "^0.7.0", 95 | "shx": "^0.1.1", 96 | "sinon": "^1.17.5", 97 | "sinon-chai": "^2.8.0", 98 | "snazzy": "^4.0.0", 99 | "uglify-es": "github:mishoo/UglifyJS2#harmony", 100 | "webpack": "^2.7.0" 101 | }, 102 | "semistandard": { 103 | "globals": [ 104 | "AFRAME", 105 | "THREE" 106 | ], 107 | "ignore": [ 108 | "examples/build.js", 109 | "dist/**" 110 | ] 111 | }, 112 | "dependencies": { 113 | "@commitlint/config-angular": "^7.0.1" 114 | } 115 | } 116 | -------------------------------------------------------------------------------- /dist/aframe-dialog-popup-component.min.js: -------------------------------------------------------------------------------- 1 | (function(modules){var installedModules={};function __webpack_require__(moduleId){if(installedModules[moduleId]){return installedModules[moduleId].exports}var module=installedModules[moduleId]={i:moduleId,l:false,exports:{}};modules[moduleId].call(module.exports,module,module.exports,__webpack_require__);module.l=true;return module.exports}__webpack_require__.m=modules;__webpack_require__.c=installedModules;__webpack_require__.i=function(value){return value};__webpack_require__.d=function(exports,name,getter){if(!__webpack_require__.o(exports,name)){Object.defineProperty(exports,name,{configurable:false,enumerable:true,get:getter})}};__webpack_require__.n=function(module){var getter=module&&module.__esModule?function getDefault(){return module["default"]}:function getModuleExports(){return module};__webpack_require__.d(getter,"a",getter);return getter};__webpack_require__.o=function(object,property){return Object.prototype.hasOwnProperty.call(object,property)};__webpack_require__.p="";return __webpack_require__(__webpack_require__.s=0)})([function(module,exports,__webpack_require__){"use strict";if(typeof AFRAME==="undefined"){throw new Error("Component attempted to register before AFRAME was available.")}AFRAME.registerComponent("dialog-popup",{schema:{title:{type:"string",default:"New Dialog"},titleColor:{type:"string",default:"black"},titleFont:{type:"string",default:"mozillavr"},titleWrapCount:{type:"number",default:24},body:{type:"string",default:"This dialog has no body yet."},bodyColor:{type:"string",default:"black"},bodyFont:{type:"string",default:"mozillavr"},bodyWrapCount:{type:"number",default:30},openOn:{type:"string",default:"click"},active:{type:"boolean",default:true},openIconImage:{type:"asset",default:""},openIconRadius:{type:"number",default:.3},openIconColor:{type:"string",default:"white"},closeIconImage:{type:"asset",default:""},closeIconRadius:{type:"number",default:.3},closeIconColor:{type:"string",default:"white"},image:{type:"string",default:""},imageWidth:{type:"number",default:2},imageHeight:{type:"number",default:2},dialogBoxWidth:{type:"number",default:4},dialogBoxHeight:{type:"number",default:4},dialogBoxColor:{type:"string",default:"white"},dialogBoxPadding:{type:"number",default:.2}},multiple:true,dialogPlaneEl:null,openIconEl:null,closeIconEl:null,titleEl:null,bodyEl:null,imageEl:null,hasImage:false,init:function init(){this.cameraEl=document.querySelector("[camera]");this.spawnEntities();this.el.emit("loaded")},tick:function tick(){if(this.isOpen){this.positionDialogPlane()}},remove:function remove(){var openOn=this.data.openOn;this.openIconEl.removeEventListener(openOn,this.toggleDialogOpen.bind(this));this.closeIconEl.removeEventListener(openOn,this.toggleDialogOpen.bind(this))},update:function update(){this.generateTitle();this.generateBody();this.generateImage()},toggleDialogOpen:function toggleDialogOpen(){this.isOpen=!this.isOpen;if(this.data.active&&this.dialogPlaneEl){this.positionDialogPlane();this.dialogPlaneEl.setAttribute("visible",this.isOpen);this.openIconEl.setAttribute("visible",!this.isOpen)}},generateOpenIcon:function generateOpenIcon(){var _this$data=this.data,radius=_this$data.openIconRadius,color=_this$data.openIconColor,src=_this$data.openIconImage,openOn=_this$data.openOn;var openIcon=document.createElement("a-entity");openIcon.setAttribute("id","".concat(this.el.getAttribute("id"),"--open-icon"));openIcon.setAttribute("position",Object.assign({},this.el.getAttribute("position")));openIcon.setAttribute("geometry",{primitive:"circle",radius:radius});openIcon.setAttribute("material",{color:color,src:src});var lookAt=this.el.getAttribute("look-at");if(lookAt){openIcon.setAttribute("look-at",lookAt)}openIcon.addEventListener(openOn,this.toggleDialogOpen.bind(this));this.openIconEl=openIcon;return openIcon},generateCloseIcon:function generateCloseIcon(){var _this$data2=this.data,radius=_this$data2.closeIconRadius,color=_this$data2.closeIconColor,src=_this$data2.closeIconImage,width=_this$data2.dialogBoxWidth,height=_this$data2.dialogBoxHeight,openOn=_this$data2.openOn;var closeIcon=document.createElement("a-entity");closeIcon.setAttribute("id","".concat(this.el.getAttribute("id"),"--close-icon"));closeIcon.setAttribute("position",{x:width/2,y:height/2,z:.01});closeIcon.setAttribute("geometry",{primitive:"circle",radius:radius});closeIcon.setAttribute("material",{color:color,src:src});closeIcon.addEventListener(openOn,this.toggleDialogOpen.bind(this));this.closeIconEl=closeIcon;return closeIcon},generateTitle:function generateTitle(){var _this$data3=this.data,value=_this$data3.title,color=_this$data3.titleColor,font=_this$data3.titleFont,wrapCount=_this$data3.titleWrapCount,width=_this$data3.dialogBoxWidth,height=_this$data3.dialogBoxHeight,padding=_this$data3.dialogBoxPadding,imageHeight=_this$data3.imageHeight;var title=this.titleEl||document.createElement("a-entity");title.setAttribute("id","".concat(this.el.getAttribute("id"),"--title"));title.setAttribute("text",{value:value.substring(0,wrapCount),color:color,font:font,wrapCount:wrapCount,width:width-padding*2,baseline:"top",anchor:"left"});var y=height/2-padding;if(this.hasImage){y-=imageHeight/2}title.setAttribute("position",{x:-(width/2)+padding,y:y,z:.01});this.titleEl=title;return title},generateBody:function generateBody(){var _this$data4=this.data,value=_this$data4.body,color=_this$data4.bodyColor,font=_this$data4.bodyFont,wrapCount=_this$data4.bodyWrapCount,width=_this$data4.dialogBoxWidth,height=_this$data4.dialogBoxHeight,padding=_this$data4.dialogBoxPadding,imageHeight=_this$data4.imageHeight;var body=this.bodyEl||document.createElement("a-entity");body.setAttribute("id","".concat(this.el.getAttribute("id"),"--title"));body.setAttribute("text",{value:value,color:color,font:font,wrapCount:wrapCount,width:width-padding*2,baseline:"top",anchor:"left"});var y=height/2-padding*3;if(this.hasImage){y-=imageHeight/2}body.setAttribute("position",{x:-(width/2)+padding,y:y,z:.01});this.bodyEl=body;return body},generateImage:function generateImage(){var _this$data5=this.data,src=_this$data5.image,width=_this$data5.imageWidth,height=_this$data5.imageHeight,dialogBoxHeight=_this$data5.dialogBoxHeight;if(!src.length){return null}var image=this.imageEl||document.createElement("a-image");image.setAttribute("id","".concat(this.el.getAttribute("id"),"--image"));image.setAttribute("src",src);image.setAttribute("width",width);image.setAttribute("height",height);image.setAttribute("position",{x:0,y:dialogBoxHeight/2,z:.01});this.hasImage=true;this.imageEl=image;return image},generateDialogPlane:function generateDialogPlane(){var _this$data6=this.data,width=_this$data6.dialogBoxWidth,height=_this$data6.dialogBoxHeight,padding=_this$data6.dialogBoxPadding,color=_this$data6.dialogBoxColor;var plane=this.dialogPlaneEl||document.createElement("a-entity");plane.setAttribute("id","".concat(this.el.getAttribute("id"),"--dialog-plane"));plane.setAttribute("position",Object.assign({},this.el.getAttribute("position")));plane.setAttribute("visible",false);plane.setAttribute("geometry",{primitive:"plane",width:width+padding,height:height+padding});var image=this.generateImage();if(image){plane.appendChild(this.generateImage())}plane.setAttribute("material",{color:color});plane.appendChild(this.generateCloseIcon());plane.appendChild(this.generateTitle());plane.appendChild(this.generateBody());this.dialogPlaneEl=plane;return plane},positionDialogPlane:function positionDialogPlane(){if(this.dialogPlaneEl){var vector=this.dialogPlaneEl.object3D.parent.worldToLocal(this.cameraEl.object3D.getWorldPosition());this.dialogPlaneEl.object3D.lookAt(vector)}},spawnEntities:function spawnEntities(){this.el.appendChild(this.generateOpenIcon());this.el.appendChild(this.generateDialogPlane());this.el.removeAttribute("position")}})}]); 2 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | /** 2 | * @file index.js 3 | * Contains code that registers a dialog popup component. 4 | */ 5 | 6 | /* global AFRAME */ 7 | 8 | if (typeof AFRAME === 'undefined') { 9 | throw new Error( 10 | 'Component attempted to register before AFRAME was available.' 11 | ); 12 | } 13 | 14 | /** 15 | * Dialog Popup component for A-Frame. 16 | */ 17 | AFRAME.registerComponent('dialog-popup', { 18 | schema: { 19 | title: { 20 | type: 'string', 21 | default: 'New Dialog' 22 | }, 23 | titleColor: { 24 | type: 'string', 25 | default: 'black' 26 | }, 27 | titleFont: { 28 | type: 'string', 29 | default: 'mozillavr' 30 | }, 31 | titleWrapCount: { 32 | type: 'number', 33 | default: 24 34 | }, 35 | body: { 36 | type: 'string', 37 | default: 'This dialog has no body yet.' 38 | }, 39 | bodyColor: { 40 | type: 'string', 41 | default: 'black' 42 | }, 43 | bodyFont: { 44 | type: 'string', 45 | default: 'mozillavr' 46 | }, 47 | bodyWrapCount: { 48 | type: 'number', 49 | default: 30 50 | }, 51 | openOn: { 52 | type: 'string', 53 | default: 'click' 54 | }, 55 | active: { 56 | type: 'boolean', 57 | default: true, 58 | }, 59 | openIconImage: { 60 | type: 'asset', 61 | default: '' 62 | }, 63 | openIconRadius: { 64 | type: 'number', 65 | default: 0.3 66 | }, 67 | openIconColor: { 68 | type: 'string', 69 | default: 'white' 70 | }, 71 | closeIconImage: { 72 | type: 'asset', 73 | default: '' 74 | }, 75 | closeIconRadius: { 76 | type: 'number', 77 | default: 0.3 78 | }, 79 | closeIconColor: { 80 | type: 'string', 81 | default: 'white' 82 | }, 83 | image: { 84 | type: 'string', 85 | default: '' 86 | }, 87 | imageWidth: { 88 | type: 'number', 89 | default: 2 90 | }, 91 | imageHeight: { 92 | type: 'number', 93 | default: 2 94 | }, 95 | dialogBoxWidth: { 96 | type: 'number', 97 | default: 4 98 | }, 99 | dialogBoxHeight: { 100 | type: 'number', 101 | default: 4 102 | }, 103 | dialogBoxColor: { 104 | type: 'string', 105 | default: 'white' 106 | }, 107 | dialogBoxPadding: { 108 | type: 'number', 109 | default: 0.2 110 | } 111 | }, 112 | multiple: true, 113 | dialogPlaneEl: null, 114 | closeIconEl: null, 115 | titleEl: null, 116 | bodyEl: null, 117 | imageEl: null, 118 | hasImage: false, 119 | /** 120 | * Spawns the entities required to support this dialog. 121 | */ 122 | init() { 123 | this.cameraEl = document.querySelector('[camera]'); 124 | this.generateOpenIcon() 125 | this.spawnEntities(); 126 | this.el.emit('loaded'); 127 | }, 128 | /** 129 | * If the component is open, ensure it always faces the camera. 130 | */ 131 | tick() { 132 | if (this.isOpen) { 133 | this.positionDialogPlane(); 134 | } 135 | }, 136 | /** 137 | * When this component is removed, destruct event listeners. 138 | */ 139 | remove() { 140 | const { openOn } = this.data; 141 | this.el.removeEventListener( 142 | openOn, 143 | this.toggleDialogOpen.bind(this) 144 | ); 145 | this.closeIconEl.removeEventListener( 146 | openOn, 147 | this.toggleDialogOpen.bind(this) 148 | ); 149 | }, 150 | /** 151 | * When this component is updated, re-calculate title, body, image, and 152 | * dialog plane to incorporate changes. 153 | */ 154 | update() { 155 | this.generateTitle(); 156 | this.generateBody(); 157 | this.generateImage(); 158 | }, 159 | /** 160 | * Handles opening and closing the dialog plane. 161 | */ 162 | toggleDialogOpen(event) { 163 | // If the close icon is clicked, close the dialog. 164 | if (event.target.getAttribute('id') === `${this.el.getAttribute('id')}--close-icon`) { 165 | this.dialogPlaneEl.setAttribute('visible', false); 166 | this.isOpen = false; 167 | } 168 | 169 | // If the open icon is clicked, and the dialog is active, open the dialog. 170 | if (this.data.active && event.target.getAttribute('id') === this.el.getAttribute('id')) { 171 | this.positionDialogPlane(); 172 | this.dialogPlaneEl.setAttribute('visible', true); 173 | this.isOpen = true; 174 | } 175 | }, 176 | /** 177 | * Generates the open icon. 178 | */ 179 | generateOpenIcon() { 180 | const { 181 | openIconRadius: radius, 182 | openIconColor: color, 183 | openIconImage: src, 184 | openOn 185 | } = this.data; 186 | 187 | this.el.setAttribute('geometry', { 188 | primitive: 'circle', 189 | radius 190 | }); 191 | this.el.setAttribute('material', { 192 | color, 193 | src 194 | }); 195 | 196 | this.el.addEventListener(openOn, this.toggleDialogOpen.bind(this)); 197 | }, 198 | /** 199 | * Generates the close icon. 200 | */ 201 | generateCloseIcon() { 202 | const { 203 | closeIconRadius: radius, 204 | closeIconColor: color, 205 | closeIconImage: src, 206 | dialogBoxWidth: width, 207 | dialogBoxHeight: height, 208 | openOn 209 | } = this.data; 210 | 211 | const closeIcon = document.createElement('a-entity'); 212 | closeIcon.setAttribute('id', `${this.el.getAttribute('id')}--close-icon`); 213 | closeIcon.setAttribute('position', { 214 | x: width / 2, 215 | y: height / 2, 216 | z: 0.01 217 | }); 218 | closeIcon.setAttribute('geometry', { 219 | primitive: 'circle', 220 | radius 221 | }); 222 | closeIcon.setAttribute('material', { 223 | color, 224 | src 225 | }); 226 | 227 | closeIcon.addEventListener(openOn, this.toggleDialogOpen.bind(this)); 228 | 229 | this.closeIconEl = closeIcon; 230 | return closeIcon; 231 | }, 232 | /** 233 | * Generates the title text. 234 | */ 235 | generateTitle() { 236 | const { 237 | title: value, 238 | titleColor: color, 239 | titleFont: font, 240 | titleWrapCount: wrapCount, 241 | dialogBoxWidth: width, 242 | dialogBoxHeight: height, 243 | dialogBoxPadding: padding, 244 | imageHeight 245 | } = this.data; 246 | 247 | const title = this.titleEl || document.createElement('a-entity'); 248 | title.setAttribute('id', `${this.el.getAttribute('id')}--title`); 249 | title.setAttribute('text', { 250 | value: value.substring(0, wrapCount), 251 | color, 252 | font, 253 | wrapCount, 254 | width: width - padding * 2, 255 | baseline: 'top', 256 | anchor: 'left' 257 | }); 258 | 259 | let y = height / 2 - padding; 260 | if (this.hasImage) { 261 | y -= imageHeight / 2; 262 | } 263 | 264 | title.setAttribute('position', { 265 | x: -(width / 2) + padding, 266 | y, 267 | z: 0.01 268 | }); 269 | 270 | this.titleEl = title; 271 | return title; 272 | }, 273 | /** 274 | * Generates the body text entity. 275 | */ 276 | generateBody() { 277 | const { 278 | body: value, 279 | bodyColor: color, 280 | bodyFont: font, 281 | bodyWrapCount: wrapCount, 282 | dialogBoxWidth: width, 283 | dialogBoxHeight: height, 284 | dialogBoxPadding: padding, 285 | imageHeight 286 | } = this.data; 287 | 288 | const body = this.bodyEl || document.createElement('a-entity'); 289 | body.setAttribute('id', `${this.el.getAttribute('id')}--title`); 290 | body.setAttribute('text', { 291 | value, 292 | color, 293 | font, 294 | wrapCount, 295 | width: width - padding * 2, 296 | baseline: 'top', 297 | anchor: 'left' 298 | }); 299 | 300 | let y = height / 2 - padding * 3; 301 | if (this.hasImage) { 302 | y -= imageHeight / 2; 303 | } 304 | 305 | body.setAttribute('position', { 306 | x: -(width / 2) + padding, 307 | y, 308 | z: 0.01 309 | }); 310 | 311 | this.bodyEl = body; 312 | return body; 313 | }, 314 | /** 315 | * Generates the image entity. 316 | */ 317 | generateImage() { 318 | const { 319 | image: src, 320 | imageWidth: width, 321 | imageHeight: height, 322 | dialogBoxHeight 323 | } = this.data; 324 | 325 | if (!src.length) { 326 | return null; 327 | } 328 | 329 | const image = this.imageEl || document.createElement('a-image'); 330 | image.setAttribute('id', `${this.el.getAttribute('id')}--image`); 331 | image.setAttribute('src', src); 332 | image.setAttribute('width', width); 333 | image.setAttribute('height', height); 334 | image.setAttribute('position', { 335 | x: 0, 336 | y: dialogBoxHeight / 2, 337 | z: 0.01 338 | }); 339 | 340 | this.hasImage = true; 341 | this.imageEl = image; 342 | return image; 343 | }, 344 | /** 345 | * Generates the dialog plane. 346 | */ 347 | generateDialogPlane() { 348 | const { 349 | dialogBoxWidth: width, 350 | dialogBoxHeight: height, 351 | dialogBoxPadding: padding, 352 | dialogBoxColor: color 353 | } = this.data; 354 | 355 | const plane = this.dialogPlaneEl || document.createElement('a-entity'); 356 | plane.setAttribute('id', `${this.el.getAttribute('id')}--dialog-plane`); 357 | plane.setAttribute('position', { x: 0, y: 0, z: 0.5 }); 358 | plane.setAttribute('visible', false); 359 | plane.setAttribute('geometry', { 360 | primitive: 'plane', 361 | width: width + padding, 362 | height: height + padding 363 | }); 364 | 365 | const image = this.generateImage(); 366 | if (image) { 367 | plane.appendChild(this.generateImage()); 368 | } 369 | 370 | plane.setAttribute('material', { color }); 371 | plane.appendChild(this.generateCloseIcon()); 372 | plane.appendChild(this.generateTitle()); 373 | plane.appendChild(this.generateBody()); 374 | 375 | this.dialogPlaneEl = plane; 376 | 377 | return plane; 378 | }, 379 | positionDialogPlane() { 380 | if (this.dialogPlaneEl) { 381 | const vector = this.dialogPlaneEl.object3D.parent.worldToLocal( 382 | this.cameraEl.object3D.getWorldPosition() 383 | ); 384 | this.dialogPlaneEl.object3D.lookAt(vector); 385 | } 386 | }, 387 | spawnEntities() { 388 | this.el.appendChild(this.generateDialogPlane()); 389 | } 390 | }); 391 | -------------------------------------------------------------------------------- /dist/aframe-dialog-popup-component.js: -------------------------------------------------------------------------------- 1 | /******/ (function(modules) { // webpackBootstrap 2 | /******/ // The module cache 3 | /******/ var installedModules = {}; 4 | /******/ 5 | /******/ // The require function 6 | /******/ function __webpack_require__(moduleId) { 7 | /******/ 8 | /******/ // Check if module is in cache 9 | /******/ if(installedModules[moduleId]) { 10 | /******/ return installedModules[moduleId].exports; 11 | /******/ } 12 | /******/ // Create a new module (and put it into the cache) 13 | /******/ var module = installedModules[moduleId] = { 14 | /******/ i: moduleId, 15 | /******/ l: false, 16 | /******/ exports: {} 17 | /******/ }; 18 | /******/ 19 | /******/ // Execute the module function 20 | /******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__); 21 | /******/ 22 | /******/ // Flag the module as loaded 23 | /******/ module.l = true; 24 | /******/ 25 | /******/ // Return the exports of the module 26 | /******/ return module.exports; 27 | /******/ } 28 | /******/ 29 | /******/ 30 | /******/ // expose the modules object (__webpack_modules__) 31 | /******/ __webpack_require__.m = modules; 32 | /******/ 33 | /******/ // expose the module cache 34 | /******/ __webpack_require__.c = installedModules; 35 | /******/ 36 | /******/ // identity function for calling harmony imports with the correct context 37 | /******/ __webpack_require__.i = function(value) { return value; }; 38 | /******/ 39 | /******/ // define getter function for harmony exports 40 | /******/ __webpack_require__.d = function(exports, name, getter) { 41 | /******/ if(!__webpack_require__.o(exports, name)) { 42 | /******/ Object.defineProperty(exports, name, { 43 | /******/ configurable: false, 44 | /******/ enumerable: true, 45 | /******/ get: getter 46 | /******/ }); 47 | /******/ } 48 | /******/ }; 49 | /******/ 50 | /******/ // getDefaultExport function for compatibility with non-harmony modules 51 | /******/ __webpack_require__.n = function(module) { 52 | /******/ var getter = module && module.__esModule ? 53 | /******/ function getDefault() { return module['default']; } : 54 | /******/ function getModuleExports() { return module; }; 55 | /******/ __webpack_require__.d(getter, 'a', getter); 56 | /******/ return getter; 57 | /******/ }; 58 | /******/ 59 | /******/ // Object.prototype.hasOwnProperty.call 60 | /******/ __webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); }; 61 | /******/ 62 | /******/ // __webpack_public_path__ 63 | /******/ __webpack_require__.p = ""; 64 | /******/ 65 | /******/ // Load entry module and return exports 66 | /******/ return __webpack_require__(__webpack_require__.s = 0); 67 | /******/ }) 68 | /************************************************************************/ 69 | /******/ ([ 70 | /* 0 */ 71 | /***/ (function(module, exports, __webpack_require__) { 72 | 73 | "use strict"; 74 | 75 | 76 | /** 77 | * @file index.js 78 | * Contains code that registers a dialog popup component. 79 | */ 80 | 81 | /* global AFRAME */ 82 | if (typeof AFRAME === 'undefined') { 83 | throw new Error('Component attempted to register before AFRAME was available.'); 84 | } 85 | /** 86 | * Dialog Popup component for A-Frame. 87 | */ 88 | 89 | 90 | AFRAME.registerComponent('dialog-popup', { 91 | schema: { 92 | title: { 93 | type: 'string', 94 | default: 'New Dialog' 95 | }, 96 | titleColor: { 97 | type: 'string', 98 | default: 'black' 99 | }, 100 | titleFont: { 101 | type: 'string', 102 | default: 'mozillavr' 103 | }, 104 | titleWrapCount: { 105 | type: 'number', 106 | default: 24 107 | }, 108 | body: { 109 | type: 'string', 110 | default: 'This dialog has no body yet.' 111 | }, 112 | bodyColor: { 113 | type: 'string', 114 | default: 'black' 115 | }, 116 | bodyFont: { 117 | type: 'string', 118 | default: 'mozillavr' 119 | }, 120 | bodyWrapCount: { 121 | type: 'number', 122 | default: 30 123 | }, 124 | openOn: { 125 | type: 'string', 126 | default: 'click' 127 | }, 128 | active: { 129 | type: 'boolean', 130 | default: true 131 | }, 132 | openIconImage: { 133 | type: 'asset', 134 | default: '' 135 | }, 136 | openIconRadius: { 137 | type: 'number', 138 | default: 0.3 139 | }, 140 | openIconColor: { 141 | type: 'string', 142 | default: 'white' 143 | }, 144 | closeIconImage: { 145 | type: 'asset', 146 | default: '' 147 | }, 148 | closeIconRadius: { 149 | type: 'number', 150 | default: 0.3 151 | }, 152 | closeIconColor: { 153 | type: 'string', 154 | default: 'white' 155 | }, 156 | image: { 157 | type: 'string', 158 | default: '' 159 | }, 160 | imageWidth: { 161 | type: 'number', 162 | default: 2 163 | }, 164 | imageHeight: { 165 | type: 'number', 166 | default: 2 167 | }, 168 | dialogBoxWidth: { 169 | type: 'number', 170 | default: 4 171 | }, 172 | dialogBoxHeight: { 173 | type: 'number', 174 | default: 4 175 | }, 176 | dialogBoxColor: { 177 | type: 'string', 178 | default: 'white' 179 | }, 180 | dialogBoxPadding: { 181 | type: 'number', 182 | default: 0.2 183 | } 184 | }, 185 | multiple: true, 186 | dialogPlaneEl: null, 187 | openIconEl: null, 188 | closeIconEl: null, 189 | titleEl: null, 190 | bodyEl: null, 191 | imageEl: null, 192 | hasImage: false, 193 | 194 | /** 195 | * Spawns the entities required to support this dialog. 196 | */ 197 | init: function init() { 198 | this.cameraEl = document.querySelector('[camera]'); 199 | this.spawnEntities(); 200 | this.el.emit('loaded'); 201 | }, 202 | 203 | /** 204 | * If the component is open, ensure it always faces the camera. 205 | */ 206 | tick: function tick() { 207 | if (this.isOpen) { 208 | this.positionDialogPlane(); 209 | } 210 | }, 211 | 212 | /** 213 | * When this component is removed, destruct event listeners. 214 | */ 215 | remove: function remove() { 216 | var openOn = this.data.openOn; 217 | this.openIconEl.removeEventListener(openOn, this.toggleDialogOpen.bind(this)); 218 | this.closeIconEl.removeEventListener(openOn, this.toggleDialogOpen.bind(this)); 219 | }, 220 | 221 | /** 222 | * When this component is updated, re-calculate title, body, image, and 223 | * dialog plane to incorporate changes. 224 | */ 225 | update: function update() { 226 | this.generateTitle(); 227 | this.generateBody(); 228 | this.generateImage(); 229 | }, 230 | 231 | /** 232 | * Handles opening and closing the dialog plane. 233 | */ 234 | toggleDialogOpen: function toggleDialogOpen() { 235 | this.isOpen = !this.isOpen; 236 | 237 | if (this.data.active && this.dialogPlaneEl) { 238 | this.positionDialogPlane(); 239 | this.dialogPlaneEl.setAttribute('visible', this.isOpen); 240 | this.openIconEl.setAttribute('visible', !this.isOpen); 241 | } 242 | }, 243 | 244 | /** 245 | * Generates the open icon. 246 | */ 247 | generateOpenIcon: function generateOpenIcon() { 248 | var _this$data = this.data, 249 | radius = _this$data.openIconRadius, 250 | color = _this$data.openIconColor, 251 | src = _this$data.openIconImage, 252 | openOn = _this$data.openOn; 253 | var openIcon = document.createElement('a-entity'); 254 | openIcon.setAttribute('id', "".concat(this.el.getAttribute('id'), "--open-icon")); 255 | openIcon.setAttribute('position', Object.assign({}, this.el.getAttribute('position'))); 256 | openIcon.setAttribute('geometry', { 257 | primitive: 'circle', 258 | radius: radius 259 | }); 260 | openIcon.setAttribute('material', { 261 | color: color, 262 | src: src 263 | }); // If the parent entity has aa look-at component attached, apply the look-at 264 | // component to the openIcon. 265 | 266 | var lookAt = this.el.getAttribute('look-at'); 267 | 268 | if (lookAt) { 269 | openIcon.setAttribute('look-at', lookAt); 270 | } 271 | 272 | openIcon.addEventListener(openOn, this.toggleDialogOpen.bind(this)); 273 | this.openIconEl = openIcon; 274 | return openIcon; 275 | }, 276 | 277 | /** 278 | * Generates the close icon. 279 | */ 280 | generateCloseIcon: function generateCloseIcon() { 281 | var _this$data2 = this.data, 282 | radius = _this$data2.closeIconRadius, 283 | color = _this$data2.closeIconColor, 284 | src = _this$data2.closeIconImage, 285 | width = _this$data2.dialogBoxWidth, 286 | height = _this$data2.dialogBoxHeight, 287 | openOn = _this$data2.openOn; 288 | var closeIcon = document.createElement('a-entity'); 289 | closeIcon.setAttribute('id', "".concat(this.el.getAttribute('id'), "--close-icon")); 290 | closeIcon.setAttribute('position', { 291 | x: width / 2, 292 | y: height / 2, 293 | z: 0.01 294 | }); 295 | closeIcon.setAttribute('geometry', { 296 | primitive: 'circle', 297 | radius: radius 298 | }); 299 | closeIcon.setAttribute('material', { 300 | color: color, 301 | src: src 302 | }); 303 | closeIcon.addEventListener(openOn, this.toggleDialogOpen.bind(this)); 304 | this.closeIconEl = closeIcon; 305 | return closeIcon; 306 | }, 307 | 308 | /** 309 | * Generates the title text. 310 | */ 311 | generateTitle: function generateTitle() { 312 | var _this$data3 = this.data, 313 | value = _this$data3.title, 314 | color = _this$data3.titleColor, 315 | font = _this$data3.titleFont, 316 | wrapCount = _this$data3.titleWrapCount, 317 | width = _this$data3.dialogBoxWidth, 318 | height = _this$data3.dialogBoxHeight, 319 | padding = _this$data3.dialogBoxPadding, 320 | imageHeight = _this$data3.imageHeight; 321 | var title = this.titleEl || document.createElement('a-entity'); 322 | title.setAttribute('id', "".concat(this.el.getAttribute('id'), "--title")); 323 | title.setAttribute('text', { 324 | value: value.substring(0, wrapCount), 325 | color: color, 326 | font: font, 327 | wrapCount: wrapCount, 328 | width: width - padding * 2, 329 | baseline: 'top', 330 | anchor: 'left' 331 | }); 332 | var y = height / 2 - padding; 333 | 334 | if (this.hasImage) { 335 | y -= imageHeight / 2; 336 | } 337 | 338 | title.setAttribute('position', { 339 | x: -(width / 2) + padding, 340 | y: y, 341 | z: 0.01 342 | }); 343 | this.titleEl = title; 344 | return title; 345 | }, 346 | 347 | /** 348 | * Generates the body text entity. 349 | */ 350 | generateBody: function generateBody() { 351 | var _this$data4 = this.data, 352 | value = _this$data4.body, 353 | color = _this$data4.bodyColor, 354 | font = _this$data4.bodyFont, 355 | wrapCount = _this$data4.bodyWrapCount, 356 | width = _this$data4.dialogBoxWidth, 357 | height = _this$data4.dialogBoxHeight, 358 | padding = _this$data4.dialogBoxPadding, 359 | imageHeight = _this$data4.imageHeight; 360 | var body = this.bodyEl || document.createElement('a-entity'); 361 | body.setAttribute('id', "".concat(this.el.getAttribute('id'), "--title")); 362 | body.setAttribute('text', { 363 | value: value, 364 | color: color, 365 | font: font, 366 | wrapCount: wrapCount, 367 | width: width - padding * 2, 368 | baseline: 'top', 369 | anchor: 'left' 370 | }); 371 | var y = height / 2 - padding * 3; 372 | 373 | if (this.hasImage) { 374 | y -= imageHeight / 2; 375 | } 376 | 377 | body.setAttribute('position', { 378 | x: -(width / 2) + padding, 379 | y: y, 380 | z: 0.01 381 | }); 382 | this.bodyEl = body; 383 | return body; 384 | }, 385 | 386 | /** 387 | * Generates the image entity. 388 | */ 389 | generateImage: function generateImage() { 390 | var _this$data5 = this.data, 391 | src = _this$data5.image, 392 | width = _this$data5.imageWidth, 393 | height = _this$data5.imageHeight, 394 | dialogBoxHeight = _this$data5.dialogBoxHeight; 395 | 396 | if (!src.length) { 397 | return null; 398 | } 399 | 400 | var image = this.imageEl || document.createElement('a-image'); 401 | image.setAttribute('id', "".concat(this.el.getAttribute('id'), "--image")); 402 | image.setAttribute('src', src); 403 | image.setAttribute('width', width); 404 | image.setAttribute('height', height); 405 | image.setAttribute('position', { 406 | x: 0, 407 | y: dialogBoxHeight / 2, 408 | z: 0.01 409 | }); 410 | this.hasImage = true; 411 | this.imageEl = image; 412 | return image; 413 | }, 414 | 415 | /** 416 | * Generates the dialog plane. 417 | */ 418 | generateDialogPlane: function generateDialogPlane() { 419 | var _this$data6 = this.data, 420 | width = _this$data6.dialogBoxWidth, 421 | height = _this$data6.dialogBoxHeight, 422 | padding = _this$data6.dialogBoxPadding, 423 | color = _this$data6.dialogBoxColor; 424 | var plane = this.dialogPlaneEl || document.createElement('a-entity'); 425 | plane.setAttribute('id', "".concat(this.el.getAttribute('id'), "--dialog-plane")); 426 | plane.setAttribute('position', Object.assign({}, this.el.getAttribute('position'))); 427 | plane.setAttribute('visible', false); 428 | plane.setAttribute('geometry', { 429 | primitive: 'plane', 430 | width: width + padding, 431 | height: height + padding 432 | }); 433 | var image = this.generateImage(); 434 | 435 | if (image) { 436 | plane.appendChild(this.generateImage()); 437 | } 438 | 439 | plane.setAttribute('material', { 440 | color: color 441 | }); 442 | plane.appendChild(this.generateCloseIcon()); 443 | plane.appendChild(this.generateTitle()); 444 | plane.appendChild(this.generateBody()); 445 | this.dialogPlaneEl = plane; 446 | return plane; 447 | }, 448 | positionDialogPlane: function positionDialogPlane() { 449 | if (this.dialogPlaneEl) { 450 | var vector = this.dialogPlaneEl.object3D.parent.worldToLocal(this.cameraEl.object3D.getWorldPosition()); 451 | this.dialogPlaneEl.object3D.lookAt(vector); 452 | } 453 | }, 454 | spawnEntities: function spawnEntities() { 455 | this.el.appendChild(this.generateOpenIcon()); 456 | this.el.appendChild(this.generateDialogPlane()); 457 | this.el.removeAttribute('position'); 458 | } 459 | }); 460 | 461 | /***/ }) 462 | /******/ ]); -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------