GDevelop/Core/GDCore/Project/ObjectConfiguration.h

/*
 * GDevelop Core
 * Copyright 2008-2016 Florian Rival (Florian.Rival@gmail.com). All rights
 * reserved. This project is released under the MIT License.
 */
#ifndef GDCORE_OBJECTCONFIGURATION_H
#define GDCORE_OBJECTCONFIGURATION_H
#include "GDCore/Vector2.h"
#include <map>
#include <memory>
#include <vector>

#include "GDCore/Project/Behavior.h"
#include "GDCore/Project/EffectsContainer.h"
#include "GDCore/Project/ResourcesManager.h"
#include "GDCore/Project/VariablesContainer.h"
#include "GDCore/String.h"
#include "GDCore/Tools/MakeUnique.h"
namespace gd {
class PropertyDescriptor;
class Project;
class Layout;
class ArbitraryResourceWorker;
class InitialInstance;
class SerializerElement;
class EffectsContainer;
}  // namespace gd

namespace gd {

/**
 * \brief Base class used to represent an object configuration.
 * For example, this can be the animations in a sprite, the text, its font,
 * its color in a Text object, etc...
 *
 * \ingroup PlatformDefinition
 */
class GD_CORE_API ObjectConfiguration {
 public:
  /**
   * Create a new object configuration.
   */
  ObjectConfiguration();

  /**
   * Destructor.
   */
  virtual ~ObjectConfiguration();

  /**
   * Must return a pointer to a copy of the configuration. This method is
   * needed to do polymorphic copies. Just redefine this method in your derived
   * object class like this:
   * \code
   * return gd::make_unique<MyObjectConfiguration>(*this);
   * \endcode
   */
  virtual std::unique_ptr<gd::ObjectConfiguration> Clone() const {
    return gd::make_unique<gd::ObjectConfiguration>(*this);
  }

  /** \brief Change the type of the object.
   */
  void SetType(const gd::String& type_) {
    type = type_;

    // For now, as a shortcut, consider only the objects from the built-in 3D extension
    // to be 3D object.
    is3DObject = type.find("Scene3D::") == 0;
  }

  /** \brief Return the type of the object.
   */
  const gd::String& GetType() const { return type; }

  /** \brief Shortcut to check if the object is a 3D object.
   */
  bool Is3DObject() const { return is3DObject; }

  /** \name Object properties
   * Reading and updating object configuration properties
   */
  ///@{
  /**
   * \brief Called when the IDE wants to know about the custom properties of the
   object configuration.
   *
   * Usage example:
   \code
      std::map<gd::String, gd::PropertyDescriptor> properties;
      properties[ToString(_("Text"))].SetValue("Hello world!");

      return properties;
   \endcode
   *
   * \return a std::map with properties names as key.
   * \see gd::PropertyDescriptor
   */
  virtual std::map<gd::String, gd::PropertyDescriptor> GetProperties() const;

  /**
   * \brief Called when the IDE wants to update a custom property of the object
   * configuration.
   *
   * \return false if the new value cannot be set
   */
  virtual bool UpdateProperty(const gd::String& name, const gd::String& value) {
    return false;
  };
  ///@}

  /** \name Drawing and editing initial instances
   * Members functions related to drawing and editing initial instances of this
   * object configuration
   */
  ///@{
  /**
   * \brief Called when the IDE wants to know about the custom properties of an
   * initial instance of this object configuration.
   *
   * \return a std::map with properties names as key and values.
   * \see gd::InitialInstance
   */
  virtual std::map<gd::String, gd::PropertyDescriptor>
  GetInitialInstanceProperties(const gd::InitialInstance& instance,
                               gd::Project& project,
                               gd::Layout& layout);

  /**
   * \brief Called when the IDE wants to update a custom property of an initial
   * instance of this object configuration.
   *
   * \return false if the new value cannot be set
   * \see gd::InitialInstance
   */
  virtual bool UpdateInitialInstanceProperty(gd::InitialInstance& instance,
                                             const gd::String& name,
                                             const gd::String& value,
                                             gd::Project& project,
                                             gd::Layout& layout) {
    return false;
  };
    ///@}

  /** \name Resources management
   * Members functions related to managing resources used by the object configuration
   */
  ///@{

  /**
   * \brief Called ( e.g. during compilation ) so as to inventory internal
   * resources and sometimes update their filename. Implementation example:
   * \code
   * worker.ExposeImage(myImage);
   * worker.ExposeFile(myResourceFile);
   * \endcode
   *
   * \see ArbitraryResourceWorker
   */
  virtual void ExposeResources(gd::ArbitraryResourceWorker& worker) { return; };
  ///@}

/** \name Serialization
 * Members functions related to serialization of the object configuration
 */
///@{
  /**
   * \brief Serialize the object configuration.
   * \see DoSerializeTo
   */
  void SerializeTo(SerializerElement& element) const;

  /**
   * \brief Unserialize the object configuration.
   * \see DoUnserializeFrom
   */
  void UnserializeFrom(gd::Project& project, const SerializerElement& element);
  ///@}

 protected:
  gd::String type; ///< Which type of object is represented by this
                   ///< configuration.
  bool is3DObject;

  /**
   * \brief Derived object configuration can redefine this method to load
   * custom attributes.
   */
  virtual void DoUnserializeFrom(gd::Project& project,
                                 const SerializerElement& element){};

  /**
   * \brief Derived object configuration can redefine this method to save
   * custom attributes.
   */
  virtual void DoSerializeTo(SerializerElement& element) const {};
};

}  // namespace gd

/**
 * Object configurations are usually managed thanks to (smart) pointers.
 */
using ObjConfSPtr = std::unique_ptr<gd::ObjectConfiguration>;

#endif  // GDCORE_OBJECT_H