Web3D/trois
1
0
Fork 0
mirror of https://github.com/troisjs/trois.git synced 2024-11-24 04:12:02 +08:00
Code Issues Projects Releases Wiki Activity

remove extra docs

Browse Source
This commit is contained in:
Sander Moolin 2021-03-26 13:37:53 -04:00
parent c4679c6d1a
commit 6d4c2fe849
1 changed files with 0 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
src/core/README.md
View File

@ -1,48 +0,0 @@
## TODO
- [X] Document raycaster component
- [X] Document new events/props on Object3D
- [X] Click events on Raycaster
- [X] Click events on Object3D
## Changelog
### Raycaster component
See [here](https://troisjs-instancedcolors.netlify.app/) for an example ([source](https://github.com/SaFrMo/trois-examples/blob/instanced-colors-standalone-demo/src/components/InstancedColors/InstancedColors.vue)).
```html
<Camera>
<!-- if the Raycaster is a child of a camera, use that camera as the ray origin -->
<Raycaster
:onPointerOver="callback that accepts an array of all new intersections, like onMouseEnter"
:onPointerLeave="callback that accepts an array of all newly-ended intersections, like onMouseLeave"
:onPointerOver="callback that accepts array of all current intersections"
:onClick="callback that accepts array of currently intersected objects"
:onBeforeRender="callback that fires every frame - optional, accepts the created raycaster. setting this property assumes the user is implementing all raycaster functionality and nullifies all other props and built-in functionality."
:scene="THREE scene - optional, defaults to current scene"
:camera="camera - optional, defaults to parent camera"
:intersects="array of objects to check for intersections - optional, casts against all scene children by default"
/>
</Camera>
```
### Object3D additions
See [here](https://troisjs-pointer-tester-demo.netlify.app/) for an example ([source](https://github.com/SaFrMo/trois-examples/blob/pointer-tester-demo/src/components/PointerTester.vue)). New Object3D props (all optional):
* `onPointerEnter`: Function, accepts an object with properties `{ object, intersect }`, containing the object being hovered and the actual intersection.
* `onPointerOver`: Function, accepts an object with properties `{ object, intersect }`, containing the object being hovered and the actual intersection.
* `onPointerLeave`: : Function, accepts an object with properties `{ object }`, containing the object no longer being hovered.
* `onClick`: Function, accepts an object with properties `{ object, intersect }`, containing the object being clicked and the actual intersection.
* `usePointerEvents`: Boolean, default false. If set to `true`, this object will emit `pointerEnter`, `pointerOver`, `pointerLeave`, and `click` events, all with the same arguments as the props. Function props are preferred over events to avoid the extra overhead of event emitting, but this option is provided if the user prefers events.
* `pointerObjects`: Array of objects to cast against. Defaults to just the given object. Set to `true` (ie, `<Object3D pointer-objects>`) to cast against all scene children.
### Deprecations and Other Notes
* `mouseMove`, `mouseRaycast`, `mouseOver`, and `click` are all no longer used on the renderer.
* `usePointer` on the `Renderer` is `true` by default. Switch to `false` to prevent mouse event handling on the renderer element. Example:
```html
<!-- Do not listen to mousemove events - marginal performance improvement -->
<Renderer :use-pointer="false">
```