SceneGroupManager.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 #include <string>
27 #include <vector>
28 
29 #include "Scene.h"
30 #include "SceneGroup.h"
31 
32 namespace scene3D
33 {
35  {
36  public:
37  /**
38  * Returns all SceneGroups.
39  *
40  * @return vector<scene3D::SceneGroupPtr> All Groups
41  */
42  std::vector<scene3D::SceneGroupPtr> getAllGroups();
43 
44  /**
45  * Returns a SceneGroup specified by an ID.
46  *
47  * @param groupId ID specifying the SceneGroup
48  * @return scene3D::SceneGroup SceneGroup found
49  */
50  scene3D::SceneGroupPtr getGroupById(std::string groupId);
51 
52  /**
53  * Adds a SceneGroup.
54  *
55  * @param group SceneGroup to be added.
56  */
57  void addGroup(SceneGroupPtr group);
58 
59  /**
60  * Removes a SceneGroup.
61  *
62  * @param group SceneGroup to be removed
63  */
65 
66  /**
67  * Renames a SceneGroup.
68  *
69  * @param group SceneGroup to be renamed
70  * @param newGroupId New ID
71  */
72  void renameGroup(scene3D::SceneGroupPtr group, std::string newGroupId);
73 
74  private:
75  std::vector<scene3D::SceneGroupPtr> sceneGroups;
76  };
77 }
78 
79 
scene3D::SceneGroupManager::removeGroup
void removeGroup(scene3D::SceneGroupPtr group)
Removes a SceneGroup.
Definition: SceneGroupManager.cpp:58
scene3D::SceneGroupManager::getAllGroups
std::vector< scene3D::SceneGroupPtr > getAllGroups()
Returns all SceneGroups.
Definition: SceneGroupManager.cpp:28
scene3D::SceneGroupManager::renameGroup
void renameGroup(scene3D::SceneGroupPtr group, std::string newGroupId)
Renames a SceneGroup.
Definition: SceneGroupManager.cpp:78
scene3D::SceneGroupManager::getGroupById
scene3D::SceneGroupPtr getGroupById(std::string groupId)
Returns a SceneGroup specified by an ID.
Definition: SceneGroupManager.cpp:33
scene3D::SceneGroupManager
Definition: SceneGroupManager.h:34
Scene.h
scene3D
Definition: ManipulatorMode.h:26
scene3D::SceneGroupPtr
std::shared_ptr< SceneGroup > SceneGroupPtr
Definition: PointerDefinitions.h:53
SceneGroup.h
scene3D::SceneGroupManager::addGroup
void addGroup(SceneGroupPtr group)
Adds a SceneGroup.
Definition: SceneGroupManager.cpp:46