GDevelop Core
Core library for developing platforms and tools compatible with GDevelop.
CustomObjectConfiguration.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 "GDCore/Project/ObjectConfiguration.h"
9 
10 #include <map>
11 #include <memory>
12 #include <unordered_set>
13 #include "GDCore/Project/Object.h"
14 #include "GDCore/Project/Project.h"
15 #include "GDCore/Project/EventsBasedObject.h"
16 #include "GDCore/Project/PropertyDescriptor.h"
17 #include "GDCore/Serialization/Serializer.h"
18 #include "GDCore/Serialization/SerializerElement.h"
19 #include "GDCore/Extensions/Builtin/SpriteExtension/SpriteAnimationList.h"
20 
21 using namespace gd;
22 
23 namespace gd {
32  public:
33  CustomObjectConfiguration(const Project& project_, const String& type_)
34  : project(&project_), isMarkedAsOverridingEventsBasedObjectChildrenConfiguration(false) {
35  SetType(type_);
36  }
37  std::unique_ptr<gd::ObjectConfiguration> Clone() const override;
38 
43  : ObjectConfiguration(object) {
44  Init(object);
45  };
46 
51  if ((this) != &object) {
52  ObjectConfiguration::operator=(object);
53  Init(object);
54  }
55  return *this;
56  }
57 
58  std::map<gd::String, gd::PropertyDescriptor> GetProperties() const override;
59  bool UpdateProperty(const gd::String& name, const gd::String& value) override;
60 
61  std::map<gd::String, gd::PropertyDescriptor> GetInitialInstanceProperties(
62  const gd::InitialInstance& instance) override;
64  const gd::String& name,
65  const gd::String& value) override;
66 
67  void ExposeResources(gd::ArbitraryResourceWorker& worker) override;
68 
69  bool IsForcedToOverrideEventsBasedObjectChildrenConfiguration() const;
70 
71  bool IsMarkedAsOverridingEventsBasedObjectChildrenConfiguration() const {
72  return isMarkedAsOverridingEventsBasedObjectChildrenConfiguration;
73  }
74 
75  void SetMarkedAsOverridingEventsBasedObjectChildrenConfiguration(
76  bool isOverridingEventsBasedObjectChildrenConfiguration_) {
77  isMarkedAsOverridingEventsBasedObjectChildrenConfiguration =
78  isOverridingEventsBasedObjectChildrenConfiguration_;
79  }
80 
81  void ClearChildrenConfiguration();
82 
84  GetChildObjectConfiguration(const gd::String &objectName);
85 
86  std::size_t GetAnimationsCount() const override;
87 
88  const gd::String &GetAnimationName(size_t index) const override;
89 
90  bool HasAnimationNamed(const gd::String &animationName) const override;
91 
95  const SpriteAnimationList& GetAnimations() const;
96 
101 
102  enum EdgeAnchor {
103  NoAnchor = 0,
104  MinEdge = 1,
105  MaxEdge = 2,
106  Proportional = 3,
107  Center = 4,
108  };
109 
110  static const gd::CustomObjectConfiguration::EdgeAnchor
111  GetEdgeAnchorFromString(const gd::String &value);
112 
118  bool IsChildObjectFolded(const gd::String& childName) const {
119  return unfoldedChildren.find(childName) == unfoldedChildren.end();
120  }
121 
127  void SetChildObjectFolded(const gd::String& childName, bool folded) {
128  if (!folded)
129  unfoldedChildren.insert(childName);
130  else
131  unfoldedChildren.erase(childName);
132  }
133 
134 protected:
135  void DoSerializeTo(SerializerElement& element) const override;
136  void DoUnserializeFrom(Project& project, const SerializerElement& element) override;
137 
138  private:
139  const gd::EventsBasedObject* GetEventsBasedObject() const;
140 
141  bool IsOverridingEventsBasedObjectChildrenConfiguration() const;
142 
143  const Project* project = nullptr;
145  gd::SerializerElement objectContent;
146  std::unordered_set<gd::String> unfoldedChildren;
147 
148  bool isMarkedAsOverridingEventsBasedObjectChildrenConfiguration = false;
149  mutable std::map<gd::String, std::unique_ptr<gd::ObjectConfiguration>> childObjectConfigurations;
150 
151  static gd::ObjectConfiguration badObjectConfiguration;
152 
153  SpriteAnimationList animations;
154 
164  void Init(const gd::CustomObjectConfiguration& object);
165 };
166 
167 } // namespace gd
ArbitraryResourceWorker is used so as to inventory resources and sometimes update them.
Definition: ArbitraryResourceWorker.h:44
A gd::ObjectConfiguration that stores its content in JSON and is composed of other configuration acco...
Definition: CustomObjectConfiguration.h:31
void SetChildObjectFolded(const gd::String &childName, bool folded)
Definition: CustomObjectConfiguration.h:127
void ExposeResources(gd::ArbitraryResourceWorker &worker) override
Called ( e.g. during compilation ) so as to inventory internal resources and sometimes update their f...
Definition: CustomObjectConfiguration.cpp:200
bool UpdateProperty(const gd::String &name, const gd::String &value) override
Called when the IDE wants to update a custom property of the object configuration.
Definition: CustomObjectConfiguration.cpp:118
void DoUnserializeFrom(Project &project, const SerializerElement &element) override
Derived object configuration can redefine this method to load custom attributes.
Definition: CustomObjectConfiguration.cpp:178
void DoSerializeTo(SerializerElement &element) const override
Derived object configuration can redefine this method to save custom attributes.
Definition: CustomObjectConfiguration.cpp:158
std::size_t GetAnimationsCount() const override
Return the number of animations declared in this object configuration.
Definition: CustomObjectConfiguration.cpp:256
CustomObjectConfiguration(const gd::CustomObjectConfiguration &object)
Definition: CustomObjectConfiguration.h:42
std::map< gd::String, gd::PropertyDescriptor > GetProperties() const override
Called when the IDE wants to know about the custom properties of the object configuration.
Definition: CustomObjectConfiguration.cpp:107
const SpriteAnimationList & GetAnimations() const
Return the animation configuration for Animatable custom objects.
Definition: CustomObjectConfiguration.cpp:270
bool IsChildObjectFolded(const gd::String &childName) const
Definition: CustomObjectConfiguration.h:118
std::map< gd::String, gd::PropertyDescriptor > GetInitialInstanceProperties(const gd::InitialInstance &instance) override
Called when the IDE wants to know about the custom properties of an initial instance of this object c...
Definition: CustomObjectConfiguration.cpp:134
CustomObjectConfiguration & operator=(const gd::CustomObjectConfiguration &object)
Definition: CustomObjectConfiguration.h:50
const gd::String & GetAnimationName(size_t index) const override
Return the name of an animation declared in this object configuration.
Definition: CustomObjectConfiguration.cpp:261
bool UpdateInitialInstanceProperty(gd::InitialInstance &instance, const gd::String &name, const gd::String &value) override
Called when the IDE wants to update a custom property of an initial instance of this object configura...
Definition: CustomObjectConfiguration.cpp:147
bool HasAnimationNamed(const gd::String &animationName) const override
Return true if an animation is declared in this object configuration for a given name.
Definition: CustomObjectConfiguration.cpp:265
std::unique_ptr< gd::ObjectConfiguration > Clone() const override
Definition: CustomObjectConfiguration.cpp:37
Represents an object that is implemented with events.
Definition: EventsBasedObject.h:30
Represents an instance of an object to be created on a layout start up.
Definition: InitialInstance.h:26
Base class used to represent an object configuration. For example, this can be the animations in a sp...
Definition: ObjectConfiguration.h:38
void SetType(const gd::String &type_)
Change the type of the object.
Definition: ObjectConfiguration.h:64
Base class representing a project (game), including all resources, scenes, objects,...
Definition: Project.h:51
A generic container that can represent a value ( containing a string, double, bool or int),...
Definition: SerializerElement.h:37
A list of animations, containing directions with images and collision mask.
Definition: SpriteAnimationList.h:30
String represents an UTF8 encoded string.
Definition: String.h:33
Definition: CommonTools.h:24