Giter Club home page Giter Club logo

aframe-area-light-component's Introduction

aframe-area-light-component

Version License

Add Area Lights to an A-Frame entity. Uses THREE.RectAreaLight at the core.

WARNING: Area Lights are highly experimental and performance intensive at the moment. Please use sparingly

Example of Area Light

For A-Frame

Examples

API

Property Description Default Value
intensity intensity of the light output 1.0
color color of the light output (and helper if enabled) 1.0
width width of the light output 2.0
height height of the light output 2.0
showHelper Show the RectAreaLightHelper. Useful for positioning lights in the Inspector, or as a quick panel light (Note that the helper is single sided) true
helperColor Given showHelper is enabled, set a custom color for it here undefined

Installation

Browser

Install and use by directly including the browser files:

<head>
  <title>My A-Frame Scene</title>
  <script src="https://aframe.io/releases/0.6.1/aframe.min.js"></script>
  <script src="https://unpkg.com/aframe-area-light-component/dist/aframe-area-light-component.min.js"></script>
</head>

<body>
  <a-scene>
    <a-entity area-light="intensity:4; width:1; height:1; color: #FFFFFF;"></a-entity>
  </a-scene>
</body>

npm

Install via npm:

npm install aframe-area-light-component

Then require and use.

require('aframe');
require('aframe-area-light-component');

Recommended enhancements

  • Combine with A-Frame Effects post-processing effects like Bloom and showHelper:true for a neat glow effect

TODO

  • Add tests :)
  • Performance fixes
  • Enable a simple plane rather than a helper (?)

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.