gazebo::gui::LightMaker Class Reference

Used to insert a new light into the scene. More...

#include <LightMaker.hh>

Inheritance diagram for gazebo::gui::LightMaker:

Public Member Functions
	LightMaker ()
	Constructor. More...
virtual ignition::math::Vector3d	EntityPosition () const
	Returns the entity world position. More...
bool	InitFromLight (const std::string &_lightName)
	Initialize the light maker from an existing light in the scene. More...
void	Start ()
	Start the maker. More...
void	Stop ()
	Stop the maker. More...
Public Member Functions inherited from gazebo::gui::EntityMaker
virtual	~EntityMaker ()
	Destructor. More...
virtual void	OnMouseMove (const common::MouseEvent &_event)
	Callback when moving mouse. More...
virtual void	OnMouseRelease (const common::MouseEvent &_event)
	Callback when mouse button is released. More...

Protected Member Functions
virtual void	CreateTheEntity ()
	Creates the entity. More...
virtual bool	Init ()
	Initialize the light maker. More...
virtual void	SetEntityPosition (const ignition::math::Vector3d &_pos)
	Sets the entity world position. More...
Protected Member Functions inherited from gazebo::gui::EntityMaker
	EntityMaker (EntityMakerPrivate &_dataPtr)
	Constructor used by inherited classes. More...

Additional Inherited Members
Protected Attributes inherited from gazebo::gui::EntityMaker
EntityMakerPrivate *	dataPtr

Detailed Description

Used to insert a new light into the scene.

Constructor & Destructor Documentation

gazebo::gui::LightMaker::LightMaker

(

)

Constructor.

Member Function Documentation

virtual void gazebo::gui::LightMaker::CreateTheEntity ( )

protectedvirtual

Creates the entity.

Implements gazebo::gui::EntityMaker.

virtual ignition::math::Vector3d gazebo::gui::LightMaker::EntityPosition ( ) const

virtual

Returns the entity world position.

Returns

Entity's position in the world frame.

Reimplemented from gazebo::gui::EntityMaker.

virtual bool gazebo::gui::LightMaker::Init ( )

protectedvirtual

Initialize the light maker.

Returns

True if the light maker is initialized successfully.

bool gazebo::gui::LightMaker::InitFromLight

(

const std::string &

_lightName

)

Initialize the light maker from an existing light in the scene.

Parameters

[in]

_lightName

Name of existing light in the scene.

Returns

True if initialization is successful.

virtual void gazebo::gui::LightMaker::SetEntityPosition ( const ignition::math::Vector3d &  _pos )

protectedvirtual

Sets the entity world position.

Parameters

[in]

_pos

New position in the world frame.

Reimplemented from gazebo::gui::EntityMaker.

void gazebo::gui::LightMaker::Start ( )

virtual

Start the maker.

Reimplemented from gazebo::gui::EntityMaker.

void gazebo::gui::LightMaker::Stop ( )

virtual

Stop the maker.

Reimplemented from gazebo::gui::EntityMaker.

---

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

• LightMaker.hh