Browse Source

docs: added cone

astanusic 2 years ago
parent
commit
bc185208a8
3 changed files with 17 additions and 0 deletions
  1. 1 0
      docs/.vitepress/config.ts
  2. 16 0
      docs/cientos/shapes/cone.md
  3. BIN
      docs/public/cientos/cone.png

+ 1 - 0
docs/.vitepress/config.ts

@@ -89,6 +89,7 @@ export default defineConfig({
             items: [
               { text: 'Box', link: '/cientos/shapes/box' },
               { text: 'Circle', link: '/cientos/shapes/circle' },
+              { text: 'Cone', link: '/cientos/shapes/cone' },
               { text: 'Plane', link: '/cientos/shapes/plane' },
               { text: 'Sphere', link: '/cientos/shapes/sphere' },
               { text: 'Torus', link: '/cientos/shapes/torus' },

+ 16 - 0
docs/cientos/shapes/cone.md

@@ -0,0 +1,16 @@
+# Cone
+
+![](/cientos/cone.png)
+
+The `cientos` package provides a `<Cone />` component that serves as a short-cut for a `ConeGeometry` and a `MeshBasicMaterial` with a `Mesh` object.
+
+## Usage
+
+```html
+<Cone :args="[1, 1, 8]" color="orange" />
+
+// Cone with a custom material transformations
+<Cone ref="coneRef" :args="[1, 1, 8]" :position="[0, 4, 0]">
+  <TresMeshToonMaterial color="orange" />
+</Cone>
+```

BIN
docs/public/cientos/cone.png