Ignition Rendering

API Reference

6.3.1

A Ray Query class used for computing ray object intersections. More...

#include <BaseRayQuery.hh>

Public Member Functions

virtual ~BaseRayQuery () override
 Destructor. More...
 
virtual RayQueryResult ClosestPoint () override
 Compute intersections. More...
 
virtual math::Vector3d Direction () const override
 Get ray direction. More...
 
virtual math::Vector3d Origin () const override
 Get ray origin. More...
 
virtual void SetDirection (const math::Vector3d &_dir) override
 Set ray direction. More...
 
virtual void SetFromCamera (const CameraPtr &_camera, const math::Vector2d &_coord) override
 Create the ray query from camera. More...
 
virtual void SetOrigin (const math::Vector3d &_origin) override
 Set ray origin. More...
 
- Public Member Functions inherited from RayQuery
virtual ~RayQuery ()
 Destructor. More...
 
- Public Member Functions inherited from Object
virtual ~Object ()
 Destructor. More...
 
virtual void Destroy ()=0
 Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. More...
 
virtual unsigned int Id () const =0
 Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...
 
virtual std::string Name () const =0
 Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...
 
virtual void PostRender ()=0
 Post process this object and any of its children after rendering. More...
 
virtual void PreRender ()=0
 Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender. More...
 
virtual ScenePtr Scene () const =0
 Get the Scene that created this object. More...
 

Protected Member Functions

 BaseRayQuery ()
 Constructor. More...
 

Protected Attributes

math::Vector3d direction
 Ray direction. More...
 
math::Vector3d origin
 Ray origin. More...
 

Detailed Description

template<class T>
class ignition::rendering::BaseRayQuery< T >

A Ray Query class used for computing ray object intersections.

ignition/rendering/base/BaseRayQuery.hh

Constructor & Destructor Documentation

◆ BaseRayQuery()

BaseRayQuery ( )
protected

Constructor.

◆ ~BaseRayQuery()

~BaseRayQuery ( )
overridevirtual

Destructor.

Member Function Documentation

◆ ClosestPoint()

RayQueryResult ClosestPoint ( )
overridevirtual

Compute intersections.

Returns
A vector of intersection results

Implements RayQuery.

Reimplemented in OgreRayQuery.

◆ Direction()

ignition::math::Vector3d Direction ( ) const
overridevirtual

Get ray direction.

Returns
Ray direction.

Implements RayQuery.

◆ Origin()

ignition::math::Vector3d Origin ( ) const
overridevirtual

Get ray origin.

Returns
Ray origin

Implements RayQuery.

◆ SetDirection()

void SetDirection ( const math::Vector3d _dir)
overridevirtual

Set ray direction.

Parameters
[in]_dirRay origin

Implements RayQuery.

◆ SetFromCamera()

void SetFromCamera ( const CameraPtr _camera,
const math::Vector2d _coord 
)
overridevirtual

Create the ray query from camera.

Parameters
[in]_cameraCamera to construct ray
[in]_coordnormalized device coords [-1, +1]

Implements RayQuery.

Reimplemented in OgreRayQuery.

◆ SetOrigin()

void SetOrigin ( const math::Vector3d _origin)
overridevirtual

Set ray origin.

Parameters
[in]_originRay origin

Implements RayQuery.

Member Data Documentation

◆ direction

◆ origin


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