remixlab.bias

Class Profile

java.lang.Object

remixlab.bias.Profile

public class Profile
extends Object

A Grabber extension which allows to define Shortcut to Method bindings. See setBinding(Shortcut, String) and setBinding(Object, Shortcut, String) .

To attach a profile to a grabber first override your Grabber.performInteraction(BogusEvent) method like this:

 
   public void performInteraction(BogusEvent event) {
     profile.handle(event);
   }
 
 

(see handle(BogusEvent)) and then simply pass the grabber instance to the Profile(Grabber) constructor.

Field Summary

Fields

Modifier and Type	Field and Description
static Object	context

Constructor Summary

Constructors

Constructor and Description
Profile(Grabber g) Attaches a profile to the given grabber.

Method Summary

Modifier and Type	Method and Description
String	action(Shortcut shortcut) Returns the Method binding for the given Shortcut key.
Grabber	grabber() Returns the grabber to which this profile is attached.
boolean	handle(BogusEvent event) Main class method to be called from Grabber.performInteraction(BogusEvent).
boolean	hasBinding(Shortcut shortcut) Returns true if this object contains a binding for the specified shortcut.
String	info() Returns a description of all the bindings this profile holds.
String	info(Class<? extends Shortcut> cls) Returns a description of all the bindings this profile holds from the given shortcut class.
boolean	isActionBound(String action) Returns true if this object maps one or more shortcuts to the action specified by the grabber().
Method	method(Shortcut shortcut) Returns the Method binding for the given Shortcut key.
Object	object(Shortcut shortcut) Returns the action performing object.
static void	registerVKeys(Class<? extends Shortcut> shortcutClass, Class<?> keyEventClass) Utility function to programmatically register virtual keys to a Shortcut class, typically KeyboardShortcuts.
void	removeBinding(Shortcut shortcut) Removes the shortcut binding.
void	removeBindings() Removes all the shortcuts from this object.
void	removeBindings(Class<? extends Shortcut> cls) Removes all the shortcuts from the given shortcut class.
void	set(Profile p) Instantiates this profile from another profile.
boolean	setBinding(Object object, Shortcut shortcut, String action) Defines the shortcut that triggers the given action.
boolean	setBinding(Shortcut shortcut, String action) Defines the shortcut that triggers the given action.
Set<Shortcut>	shortcuts() Returns this profile set of shortcuts.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

context

public static Object context

Constructor Detail

Profile

public Profile(Grabber g)

Attaches a profile to the given grabber.

Method Detail

registerVKeys

public static void registerVKeys(Class<? extends Shortcut> shortcutClass,
                                 Class<?> keyEventClass)

Utility function to programmatically register virtual keys to a Shortcut class, typically KeyboardShortcuts.

set

public void set(Profile p)

Instantiates this profile from another profile. Both Profile grabber() should be of the same type.

shortcuts

public Set<Shortcut> shortcuts()

Returns this profile set of shortcuts.

grabber

public Grabber grabber()

Returns the grabber to which this profile is attached.

method

public Method method(Shortcut shortcut)

Returns the Method binding for the given Shortcut key.

See Also:

action(Shortcut)

action

public String action(Shortcut shortcut)

Returns the Method binding for the given Shortcut key.

See Also:

method(Shortcut)

object

public Object object(Shortcut shortcut)

Returns the action performing object. Either the grabber() or an external object.

handle

public boolean handle(BogusEvent event)

Main class method to be called from Grabber.performInteraction(BogusEvent). Calls an action handler if the BogusEvent.shortcut() is bound.

See Also:

setBinding(Shortcut, String), setBinding(Object, Shortcut, String)

setBinding

public boolean setBinding(Shortcut shortcut,
                          String action)

Defines the shortcut that triggers the given action.

Attempt to set a shortcut for the action implemented by the context (e.g., the PApplet in the case of a Processing application) or the grabber() (e.g., the InteractiveFrame instance this profile is attached to, in the case of a Processing application) when no prototype is found in the context.

The available action prototypes for the context are:

1. public void action(grabber.getClass(), BogusEvent)
2. public void action(grabber.getClass())

The available action prototypes for the grabber() are:

1. public void action(BogusEvent)
2. public void action()

The bogus-event type that may be passed to the above prototypes is the one specified by the Shortcut.eventClass() method:

1. A ClickEvent for a ClickShortcut
2. A KeyboardEvent for a KeyboardShortcut
3. A DOFnEvent for a MotionShortcut, where n is the MotionShortcut.dofs(int) of the motion-shortcut Shortcut.id().

Note that in the latter case a MotionEvent may be passed too.

Parameters:

shortcut - Shortcut

action - String

See Also:

setBinding(Object, Shortcut, String), Shortcut.eventClass(), MotionShortcut.eventClass(), MotionShortcut.dofs(int), MotionShortcut.registerID(int, int, String)

setBinding

public boolean setBinding(Object object,
                          Shortcut shortcut,
                          String action)

Defines the shortcut that triggers the given action.

Attempt to set a shortcut for the action implemented by object. The action procedure may have two different prototypes:

1. public void action(BogusEvent)
2. public void action()

The bogus-event type that may be passed to the first prototype is the one specified by the Shortcut.eventClass() method:

1. A ClickEvent for a ClickShortcut
2. A KeyboardEvent for a KeyboardShortcut
3. A DOFnEvent for a MotionShortcut, where n is the MotionShortcut.dofs(int) of the motion-shortcut Shortcut.id().

Note that in the latter case a MotionEvent may be passed too.

Parameters:

object - Object

shortcut - Shortcut

action - String

See Also:

setBinding(Object, Shortcut, String), Shortcut.eventClass(), MotionShortcut.eventClass(), MotionShortcut.dofs(int), MotionShortcut.registerID(int, int, String)

removeBinding

public void removeBinding(Shortcut shortcut)

Removes the shortcut binding.

Parameters:

shortcut - Shortcut

removeBindings

public void removeBindings()

Removes all the shortcuts from this object.

removeBindings

public void removeBindings(Class<? extends Shortcut> cls)

Removes all the shortcuts from the given shortcut class.

info

public String info(Class<? extends Shortcut> cls)

Returns a description of all the bindings this profile holds from the given shortcut class.

info

public String info()

Returns a description of all the bindings this profile holds.

hasBinding

public boolean hasBinding(Shortcut shortcut)

Returns true if this object contains a binding for the specified shortcut.

Parameters:

shortcut - Shortcut

Returns:

true if this object contains a binding for the specified shortcut.

isActionBound

public boolean isActionBound(String action)

Returns true if this object maps one or more shortcuts to the action specified by the grabber().

Parameters:

action - String

Returns:

true if this object maps one or more shortcuts to the specified action.