Ignition Rendering

API Reference

6.3.1

A class that stores ray query intersection results. More...

#include <RayQuery.hh>

Public Member Functions

 operator bool () const
 Returns false if result is not valid. More...
 
 operator bool ()
 Returns false if result is not valid. More...
 

Public Attributes

double distance = -1
 Intersection distance. More...
 
unsigned int objectId = 0
 Intersected object id. More...
 
math::Vector3d point
 Intersection point in 3d space. More...
 

Detailed Description

A class that stores ray query intersection results.

Member Function Documentation

◆ operator bool() [1/2]

operator bool ( ) const
inline

Returns false if result is not valid.

◆ operator bool() [2/2]

operator bool ( )
inline

Returns false if result is not valid.

Member Data Documentation

◆ distance

double distance = -1

Intersection distance.

Referenced by BaseRayQuery< OgreObject >::ClosestPoint().

◆ objectId

unsigned int objectId = 0

Intersected object id.

◆ point

Intersection point in 3d space.


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