Gazebo Rendering

API Reference

3.7.2

#include <OgreMesh.hh>

Public Member Functions

virtual ~OgreMesh ()
 
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 Ogre::MovableObject * OgreObject () const override
 
virtual void SetSkeletonLocalTransforms (const std::map< std::string, math::Matrix4d > &_tfs) override
 Set transforms for the skeleton. More...
 
virtual std::map< std::string, math::Matrix4dSkeletonLocalTransforms () const override
 Get the skeleton local transforms. More...
 
- Public Member Functions inherited from BaseMesh< OgreGeometry >
virtual ~BaseMesh ()
 
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...
 
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 std::map< std::string, math::Matrix4dSkeletonLocalTransforms () const override
 Get the skeleton local transforms. 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...
 
- Public Member Functions inherited from Mesh
virtual ~Mesh ()
 Destructor. More...
 
virtual unsigned int SubMeshCount () const =0
 Get the sub-mesh count. More...
 
- Public Member Functions inherited from Geometry
virtual ~Geometry ()
 Deconstructor. More...
 
virtual MaterialPtr Material () const =0
 Get the material of this geometry. 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...
 
- Public Member Functions inherited from OgreGeometry
virtual ~OgreGeometry ()
 
virtual bool HasParent () const
 Determine if this Geometry is attached to a Visual. More...
 
virtual VisualPtr Parent () const
 Get the parent Visual. More...
 
- Public Member Functions inherited from BaseGeometry< OgreObject >
virtual ~BaseGeometry ()
 
virtual VisualPtr Parent () const override=0
 Get the parent Visual. More...
 
virtual void RemoveParent () override
 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 OgreObject
virtual ~OgreObject ()
 
virtual ScenePtr Scene () const
 
- Public Member Functions inherited from BaseObject
virtual ~BaseObject ()
 
virtual unsigned int Id () const override
 
virtual std::string Name () const override
 
virtual void PostRender () override
 

Protected Member Functions

 OgreMesh ()
 
virtual SubMeshStorePtr SubMeshes () const override
 
- Protected Member Functions inherited from BaseMesh< OgreGeometry >
 BaseMesh ()
 
virtual SubMeshStorePtr SubMeshes () const=0
 
- Protected Member Functions inherited from OgreGeometry
 OgreGeometry ()
 
virtual void SetParent (OgreVisualPtr _parent)
 
- Protected Member Functions inherited from BaseGeometry< OgreObject >
 BaseGeometry ()
 
- Protected Member Functions inherited from OgreObject
 OgreObject ()
 
- Protected Member Functions inherited from BaseObject
 BaseObject ()
 
virtual void Init ()
 
virtual void Load ()
 

Protected Attributes

Ogre::Entity * ogreEntity = nullptr
 
OgreSubMeshStorePtr subMeshes
 
- Protected Attributes inherited from BaseMesh< OgreGeometry >
MaterialPtr material
 Pointer to currently assigned material. More...
 
bool ownsMaterial
 Flag to indicate whether or not this mesh should be responsible for destroying the material. More...
 
- Protected Attributes inherited from OgreGeometry
OgreVisualPtr parent
 
- Protected Attributes inherited from OgreObject
OgreScenePtr scene
 
- Protected Attributes inherited from BaseObject
unsigned int id
 
std::string name
 

Constructor & Destructor Documentation

◆ OgreMesh()

OgreMesh ( )
protected

◆ ~OgreMesh()

virtual ~OgreMesh ( )
virtual

Member Function Documentation

◆ Destroy()

virtual void Destroy ( )
overridevirtual

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

Reimplemented from BaseMesh< OgreGeometry >.

◆ HasSkeleton()

virtual bool HasSkeleton ( ) const
overridevirtual

Check whether the mesh has skeleton.

Returns
True if the mesh has skeleton

Implements Mesh.

◆ OgreObject()

virtual Ogre::MovableObject* OgreObject ( ) const
overridevirtual

Implements OgreGeometry.

◆ SetSkeletonLocalTransforms()

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

Set transforms for the skeleton.

Parameters
[in]_tfsMap of skeleton local transformations
  • Map holding:
    • Skeleton node names
    • Local transformations of the skeleton nodes
Returns
True if all the transformations are set to the skeleton

Reimplemented from BaseMesh< OgreGeometry >.

◆ SkeletonLocalTransforms()

virtual 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.

◆ SubMeshes()

virtual SubMeshStorePtr SubMeshes ( ) const
overrideprotectedvirtual

Member Data Documentation

◆ ogreEntity

Ogre::Entity* ogreEntity = nullptr
protected

◆ subMeshes

OgreSubMeshStorePtr subMeshes
protected

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