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 
86  bool UpdateProperty(const gd::String& name, const gd::String& value) {
87  return UpdateProperty(content, name, value);
88  };
89 
94  virtual void InitializeContent() { InitializeContent(content); };
95 
99  virtual void SerializeTo(gd::SerializerElement& element) const {
100  element = content;
101  };
102 
106  virtual void UnserializeFrom(const gd::SerializerElement& element) {
107  content = element;
108  };
109 
110  const gd::SerializerElement& GetContent() const { return content; };
111  gd::SerializerElement& GetContent() { return content; };
112 
116  void SetFolded(bool fold = true) { folded = fold; }
117 
121  bool IsFolded() const { return folded; }
122 
128  QuickCustomization::Visibility visibility) {
129  quickCustomizationVisibility = visibility;
130  }
131 
137  return quickCustomizationVisibility;
138  }
139 
146  return propertiesQuickCustomizationVisibilities;
147  }
148 
155  return propertiesQuickCustomizationVisibilities;
156  }
157 
168  void ExposeResources(gd::ArbitraryResourceWorker& worker);
169 
170  protected:
186  virtual std::map<gd::String, gd::PropertyDescriptor> GetProperties(
187  const gd::SerializerElement& behaviorContent) const;
188 
196  virtual bool UpdateProperty(gd::SerializerElement& behaviorContent,
197  const gd::String& name,
198  const gd::String& value) {
199  return false;
200  };
201 
206  virtual void InitializeContent(gd::SerializerElement& behaviorContent) {};
207 
208  private:
209  gd::String name;
210  gd::String type;
212 
213  gd::SerializerElement content; // Storage for the behavior properties
214  bool folded;
215  QuickCustomization::Visibility quickCustomizationVisibility;
217  propertiesQuickCustomizationVisibilities;
218 };
219 
220 } // 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:86
const QuickCustomizationVisibilitiesContainer & GetPropertiesQuickCustomizationVisibilities() const
Get the map of properties and their visibility in the Quick Customization.
Definition: BehaviorConfigurationContainer.h:154
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:196
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:127
QuickCustomization::Visibility GetQuickCustomizationVisibility() const
Get if the whole behavior should be visible or not in the Quick Customization.
Definition: BehaviorConfigurationContainer.h:136
virtual void SerializeTo(gd::SerializerElement &element) const
Serialize the behavior content.
Definition: BehaviorConfigurationContainer.h:99
virtual void InitializeContent(gd::SerializerElement &behaviorContent)
Called to initialize the content with the default properties for the behavior.
Definition: BehaviorConfigurationContainer.h:206
QuickCustomizationVisibilitiesContainer & GetPropertiesQuickCustomizationVisibilities()
Get the map of properties and their visibility in the Quick Customization.
Definition: BehaviorConfigurationContainer.h:145
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:94
bool IsFolded() const
True if the behavior configuration panel should be folded in the UI.
Definition: BehaviorConfigurationContainer.h:121
virtual void UnserializeFrom(const gd::SerializerElement &element)
Unserialize the behavior content.
Definition: BehaviorConfigurationContainer.h:106
void SetFolded(bool fold=true)
Set if the behavior configuration panel should be folded in the UI.
Definition: BehaviorConfigurationContainer.h:116
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