HeightmapLODPlugin Class Reference

Plugin that sets the heightmap Level of Detail (LOD) parameters. More...

#include <HeightmapLODPlugin.hh>

Inherits VisualPlugin.

Public Types
typedef boost::shared_ptr< VisualPlugin >	TPtr
	plugin pointer type definition More...

Public Member Functions
	HeightmapLODPlugin ()
	Constructor. More...
	~HeightmapLODPlugin ()=default
	Destructor. More...
std::string	GetFilename () const
	Get the name of the handler. More...
std::string	GetHandle () const
	Get the short name of the handler. More...
PluginType	GetType () const
	Returns the type of the plugin. More...
virtual void	Init ()
	Initialize the plugin. More...
virtual void	Load (rendering::VisualPtr _visual, sdf::ElementPtr _sdf)
	Load function. More...
virtual void	Reset ()
	Override this method for custom plugin reset behavior. More...

Static Public Member Functions
static TPtr	Create (const std::string &_filename, const std::string &_name)
	a class method that creates a plugin from a file name. More...

Protected Member Functions
void	LoadParam (const sdf::ElementPtr &_sdf, const std::string &_name, V &_target, V _defaultValue=V()) const
	Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found. More...
void	LoadParam (sdf::ElementPtr &_sdf, const std::string &_name, std::string &_target, const char *_defaultValue) const
	Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found. More...

Protected Attributes
std::string	filename
	Path to the shared library file. More...
std::string	handleName
	Short name. More...
PluginType	type
	Type of plugin. More...

Detailed Description

Plugin that sets the heightmap Level of Detail (LOD) parameters.

lod: a render-engine specific value used to compute Level of Detail. skirt_length: length of skirts on LOD tiles. These parameters can be set uniformly for all scenes in a simulation by specifying the parameters directly under the <plugin > element:

 <plugin filename="libHeightmapLODPlugin.so" name="heightmap_lod">
   <lod>5</lod>
   <skirt_length>0.5</skirt_length>
 </plugin>

Alternatively, you can specify distinct values for server scene used for rendering camera sensors, and the gui scene used for gzclient's graphical interface.

 <plugin filename="libHeightmapLODPlugin.so" name="heightmap_lod">
   <gui>
     <lod>5</lod>
     <skirt_length>1.5</skirt_length>
   </gui>
   <server>
     <lod>0</lod>
     <skirt_length>0.5</skirt_length>
   </server>
 </plugin>

Parameters specified in the root namespace have precedence. The <server> and <gui> elements are only checked if parameters are not set in the root namespace.

 <plugin filename="libHeightmapLODPlugin.so" name="heightmap_lod">
   <skirt_length>2.5</skirt_length>
   <gui>
     <lod>5</lod>
     <skirt_length>1.5</skirt_length> <!-- this is ignored -->
   </gui>
   <server>
     <lod>0</lod>
     <skirt_length>0.5</skirt_length> <!-- this is ignored -->
   </server>
 </plugin>

Member Typedef Documentation

TPtr

typedef boost::shared_ptr<VisualPlugin > TPtr

inherited

plugin pointer type definition

Constructor & Destructor Documentation

HeightmapLODPlugin()

HeightmapLODPlugin

(

)

Constructor.

~HeightmapLODPlugin()

~HeightmapLODPlugin ( )

default

Destructor.

Member Function Documentation

Create()

static TPtr Create ( const std::string &  _filename, const std::string &  _name  )

inlinestaticinherited

a class method that creates a plugin from a file name.

It locates the shared library and loads it dynamically.

Parameters

[in]	_filename	the path to the shared library.
[in]	_name	short name of the plugin

Returns

Shared Pointer to this class type

GetFilename()

std::string GetFilename ( ) const

inlineinherited

Get the name of the handler.

GetHandle()

std::string GetHandle ( ) const

inlineinherited

Get the short name of the handler.

GetType()

PluginType GetType ( ) const

inlineinherited

Returns the type of the plugin.

Returns

type of the plugin

Init()

virtual void Init ( )

inlinevirtualinherited

Initialize the plugin.

Called after Gazebo has been loaded. Must not block.

Load()

virtual void Load ( rendering::VisualPtr  _visual, sdf::ElementPtr  _sdf  )

virtual

Load function.

Called when a Plugin is first created, and after the World has been loaded. This function should not be blocking.

Parameters

[in]	_visual	Pointer the Visual Object.
[in]	_sdf	Pointer the the SDF element of the plugin.

Implements VisualPlugin.

LoadParam() [1/2]

void LoadParam ( const sdf::ElementPtr &  _sdf, const std::string &  _name, V &  _target, V  _defaultValue = V()  ) const

inlineprotectedinherited

Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found.

A message is written using gzmsg reporting whether the default value was used or not.

Parameters

[in]	_sdf	The SDF element of the plugin.
[in]	_name	Name of a tag inside the SDF.
[out]	_target	The reference to store the param value to.
[in]	_defaultValue	The default value.

LoadParam() [2/2]

void LoadParam ( sdf::ElementPtr &  _sdf, const std::string &  _name, std::string &  _target, const char *  _defaultValue  ) const

inlineprotectedinherited

Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found.

A message is written using gzmsg reporting whether the default value was used or not. String specialization to allow accepting const char* values for std::string parameters.

Parameters

[in]	_sdf	The SDF element of the plugin.
[in]	_name	Name of a tag inside the SDF.
[out]	_target	The reference to store the param value to.
[in]	_defaultValue	The default value.

Reset()

virtual void Reset ( )

inlinevirtualinherited

Override this method for custom plugin reset behavior.

Member Data Documentation

filename

std::string filename

protectedinherited

Path to the shared library file.

handleName

std::string handleName

protectedinherited

Short name.

type

PluginType type

protectedinherited

Type of plugin.

---

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

• HeightmapLODPlugin.hh