Visualizer_InputListener.h

Go to the documentation of this file.

#ifndef SimTK_SIMBODY_VISUALIZER_INPUT_LISTENER_H_
#define SimTK_SIMBODY_VISUALIZER_INPUT_LISTENER_H_

/* -------------------------------------------------------------------------- *
 *                               Simbody(tm)                                  *
 * -------------------------------------------------------------------------- *
 * This is part of the SimTK biosimulation toolkit originating from           *
 * Simbios, the NIH National Center for Physics-Based Simulation of           *
 * Biological Structures at Stanford, funded under the NIH Roadmap for        *
 * Medical Research, grant U54 GM072970. See https://simtk.org/home/simbody.  *
 *                                                                            *
 * Portions copyright (c) 2010-12 Stanford University and the Authors.        *
 * Authors: Peter Eastman, Michael Sherman                                    *
 * Contributors:                                                              *
 *                                                                            *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may    *
 * not use this file except in compliance with the License. You may obtain a  *
 * copy of the License at http://www.apache.org/licenses/LICENSE-2.0.         *
 *                                                                            *
 * Unless required by applicable law or agreed to in writing, software        *
 * distributed under the License is distributed on an "AS IS" BASIS,          *
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   *
 * See the License for the specific language governing permissions and        *
 * limitations under the License.                                             *
 * -------------------------------------------------------------------------- */

#include "simbody/internal/common.h"
#include "simbody/internal/Visualizer.h"

namespace SimTK {

//==============================================================================
//                             INPUT LISTENER
//==============================================================================
class SimTK_SIMBODY_EXPORT Visualizer::InputListener {
public:
enum Modifier {
    ShiftIsDown   = 0x01, 
    ControlIsDown = 0x02, 
    AltIsDown     = 0x04, 
    IsSpecialKey  = 0xC0  
};

static const unsigned SpecialKeyOffset = 0x100; // Added to each code

enum KeyCode {
    KeyControlC     = 3,            // some notable ASCII codes
    KeyBeep         = 7,
    KeyBackspace    = 8,            
    KeyTab          = 9,
    KeyLF           = 10,
    KeyReturn       = 13,
    KeyEnter        = KeyReturn,
    KeyEsc          = 27,
    KeyDelete       = 127,

    KeyF1  = SpecialKeyOffset + 1,  // function keys
    KeyF2  = SpecialKeyOffset + 2,
    KeyF3  = SpecialKeyOffset + 3,
    KeyF4  = SpecialKeyOffset + 4,
    KeyF5  = SpecialKeyOffset + 5,
    KeyF6  = SpecialKeyOffset + 6,
    KeyF7  = SpecialKeyOffset + 7,
    KeyF8  = SpecialKeyOffset + 8,
    KeyF9  = SpecialKeyOffset + 9,
    KeyF10 = SpecialKeyOffset + 10,
    KeyF11 = SpecialKeyOffset + 11,
    KeyF12 = SpecialKeyOffset + 12,

    KeyLeftArrow    = SpecialKeyOffset + 100,  // directional keys
    KeyUpArrow      = SpecialKeyOffset + 101,
    KeyRightArrow   = SpecialKeyOffset + 102,
    KeyDownArrow    = SpecialKeyOffset + 103,
    KeyPageUp       = SpecialKeyOffset + 104,
    KeyPageDown     = SpecialKeyOffset + 105,
    KeyHome         = SpecialKeyOffset + 106,
    KeyEnd          = SpecialKeyOffset + 107,
    KeyInsert       = SpecialKeyOffset + 108
};
    
virtual ~InputListener() {}

virtual bool keyPressed(unsigned key, unsigned modifiers) {return false;}

virtual bool menuSelected(int menu, int item) {return false;}

virtual bool sliderMoved(int slider, Real value) {return false;}
};



//==============================================================================
//                              INPUT SILO
//==============================================================================
class SimTK_SIMBODY_EXPORT Visualizer::InputSilo
:   public Visualizer::InputListener {
public:
InputSilo();
~InputSilo();

bool isAnyUserInput() const;

void waitForAnyUserInput() const;

bool takeKeyHit(unsigned& key, unsigned& modifiers);

void waitForKeyHit(unsigned& key, unsigned& modifiers);

bool takeMenuPick(int& menu, int& item);

void waitForMenuPick(int& menu, int& item);

bool takeSliderMove(int& slider, Real& value);

void waitForSliderMove(int& slider, Real& value);

void clear();

//------------------------------------------------------------------------------
                                 private:
// Each of these will return true to the Visualizer's listener thread, meaning 
// that the input will be absorbed and subsequent listeners (if any) will not 
// be called.
virtual bool keyPressed(unsigned key, unsigned modifiers) override;
virtual bool menuSelected(int menu, int item) override;
virtual bool sliderMoved(int slider, Real value) override;

class Impl;
const Impl& getImpl() const {assert(m_impl); return *m_impl;}
Impl&       updImpl()       {assert(m_impl); return *m_impl;}

Impl*       m_impl;   // the lone data member in this class
};

} // namespace SimTK

#endif // SimTK_SIMBODY_VISUALIZER_INPUT_LISTENER_H_