SelectOperation.h
Go to the documentation of this file.
1 /*
2  * This file is part of ArmarX.
3  *
4  * Copyright (C) 2012-2016, High Performance Humanoid Technologies (H2T), Karlsruhe Institute of Technology (KIT), all rights reserved.
5  *
6  * ArmarX is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation.
9  *
10  * ArmarX is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
17  *
18  * @package MemoryX::gui-plugins::SceneEditor
19  * @date 2015
20  * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
21  * GNU General Public License
22  */
23 
24 #pragma once
25 
26 // std
27 #include <exception>
28 #include <string>
29 
30 // local
31 #include "../scene3D/Scene.h"
32 #include "Operation.h"
33 
34 namespace controller
35 {
36  /**
37  * A operation to select a object.
38  *
39  * @see controller::Operation
40  */
41  class SelectOperation : public Operation
42  {
43  public:
44  /**
45  * Creates a new operation, which selects a object.
46  *
47  * @param memoryXController The MemoryXController to select the object at. (This is currently not used.)
48  * @param scene The scene to select the object at.
49  * @param objectId The ID of the object to select.
50  *
51  * @see controller::Operation::Operation
52  */
53  SelectOperation(const std::shared_ptr<memoryxcontroller::MemoryXController>& memoryXController, const std::shared_ptr<scene3D::Scene>& scene, const std::string& objectId);
54 
55  /**
56  * Returns a new operation, which deselects the object again.
57  *
58  * @return The operation, which deselects the object again.
59  *
60  * @see controller::Operation::createInverseOperation
61  */
62  const OperationPtr createInverseOperation() const override;
63 
64  protected:
65  /**
66  * Because the WorkingMemory does not support selection, nothing is done on the WorkingMemory.
67  *
68  * @see controller::Operation::executeOnWorkingMemory
69  */
70  void executeOnWorkingMemory() override;
71 
72  /**
73  * Selects the object.
74  *
75  * @see controller::Operation::executeOnScene
76  */
77  void executeOnScene() override;
78 
79  private:
80  bool wasSelected;
81  };
82 }
83 
controller::SelectOperation::SelectOperation
SelectOperation(const std::shared_ptr< memoryxcontroller::MemoryXController > &memoryXController, const std::shared_ptr< scene3D::Scene > &scene, const std::string &objectId)
Creates a new operation, which selects a object.
Definition: SelectOperation.cpp:34
controller::SelectOperation::executeOnWorkingMemory
void executeOnWorkingMemory() override
Because the WorkingMemory does not support selection, nothing is done on the WorkingMemory.
Definition: SelectOperation.cpp:54
Operation.h
controller::SelectOperation::createInverseOperation
const OperationPtr createInverseOperation() const override
Returns a new operation, which deselects the object again.
Definition: SelectOperation.cpp:40
controller
Definition: AddOperation.h:39
controller::SelectOperation
A operation to select a object.
Definition: SelectOperation.h:41
controller::SelectOperation::executeOnScene
void executeOnScene() override
Selects the object.
Definition: SelectOperation.cpp:59
controller::OperationPtr
std::shared_ptr< Operation > OperationPtr
Definition: ClassDefinitions.h:54
controller::Operation
An abstract class, which offers methods to run operations on the WorkingMemory and the Scene.
Definition: Operation.h:44