Ignition Rendering

API Reference

4.1.0

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

#include <OgreRayQuery.hh>

Public Member Functions

virtual ~OgreRayQuery ()
 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< OgreObject >
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...
 
- Public Member Functions inherited from OgreObject
virtual ~OgreObject ()
 
virtual ScenePtr Scene () const
 Get the Scene that created this object. More...
 
- Public Member Functions inherited from BaseObject
virtual ~BaseObject ()
 
virtual void Destroy () override
 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 override
 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 override
 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 () override
 Post process this object and any of its children after rendering. More...
 
virtual void PreRender () override
 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...
 
- Public Member Functions inherited from enable_shared_from_this< BaseObject >
enable_shared_from_this (T... args)
 
~enable_shared_from_this (T... args)
 
operator= (T... args)
 
shared_from_this (T... args)
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from BaseRayQuery< OgreObject >
math::Vector3d direction
 Ray direction. More...
 
math::Vector3d origin
 Ray origin. More...
 
- Protected Attributes inherited from OgreObject
OgreScenePtr scene
 
- 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/base/OgreRayQuery.hh

Constructor & Destructor Documentation

◆ OgreRayQuery()

OgreRayQuery ( )
protected

Constructor.

◆ ~OgreRayQuery()

virtual ~OgreRayQuery ( )
virtual

Destructor.

Member Function Documentation

◆ ClosestPoint()

virtual RayQueryResult ClosestPoint ( )
virtual

Compute intersections.

Parameters
[out]Avector of intersection results
Returns
True if results are not empty

Reimplemented from BaseRayQuery< OgreObject >.

◆ 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< OgreObject >.


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