distance.h

Go to the documentation of this file.

/*
 * Software License Agreement (BSD License)
 *
 * Copyright (c) 2011-2014, Willow Garage, Inc.
 * Copyright (c) 2014-2015, 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 COAL_DISTANCE_H
#define COAL_DISTANCE_H

#include "coal/collision_object.h"
#include "coal/collision_data.h"
#include "coal/distance_func_matrix.h"
#include "coal/timings.h"

namespace coal {

COAL_DLLAPI CoalScalar distance(const CollisionObject* o1,
 const CollisionObject* o2,
 const DistanceRequest& request,
 DistanceResult& result);

COAL_DLLAPI CoalScalar distance(const CollisionGeometry* o1,
 const Transform3s& tf1,
 const CollisionGeometry* o2,
 const Transform3s& tf2,
 const DistanceRequest& request,
 DistanceResult& result);

class COAL_DLLAPI ComputeDistance {
 public:
 ComputeDistance(const CollisionGeometry* o1, const CollisionGeometry* o2);

 CoalScalar operator()(const Transform3s& tf1, const Transform3s& tf2,
 const DistanceRequest& request,
 DistanceResult& result) const;

 bool operator==(const ComputeDistance& other) const {
 return o1 == other.o1 && o2 == other.o2 && swap_geoms == other.swap_geoms &&
 solver == other.solver && func == other.func;
 }

 bool operator!=(const ComputeDistance& other) const {
 return !(*this == other);
 }

 virtual ~ComputeDistance() {};

 protected:
 // These pointers are made mutable to let the derived classes to update
 // their values when updating the collision geometry (e.g. creating a new
 // one). This feature should be used carefully to avoid any mis usage (e.g,
 // changing the type of the collision geometry should be avoided).
 mutable const CollisionGeometry* o1;
 mutable const CollisionGeometry* o2;

 mutable GJKSolver solver;

 DistanceFunctionMatrix::DistanceFunc func;
 bool swap_geoms;

 virtual CoalScalar run(const Transform3s& tf1, const Transform3s& tf2,
 const DistanceRequest& request,
 DistanceResult& result) const;

 public:
 EIGEN_MAKE_ALIGNED_OPERATOR_NEW
};

} // namespace coal

#endif