Gazebo Physics

API Reference

9.5.1
GetRayIntersectionFromLastStepFeature::RayIntersectionT< PolicyT > Struct Template Reference

#include <GetRayIntersection.hh>

Public Types

using Scalar = typename PolicyT::Scalar
 
using VectorType = typename FromPolicy< PolicyT >::template Use< LinearVector >
 

Public Member Functions

bool IsHit () const
 Returns true if the ray intersected an object.
 

Public Attributes

Scalar fraction
 The fraction of the ray length at the intersection/hit point. NaN if no object in range. Note: gz-physics10 changed the miss value to +INF (REP-117). gz-physics9 intentionally retains NaN for API compatibility. Use IsHit() — it is correct under both conventions.
 
VectorType normal
 The normal at the hit point in the world coordinates.
 
VectorType point
 The hit point in the world coordinates.
 

Member Typedef Documentation

◆ Scalar

template<typename PolicyT >
using Scalar = typename PolicyT::Scalar

◆ VectorType

template<typename PolicyT >
using VectorType = typename FromPolicy<PolicyT>::template Use<LinearVector>

Member Function Documentation

◆ IsHit()

template<typename PolicyT >
bool IsHit ( ) const
inline

Returns true if the ray intersected an object.

References GetRayIntersectionFromLastStepFeature::RayIntersectionT< PolicyT >::fraction, and std::isfinite().

Member Data Documentation

◆ fraction

template<typename PolicyT >
Scalar fraction

The fraction of the ray length at the intersection/hit point. NaN if no object in range. Note: gz-physics10 changed the miss value to +INF (REP-117). gz-physics9 intentionally retains NaN for API compatibility. Use IsHit() — it is correct under both conventions.

Referenced by GetRayIntersectionFromLastStepFeature::RayIntersectionT< PolicyT >::IsHit().

◆ normal

template<typename PolicyT >
VectorType normal

The normal at the hit point in the world coordinates.

◆ point

template<typename PolicyT >
VectorType point

The hit point in the world coordinates.


The documentation for this struct was generated from the following file: