https://github.com/vanruesc/hermite-data-helper

A Hermite data visualization tool for rabbit-hole and three.
https://github.com/vanruesc/hermite-data-helper

edges geometry grid-point helper hermite normals rabbit-hole threejs

Last synced: about 2 months ago
JSON representation

A Hermite data visualization tool for rabbit-hole and three.

• Host: GitHub
• URL: https://github.com/vanruesc/hermite-data-helper
• Owner: vanruesc
• License: zlib
• Created: 2017-12-06T21:31:55.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2020-08-10T23:19:37.000Z (over 4 years ago)
• Last Synced: 2024-11-15T21:42:47.237Z (2 months ago)
• Topics: edges, geometry, grid-point, helper, hermite, normals, rabbit-hole, threejs
• Language: JavaScript
• Homepage:
• Size: 345 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Hermite Data Helper

[![Build status](https://travis-ci.org/vanruesc/hermite-data-helper.svg?branch=master)](https://travis-ci.org/vanruesc/hermite-data-helper) 

[![npm version](https://badgen.net/npm/v/hermite-data-helper?color=green)](https://www.npmjs.com/package/hermite-data-helper)

[![Peer dependencies](https://david-dm.org/vanruesc/hermite-data-helper/peer-status.svg)](https://david-dm.org/vanruesc/hermite-data-helper?type=peer)

A Hermite data visualization tool for [rabbit-hole](https://github.com/vanruesc/rabbit-hole) and [three.js](https://threejs.org/).

*[API Reference](https://vanruesc.github.io/hermite-data-helper)*

## Installation

This library requires the peer dependency [three](https://github.com/mrdoob/three.js/).

```sh

npm install three hermite-data-helper

``` 

## Usage

```javascript

import { Scene, Vector3 } from "three";

import { HermiteData } from "rabbit-hole";

import { HermiteDataHelper } from "hermite-data-helper";

const scene = new Scene();

const data = new HermiteData();

const cellPosition = new Vector3();

const cellSize = 1;

const hermiteDataHelper = new HermiteDataHelper(cellPosition, cellSize, data);

// Render the helper.

scene.add(hermiteDataHelper);

// Access special geometry subgroups.

console.log(hermiteDataHelper.gridPoints);

console.log(hermiteDataHelper.edges);

console.log(hermiteDataHelper.normals);

// Use a different cell size, position and data set.

hermiteDataHelper.set(otherPosition, otherSize, otherData);

try {

	// Destroy the helper geometry and rebuild grid points and edges.

	hermiteDataHelper.update(true, true);

} catch(e) {

	// The provided position, size or data is invalid.

}

// Destroy the helper geometry.

hermiteDataHelper.dispose();

```

A full example can be found [here](https://vanruesc.github.io/rabbit-hole/public/demo/#svo).

## Contributing

Maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.