Drake
Drake C++ Documentation
InMemoryMesh Struct Referencefinal

Detailed Description

Representation of a mesh file stored in memory.

At a minimum it includes the contents of a mesh file. If that mesh file makes reference to additional files (e.g., a .obj file can reference a .mtl which in turn references a .png file), then those files can be included in this InMemoryMesh's supporting files. Each supporting file is represented by a key-value pair. The key is the file-referencing string as it appears in the referencing file and the value is a FileSource. All supporting files can be located on disk; only the main mesh file is strictly required to be in memory. Failure to provide the supporting files may or may not lead to errors; it depends on the context in which the mesh data is used.

#include <drake/geometry/in_memory_mesh.h>

Public Member Functions

std::string to_string () const
 Returns a string representation. More...
 

Public Attributes

MemoryFile mesh_file
 The main mesh file's contents (e.g., a .obj or .gltf file, but not a .mtl or .bin). More...
 
string_map< FileSourcesupporting_files
 The optional collection of supporting files. More...
 

Member Function Documentation

◆ to_string()

std::string to_string ( ) const

Returns a string representation.

Member Data Documentation

◆ mesh_file

MemoryFile mesh_file

The main mesh file's contents (e.g., a .obj or .gltf file, but not a .mtl or .bin).

◆ supporting_files

string_map<FileSource> supporting_files

The optional collection of supporting files.


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