/usr/include/SurgSim/Blocks/KeyboardTogglesComponentBehavior.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 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 | // This file is a part of the OpenSurgSim project.
// Copyright 2013, 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_KEYBOARDTOGGLESCOMPONENTBEHAVIOR_H
#define SURGSIM_BLOCKS_KEYBOARDTOGGLESCOMPONENTBEHAVIOR_H
#include <unordered_map>
#include <unordered_set>
#include "SurgSim/Devices/Keyboard/KeyCode.h"
#include "SurgSim/Framework/Behavior.h"
#include "SurgSim/Framework/Macros.h"
namespace SurgSim
{
namespace Framework
{
class Component;
}
namespace Input
{
class InputComponent;
}
namespace Blocks
{
SURGSIM_STATIC_REGISTRATION(KeyboardTogglesComponentBehavior);
/// This behavior is used to control the activity of registered components.
class KeyboardTogglesComponentBehavior : public SurgSim::Framework::Behavior
{
public:
typedef std::unordered_map<int, std::unordered_set<std::shared_ptr<SurgSim::Framework::Component>>>
KeyboardRegistryType;
/// Constructor
/// \param name Name of the behavior
explicit KeyboardTogglesComponentBehavior(const std::string& name);
SURGSIM_CLASSNAME(SurgSim::Blocks::KeyboardTogglesComponentBehavior);
/// Set the input component from which pressed keys come.
/// \param inputComponent The input component which contains the pressed key(s).
void setInputComponent(std::shared_ptr<SurgSim::Framework::Component> inputComponent);
/// Get the input component of this behavior
/// \return The input component which sends signals to this behavior.
std::shared_ptr<SurgSim::Input::InputComponent> getInputComponent() const;
/// Register a key with a component in this behavior.
/// \param key A key used to control the component.
/// \param component The component being controlled by the key.
/// \note A key can be registered several times, so can a component.
void registerKey(SurgSim::Devices::KeyCode key, std::shared_ptr<SurgSim::Framework::Component> component);
/// Set the register map of this behavior
/// \param map The register map.
void setKeyboardRegistry(const KeyboardRegistryType& map);
/// Get the register map of this behavior
/// \return The register map of this behavior
const KeyboardRegistryType& getKeyboardRegistry() const;
/// Update the behavior
/// \param dt The length of time (seconds) between update calls.
void update(double dt) override;
protected:
/// Initialize this behavior
/// \return True on success, otherwise false.
/// \note In current implementation, this method always returns "true".
bool doInitialize() override;
/// Wakeup this behavior
/// \return True on success, otherwise false.
/// \note In current implementation, this method always returns "true".
bool doWakeUp() override;
private:
/// Record if any key is pressed in last update() call.
bool m_keyPressedLastUpdate;
/// Input component from which pressed keys come.
std::shared_ptr<SurgSim::Input::InputComponent> m_inputComponent;
/// A mapping between key and the graphical representation(s) it controls.
KeyboardRegistryType m_registry;
};
}; // namespace Blocks
}; // namespace SurgSim
#endif //SURGSIM_BLOCKS_KEYBOARDTOGGLESCOMPONENTBEHAVIOR_H
|