Gazebo Physics

API Reference

7.8.0
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. More...
 

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. More...
 
VectorType normal
 The normal at the hit point in the world coordinates. More...
 
VectorType point
 The hit point in the world coordinates. More...
 

Member Typedef Documentation

◆ Scalar

using Scalar = typename PolicyT::Scalar

◆ VectorType

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

Member Function Documentation

◆ IsHit()

bool IsHit ( ) const
inline

Returns true if the ray intersected an object.

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

Member Data Documentation

◆ fraction

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

VectorType normal

The normal at the hit point in the world coordinates.

◆ point

VectorType point

The hit point in the world coordinates.


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