RigidModel.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_RIGIDMODEL_H_
#define _MIRA_RIGIDMODEL_H_

#include <fw/Framework.h>

#include <serialization/Serialization.h>
#include <serialization/adapters/std/map>
#include <serialization/adapters/std/list>
#include <serialization/adapters/boost/shared_ptr.hpp>

#include <model/Link.h>
#include <model/Joint.h>
#include <model/Footprint.h>

namespace mira { namespace model {


class MIRA_RIGID_MODEL_EXPORT RigidModel : public Object
{
    MIRA_OBJECT(RigidModel)
public:
    
    typedef std::list<LinkPtr> LinkList;
    typedef std::map<std::string, JointPtr> JointMap;
    typedef std::map<std::string, MaterialPtr> MaterialMap;

    virtual ~RigidModel() {}

    template<typename Reflector>
    void reflect(Reflector& r)
    {
        r.member("Name", name, "The name of this model", "");
        r.member("Links", links, "The links of this model", LinkList());
        r.member("Joints", joints, "The joints of this model", JointMap());
        r.member("Materials", materials, "The materials of this model", MaterialMap());
    }

    void reflect(XMLDeserializer& r);

    void clear();

    std::string getRootLink() const;

    typedef std::list<std::pair<GeometryPtr, RigidTransform3f>,
                      Eigen::aligned_allocator<std::pair<GeometryPtr, RigidTransform3f>>> CollisionGeometries;

    CollisionGeometries getCollisionGeometries(std::string targetFrame="",
                                               const Time& timestamp = Time::now(),
                                               const std::string& filter = "") const;

    std::list<Box3f> getCollisionBoundingBoxes(std::string targetFrame="",
                                               const Time& timestamp = Time::now(),
                                               const std::string& filter = "") const;

    Footprint getFootprint(std::string targetFrame = "",
                           const Time& timestamp = Time::now(),
                           const std::string& filter = "") const;

    void resolveAndPublishLinks(const std::string& ns,
                                const Time& timestamp = Time::now());

    void publishJoint(const std::string& name, float value,
                      const Time& timestamp = Time::now()) const;

    std::string name;       
    LinkList links;         
    JointMap joints;        
    MaterialMap materials;  
};

typedef boost::shared_ptr<RigidModel> RigidModelPtr;


}}

#endif