playscii/vector.py

import math

import numpy as np
from OpenGL import GLU


class Vec3:
    "Basic 3D vector class. Not used very much currently."

    def __init__(self, x=0, y=0, z=0):
        self.x, self.y, self.z = x, y, z

    def __str__(self):
        return f"Vec3 {self.x:.4f}, {self.y:.4f}, {self.z:.4f}"

    def __sub__(self, b):
        "Return a new vector subtracted from given other vector."
        return Vec3(self.x - b.x, self.y - b.y, self.z - b.z)

    def length(self):
        "Return this vector's scalar length."
        return math.sqrt(self.x**2 + self.y**2 + self.z**2)

    def normalize(self):
        "Return a unit length version of this vector."
        n = Vec3()
        l = self.length()
        if l != 0:
            ilength = 1.0 / l
            n.x = self.x * ilength
            n.y = self.y * ilength
            n.z = self.z * ilength
        return n

    def cross(self, b):
        "Return a new vector of cross product with given other vector."
        x = self.y * b.z - self.z * b.y
        y = self.z * b.x - self.x * b.z
        z = self.x * b.y - self.y * b.x
        return Vec3(x, y, z)

    def dot(self, b):
        "Return scalar dot product with given other vector."
        return self.x * b.x + self.y * b.y + self.z * b.z

    def inverse(self):
        "Return a new vector that is inverse of this vector."
        return Vec3(-self.x, -self.y, -self.z)

    def copy(self):
        "Return a copy of this vector."
        return Vec3(self.x, self.y, self.z)


def get_tiles_along_line(x0, y0, x1, y1):
    """
    Return list of (x,y) tuples for all tiles crossing given worldspace
    line points.
    from http://playtechs.blogspot.com/2007/03/raytracing-on-grid.html
    NOTE: this implementation assumes square tiles!
    """
    dx, dy = abs(x1 - x0), abs(y1 - y0)
    x, y = math.floor(x0), math.floor(y0)
    n = 1
    if dx == 0:
        x_inc = 0
        error = float("inf")
    elif x1 > x0:
        x_inc = 1
        n += math.floor(x1) - x
        error = (math.floor(x0) + 1 - x0) * dy
    else:
        x_inc = -1
        n += x - math.floor(x1)
        error = (x0 - math.floor(x0)) * dy
    if dy == 0:
        y_inc = 0
        error -= float("inf")
    elif y1 > y0:
        y_inc = 1
        n += math.floor(y1) - y
        error -= (math.floor(y0) + 1 - y0) * dx
    else:
        y_inc = -1
        n += y - math.floor(y1)
        error -= (y0 - math.floor(y0)) * dx
    tiles = []
    while n > 0:
        tiles.append((x, y))
        if error > 0:
            y += y_inc
            error -= dx
        else:
            x += x_inc
            error += dy
        n -= 1
    return tiles


def get_tiles_along_integer_line(x0, y0, x1, y1, cut_corners=True):
    """
    simplified version of get_tiles_along_line using only integer math,
    also from http://playtechs.blogspot.com/2007/03/raytracing-on-grid.html

    cut_corners=True: when a 45 degree line is only intersecting the corners
    of two tiles, don't count them as overlapped.
    """
    dx, dy = abs(x1 - x0), abs(y1 - y0)
    x, y = x0, y0
    n = 1 + dx + dy
    x_inc = 1 if x1 > x0 else -1
    y_inc = 1 if y1 > y0 else -1
    error = dx - dy
    dx *= 2
    dy *= 2
    tiles = []
    while n > 0:
        tiles.append((x, y))
        if error == 0 and cut_corners:
            x += x_inc
            y += y_inc
            # count this iteration as two
            n -= 1
        elif error > 0:
            x += x_inc
            error -= dy
        else:
            y += y_inc
            error += dx
        n -= 1
    return tiles


def cut_xyz(x, y, z, threshold):
    """
    Return input x,y,z with each axis clamped to 0 if it's close enough to
    given threshold
    """
    x = x if abs(x) > threshold else 0
    y = y if abs(y) > threshold else 0
    z = z if abs(z) > threshold else 0
    return x, y, z


def ray_plane_intersection(
    plane_x,
    plane_y,
    plane_z,
    plane_dir_x,
    plane_dir_y,
    plane_dir_z,
    ray_x,
    ray_y,
    ray_z,
    ray_dir_x,
    ray_dir_y,
    ray_dir_z,
):
    # from http://stackoverflow.com/a/39424162
    plane = np.array([plane_x, plane_y, plane_z])
    plane_dir = np.array([plane_dir_x, plane_dir_y, plane_dir_z])
    ray = np.array([ray_x, ray_y, ray_z])
    ray_dir = np.array([ray_dir_x, ray_dir_y, ray_dir_z])
    ndotu = plane_dir.dot(ray_dir)
    if abs(ndotu) < 0.000001:
        # print ("no intersection or line is within plane")
        return 0, 0, 0
    w = ray - plane
    si = -plane_dir.dot(w) / ndotu
    psi = w + si * ray_dir + plane
    return psi[0], psi[1], psi[2]


def screen_to_world(app, screen_x, screen_y):
    """
    Return 3D (float) world space coordinates for given 2D (int) screen space
    coordinates.
    """
    # thanks http://www.bfilipek.com/2012/06/select-mouse-opengl.html
    # get world space ray from view space mouse loc
    screen_y = app.window_height - screen_y
    z1, z2 = 0, 0.99999
    pjm = np.matrix(app.camera.projection_matrix, dtype=np.float64)
    vm = np.matrix(app.camera.view_matrix, dtype=np.float64)
    start_x, start_y, start_z = GLU.gluUnProject(screen_x, screen_y, z1, vm, pjm)
    end_x, end_y, end_z = GLU.gluUnProject(screen_x, screen_y, z2, vm, pjm)
    dir_x, dir_y, dir_z = end_x - start_x, end_y - start_y, end_z - start_z
    # define Z of plane to test against
    # TODO: what Z is appropriate for game mode picking? test multiple planes?
    art = app.ui.active_art
    plane_z = art.layers_z[art.active_layer] if art and not app.game_mode else 0
    x, y, z = ray_plane_intersection(
        0,
        0,
        plane_z,  # plane loc
        0,
        0,
        1,  # plane dir
        end_x,
        end_y,
        end_z,  # ray origin
        dir_x,
        dir_y,
        dir_z,
    )  # ray dir
    return x, y, z


def world_to_screen(app, world_x, world_y, world_z):
    """
    Return 2D screen pixel space coordinates for given 3D (float) world space
    coordinates.
    """
    pjm = np.matrix(app.camera.projection_matrix, dtype=np.float64)
    vm = np.matrix(app.camera.view_matrix, dtype=np.float64)
    # viewport tuple order should be same as glGetFloatv(GL_VIEWPORT)
    viewport = (0, 0, app.window_width, app.window_height)
    try:
        x, y, _z = GLU.gluProject(world_x, world_y, world_z, vm, pjm, viewport)
    except Exception:
        x, y = 0, 0
        app.log("GLU.gluProject failed!")
    # does Z mean anything here?
    return x, y


def world_to_screen_normalized(app, world_x, world_y, world_z):
    """
    Return normalized (-1 to 1) 2D screen space coordinates for given 3D
    world space coordinates.
    """
    x, y = world_to_screen(app, world_x, world_y, world_z)
    x = (2 * x) / app.window_width - 1
    y = (-2 * y) / app.window_height + 1
    return x, -y