Ignition Rendering

API Reference

5.0.0
MeshDescriptor Struct Reference

Describes how a Mesh should be loaded. More...

#include <MeshDescriptor.hh>

Public Member Functions

 MeshDescriptor ()
 Constructor. More...
 
 MeshDescriptor (const std::string &_meshName)
 Constructor. A common::Mesh will be retrieved from the MeshManager by the given name upon a call to Normalize. More...
 
 MeshDescriptor (const common::Mesh *_mesh)
 Constructor. More...
 
void Load ()
 Ensures both the meshName and mesh member variables have been assigned. If mesh is not null, it will be used to override the value of meshName. More...
 

Public Attributes

bool centerSubMesh = false
 Denotes if the loaded sub-mesh vertices should be centered. More...
 
const common::Meshmesh = nullptr
 common::Mesh object More...
 
std::string meshName
 Name of the registered Mesh. More...
 
std::string subMeshName
 Name of the sub-mesh to be loaded. An empty string signifies all sub-meshes should be loaded. More...
 

Detailed Description

Describes how a Mesh should be loaded.

ignition/rendering/MeshDescriptor.hh

Constructor & Destructor Documentation

◆ MeshDescriptor() [1/3]

Constructor.

◆ MeshDescriptor() [2/3]

MeshDescriptor ( const std::string _meshName)
explicit

Constructor. A common::Mesh will be retrieved from the MeshManager by the given name upon a call to Normalize.

Parameters
[in]_meshNameName of the mesh to load

◆ MeshDescriptor() [3/3]

MeshDescriptor ( const common::Mesh _mesh)
explicit

Constructor.

Parameters
[in]_meshMesh to load

Member Function Documentation

◆ Load()

void Load ( )

Ensures both the meshName and mesh member variables have been assigned. If mesh is not null, it will be used to override the value of meshName.

Member Data Documentation

◆ centerSubMesh

bool centerSubMesh = false

Denotes if the loaded sub-mesh vertices should be centered.

◆ mesh

const common::Mesh* mesh = nullptr

common::Mesh object

◆ meshName

std::string meshName

Name of the registered Mesh.

◆ subMeshName

std::string subMeshName

Name of the sub-mesh to be loaded. An empty string signifies all sub-meshes should be loaded.


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