GDevelop Core
Core library for developing platforms and tools compatible with GDevelop.
BehaviorConfigurationContainer.h
1 /*
2  * GDevelop Core
3  * Copyright 2008-2016 Florian Rival ([email protected]). All rights
4  * reserved. This project is released under the MIT License.
5  */
6 #pragma once
7 
8 #include <map>
9 #include <memory>
10 
11 #include "GDCore/Project/QuickCustomization.h"
12 #include "GDCore/Project/QuickCustomizationVisibilitiesContainer.h"
13 #include "GDCore/Serialization/Serializer.h"
14 #include "GDCore/String.h"
15 
16 namespace gd {
17 class PropertyDescriptor;
18 class SerializerElement;
19 class Project;
20 class Layout;
21 class ArbitraryResourceWorker;
22 } // namespace gd
23 
24 namespace gd {
25 
35 class GD_CORE_API BehaviorConfigurationContainer {
36  public:
38  : folded(false),
39  quickCustomizationVisibility(QuickCustomization::Visibility::Default),
40  propertiesQuickCustomizationVisibilities() {};
42  const gd::String& type_)
43  : name(name_),
44  type(type_),
45  folded(false),
46  quickCustomizationVisibility(QuickCustomization::Visibility::Default),
47  propertiesQuickCustomizationVisibilities() {};
49 
53  const gd::String& GetName() const { return name; }
54 
58  void SetName(const gd::String& name_) { name = name_; }
59 
63  const gd::String& GetTypeName() const { return type; }
64 
68  void SetTypeName(const gd::String& type_) { type = type_; };
69 
77  std::map<gd::String, gd::PropertyDescriptor> GetProperties() const;
78 
85  bool UpdateProperty(const gd::String& name, const gd::String& value) {
86  return UpdateProperty(content, name, value);
87  };
88 
95  virtual bool RenameProperty(const gd::String &oldName,
96  const gd::String &newName) {
97  return RenameProperty(content, oldName, newName);
98  };
99 
106  void RemoveProperty(const gd::String &name) {
107  content.RemoveChild(name);
108  content.RemoveAttribute(name);
109  };
110 
116  bool HasPropertyValue(const gd::String name) const {
117  return content.HasChild(name) || content.HasAttribute(name);
118  }
119 
124  virtual void InitializeContent() {
125  InitializeContent(content);
126  };
127 
133  void ClearContent() {
134  content.Clear();
135  };
136 
140  virtual void SerializeTo(gd::SerializerElement& element) const {
141  element = content;
142  };
143 
147  virtual void UnserializeFrom(const gd::SerializerElement& element) {
148  content = element;
149  };
150 
151  const gd::SerializerElement& GetContent() const { return content; };
152  gd::SerializerElement& GetContent() { return content; };
153 
157  void SetFolded(bool fold = true) { folded = fold; }
158 
162  bool IsFolded() const { return folded; }
163 
169  QuickCustomization::Visibility visibility) {
170  quickCustomizationVisibility = visibility;
171  }
172 
178  return quickCustomizationVisibility;
179  }
180 
187  return propertiesQuickCustomizationVisibilities;
188  }
189 
196  return propertiesQuickCustomizationVisibilities;
197  }
198 
209  void ExposeResources(gd::ArbitraryResourceWorker& worker);
210 
211  protected:
227  virtual std::map<gd::String, gd::PropertyDescriptor> GetProperties(
228  const gd::SerializerElement& behaviorContent) const;
229 
236  virtual bool UpdateProperty(gd::SerializerElement& behaviorContent,
237  const gd::String& name,
238  const gd::String& value) {
239  return false;
240  };
241 
248  virtual bool RenameProperty(gd::SerializerElement &behaviorContent,
249  const gd::String &oldName,
250  const gd::String &newName) {
251  return false;
252  };
253 
258  virtual void InitializeContent(gd::SerializerElement& behaviorContent) {};
259 
260  private:
261  gd::String name;
262  gd::String type;
264 
265  gd::SerializerElement content; // Storage for the behavior properties
266  bool folded;
267  QuickCustomization::Visibility quickCustomizationVisibility;
269  propertiesQuickCustomizationVisibilities;
270 };
271 
272 } // namespace gd
ArbitraryResourceWorker is used so as to inventory resources and sometimes update them.
Definition: ArbitraryResourceWorker.h:44
Base class for containers of behavior configuration. They can be attached to objects (Behavior) or la...
Definition: BehaviorConfigurationContainer.h:35
bool UpdateProperty(const gd::String &name, const gd::String &value)
Called when the IDE wants to update a custom property of the behavior.
Definition: BehaviorConfigurationContainer.h:85
const QuickCustomizationVisibilitiesContainer & GetPropertiesQuickCustomizationVisibilities() const
Get the map of properties and their visibility in the Quick Customization.
Definition: BehaviorConfigurationContainer.h:195
void RemoveProperty(const gd::String &name)
Called when the IDE wants to remove a custom property from the behavior.
Definition: BehaviorConfigurationContainer.h:106
virtual bool RenameProperty(gd::SerializerElement &behaviorContent, const gd::String &oldName, const gd::String &newName)
Called when the IDE wants to rename a custom property of the object configuration.
Definition: BehaviorConfigurationContainer.h:248
bool HasPropertyValue(const gd::String name) const
Called to check if a property is overriden.
Definition: BehaviorConfigurationContainer.h:116
void SetName(const gd::String &name_)
Change the name identifying the behavior.
Definition: BehaviorConfigurationContainer.h:58
const gd::String & GetTypeName() const
Return the type of the behavior.
Definition: BehaviorConfigurationContainer.h:63
virtual bool UpdateProperty(gd::SerializerElement &behaviorContent, const gd::String &name, const gd::String &value)
Called when the IDE wants to update a custom property of the behavior.
Definition: BehaviorConfigurationContainer.h:236
const gd::String & GetName() const
Return the name identifying the behavior.
Definition: BehaviorConfigurationContainer.h:53
void SetQuickCustomizationVisibility(QuickCustomization::Visibility visibility)
Set if the whole behavior should be visible or not in the Quick Customization.
Definition: BehaviorConfigurationContainer.h:168
QuickCustomization::Visibility GetQuickCustomizationVisibility() const
Get if the whole behavior should be visible or not in the Quick Customization.
Definition: BehaviorConfigurationContainer.h:177
virtual void SerializeTo(gd::SerializerElement &element) const
Serialize the behavior content.
Definition: BehaviorConfigurationContainer.h:140
virtual void InitializeContent(gd::SerializerElement &behaviorContent)
Called to initialize the content with the default properties for the behavior.
Definition: BehaviorConfigurationContainer.h:258
QuickCustomizationVisibilitiesContainer & GetPropertiesQuickCustomizationVisibilities()
Get the map of properties and their visibility in the Quick Customization.
Definition: BehaviorConfigurationContainer.h:186
void SetTypeName(const gd::String &type_)
Set the type of the behavior.
Definition: BehaviorConfigurationContainer.h:68
virtual void InitializeContent()
Called to initialize the content with the default properties for the behavior.
Definition: BehaviorConfigurationContainer.h:124
bool IsFolded() const
True if the behavior configuration panel should be folded in the UI.
Definition: BehaviorConfigurationContainer.h:162
virtual void UnserializeFrom(const gd::SerializerElement &element)
Unserialize the behavior content.
Definition: BehaviorConfigurationContainer.h:147
void ClearContent()
Called to remove all properties values for the behavior.
Definition: BehaviorConfigurationContainer.h:133
void SetFolded(bool fold=true)
Set if the behavior configuration panel should be folded in the UI.
Definition: BehaviorConfigurationContainer.h:157
virtual bool RenameProperty(const gd::String &oldName, const gd::String &newName)
Called when the IDE wants to rename a custom property of the object configuration.
Definition: BehaviorConfigurationContainer.h:95
Visibility
Definition: QuickCustomization.h:8
Definition: QuickCustomizationVisibilitiesContainer.h:11
A generic container that can represent a value ( containing a string, double, bool or int),...
Definition: SerializerElement.h:37
String represents an UTF8 encoded string.
Definition: String.h:33
Definition: CommonTools.h:24