gazebo::common Namespace Reference

Common namespace. More...

Classes
class	Animation
	Manages an animation, which is a collection of keyframes and the ability to interpolate between the keyframes. More...
class	AssertionInternalError
	Class for generating Exceptions which come from gazebo assertions. More...
class	AudioDecoder
	An audio decoder based on FFMPEG. More...
class	Battery
	A battery abstraction. More...
class	BVHLoader
	Handles loading BVH animation files. More...
class	ColladaExporter
	Class used to export Collada mesh files. More...
class	ColladaLoader
	Class used to load Collada mesh files. More...
class	Color
	Defines a color. More...
class	Console
	Container for loggers, and global logging options (such as verbose vs. More...
class	Dem
class	Exception
	Class for generating exceptions. More...
class	FileLogger
	A logger that outputs messages to a file. More...
class	GTSMeshUtils
	Creates GTS utilities for meshes. More...
class	HeightmapData
	Encapsulates a generic heightmap data file. More...
class	HeightmapDataLoader
	Helper class for loading heightmap data. More...
class	Image
	Encapsulates an image. More...
class	ImageHeightmap
	Encapsulates an image that will be interpreted as a heightmap. More...
class	InternalError
	Class for generating Internal Gazebo Errors: those errors which should never happend and represent programming bugs. More...
class	KeyEvent
	Generic description of a keyboard event. More...
class	KeyFrame
	A key frame in an animation. More...
class	Logger
	Terminal logger. More...
class	Material
	Encapsulates description of a material. More...
class	MaterialDensity
	Encapsulates density types. More...
class	Mesh
	A 3D mesh. More...
class	MeshCSG
	Creates CSG meshes. More...
class	MeshExporter
	Base class for exporting meshes. More...
class	MeshLoader
	Base class for loading meshes. More...
class	MeshManager
	Maintains and manages all meshes. More...
class	ModelDatabase
	Connects to model database, and has utility functions to find models. More...
class	MouseEvent
	Generic description of a mouse event. More...
class	MovingWindowFilter
	Base class for MovingWindowFilter. More...
class	NodeAnimation
	Node animation. More...
class	NodeAssignment
	Vertex to node weighted assignement for skeleton animation visualization. More...
class	NodeTransform
	NodeTransform Skeleton.hh common/common.hh More...
class	NumericAnimation
	A numeric animation. More...
class	NumericKeyFrame
	A keyframe for a NumericAnimation. More...
class	OBJLoader
	Class used to load obj mesh files. More...
class	ParamT
class	PID
	Generic PID controller class. More...
class	PoseAnimation
	A pose animation. More...
class	PoseKeyFrame
	A keyframe for a PoseAnimation. More...
class	SemanticVersion
	Version comparison class based on Semantic Versioning 2.0.0 http://semver.org/ Compares versions and converts versions from string. More...
class	Skeleton
	A skeleton. More...
class	SkeletonAnimation
	Skeleton animation. More...
class	SkeletonNode
	A skeleton node. More...
class	SphericalCoordinates
	Convert spherical coordinates for planetary surfaces. More...
class	STLLoader
	Class used to load STL mesh files. More...
class	SubMesh
	A child mesh. More...
class	SVGCommand
	SVG command data structure. More...
class	SvgError
	Handles errors during SVG parsing. More...
class	SVGLoader
	A loader for SVG files. More...
struct	SVGPath
	An SVG path element data structure. More...
class	SystemPaths
	Functions to handle getting system paths, keeps track of: More...
class	Time
	A Time class, can be used to hold wall- or sim-time. More...
class	Timer
	A timer class, used to time things in real world walltime. More...
class	UpdateInfo
	Information for use in an update event. More...
class	URI
	A complete URI. More...
class	URIPath
	The path component of a URI. More...
class	URIQuery
	The query component of a URI. More...
class	Video
	Handle video encoding and decoding using libavcodec. More...
class	VideoEncoder
	The VideoEncoder class supports encoding a series of images to a video format, and then writing the video to disk. More...

Typedefs
typedef boost::shared_ptr < Animation >	AnimationPtr
typedef std::shared_ptr< Battery >	BatteryPtr
typedef boost::shared_ptr < DiagnosticTimer >	DiagnosticTimerPtr
typedef std::map< unsigned int, SkeletonNode * >	NodeMap
typedef std::map< unsigned int, SkeletonNode * >::iterator	NodeMapIter
typedef boost::shared_ptr < NumericAnimation >	NumericAnimationPtr
typedef std::vector < common::Param * >	Param_V
typedef boost::shared_ptr < PoseAnimation >	PoseAnimationPtr
typedef std::map< double, std::vector< NodeTransform > >	RawNodeAnim
typedef std::vector < std::vector< std::pair < std::string, double > > >	RawNodeWeights
typedef std::map< std::string, RawNodeAnim >	RawSkeletonAnim
typedef boost::shared_ptr < SphericalCoordinates >	SphericalCoordinatesPtr
typedef std::map< std::string, std::string >	StrStr_M

Enumerations
enum	MaterialType {   BEGIN = 0, STYROFOAM = BEGIN, PINE, WOOD,   OAK, ICE, WATER, PLASTIC,   CONCRETE, ALUMINUM, STEEL_ALLOY, STEEL_STAINLESS,   IRON, BRASS, COPPER, TUNGSTEN,   END }
	Types of materials. More...

Functions
std::string	absPath (const std::string &_path)
	Get the absolute path of a provided path. More...
void	add_search_path_suffix (const std::string &_suffix)
	add path sufix to common::SystemPaths More...
AVFrame *	AVFrameAlloc (void)
	Helper function to avoid deprecation warnings. More...
void	AVFrameUnref (AVFrame *_frame)
	Helper function to avoid deprecation warnings. More...
void	AVPacketUnref (AVPacket *_packet)
	Helper function to avoid deprecation warnings. More...
bool	copyFile (const std::string &_existingFilename, const std::string &_newFilename)
	Copy a file. More...
std::string	cwd ()
	Get the current working directory. More...
bool	exists (const std::string &_path)
	Returns true if _path is a file or directory. More...
std::string	find_file (const std::string &_file)
	search for file in common::SystemPaths More...
std::string	find_file (const std::string &_file, bool _searchLocalPath)
	search for file in common::SystemPaths More...
std::string	find_file_path (const std::string &_file)
	search for a file in common::SystemPaths More...
template<typename T >
std::string	get_sha1 (const T &_buffer)
	Compute the SHA1 hash of an array of bytes. More...
const char *	getEnv (const char *_name)
	Cross platform retrieval of an environment variable. More...
bool	isDirectory (const std::string &_path)
	Check if the given path is a directory. More...
bool	isFile (const std::string &_path)
	Check if the given path is a file. More...
void	load ()
	Load the common library. More...
bool	moveFile (const std::string &_existingFilename, const std::string &_newFilename)
	Move a file. More...
void	replaceAll (std::string &_result, const std::string &_orig, const std::string &_key, const std::string &_replacement)
	Replace all occurances of _key with _replacement. More...
std::string	replaceAll (const std::string &_orig, const std::string &_key, const std::string &_replacement)
	Replace all occurances of _key with _replacement. More...
std::vector< std::string >	split (const std::string &_str, const std::string &_delim)
	Splits a string into tokens. More...
std::string	unique_file_path (const std::string &_pathAndName, const std::string &_extension)
	Generates a path for a file which doesn't collide with existing files, by appending numbers to it (i.e. More...

Variables
static std::string	PixelFormatNames []
	String names for the pixel formats. More...
static const double	SpeedOfLight = 299792458
	Speed of light. More...

Detailed Description

Common namespace.

Typedef Documentation

typedef boost::shared_ptr<Animation> AnimationPtr

typedef std::shared_ptr<Battery> BatteryPtr

typedef boost::shared_ptr<DiagnosticTimer> DiagnosticTimerPtr

typedef std::map<unsigned int, SkeletonNode*> NodeMap

typedef std::map<unsigned int, SkeletonNode*>::iterator NodeMapIter

typedef boost::shared_ptr<NumericAnimation> NumericAnimationPtr

typedef std::vector<common::Param*> Param_V

typedef boost::shared_ptr<PoseAnimation> PoseAnimationPtr

typedef std::map<double, std::vector<NodeTransform> > RawNodeAnim

typedef std::vector<std::vector<std::pair<std::string, double> > > RawNodeWeights

typedef std::map<std::string, RawNodeAnim> RawSkeletonAnim

typedef boost::shared_ptr<SphericalCoordinates> SphericalCoordinatesPtr

typedef std::map<std::string, std::string> StrStr_M

Enumeration Type Documentation

enum MaterialType

strong

Types of materials.

Source: https://en.wikipedia.org/wiki/Density

Enumerator
BEGIN
STYROFOAM	Styrofoam, density = 75.0 kg/m^3.
PINE	Pine, density = 373.0 kg/m^3.
WOOD	Wood, density = 700.0 kg/m^3.
OAK	Oak, density = 710.0 kg/m^3.
ICE	Ice, density = 916.0 kg/m^3.
WATER	Water, density = 1000.0 kg/m^3.
PLASTIC	Plastic, density = 1175.0 kg/m^3.
CONCRETE	Concrete, density = 2000.0 kg/m^3.
ALUMINUM	Aluminum, density = 2700.0 kg/m^3.
STEEL_ALLOY	Steel alloy, density = 7600.0 kg/m^3.
STEEL_STAINLESS	Stainless steel, density = 7800.0 kg/m^3.
IRON	Iron, density = 7870.0 kg/m^3.
BRASS	Brass, density = 8600.0 kg/m^3.
COPPER	Copper, density = 8940.0 kg/m^3.
TUNGSTEN	Tungsten, density = 19300.0 kg/m^3.
END

Function Documentation

AVFrame* gazebo::common::AVFrameAlloc

(

void

)

Helper function to avoid deprecation warnings.

void gazebo::common::AVFrameUnref

(

AVFrame *

_frame

)

Helper function to avoid deprecation warnings.

void gazebo::common::AVPacketUnref

(

AVPacket *

_packet

)

Helper function to avoid deprecation warnings.

Parameters

[in]

_packet

AVPacket structure that stores compressed data

Variable Documentation

const double SpeedOfLight = 299792458

static

Speed of light.