collision_object.h

Go to the documentation of this file.

/*
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2011-2014, Willow Garage, Inc.
 *  Copyright (c) 2014-2016, Open Source Robotics Foundation
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   * Neither the name of Open Source Robotics Foundation nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef FCL_COLLISION_OBJECT_H
#define FCL_COLLISION_OBJECT_H

#include <memory>

#include "fcl/geometry/collision_geometry.h"

namespace fcl
{

template <typename S>
class FCL_EXPORT CollisionObject
{
public:
  CollisionObject(const std::shared_ptr<CollisionGeometry<S>>& cgeom);

  CollisionObject(const std::shared_ptr<CollisionGeometry<S>>& cgeom,
                  const Transform3<S>& tf);

  CollisionObject(const std::shared_ptr<CollisionGeometry<S>>& cgeom,
                  const Matrix3<S>& R,
                  const Vector3<S>& T);

  ~CollisionObject();

  OBJECT_TYPE getObjectType() const;

  NODE_TYPE getNodeType() const;

  const AABB<S>& getAABB() const;

  void computeAABB();

  void* getUserData() const;

  void setUserData(void *data);

  const Vector3<S> getTranslation() const;

  const Matrix3<S> getRotation() const;

  const Quaternion<S> getQuatRotation() const;

  const Transform3<S>& getTransform() const;

  void setRotation(const Matrix3<S>& R);

  void setTranslation(const Vector3<S>& T);

  void setQuatRotation(const Quaternion<S>& q);

  void setTransform(const Matrix3<S>& R, const Vector3<S>& T);

  void setTransform(const Quaternion<S>& q, const Vector3<S>& T);

  void setTransform(const Transform3<S>& tf);

  bool isIdentityTransform() const;

  void setIdentityTransform();

  FCL_DEPRECATED
  const CollisionGeometry<S>* getCollisionGeometry() const;

  const std::shared_ptr<const CollisionGeometry<S>>& collisionGeometry() const;

  S getCostDensity() const;

  void setCostDensity(S c);

  bool isOccupied() const;

  bool isFree() const;

  bool isUncertain() const;

protected:

  std::shared_ptr<CollisionGeometry<S>> cgeom;
  std::shared_ptr<const CollisionGeometry<S>> cgeom_const;

  Transform3<S> t;

  mutable AABB<S> aabb;

  void *user_data;

public:

  EIGEN_MAKE_ALIGNED_OPERATOR_NEW
};

using CollisionObjectf = CollisionObject<float>;
using CollisionObjectd = CollisionObject<double>;

} // namespace fcl

#include "fcl/narrowphase/collision_object-inl.h"

#endif