Represents a collection of mesh geometries. More...

#include <gz/rendering/Mesh>

Public Member Functions
virtual	~Mesh ()
	Destructor. More...

virtual const MeshDescriptor &	Descriptor () const =0
	Get the mesh's mesh descriptor. More...

virtual bool	HasSkeleton () const =0
	Check whether the mesh has skeleton. More...

virtual bool	HasSubMesh (ConstSubMeshPtr _subMesh) const =0
	Determine if has given sub-mesh. More...

virtual bool	HasSubMeshName (const std::string &_name) const =0
	Determine if has sub-mesh with given name. More...

virtual void	SetDescriptor (const MeshDescriptor &_desc)=0
	Set the mesh's descriptor. More...

virtual void	SetSkeletonAnimationEnabled (const std::string &_name, bool _enabled, bool _loop=true, float _weight=1.0)=0
	Set whether a skeleton animation should be enabled or not. More...

virtual void	SetSkeletonLocalTransforms (const std::map< std::string, math::Matrix4d > &_tfs)=0
	Set transforms for the skeleton. More...

virtual void	SetSkeletonWeights (const std::unordered_map< std::string, float > &_weights)=0
	Set skeleton node weight. More...

virtual bool	SkeletonAnimationEnabled (const std::string &_name) const =0
	Get whether a skeleton animation is enabled or not. More...

virtual std::map< std::string, math::Matrix4d >	SkeletonLocalTransforms () const =0
	Get the skeleton local transforms. More...

virtual std::unordered_map< std::string, float >	SkeletonWeights () const =0
	Get skeleton node weight. More...

virtual SubMeshPtr	SubMeshByIndex (unsigned int _index) const =0
	Get sub-mesh at given index. More...

virtual SubMeshPtr	SubMeshByName (const std::string &_name) const =0
	Get sub-mesh with given name. More...

virtual unsigned int	SubMeshCount () const =0
	Get the sub-mesh count. More...

virtual void	UpdateSkeletonAnimation (std::chrono::steady_clock::duration _time)=0
	Play the active skeleton animation to the specified time. More...

Public Member Functions inherited from Geometry
virtual	~Geometry ()
	Destructor. More...

virtual GeometryPtr	Clone () const =0
	Clone the geometry. More...

virtual bool	HasParent () const =0
	Determine if this Geometry is attached to a Visual. More...

virtual MaterialPtr	Material () const =0
	Get the material of this geometry. More...

virtual VisualPtr	Parent () const =0
	Get the parent Visual. More...

virtual void	RemoveParent ()=0
	Detach this Geometry from its parent Visual. If this Geometry does not have a parent, no work will be done. More...

virtual void	SetMaterial (const std::string &_name, bool _unique=true)=0
	Set the materials of this Geometry. The specified material will be retrieved from the parent Scene. If no material is registered by the given name, no work will be done. More...

virtual void	SetMaterial (MaterialPtr _material, bool _unique=true)=0
	Set the materials of this Geometry. More...

Public Member Functions inherited from Object
virtual	~Object ()
	Destructor. More...

virtual void	Destroy ()=0
	Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. More...

virtual unsigned int	Id () const =0
	Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...

virtual std::string	Name () const =0
	Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...

virtual void	PostRender ()=0
	Post process this object and any of its children after rendering. More...

virtual void	PreRender ()=0
	Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender. More...

virtual ScenePtr	Scene () const =0
	Get the Scene that created this object. More...

Detailed Description

Represents a collection of mesh geometries.

Constructor & Destructor Documentation

◆ ~Mesh()

virtual ~Mesh ( )

virtual

Destructor.

Member Function Documentation

◆ Descriptor()

virtual const MeshDescriptor& Descriptor ( ) const

pure virtual

Get the mesh's mesh descriptor.

Returns: The mesh's mesh descriptor

Implemented in BaseMesh< T >.

◆ HasSkeleton()

virtual bool HasSkeleton ( ) const

pure virtual

Check whether the mesh has skeleton.

Returns: True if the mesh has skeleton

Implemented in Ogre2Mesh, OgreMesh, and BaseMesh< T >.

◆ HasSubMesh()

virtual bool HasSubMesh ( ConstSubMeshPtr _subMesh ) const

pure virtual

Determine if has given sub-mesh.

Parameters

[in] _subMesh Sub-mesh in question

Returns: True if has given sub-mesh

Implemented in BaseMesh< T >, BaseMesh< Ogre2Geometry >, and BaseMesh< OgreGeometry >.

◆ HasSubMeshName()

virtual bool HasSubMeshName ( const std::string & _name ) const

pure virtual

Determine if has sub-mesh with given name.

Parameters

[in] _name Name of sub-mesh in question

Returns: True if has sub-mesh with given name

Implemented in BaseMesh< T >, BaseMesh< Ogre2Geometry >, and BaseMesh< OgreGeometry >.

◆ SetDescriptor()

virtual void SetDescriptor ( const MeshDescriptor & _desc )

pure virtual

Set the mesh's descriptor.

Parameters

