/usr/include/SurgSim/Blocks/KeyboardCallbackBehavior.h is in libopensurgsim-dev 0.7.0-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 | // This file is a part of the OpenSurgSim project.
// Copyright 2015, SimQuest Solutions Inc.
//
// 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.
#ifndef SURGSIM_BLOCKS_KEYBOARDCALLBACKBEHAVIOR_H
#define SURGSIM_BLOCKS_KEYBOARDCALLBACKBEHAVIOR_H
#include <functional>
#include "SurgSim/Devices/Keyboard/KeyCode.h"
#include "SurgSim/Framework/Behavior.h"
namespace SurgSim
{
namespace Input
{
class InputComponent;
}
namespace Blocks
{
SURGSIM_STATIC_REGISTRATION(KeyboardCallbackBehavior);
/// This behavior will call the registered callback function when the registered key is pressed.
class KeyboardCallbackBehavior : public Framework::Behavior
{
public:
typedef std::function<void()> CallbackType;
/// Constructor
/// \param name Name of the behavior
explicit KeyboardCallbackBehavior(const std::string& name);
SURGSIM_CLASSNAME(SurgSim::Blocks::KeyboardCallbackBehavior);
/// Set the input component from which pressed key comes.
/// \param inputComponent The input component which contains the pressed key(s).
void setInputComponent(std::shared_ptr<Framework::Component> inputComponent);
/// Get the input component of this behavior, from which the pressed key comes.
/// \return The input component which sends key press to this behavior.
std::shared_ptr<Input::InputComponent> getInputComponent() const;
/// Register a key, so that when such key is pressed, this behavior will call the callback.
/// \param key The controlling key.
void registerKey(int key);
/// Register a callback function.
/// This function will be called when the registered key is pressed.
/// \param func The callback function.
void registerCallback(CallbackType func);
void update(double dt) override;
protected:
/// \return The key which will make this behavior to call the callback.
/// \note This is used for serialization only.
int getKey() const;
bool doInitialize() override;
bool doWakeUp() override;
private:
/// Record if any key is pressed in last update() call.
bool m_keyPressedLastUpdate;
/// The registered key, when pressed, the registered callback will be called.
int m_actionKey;
/// Callback function.
CallbackType m_callback;
/// Input component from which pressed key comes.
std::shared_ptr<Input::InputComponent> m_inputComponent;
};
}; // namespace Blocks
}; // namespace SurgSim
#endif //SURGSIM_BLOCKS_KEYBOARDCALLBACKBEHAVIOR_H
|