three-point-text-helper - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #react #llm #go #android #deep-learning #windows #cli #pytorch #security #ios #mcp #openai

three-point-text-helper

(★ 77)

"Point Text" Helper for three JS

파일 탐색기

최종 버전 다운로드 (.zip)

- - atlas-core.d.ts
  - atlas-data.js
  - atlas-utils.d.ts
  - atlas.d.ts
  - index.d.ts
  - index.js
- PointTextHelper.three.js
- vanilla-effect-composer.jpg
- vanilla-stress-2.jpg
- vanilla-stress.jpg
- vanilla-triangle.jpg
- vertices-knot.jpg
- vertices-stress-2.jpg
- vertices-stress.jpg
- vertices-stress.psd
- vertices.jpg
- - atlas-generator.ts
  - index.ts
  - utils.ts
- dev.ts
- - get_shaders.ts
  - index.ts
  - point.frag
  - point.vert
  - PointTextHelperMaterial.ts
- - point.frag
  - point.vert
- atlas-core.ts
- atlas-data.d.ts
- atlas-data.js
- atlas-utils.ts
- atlas.png
- atlas.ts
- global.d.ts
- index.ts
- - index.html
- - README.md
- - README.md
  - tsconfig.json
  - webpack.config.js
- README.md
.gitignore
.npmignore
NOTE.md
package-lock.json
package.json
README.md
rollup.config.mjs
tsconfig.json
VERSIONS.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/jniac/three-point-text-helper

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd three-point-text-helper

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm i @jniac/three-point-text-helper

이 명령어를 터미널에 그대로 입력해 실행하세요.

npm run dev

개발/실행 서버를 켭니다.

npm run examples-webpack

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Point Text Helper
"Point Text" Helper for ThreeJS

Thousand of tiny texts (labels) in one draw call.

<a href="https://jniac.github.io/three-point-text-helper/tests/examples-vanilla/stress/">
<p align="center">
  <img src="screenshots/vanilla-stress-2.jpg">
<p>
<p align="center">
  Stress test with "vanilla" js (module).
  31 436 texts.
</p>
</a>

## Demos
- [triangle](https://jniac.github.io/three-point-text-helper/tests/examples-vanilla/triangle/)
- [stress](https://jniac.github.io/three-point-text-helper/tests/examples-vanilla/stress/)
- [effect-composer](https://jniac.github.io/three-point-text-helper/tests/examples-vanilla/effect-composer/)
- [blending](https://jniac.github.io/three-point-text-helper/tests/examples-vanilla/blending/)

## Install

NPM:
```
npm i @jniac/three-point-text-helper
```

Or plain JS, using github pages hosting:
```javascript
import { PointTextHelper } from 'https://jniac.github.io/three-point-text-helper/dist/PointTextHelper.three.js'
```

## Usage

```javascript
import * as THREE from 'three'
import { PointTextHelper } from '@jniac/three-point-text-helper'

//- snip -//

const pth = new PointTextHelper({ charMax:10 })
mesh.add(pth)

// display some text
pth.display({ text:'hello!',  color:'cyan' })
pth.display({ text:'top',     color:'cyan', size:.5, position:new THREE.Vector3(0, 1, 0) })
pth.display({ text:'bottom',  color:'cyan', size:.5, position:{ x:0, y:-1, z:0 } })

// or, from a mesh...
const mesh = new THREE.Mesh(
  new THREE.IcosahedronGeometry(1, 0),
  new THREE.MeshBasicMaterial({ color:'cyan', wireframe:true }),
)
scene.add(mesh)

// ...display an array of vertices:
pth.displayVertices(mesh.geometry.vertices)

// ...or a "position" buffer:
// (be aware that in buffer geometries, vertices are most often duplicated)
const geometry = new THREE.SphereBufferGeometry(1.4, 12, 24)
pth.displayVertices(geometry.getAttribute('position').array, {
  color: '#fc9',
  size: .3,
  format: index => `#${index}`,
})
```

## "dev" mode & examples
from a local repository, 2 process:
- run the library itself + static server
```shell
npm run dev
```
It will watch over any changes into the src folder, and re-build if any.
http://localhost:8000

For the "vanilla" js examples, this is enough:
http://localhost:8000/tests/examples-vanilla/triangle/

- but for the webpack examples, one may start the webpack service:
```shell
npm run examples-webpack
```

## Build
```shell
npx rollup -c
```