/*
 * Copyright (C) 2021 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
#ifndef GZ_SIM_COMPONENTS_RECREATE_HH_
#define GZ_SIM_COMPONENTS_RECREATE_HH_

#include <gz/sim/components/Factory.hh>
#include <gz/sim/components/Component.hh>
#include <gz/sim/config.hh>

namespace gz
{
namespace sim
{
// Inline bracket to help doxygen filtering.
inline namespace GZ_SIM_VERSION_NAMESPACE {
namespace components
{
  /// \brief A component that identifies an entity needs to be recreated.
  /// Currently, only Models will be processed for recreation by the
  /// SimulationRunner in the ProcessRecreateEntitiesRemove and
  /// ProcessRecreateEntitiesCreate functions.
  ///
  /// The GUI ModelEditor contains example code on how to use this
  /// component. For example, the ModelEditor allows a user to add a link to an
  /// existing model. The existing model is tagged with this component so
  /// that it can be recreated by the server.
  using Recreate = Component<NoData, class RecreateTag>;
  GZ_SIM_REGISTER_COMPONENT("gz_sim_components.Recreate", Recreate)
}
}
}
}

#endif
