GDevelop Core
Core library for developing platforms and tools compatible with GDevelop.
EventsBasedObject.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 <vector>
9 #include "GDCore/Project/AbstractEventsBasedEntity.h"
10 #include "GDCore/Project/EventsBasedObjectVariant.h"
11 #include "GDCore/Project/EventsBasedObjectVariantsContainer.h"
12 #include "GDCore/Project/ObjectsContainer.h"
13 #include "GDCore/Project/InitialInstancesContainer.h"
14 #include "GDCore/Project/LayersContainer.h"
15 #include "GDCore/String.h"
16 namespace gd {
17 class SerializerElement;
18 class Project;
19 } // namespace gd
20 
21 namespace gd {
22 // TODO EBO Add a way to mark some parts of children configuration as readonly.
32 class GD_CORE_API EventsBasedObject: public AbstractEventsBasedEntity {
33  public:
35  virtual ~EventsBasedObject();
36 
41  EventsBasedObject* Clone() const { return new EventsBasedObject(*this); };
42 
46  const gd::String& GetDefaultName() const { return defaultName; };
47 
52  defaultName = defaultName_;
53  return *this;
54  }
55 
56  EventsBasedObject& SetDescription(const gd::String& description_) override {
58  return *this;
59  }
60 
66  return *this;
67  }
68 
74  return *this;
75  }
76 
81  const gd::String& GetAssetStoreTag() const { return assetStoreTag; }
82 
87  EventsBasedObject &SetAssetStoreTag(const gd::String& assetStoreTag_) {
88  assetStoreTag = assetStoreTag_;
89  return *this;
90  }
91 
96  EventsBasedObject& SetPrivate(bool isPrivate) {
98  return *this;
99  }
100 
104  EventsBasedObject& MarkAsRenderedIn3D(bool isRenderedIn3D_) {
105  isRenderedIn3D = isRenderedIn3D_;
106  return *this;
107  }
108 
112  bool IsRenderedIn3D() const { return isRenderedIn3D; }
113 
117  EventsBasedObject& MarkAsAnimatable(bool isAnimatable_) {
118  isAnimatable = isAnimatable_;
119  return *this;
120  }
121 
125  bool IsAnimatable() const { return isAnimatable; }
126 
130  EventsBasedObject &MarkAsTextContainer(bool isTextContainer_) {
131  isTextContainer = isTextContainer_;
132  return *this;
133  }
134 
140  MarkAsInnerAreaFollowingParentSize(bool isInnerAreaExpandingWithParent_) {
141  isInnerAreaFollowingParentSize = isInnerAreaExpandingWithParent_;
142  return *this;
143  }
144 
156  return isInnerAreaFollowingParentSize;
157  }
158 
164  MakAsUsingLegacyInstancesRenderer(bool isUsingLegacyInstancesRenderer_) {
165  isUsingLegacyInstancesRenderer = isUsingLegacyInstancesRenderer_;
166  return *this;
167  }
168 
174  return isUsingLegacyInstancesRenderer;
175  }
176 
180  bool IsTextContainer() const { return isTextContainer; }
181 
185  const gd::EventsBasedObjectVariant& GetDefaultVariant() const { return defaultVariant; }
186 
190  gd::EventsBasedObjectVariant& GetDefaultVariant() { return defaultVariant; }
191 
195  const gd::EventsBasedObjectVariantsContainer& GetVariants() const { return variants; }
196 
201 
205 
208  const gd::LayersContainer& GetLayers() const { return defaultVariant.GetLayers(); }
209 
213  gd::LayersContainer& GetLayers() { return defaultVariant.GetLayers(); }
215 
219 
223  return defaultVariant.GetObjects();
224  }
225 
230  return defaultVariant.GetObjects();
231  }
233 
237 
241  return defaultVariant.GetInitialInstances();
242  }
243 
248  return defaultVariant.GetInitialInstances();
249  }
250 
258  int GetAreaMinX() const {
259  return defaultVariant.GetAreaMinX();
260  }
261 
265  void SetAreaMinX(int areaMinX) {
266  defaultVariant.SetAreaMinX(areaMinX);
267  }
268 
276  int GetAreaMinY() const {
277  return defaultVariant.GetAreaMinY();
278  }
279 
283  void SetAreaMinY(int areaMinY) {
284  defaultVariant.SetAreaMinY(areaMinY);
285  }
286 
294  int GetAreaMinZ() const {
295  return defaultVariant.GetAreaMinZ();
296  }
297 
301  void SetAreaMinZ(int areaMinZ) {
302  defaultVariant.SetAreaMinZ(areaMinZ);
303  }
304 
312  int GetAreaMaxX() const {
313  return defaultVariant.GetAreaMaxX();
314  }
315 
319  void SetAreaMaxX(int areaMaxX) {
320  defaultVariant.SetAreaMaxX(areaMaxX);
321  }
322 
330  int GetAreaMaxY() const {
331  return defaultVariant.GetAreaMaxY();
332  }
333 
337  void SetAreaMaxY(int areaMaxY) {
338  defaultVariant.SetAreaMaxY(areaMaxY);
339  }
340 
348  int GetAreaMaxZ() const {
349  return defaultVariant.GetAreaMaxZ();
350  }
351 
355  void SetAreaMaxZ(int areaMaxZ) {
356  defaultVariant.SetAreaMaxZ(areaMaxZ);
357  }
359 
364  void SerializeToExternal(SerializerElement& element) const;
365 
366  void SerializeTo(SerializerElement& element) const override;
367 
368  void UnserializeFrom(gd::Project& project,
369  const SerializerElement& element) override;
370 
371  private:
372  gd::String defaultName;
373  gd::String assetStoreTag;
374  bool isRenderedIn3D;
375  bool isAnimatable;
376  bool isTextContainer;
377  bool isInnerAreaFollowingParentSize;
378  bool isUsingLegacyInstancesRenderer;
379  gd::EventsBasedObjectVariant defaultVariant;
381 };
382 
383 } // namespace gd
Represents a behavior or an object that is implemented with events.
Definition: AbstractEventsBasedEntity.h:29
AbstractEventsBasedEntity & SetPrivate(bool isPrivate_)
Set that the behavior or object is private - it can't be used outside of its extension.
Definition: AbstractEventsBasedEntity.h:52
virtual AbstractEventsBasedEntity & SetDescription(const gd::String &description_)
Set the description of the behavior or object, to be displayed in the editor.
Definition: AbstractEventsBasedEntity.h:66
AbstractEventsBasedEntity & SetName(const gd::String &name_)
Set the internal name of the behavior or object.
Definition: AbstractEventsBasedEntity.h:79
AbstractEventsBasedEntity & SetFullName(const gd::String &fullName_)
Set the name of the behavior or object, to be displayed in the editor.
Definition: AbstractEventsBasedEntity.h:92
Represents an object that is implemented with events.
Definition: EventsBasedObject.h:32
const gd::ObjectsContainer & GetObjects() const
Get the objects of the custom object.
Definition: EventsBasedObject.h:229
EventsBasedObject & MarkAsInnerAreaFollowingParentSize(bool isInnerAreaExpandingWithParent_)
Declare that the parent scale will always be 1 and children will adapt there size....
Definition: EventsBasedObject.h:140
EventsBasedObject * Clone() const
Return a pointer to a new EventsBasedObject constructed from this one.
Definition: EventsBasedObject.h:41
void SetAreaMaxY(int areaMaxY)
Set the bottom bound of the custom object.
Definition: EventsBasedObject.h:337
bool IsInnerAreaFollowingParentSize() const
Return true if objects handle size changes on their own and don't have the ScalableCapability.
Definition: EventsBasedObject.h:155
int GetAreaMinX() const
Get the left bound of the custom object.
Definition: EventsBasedObject.h:258
bool IsUsingLegacyInstancesRenderer() const
Return true if custom object are rendered using their child-objects instead of their child-instances.
Definition: EventsBasedObject.h:173
bool IsTextContainer() const
Return true if the object needs a TextContainer capability.
Definition: EventsBasedObject.h:180
gd::LayersContainer & GetLayers()
Get the layers of the custom object.
Definition: EventsBasedObject.h:213
EventsBasedObject & SetName(const gd::String &name_)
Set the internal name of the object.
Definition: EventsBasedObject.h:64
int GetAreaMinZ() const
Get the min Z bound of the custom object.
Definition: EventsBasedObject.h:294
gd::EventsBasedObjectVariant & GetDefaultVariant()
Get the default variant of the custom object.
Definition: EventsBasedObject.h:190
void SetAreaMaxX(int areaMaxX)
Set the right bound of the custom object.
Definition: EventsBasedObject.h:319
const gd::EventsBasedObjectVariantsContainer & GetVariants() const
Get the variants of the custom object.
Definition: EventsBasedObject.h:195
EventsBasedObject & SetDefaultName(const gd::String &defaultName_)
Set the default name for created objects.
Definition: EventsBasedObject.h:51
const gd::String & GetDefaultName() const
Get the default name for created objects.
Definition: EventsBasedObject.h:46
int GetAreaMaxX() const
Get the right bound of the custom object.
Definition: EventsBasedObject.h:312
int GetAreaMinY() const
Get the top bound of the custom object.
Definition: EventsBasedObject.h:276
const gd::EventsBasedObjectVariant & GetDefaultVariant() const
Get the default variant of the custom object.
Definition: EventsBasedObject.h:185
EventsBasedObject & SetFullName(const gd::String &fullName_)
Set the name of the object, to be displayed in the editor.
Definition: EventsBasedObject.h:72
bool IsRenderedIn3D() const
Return true if the object uses the 3D renderer.
Definition: EventsBasedObject.h:112
EventsBasedObject & SetAssetStoreTag(const gd::String &assetStoreTag_)
Set the tag from which to choose assets from when creating a new object.
Definition: EventsBasedObject.h:87
void SetAreaMinY(int areaMinY)
Set the top bound of the custom object.
Definition: EventsBasedObject.h:283
int GetAreaMaxY() const
Get the bottom bound of the custom object.
Definition: EventsBasedObject.h:330
EventsBasedObject & MarkAsRenderedIn3D(bool isRenderedIn3D_)
Declare a usage of the 3D renderer.
Definition: EventsBasedObject.h:104
gd::ObjectsContainer & GetObjects()
Get the objects of the custom object.
Definition: EventsBasedObject.h:222
void SetAreaMinX(int areaMinX)
Set the left bound of the custom object.
Definition: EventsBasedObject.h:265
gd::InitialInstancesContainer & GetInitialInstances()
Get the instances of the custom object.
Definition: EventsBasedObject.h:240
EventsBasedObject & SetPrivate(bool isPrivate)
Set that the object is private - it can't be used outside of its extension.
Definition: EventsBasedObject.h:96
EventsBasedObject & SetDescription(const gd::String &description_) override
Set the description of the behavior or object, to be displayed in the editor.
Definition: EventsBasedObject.h:56
const gd::LayersContainer & GetLayers() const
Get the layers of the custom object.
Definition: EventsBasedObject.h:208
EventsBasedObject & MarkAsTextContainer(bool isTextContainer_)
Declare a TextContainer capability.
Definition: EventsBasedObject.h:130
void SetAreaMaxZ(int areaMaxZ)
Set the bottom bound of the custom object.
Definition: EventsBasedObject.h:355
void SetAreaMinZ(int areaMinZ)
Set the min Z bound of the custom object.
Definition: EventsBasedObject.h:301
gd::EventsBasedObjectVariantsContainer & GetVariants()
Get the variants of the custom object.
Definition: EventsBasedObject.h:200
bool IsAnimatable() const
Return true if the object needs an Animatable capability.
Definition: EventsBasedObject.h:125
int GetAreaMaxZ() const
Get the max Z bound of the custom object.
Definition: EventsBasedObject.h:348
EventsBasedObject & MarkAsAnimatable(bool isAnimatable_)
Declare an Animatable capability.
Definition: EventsBasedObject.h:117
EventsBasedObject & MakAsUsingLegacyInstancesRenderer(bool isUsingLegacyInstancesRenderer_)
Declare that custom object are rendered using their child-objects instead of their child-instances.
Definition: EventsBasedObject.h:164
const gd::String & GetAssetStoreTag() const
Get the tag from which to choose assets from when creating a new object.
Definition: EventsBasedObject.h:81
const gd::InitialInstancesContainer & GetInitialInstances() const
Get the instances of the custom object.
Definition: EventsBasedObject.h:247
Represents a variation of style of an events-based object.
Definition: EventsBasedObjectVariant.h:26
Used as a base class for classes that will own events-backed variants.
Definition: EventsBasedObjectVariantsContainer.h:27
Defines a container of gd::InitialInstances.
Definition: InitialInstancesContainer.h:38
Contains the layers for a scene or a custom object.
Definition: LayersContainer.h:21
Used as a base class for classes that will own objects (see gd::Object).
Definition: ObjectsContainer.h:37
std::vector< std::unique_ptr< gd::Object > > & GetObjects()
Definition: ObjectsContainer.h:177
Base class representing a project (game), including all resources, scenes, objects,...
Definition: Project.h:50
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