aframe-geometry-merger-component
v2.0.1
Published
An A-Frame component to merge geometries to reduce draw calls.
Downloads
299
Readme
aframe-geometry-merger-component
An A-Frame component to merge geometries to reduce draw calls.
For A-Frame.
This component is attached to a parent and will merge any meshes found in the
descendants. A-Frame transforms placed on entities will be preserved. The
merged geometry will be set on the parent entity's mesh
(el.getObject3D('mesh')).
Useful if using vertex or face coloring as individual geometries' colors can
still be manipulated individually since this component keeps a faceIndex and
vertexIndex.
Source code for interactive merged geometries
API
| Property | Description | Default Value |
| -------- | ----------- | ------------- |
| preserveOriginal | Whether to remove the now-merged child goemetry or keep in scene graph. It can be useful to keep the original child entities' geometries and set their material="visible: false" so that we can still interact with them with colliders and raycasters. | false |
Members
| Member | Description | |-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| | vertexIndex | Map of child A-Frame entitites Object3D UUIDs to array of vertex indices indicating which vertices in the merged geometries belong to the former child geometry.Each array consists of two values, indicating the start & end index for the vertices associated wit |
Methods
| Method | Description | | --------------------- | ------------------------------------------------------------ | | getColor(uuid, color) | Get the color of the 1st vertex of the object with this UUID that was incorporated into the merged geometry. The color parameter should contain a THREE.Color object into which the color can be written. | | setColor(uuid, color) | Set all the vertices of the object with this UUID to the specified color. The supplied color can be in any format supported by THREE.Color.set(), i.e. a THREE.Color, a hex string or a CSS-style string. |
Utility Functions
Including this component also makes the following generic utility functions available:
THREE.BufferGeometryUtils - See theTHREE documentation for details
AFRAME.utils.setBufferGeometryColor(geometry, color, start, end) - this sets the vertices of a buffer geometry to a specified color (a THREE.Color, a hex string or a CSS-style string). Optionally a start & end can be provided, to indicate the vertex index at which to start and end the coloring.
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.4.1/aframe.min.js"></script>
<script src="https://unpkg.com/aframe-geometry-merger-component/dist/aframe-geometry-merger-component.min.js"></script>
</head>
<body>
<a-scene>
<a-entity geometry-merger="preserveOriginal: false" material="color: #AAA">
<a-entity geometry="primitive: box; buffer: false" position="-1 0.5 -2"></a-entity>
<a-entity geometry="primitive: sphere; buffer: false" position="0 0.5 -2"></a-entity>
<a-entity geometry="primitive: cylinder; buffer: false" position="1 0.5 -2" scale="0.5 0.5 05"></a-entity>
</a-entity>
</a-scene>
</body>npm
Install via npm:
npm install aframe-geometry-merger-componentThen require and use.
require('aframe');
require('aframe-geometry-merger-component');