Giter Club home page Giter Club logo

camera-picking-ray's Introduction

camera-picking-ray

stable

Creates a picking ray for a camera. Commonly used for mouse interaction in 2D and 3D games.

The camera is assumed to have a projection and view matrix, which can be combined and inverted to form invProjView.

var origin = [0, 0, 0]
var direction = [0, 0, 0]

//compute ray and store it in (origin, direction)
pick(origin, direction, mouse, viewport, invProjView)

console.log(origin, direction)

Full example, hit-testing against a 3D sphere:

var mat4 = require('gl-mat4')
var pick = require('camera-picking-ray')
var intersect = require('ray-sphere-intersection')

//your camera matrices
var projection = ...
var view = ...
var projView = mat4.multiply([], projection, view)
var invProjView = mat4.invert([], projView)

var mouse = [ screenX, screenHeight - screenY ]
var viewport = [ 0, 0, screenWidth, screenHeight ]

var ray = {
  ro: [0, 0, 0],
  rd: [0, 0, 0]
}

//store result in ray (origin, direction)
pick(ray.ro, ray.rd, mouse, viewport, invProjView)

//let's see if the mouse hit a 3D sphere...
var center = [0, 0, 0],
    radius = 1.5
var hit = intersect([], ray.ro, ray.rd, center, radius)

if (hit) {
  console.log("Mouse hit the sphere at:", hit)
}

PRs welcome.

Usage

NPM

pick(origin, direction, mouse, viewport, invProjView)

Creates a picking ray for the given mouse screen-space position (vec2) and viewport screen-space bounds (x, y, width, height). invProjView is the inverse of the combined projection * view matrix for your camera.

Stores the resulting ray in the first two parameters: origin (vec3) and direction (vec3).

See Also

License

MIT, see LICENSE.md for details.

camera-picking-ray's People

Contributors

mattdesl avatar

Stargazers

Yosef Ashkenazy avatar Fabio Dias Rollo avatar Ash Weeks avatar  avatar Matt Felsen avatar Reza Ali avatar Ole J. Rosendahl avatar Mark Moissette avatar Thibaut Séguy avatar Hugh Kennedy avatar Yosh avatar

Watchers

Andor Salga avatar Miguel Moraleda avatar Max Rusan avatar Tomasz Dysinski avatar James Cloos avatar  avatar Mark McQuillan avatar Nick Poisson avatar  avatar Brendan Neufeld avatar Jeremias Menichelli avatar Marcelo Rodriguez avatar max avatar Felipe Vega avatar Chris avatar Guillermo Figueroa Mesa avatar  avatar  avatar Santiago D'Antuoni avatar  avatar

camera-picking-ray's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.