Ignition Rendering

API Reference

5.1.0

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

#include <Ogre2RayQuery.hh>

Public Member Functions

virtual ~Ogre2RayQuery ()
 Destructor. More...
 
virtual RayQueryResult ClosestPoint ()
 Compute intersections. More...
 
virtual void SetFromCamera (const CameraPtr &_camera, const math::Vector2d &_coord)
 Create the ray query from camera. More...
 
- Public Member Functions inherited from BaseRayQuery< Ogre2Object >
virtual ~BaseRayQuery () override
 Destructor. 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 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...
 
- Public Member Functions inherited from Ogre2Object
virtual ~Ogre2Object ()
 Destructor. More...
 
virtual ScenePtr Scene () const override
 
- Public Member Functions inherited from BaseObject
virtual ~BaseObject ()
 
virtual void Destroy () override
 
virtual unsigned int Id () const override
 
virtual std::string Name () const override
 
virtual void PostRender () override
 
virtual void PreRender () override
 

Protected Member Functions

 Ogre2RayQuery ()
 Constructor. More...
 
- Protected Member Functions inherited from BaseRayQuery< Ogre2Object >
 BaseRayQuery ()
 Constructor. More...
 
- Protected Member Functions inherited from Ogre2Object
 Ogre2Object ()
 Constructor. More...
 
- Protected Member Functions inherited from BaseObject
 BaseObject ()
 
virtual void Init ()
 
virtual void Load ()
 

Additional Inherited Members

- Protected Attributes inherited from BaseRayQuery< Ogre2Object >
math::Vector3d direction
 Ray direction. More...
 
math::Vector3d origin
 Ray origin. More...
 
- Protected Attributes inherited from Ogre2Object
Ogre2ScenePtr scene
 Pointer to the ogre scene. More...
 
- Protected Attributes inherited from BaseObject
unsigned int id
 
std::string name
 

Detailed Description

A Ray Query class used for computing ray object intersections.

ignition/rendering/ogre2/Ogre2RayQuery.hh

Constructor & Destructor Documentation

◆ Ogre2RayQuery()

Ogre2RayQuery ( )
protected

Constructor.

◆ ~Ogre2RayQuery()

virtual ~Ogre2RayQuery ( )
virtual

Destructor.

Member Function Documentation

◆ ClosestPoint()

virtual RayQueryResult ClosestPoint ( )
virtual

Compute intersections.

Returns
A vector of intersection results

Reimplemented from BaseRayQuery< Ogre2Object >.

◆ SetFromCamera()

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

Create the ray query from camera.

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

Reimplemented from BaseRayQuery< Ogre2Object >.


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