RayCastOutput.hpp

Go to the documentation of this file.

/*
 * Original work Copyright (c) 2006-2009 Erin Catto http://www.box2d.org
 * Modified work Copyright (c) 2017 Louis Langholtz https://github.com/louis-langholtz/PlayRho
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 */
 
#ifndef PLAYRHO_COLLISION_RAYCASTOUTPUT_HPP
#define PLAYRHO_COLLISION_RAYCASTOUTPUT_HPP
 
 
#include <PlayRho/Common/BoundedValue.hpp>
#include <PlayRho/Common/OptionalValue.hpp>
#include <PlayRho/Collision/RayCastInput.hpp>
 
namespace playrho {
namespace detail {
 
template <std::size_t N>
struct AABB;
 
} // namespace detail
 
enum class RayCastOpcode
{
    Terminate,
    
    IgnoreFixture,
    
    ClipRay,
    
    ResetRay
};
 
namespace d2 {
 
class Shape;
class Fixture;
class DistanceProxy;
class DynamicTree;
 
struct RayCastHit
{
    UnitVec normal;
    
    UnitInterval<Real> fraction = UnitInterval<Real>{0};
};
 
using RayCastOutput = Optional<RayCastHit>;
 
using DynamicTreeRayCastCB = std::function<Real(Fixture* fixture, ChildCounter child,
                                                const RayCastInput& input)>;
 
using FixtureRayCastCB = std::function<RayCastOpcode(Fixture* fixture, ChildCounter child,
                                                     Length2 point, UnitVec normal)>;
 
 
RayCastOutput RayCast(Length radius, Length2 location, const RayCastInput& input) noexcept;
 
RayCastOutput RayCast(const detail::AABB<2>& aabb, const RayCastInput& input) noexcept;
 
RayCastOutput RayCast(const DistanceProxy& proxy, const RayCastInput& input,
                      const Transformation& transform) noexcept;
 
RayCastOutput RayCast(const Shape& shape, ChildCounter childIndex,
                      const RayCastInput& input, const Transformation& transform) noexcept;
 
bool RayCast(const DynamicTree& tree, RayCastInput input, const DynamicTreeRayCastCB& callback);
 
bool RayCast(const DynamicTree& tree, const RayCastInput& input, FixtureRayCastCB callback);
 
 
} // namespace d2
} // namespace playrho
 
#endif // PLAYRHO_COLLISION_RAYCASTOUTPUT_HPP