#include <BaseMesh.hh>

Public Member Functions
virtual	~BaseMesh ()

virtual GeometryPtr	Clone () const override
	Clone the geometry. More...

const MeshDescriptor &	Descriptor () const override
	Get the mesh's mesh descriptor. More...

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

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

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

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

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

virtual void	PreRender () override
	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...

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

virtual void	SetMaterial (const std::string &_name, bool _unique=true) override
	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) override
	Set the materials of this Geometry. More...

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

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

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

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

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

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

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

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

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

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

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

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

virtual bool	HasParent () const =0
	Determine if this Geometry is attached to a Visual. 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...

Public Member Functions inherited from Object
virtual	~Object ()
	Destructor. 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 ScenePtr	Scene () const =0
	Get the Scene that created this object. More...

Protected Member Functions
	BaseMesh ()

virtual SubMeshStorePtr	SubMeshes () const =0

Protected Attributes
MaterialPtr	material
	Pointer to currently assigned material. More...

MeshDescriptor	meshDescriptor
	MeshDescriptor for this mesh. More...

bool	ownsMaterial = false
	Flag to indicate whether or not this mesh should be responsible for destroying the material. More...

Constructor & Destructor Documentation

◆ BaseMesh()

BaseMesh

protected

◆ ~BaseMesh()

~BaseMesh

virtual

Member Function Documentation

◆ Clone()

GeometryPtr Clone ( ) const

overridevirtual

Clone the geometry.

Returns: The cloned geometry.

Implements Geometry.

◆ Descriptor()

const MeshDescriptor & Descriptor ( ) const

overridevirtual

Get the mesh's mesh descriptor.

Returns: The mesh's mesh descriptor

Implements Mesh.

◆ Destroy()

void Destroy ( )

overridevirtual

Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.

Implements Object.

Reimplemented in Ogre2Mesh, and OgreMesh.

◆ HasSkeleton()

bool HasSkeleton ( ) const

overridevirtual

Check whether the mesh has skeleton.

Returns: True if the mesh has skeleton

Implements Mesh.

◆ HasSubMesh()

bool HasSubMesh ( ConstSubMeshPtr _subMesh ) const

overridevirtual

Determine if has given sub-mesh.

Parameters

[in] _subMesh Sub-mesh in question

Returns: True if has given sub-mesh

Implements Mesh.

◆ HasSubMeshName()

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

overridevirtual

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

Implements Mesh.

◆ Material()

MaterialPtr Material ( ) const

overridevirtual

Get the material of this geometry.

Returns: Material used by this geometry

Implements Geometry.

◆ PreRender()

void PreRender ( )

overridevirtual

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.

Implements Object.

◆ SetDescriptor()

void SetDescriptor ( const MeshDescriptor & _desc )

overridevirtual

Set the mesh's descriptor.

Parameters

[in] _desc The new mesh descriptor

Implements Mesh.

◆ SetMaterial() [1/2]

void SetMaterial	(	const std::string &	_name,
		bool	_unique = `true`
	)

overridevirtual

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.

Parameters

[in]	_name	Name of registered Material
[in]	_unique	True if the specified material should be cloned

Implements Geometry.

◆ SetMaterial() [2/2]

void SetMaterial	(	MaterialPtr	_material,
		bool	_unique = `true`
	)

overridevirtual

Set the materials of this Geometry.

Parameters

[in]	_material	New Material to be assigned
[in]	_unique	True if the given material should be cloned

Implements Geometry.

◆ SetSkeletonAnimationEnabled()

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

overridevirtual

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

Implements Mesh.

Reimplemented in Ogre2Mesh, and OgreMesh.

◆ SetSkeletonLocalTransforms()

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

overridevirtual

Set transforms for the skeleton.

Parameters

[in]

_tfs

Map of skeleton local transformations

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

Implements Mesh.

Reimplemented in Ogre2Mesh, and OgreMesh.

◆ SetSkeletonWeights()

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

overridevirtual

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

Implements Mesh.

Reimplemented in Ogre2Mesh, and OgreMesh.

◆ SkeletonAnimationEnabled()

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

overridevirtual

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

Implements Mesh.

Reimplemented in Ogre2Mesh, and OgreMesh.

◆ SkeletonLocalTransforms()

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

overridevirtual

Get the skeleton local transforms.

Returns

Map of skeleton local transformations

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

Implements Mesh.

◆ SkeletonWeights()

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

overridevirtual

Get skeleton node weight.

Returns

Map of skeleton node name to its weight

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

Implements Mesh.

◆ SubMeshByIndex()

SubMeshPtr SubMeshByIndex ( unsigned int _index ) const

overridevirtual

Get sub-mesh at given index.

Parameters

[in] _index Index of sub-mesh

Returns: The sub-mesh at the given index

Implements Mesh.

◆ SubMeshByName()

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

overridevirtual

Get sub-mesh with given name.

Parameters

[in] _name Name of sub-mesh

Returns: The sub-mesh with the given name

Implements Mesh.

◆ SubMeshCount()

unsigned int SubMeshCount ( ) const

overridevirtual

Get the sub-mesh count.

Returns: The sub-mesh count

Implements Mesh.

◆ SubMeshes()

virtual SubMeshStorePtr SubMeshes ( ) const

protectedpure virtual

◆ UpdateSkeletonAnimation()

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

overridevirtual

Play the active skeleton animation to the specified time.

Parameters

[in] _time Time to set the skeleton animation to

Implements Mesh.

Reimplemented in Ogre2Mesh, and OgreMesh.

Member Data Documentation

◆ material

MaterialPtr material

protected

Pointer to currently assigned material.

◆ meshDescriptor

MeshDescriptor meshDescriptor

protected

MeshDescriptor for this mesh.

◆ ownsMaterial

bool ownsMaterial = false

protected

Flag to indicate whether or not this mesh should be responsible for destroying the material.

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

gz/rendering/base/BaseMesh.hh

Gazebo Rendering

API Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ BaseMesh()

◆ ~BaseMesh()

Member Function Documentation

◆ Clone()

◆ Descriptor()

◆ Destroy()

◆ HasSkeleton()

◆ HasSubMesh()

◆ HasSubMeshName()

◆ Material()

◆ PreRender()

◆ SetDescriptor()

◆ SetMaterial() [1/2]

◆ SetMaterial() [2/2]

◆ SetSkeletonAnimationEnabled()

◆ SetSkeletonLocalTransforms()

◆ SetSkeletonWeights()

◆ SkeletonAnimationEnabled()

◆ SkeletonLocalTransforms()

◆ SkeletonWeights()

◆ SubMeshByIndex()

◆ SubMeshByName()

◆ SubMeshCount()

◆ SubMeshes()

◆ UpdateSkeletonAnimation()

Member Data Documentation

◆ material

◆ meshDescriptor

◆ ownsMaterial