瀏覽代碼

docs: added ring

astanusic 2 年之前
父節點
當前提交
80d49e2c0b
共有 3 個文件被更改,包括 19 次插入0 次删除
  1. 1 0
      docs/.vitepress/config.ts
  2. 18 0
      docs/cientos/shapes/ring.md
  3. 二進制
      docs/public/cientos/ring.png

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

@@ -91,6 +91,7 @@ export default defineConfig({
               { text: 'Circle', link: '/cientos/shapes/circle' },
               { text: 'Cone', link: '/cientos/shapes/cone' },
               { text: 'Plane', link: '/cientos/shapes/plane' },
+              { text: 'Ring', link: '/cientos/shapes/ring' },
               { text: 'Sphere', link: '/cientos/shapes/sphere' },
               { text: 'Torus', link: '/cientos/shapes/torus' },
               { text: 'TorusKnot', link: '/cientos/shapes/torus-knot' },

+ 18 - 0
docs/cientos/shapes/ring.md

@@ -0,0 +1,18 @@
+# Ring
+
+![](/cientos/ring.png)
+
+The `cientos` package provides a `<Ring />` component that serves as a short-cut for a `RingGeometry` and a `MeshBasicMaterial` with a `Mesh` object.
+
+## Usage
+
+```html
+<Ring :args="[0.5, 1, 32]" color="purple" />
+
+// Ring with a custom material transformations
+<Ring ref="ringRef" :args="[0.5, 1, 32]" :position="[2, 4, 0]">
+  <TresMeshToonMaterial color="purple" />
+</Ring>
+```
+
+

二進制
docs/public/cientos/ring.png