aframe-atlas-uvs-component
v3.0.0
Published
An A-Frame component to set UVs onto a plane geometry given a gridded texture atlas.
Downloads
163
Readme
aframe-atlas-uvs-component
An A-Frame component to set UVs onto a plane geometry given a gridded texture atlas.
See examples here: https://supermedium.github.io/superframe/components/atlas-uvs/
Version 3.0 supports buffer geometries for A-Frame 1.2 and greater. (Use version 2.1 of this component for A-Frame 1.1 and earlier)
API
| Property | Description | Default Value |
| -------- | ----------- | ------------- |
| column | Column to select from atlas, 1-indexed, where 1 is the left-most column. | 1 |
| row | Row to select from atlas, 1-indexed, where 1 is the bottom-most row. | 1 |
| totalColumns | Total number of columns to divide the atlas. | 1 |
| totalRows | Total number of rows to divide the atlas. | 1 |
Installation
Browser
Install and use by directly including the browser files:
<head>
<title>My A-Frame Scene</title>
<script src="https://aframe.io/releases/1.2.0/aframe.min.js"></script>
<script src="https://unpkg.com/[email protected]/dist/aframe-atlas-uvs-component.min.js"></script>
</head>
<body>
<a-scene>
<a-mixin id="myAtlas" atlas-uvs="totalRows: 4; totalColumns: 4" material="src: myAtlas.png" geometry="primitive: plane; buffer: false; skipCache: true"></a-mixin>
<a-entity mixin="myAtlas" atlas-uvs="column: 1; row: 1"></a-entity>
<a-entity mixin="myAtlas" atlas-uvs="column: 3; row: 2"></a-entity>
<a-entity mixin="myAtlas" atlas-uvs="column: 2; row: 4"></a-entity>
</a-scene>
</body>For A-Frame versions 1.1 and earlier:
<script src="https://unpkg.com/[email protected]/dist/aframe-atlas-uvs-component.min.js"></script>npm
Install via npm:
npm install aframe-atlas-uvs-componentThen require and use.
require('aframe');
require('aframe-atlas-uvs-component');