aframe-cubemap-component-c3d
v0.1.6
Published
Cubemap component for A-Frame.
Downloads
2
Maintainers
milkman90Readme
aframe-cubemap-component
An A-Frame component for creating a skybox from a cubemap.
Properties
| Property | Description | Default Value | |:------------:|:---------------------------------------:|:-------------:| | folder | Path to the folder holding your cubemap | none | | edgeLength | Controls the dimensions of the skybox | 5000 | | ext | The image extension | jpg | | transparent | Enable transparency for png | false |
By default, the height, width, and depth of the skybox are set to 5000. In other words, the dimensions of the skybox are 5000x5000x5000.
Usage
Attach the component to an entity using the path to the folder holding your cubemap as the attribute.
<a-entity cubemap="folder: /assets/Yokohama3/"></a-entity>Inside the folder, the component assumes the following naming scheme:
var urls = [
'posx.jpg', 'negx.jpg',
'posy.jpg', 'negy.jpg',
'posz.jpg', 'negz.jpg'
];Note: if your images are not jpgs, you must use the ext component property to specify the extension (e.g. cubemap="ext: png"). To enable transparency on pngs, set transparent: true.
This is the scheme used by Three.js's CubeTexture. If your cubemap images do not follow this scheme, you will need to rename them (or fork this repo and alter the above in index.js).
The Yokohama cubemap texture is the work of Emil Persson, aka Humus. Check out his website, it is a good source for cubemap textures. IIRC, I got the milky way texture from uschi0815 on the Kerbal Space Program forum.
To modify the size of the resulting skybox, use the edgeLength property.
<a-entity cubemap="folder: /assets/Yokohama3/; edgeLength: 1000"></a-entity>Browser Installation
Install and use by directly including the browser files:
<head>
<title>My A-Frame Scene</title>
<script src="https://aframe.io/releases/0.6.0/aframe.min.js"></script>
<script src="https://unpkg.com/[email protected]/dist/aframe-cubemap-component.min.js"></script>
</head>
<body>
<a-scene>
<a-entity cubemap="folder: /assets/Yokohama3/"></a-entity>
</a-scene>
</body>