Projector Class Reference

Projects a material onto surface, light a light projector. More...

#include <rendering/rendering.hh>

Public Member Functions

 Projector (VisualPtr _parent)
 Constructor. More...
 
virtual ~Projector ()
 Destructor. More...
 
VisualPtr GetParent ()
 Get the parent visual. More...
 
void Load (sdf::ElementPtr _sdf)
 Load from an sdf pointer. More...
 
void Load (const msgs::Projector &_msg)
 Load from a message. More...
 
void Load (const std::string &_name, const ignition::math::Pose3d &_pose=ignition::math::Pose3d::Zero, const std::string &_textureName="", const double _nearClip=0.25, const double _farClip=15.0, const double _fov=IGN_PI *0.25)
 Load the projector. More...
 
void SetEnabled (bool _enabled)
 Set whether the projector is enabled or disabled. More...
 
void SetTexture (const std::string &_textureName)
 Load a texture into the projector. More...
 
void Toggle ()
 Toggle the activation of the projector. More...
 

Detailed Description

Projects a material onto surface, light a light projector.

Constructor & Destructor Documentation

◆ Projector()

Projector ( VisualPtr  _parent)
explicit

Constructor.

Parameters
[in]_parentName of the parent visual.

◆ ~Projector()

virtual ~Projector ( )
virtual

Destructor.

Member Function Documentation

◆ GetParent()

VisualPtr GetParent ( )

Get the parent visual.

Returns
Pointer to the parent visual.

◆ Load() [1/3]

void Load ( sdf::ElementPtr  _sdf)

Load from an sdf pointer.

Parameters
[in]_sdfPointer to the SDF element.

◆ Load() [2/3]

void Load ( const msgs::Projector &  _msg)

Load from a message.

Parameters
[in]_msgLoad from a message.

◆ Load() [3/3]

void Load ( const std::string &  _name,
const ignition::math::Pose3d &  _pose = ignition::math::Pose3d::Zero,
const std::string &  _textureName = "",
const double  _nearClip = 0.25,
const double  _farClip = 15.0,
const double  _fov = IGN_PI *0.25 
)

Load the projector.

Parameters
[in]_nameName of the projector.
[in]_posPose of the projector.
[in]_textureNameName of the texture to project.
[in]_nearClipNear clip distance.
[in]_farClipFar clip distance.
[in]_fovField of view.

◆ SetEnabled()

void SetEnabled ( bool  _enabled)

Set whether the projector is enabled or disabled.

Parameters
[in]_enabledTrue to enable the projector.

◆ SetTexture()

void SetTexture ( const std::string &  _textureName)

Load a texture into the projector.

Parameters
[in]_textureNameName of the texture to project.

◆ Toggle()

void Toggle ( )

Toggle the activation of the projector.


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