TraversoCommands Class Reference

The Traverso CommandPlugin class which 'implements' many of the default Commands. More...

Inheritance diagram for TraversoCommands:

Detailed Description

The Traverso CommandPlugin class which 'implements' many of the default Commands.

With this plugin, the InputEngine is able to dispatch key actions by directly asking this Plugin for the needed Command object.

Dispatching key events to a specific object to create a Command object is accomplished by creating entries in the keymap.xml file, which has the following syntax:

        <Object objectname="" mousehint="" modes="" sortorder="" pluginname="" commandname="" arguments="" />

        objectname:     The class name of the object that we want to dispatch the key action on
        mousehint       Used to set the mouse cursor. Use "LR" for horizontal suggestion, "UD" for vertical suggestion, or "RLUD" for omnidirectional suggestion.
        modes:          Modes for which this command can be used, like All, Edit or Effects. Modes are to be defined in the keymap itself!
        sortorder:      The order of where the key action should show up in the ContextMenu of 'objectname'
        plugniname:     The plugin to ask the Command for, the only one available right now is TraversoCommands
        commandname:    The Command to be created, which by convention tries to be the same name as the actuall class implementing the Command
        arguments:      One, or more values (seperated by semicolons), each Command explains which (list of) values it can understand

Available Command classes, their required Object (to operate on) and arguments are:

        MoveClip: Move or Copy-move an AudioClip.
        
        objectname:     AudioClipView
        arguments:      First entry, either one of the following: "move", "copy", "move_to_end", "move_to_start"
                        Second (optional) entry: Move vertical only: "true" for vertical moving only, "false" for omnidirectional moving (the default if none is given)
        commandname:    MoveClip

        Gain: Change (jog), or reset the Gain of audio processing items
        objectname:     SheetView, TrackView, AudioClipView
        arguments:      No argument: Move Mouse vertically. Argument "horizontal": Move Mouse horizontally
        commandname:    Gain

        ResetGain: Set Gain value to a pre-defined value (by means of the supplied argument).
        
        objectname:     SheetView, TrackView, AudioClipView
        arguments:      a floating point value, eg: "0.5"
        commandname:    ResetGain

TODO document all remaining Commands

        ?: ?
        
        Objects(s):     
        arguments:      
        commandname:

The documentation for this class was generated from the following files:

Traverso/cvs/traverso/src/commands/plugins/TraversoCommands/TraversoCommands.h
Traverso/cvs/traverso/src/commands/plugins/TraversoCommands/TraversoCommands.cpp