Module simple_3dviz.behaviours.keyboard

Expand source code 
from ..utils import save_frame
from . import Behaviour


class OnKeys(Behaviour):
    """Abstract class that performs an action when a set of keys is pressed."""
    def __init__(self, keys):
        self._keys = keys
        self._act = False

    def behave(self, params):
        if params.keyboard.keys_down & self._keys == self._keys:
            self._act = True
        elif self._act and params.keyboard.keys_up | self._keys:
            self._act = False
            self.action(params)

    def action(self, params):
        raise NotImplementedError()


class SnapshotOnKey(OnKeys):
    """Save a snapshot when a key is pressed.
    
    Arguments
    ---------
        path: The path to save the images with the optional index for the
              snapshot (ie. snapshot_{}.png)
        keys: A set of keys that must all be pressed to save the frame.
              Available special keys are <ctrl>, <cmd>, <alt>, etc.
    """
    def __init__(self, path="snapshot_{:03d}.png", keys={"S"}):
        super(SnapshotOnKey, self).__init__(keys)
        self._path = path
        self._i = 0

    def action(self, params):
        frame = params.frame()
        path = self._path.format(self._i)
        self._i += 1
        save_frame(path, frame)


class CameraReport(OnKeys):
    """Print the scene parameters to stdout when a key is pressed.

    Arguments
    ---------
        keys: A set of keys that must all be pressed to activate the action.
    """
    def __init__(self, keys={"R"}):
        super(CameraReport, self).__init__(keys)

    def action(self, params):
        def csv(x):
            return ",".join(list(map(str, x)))
        print("--camera_target='{}' --camera_position='{}' --up='{}'".format(
            csv(params.scene.camera_target),
            csv(params.scene.camera_position),
            csv(params.scene.up_vector)
        ))


class SortTriangles(OnKeys):
    """Sort the triangles wrt to the camera so that the transparency works.

    Arguments
    ---------
        keys: A set of keys that must all be pressed to activate the action
    """
    def __init__(self, keys={"T"}):
        super(SortTriangles, self).__init__(keys)

    def action(self, params):
        camera = params.scene.camera_position
        for r in params.scene.renderables:
            if hasattr(r, "sort_triangles"):
                r.sort_triangles(camera)
        params.refresh = True

Classes

class CameraReport (keys={'R'})

Print the scene parameters to stdout when a key is pressed.

Arguments

keys: A set of keys that must all be pressed to activate the action.
Expand source code 
class CameraReport(OnKeys):
    """Print the scene parameters to stdout when a key is pressed.

    Arguments
    ---------
        keys: A set of keys that must all be pressed to activate the action.
    """
    def __init__(self, keys={"R"}):
        super(CameraReport, self).__init__(keys)

    def action(self, params):
        def csv(x):
            return ",".join(list(map(str, x)))
        print("--camera_target='{}' --camera_position='{}' --up='{}'".format(
            csv(params.scene.camera_target),
            csv(params.scene.camera_position),
            csv(params.scene.up_vector)
        ))

Ancestors

Methods

def action(self, params)
Expand source code 
def action(self, params):
    def csv(x):
        return ",".join(list(map(str, x)))
    print("--camera_target='{}' --camera_position='{}' --up='{}'".format(
        csv(params.scene.camera_target),
        csv(params.scene.camera_position),
        csv(params.scene.up_vector)
    ))

Inherited members

class OnKeys (keys)

Abstract class that performs an action when a set of keys is pressed.

Expand source code 
class OnKeys(Behaviour):
    """Abstract class that performs an action when a set of keys is pressed."""
    def __init__(self, keys):
        self._keys = keys
        self._act = False

    def behave(self, params):
        if params.keyboard.keys_down & self._keys == self._keys:
            self._act = True
        elif self._act and params.keyboard.keys_up | self._keys:
            self._act = False
            self.action(params)

    def action(self, params):
        raise NotImplementedError()

Ancestors

Subclasses

Methods

def action(self, params)
Expand source code 
def action(self, params):
    raise NotImplementedError()

Inherited members

class SnapshotOnKey (path='snapshot_{:03d}.png', keys={'S'})

Save a snapshot when a key is pressed.

Arguments

path: The path to save the images with the optional index for the
      snapshot (ie. snapshot_{}.png)
keys: A set of keys that must all be pressed to save the frame.
      Available special keys are <ctrl>, <cmd>, <alt>, etc.
Expand source code 
class SnapshotOnKey(OnKeys):
    """Save a snapshot when a key is pressed.
    
    Arguments
    ---------
        path: The path to save the images with the optional index for the
              snapshot (ie. snapshot_{}.png)
        keys: A set of keys that must all be pressed to save the frame.
              Available special keys are <ctrl>, <cmd>, <alt>, etc.
    """
    def __init__(self, path="snapshot_{:03d}.png", keys={"S"}):
        super(SnapshotOnKey, self).__init__(keys)
        self._path = path
        self._i = 0

    def action(self, params):
        frame = params.frame()
        path = self._path.format(self._i)
        self._i += 1
        save_frame(path, frame)

Ancestors

Methods

def action(self, params)
Expand source code 
def action(self, params):
    frame = params.frame()
    path = self._path.format(self._i)
    self._i += 1
    save_frame(path, frame)

Inherited members

class SortTriangles (keys={'T'})

Sort the triangles wrt to the camera so that the transparency works.

Arguments

keys: A set of keys that must all be pressed to activate the action
Expand source code 
class SortTriangles(OnKeys):
    """Sort the triangles wrt to the camera so that the transparency works.

    Arguments
    ---------
        keys: A set of keys that must all be pressed to activate the action
    """
    def __init__(self, keys={"T"}):
        super(SortTriangles, self).__init__(keys)

    def action(self, params):
        camera = params.scene.camera_position
        for r in params.scene.renderables:
            if hasattr(r, "sort_triangles"):
                r.sort_triangles(camera)
        params.refresh = True

Ancestors

Methods

def action(self, params)
Expand source code 
def action(self, params):
    camera = params.scene.camera_position
    for r in params.scene.renderables:
        if hasattr(r, "sort_triangles"):
            r.sort_triangles(camera)
    params.refresh = True

Inherited members