https://github.com/hackergrrl/fov-2d

:mag_right: Test whether a point is in an observer's field-of-view.
https://github.com/hackergrrl/fov-2d

Last synced: 20 days ago
JSON representation

:mag_right: Test whether a point is in an observer's field-of-view.

• Host: GitHub
• URL: https://github.com/hackergrrl/fov-2d
• Owner: hackergrrl
• License: mit
• Created: 2015-11-20T00:55:41.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-11-20T21:57:25.000Z (almost 9 years ago)
• Last Synced: 2024-10-10T16:08:53.161Z (about 1 month ago)
• Language: JavaScript
• Size: 5.86 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# fov-2d

> Test whether a point is in an observer's field-of-view.

![fov](http://noffle.github.io/fov-2d/illustration.png)

Given the location, heading, and field-of-view (as an angle) of an observer's

eye, determine whether the target is visible (the blue triangle).

## Installation

```sh

npm install fov-2d

```

## Example

```js

var inFov = require('fov-2d')

var enemy = [0, 0]

var enemyFacing = [1, 0]

var enemyFov = Math.PI / 3  // 60 degrees

var player = [100, 0]

var crate = [0, 10]

var testPlayer = inFov(enemy, enemyFacing, enemyFov, player)

var testCrate = inFov(enemy, enemyFacing, enemyFov, crate)

console.log(testPlayer)

console.log(testCrate)

```

outputs

```

true

false

```

## Usage

```js

var fov = require('fov-2d')

```

### var visible = fov(eyePos, eyeFacing, eyeFov, targetPos)

* `eyePos` - origin of the eye `[x, y]`

* `eyeFacing` - the direction the eye is facing, given by a 2d vector

* `eyeFov` - the angle, in radians, of the eye's field-of-view

* `targetPos` - origin of the target the eye is trying to test the visibility of

Returns `true` if the target is within the eye's FOV, and false otherwise.

## More

This module can be readily combined with modules like

[raycast-2d-tilemap](https://github.com/noffle/raycast-2d-tilemap) to check for

solid tiles in a tilemap to determine visibility.