Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
r3f-cutter committed Apr 14, 2023
1 parent 29f4263 commit 125cdc2
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<a href="https://codesandbox.io/s/r3f-cutter-box-example-q3uip1" target="_blank" rel="noopener noreferrer"><img src="doc/images/gifted-sound-q3uip1.png" width="128"/></a>
<a href="https://codesandbox.io/s/torus-and-box-single-cutplane-y6hl0d" target="_blank" rel="noopener noreferrer"><img src="doc/images/torus-and-box-single-cutplane-y6hl0d.png" width="128"></a>
<a href="https://codesandbox.io/s/rotating-box-example-sculn6" target="_blank" rel="noopener noreferrer"><img src="doc/images/gifted-sound-q3uip1.png" width="128"/></a>
<a href="https://codesandbox.io/s/r3f-cutter-box-example-q3uip1"><img src="doc/images/gifted-sound-q3uip1.png" width="128"/></a>
<a href="https://codesandbox.io/s/torus-and-box-single-cutplane-y6hl0d"><img src="doc/images/torus-and-box-single-cutplane-y6hl0d.png" width="128"></a>
<a href="https://codesandbox.io/s/rotating-box-example-sculn6"><img src="doc/images/gifted-sound-q3uip1.png" width="128"/></a>

# Overview
This package provides a `<Cutter>` component based on [react-three-fiber](https://github.com/pmndrs/react-three-fiber) that can clip and cap [Mesh](https://threejs.org/docs/index.html?q=Mesh#api/en/objects/Mesh)es in an arbitrary scene in a manner similar to [this](https://codesandbox.io/s/r3f-torus-capped-9f5kyb) example. A `<Cutter>` will clip and cap all descendant meshes using a [Plane](https://threejs.org/docs/index.html?q=Plane#api/en/math/Plane) specified via its `plane` prop. This gives the meshes the appearance of filled solids instead of hollow objects with just surfaces. The caps at the clipping plane position use the same material as the original meshes. This means that each mesh will get a cap that looks like its own material. See [Limitations/Bugs](#limitationbugs) section below for some issues with the current implementation that are expected to be fixed in the future.
Expand Down

0 comments on commit 125cdc2

Please sign in to comment.