pxmlw6n2f/Gazebo_Distributed_MPI/gazebo/gui/ModelMaker.hh

92 lines
2.8 KiB
C++

/*
* Copyright (C) 2012 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 _GAZEBO_MODEL_MAKER_HH_
#define _GAZEBO_MODEL_MAKER_HH_
#include <list>
#include <string>
#include <sdf/sdf.hh>
#include "gazebo/gui/EntityMaker.hh"
#include "gazebo/util/system.hh"
namespace gazebo
{
namespace gui
{
class ModelMakerPrivate;
/// \brief Used to insert new models into the scene.
class GZ_GUI_VISIBLE ModelMaker : public EntityMaker
{
/// \enum SimpleShapes
/// \brief Unique identifiers for each simple shape supported.
public: enum SimpleShapes {
/// \brief Box
BOX,
/// \brief Sphere
SPHERE,
/// \brief Cylinder
CYLINDER
};
/// \brief Constructor
public: ModelMaker();
/// \brief Destructor
public: ~ModelMaker();
// Documentation inherited
public: virtual void Stop();
/// \brief Initialize the model maker with an existing model
/// \param[in] _modelName Name of existing model in the scene.
/// \return True if initialization is successful.
public: bool InitFromModel(const std::string &_modelName);
/// \brief Initialize the model maker from a file.
/// \param[in] _filename Path to the file.
/// \return True if initialization is successful.
public: bool InitFromFile(const std::string &_filename);
/// \brief Initialize the model maker to make one of the supported simple
/// shapes.
/// \param[in] _shape The desired shape.
/// \return True if initialization is successful.
public: bool InitSimpleShape(SimpleShapes _shape);
// Documentation inherited
public: virtual ignition::math::Vector3d EntityPosition() const;
// Documentation inherited
protected: virtual void SetEntityPosition(
const ignition::math::Vector3d &_pos);
/// \brief Internal init function.
private: bool Init();
/// \brief Create the model visual from model SDF
/// \param[in] _modelElem Root model SDF element.
private: void CreateModelFromSDF(sdf::ElementPtr _modelElem);
/// \brief Publish a factory message to create the entity.
private: virtual void CreateTheEntity();
};
}
}
#endif