[in] _desc The new mesh descriptor

Implemented in BaseMesh< T >, BaseMesh< Ogre2Geometry >, and BaseMesh< OgreGeometry >.

◆ SetSkeletonAnimationEnabled()

virtual void SetSkeletonAnimationEnabled	(	const std::string &	_name,
		bool	_enabled,
		bool	_loop = `true`,
		float	_weight = `1.0`
	)

pure virtual

Set whether a skeleton animation should be enabled or not.

Parameters

[in]	_name	Name of animation
[in]	_enabled	True to enable animation, false to disable
[in]	_loop	True to loop animation
[in]	_weight	Weight of animation

Implemented in Ogre2Mesh, OgreMesh, BaseMesh< T >, BaseMesh< Ogre2Geometry >, and BaseMesh< OgreGeometry >.

◆ SetSkeletonLocalTransforms()

virtual void SetSkeletonLocalTransforms ( const std::map< std::string, math::Matrix4d > & _tfs )

pure virtual

Set transforms for the skeleton.

Parameters

[in]

_tfs

Map of skeleton local transformations

Map holding:
- Skeleton node names
- Local transformations of the skeleton nodes

Implemented in Ogre2Mesh, OgreMesh, BaseMesh< T >, BaseMesh< Ogre2Geometry >, and BaseMesh< OgreGeometry >.

◆ SetSkeletonWeights()

virtual void SetSkeletonWeights ( const std::unordered_map< std::string, float > & _weights )

pure virtual

Set skeleton node weight.

Parameters

[in]

_weights

Map of skeleton node's name to its weight

Map holding:
- Skeleton node names
- Weight the skeleton nodes

Implemented in Ogre2Mesh, OgreMesh, BaseMesh< T >, BaseMesh< Ogre2Geometry >, and BaseMesh< OgreGeometry >.

◆ SkeletonAnimationEnabled()

virtual bool SkeletonAnimationEnabled ( const std::string & _name ) const

pure virtual

Get whether a skeleton animation is enabled or not.

Parameters

[in] _name Name of animation

Returns: True is the skeleton animation is enabled, false otherwise

Implemented in Ogre2Mesh, OgreMesh, BaseMesh< T >, BaseMesh< Ogre2Geometry >, and BaseMesh< OgreGeometry >.

◆ SkeletonLocalTransforms()

virtual std::map<std::string, math::Matrix4d> SkeletonLocalTransforms ( ) const

pure virtual

Get the skeleton local transforms.

Returns

Map of skeleton local transformations

Map holding:
- Skeleton node names
- Local transformations of the skeleton nodes

Implemented in Ogre2Mesh, OgreMesh, and BaseMesh< T >.

◆ SkeletonWeights()

virtual std::unordered_map<std::string, float> SkeletonWeights ( ) const

pure virtual

Get skeleton node weight.

Returns

Map of skeleton node name to its weight

Map holding:
- Skeleton node names
- Weight the skeleton nodes

Implemented in Ogre2Mesh, OgreMesh, and BaseMesh< T >.

◆ SubMeshByIndex()

virtual SubMeshPtr SubMeshByIndex ( unsigned int _index ) const

pure virtual

Get sub-mesh at given index.

Parameters

[in] _index Index of sub-mesh

Returns: The sub-mesh at the given index

Implemented in BaseMesh< T >, BaseMesh< Ogre2Geometry >, and BaseMesh< OgreGeometry >.

◆ SubMeshByName()

virtual SubMeshPtr SubMeshByName ( const std::string & _name ) const

pure virtual

Get sub-mesh with given name.

Parameters

[in] _name Name of sub-mesh

Returns: The sub-mesh with the given name

Implemented in BaseMesh< T >, BaseMesh< Ogre2Geometry >, and BaseMesh< OgreGeometry >.

◆ SubMeshCount()

virtual unsigned int SubMeshCount ( ) const

pure virtual

Get the sub-mesh count.

Returns: The sub-mesh count

Implemented in BaseMesh< T >.

◆ UpdateSkeletonAnimation()

virtual void UpdateSkeletonAnimation ( std::chrono::steady_clock::duration _time )

pure virtual

Play the active skeleton animation to the specified time.

Parameters

[in] _time Time to set the skeleton animation to

Implemented in Ogre2Mesh, OgreMesh, BaseMesh< T >, BaseMesh< Ogre2Geometry >, and BaseMesh< OgreGeometry >.

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

gz/rendering/Mesh.hh

Gazebo Rendering

API Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~Mesh()

Member Function Documentation

◆ Descriptor()

◆ HasSkeleton()

◆ HasSubMesh()

◆ HasSubMeshName()

◆ SetDescriptor()

◆ SetSkeletonAnimationEnabled()

◆ SetSkeletonLocalTransforms()

◆ SetSkeletonWeights()

◆ SkeletonAnimationEnabled()

◆ SkeletonLocalTransforms()

◆ SkeletonWeights()

◆ SubMeshByIndex()

◆ SubMeshByName()

◆ SubMeshCount()

◆ UpdateSkeletonAnimation()