fix: rename "render" to "generate" in outlines (#41)

pmndrs · Sep 10, 2023 · 60726e1 · 60726e1
1 parent 689b7b7
commit 60726e1
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git a/.storybook/stories/Outlines.stories.ts b/.storybook/stories/Outlines.stories.ts
@@ -14,7 +14,7 @@ let gui: GUI
 let allOutlines: OutlinesType[] = []
 
 const outlinesParams = {
-  color: '#ffff00',
+  color: '#ffff00' as THREE.ColorRepresentation,
   thickness: 0.1,
 }
 
@@ -42,7 +42,7 @@ const setupTourMesh = () => {
   })
   torusMesh.position.set(0, 5, 0)
   torusMesh.add(outlines.group)
-  outlines.render()
+  outlines.generate()
   allOutlines.push(outlines)
   return torusMesh
 }
@@ -57,7 +57,7 @@ const setupBox = () => {
   allOutlines.push(outlines)
   boxMesh.add(outlines.group)
   boxMesh.castShadow = true
-  outlines.render()
+  outlines.generate()
   return boxMesh
 }
 
@@ -113,7 +113,7 @@ const addOutlineGui = () => {
   const params = Object.assign({}, outlinesParams)
   const folder = gui.addFolder('O U T L I N E S')
   folder.open()
-  folder.addColor(params, 'color').onChange((color: string) => {
+  folder.addColor(params, 'color').onChange((color: THREE.ColorRepresentation) => {
     allOutlines.forEach((outline) => {
       outline.updateProps({ color: new THREE.Color(color) })
     })

diff --git a/README.md b/README.md
@@ -451,8 +451,8 @@ const outlines = Outlines()
 const mesh = new THREE.Mesh(geometry, material)
 mesh.add(outlines.group)
 
-// must call render() if added
-outlines.render()
+// must call generate() to create the outline mesh
+outlines.generate()
 
 scene.add(mesh)
 ```
@@ -463,7 +463,7 @@ Outlines function returns the following
 export type OutlinesType = {
   group: THREE.Group
   updateProps: (props: Partial<OutlinesProps>) => void
-  render: () => void
+  generate: () => void
 }
 ```
 

diff --git a/src/core/Outlines.ts b/src/core/Outlines.ts
@@ -19,9 +19,9 @@ export type OutlinesType = {
   group: THREE.Group
   updateProps: (props: Partial<OutlinesProps>) => void
   /**
-   * **Note**: Call this method after adding group to mesh.
+   * **Note**: Call this method to generate the outline mesh
    */
-  render: () => void
+  generate: () => void
 }
 
 const OutlinesMaterial = shaderMaterial(
@@ -120,7 +120,7 @@ export function Outlines({
       }
       updateProps(props)
     },
-    render() {
+    generate() {
       updateMesh(shapeProps.angle)
       updateProps(shapeProps)
     },