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	Load (const std::string &_name, const math::Pose &_pose=math::Pose(0, 0, 0, 0, 0, 0), const std::string &_textureName="", double _nearClip=0.25, double _farClip=15.0, double _fov=IGN_PI *0.25) GAZEBO_DEPRECATED(8.0)
	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 ( VisualPtr  _parent )

explicit

Constructor.

Parameters

[in]

_parent

Name of the parent visual.

virtual ~Projector ( )

virtual

Destructor.

Member Function Documentation

VisualPtr GetParent

(

)

Get the parent visual.

Returns

Pointer to the parent visual.

void Load

(

sdf::ElementPtr

_sdf

)

Load from an sdf pointer.

Parameters

[in]

_sdf

Pointer to the SDF element.

void Load

(

const msgs::Projector &

_msg

)

Load from a message.

Parameters

[in]

_msg

Load from a message.

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]	_name	Name of the projector.
[in]	_pos	Pose of the projector.
[in]	_textureName	Name of the texture to project.
[in]	_nearClip	Near clip distance.
[in]	_farClip	Far clip distance.
[in]	_fov	Field of view.

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

Load the projector.

Parameters

[in]	_name	Name of the projector.
[in]	_pos	Pose of the projector.
[in]	_textureName	Name of the texture to project.
[in]	_nearClip	Near clip distance.
[in]	_farClip	Far clip distance.
[in]	_fov	Field of view.

Deprecated:

See version that uses a ignition::math Pose3d objects.

void SetEnabled

(

bool

_enabled

)

Set whether the projector is enabled or disabled.

Parameters

[in]

_enabled

True to enable the projector.

void SetTexture

(

const std::string &

_textureName

)

Load a texture into the projector.

Parameters

[in]

_textureName

Name of the texture to project.

void Toggle

(

)

Toggle the activation of the projector.

---

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

• Projector.hh