Skip to content

Commit

Permalink
chore: update the doc
Browse files Browse the repository at this point in the history
  • Loading branch information
yomotsu committed Jun 27, 2023
1 parent 7bbbd78 commit 769a9b3
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@ See [the demo](https://github.com/yomotsu/camera-movement-comparison#dolly-vs-zo
| `.verticalDragToForward` | `boolean` | `false` | The same as `.screenSpacePanning` in three.js's OrbitControls. |
| `.dollyToCursor` | `boolean` | `false` | `true` to enable Dolly-in to the mouse cursor coords. |
| `.dollyDragInverted` | `boolean` | `false` | `true` to invert direction when dollying or zooming via drag. |
| `.interactiveArea` | `DOMRect` | N/A | Set drag-start, touches and wheel enable area in the domElement. each values are between `0` and `1` inclusive, where `0` is left/top and `1` is right/bottom of the screen. |
| `.colliderMeshes` | `array` | `[]` | An array of Meshes to collide with camera ². |
| `.infinityDolly` | `boolean` | `false` | `true` to enable Infinity Dolly for wheel and pinch. Use this with `minDistance` and `maxDistance` ³. |
| `.restThreshold` | `number` | `0.0025` | Controls how soon the `rest` event fires as the camera slows |
Expand Down
2 changes: 1 addition & 1 deletion src/CameraControls.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1544,7 +1544,7 @@ export class CameraControls extends EventDispatcher {

/**
* Set drag-start, touches and wheel enable area in the domElement.
* each values are between 0 and 1 inclusive, where 0 is left/top and 1 is right/bottom of the screen.
* each values are between `0` and `1` inclusive, where `0` is left/top and `1` is right/bottom of the screen.
* e.g. `{ x: 0, y: 0, width: 1, height: 1 }` for entire area.
* @category Properties
*/
Expand Down

0 comments on commit 769a9b3

Please sign in to comment.