Castor3D 0.12.0
Multiplatform 3D engine
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
castor3d::CmshImporter Class Reference

#include <CmshImporter.hpp>

Inheritance diagram for castor3d::CmshImporter:
Inheritance graph
[legend]
Collaboration diagram for castor3d::CmshImporter:
Collaboration graph
[legend]

Public Member Functions

C3D_API CmshImporter (Engine &engine)
 Constructor. More...
 
- Public Member Functions inherited from castor3d::MeshImporter
virtual ~MeshImporter ()=default
 
C3D_API MeshImporter (Engine &engine)
 Constructor. More...
 
C3D_API bool import (Mesh &mesh, castor::Path const &pathFile, Parameters const &parameters, bool initialise)
 Mesh import Function. More...
 
C3D_API bool import (Scene &scene, castor::Path const &pathFile, Parameters const &parameters, std::map< TextureFlag, TextureConfiguration > const &textureRemaps, bool initialise)
 Scene import Function. More...
 
C3D_API castor::ImageSPtr loadImage (castor::String const &name, castor::ImageCreateParams const &params) const
 Loads an image. More...
 
C3D_API castor::ImageSPtr loadImage (castor::Path const &path) const
 Loads an image from a file. More...
 
C3D_API castor::ImageSPtr loadImage (castor::String name, castor::String type, castor::ByteArray data) const
 Loads a texture. More...
 
C3D_API TextureSourceInfo loadTexture (castor3d::SamplerRes sampler, castor::Path const &path, TextureConfiguration const &config) const
 Loads a texture. More...
 
C3D_API TextureSourceInfo loadTexture (castor3d::SamplerRes sampler, castor::String name, castor::String type, castor::ByteArray data, TextureConfiguration const &config) const
 Loads a texture. More...
 
C3D_API bool convertToNormalMap (castor::Path &path, castor3d::TextureConfiguration &config) const
 Converts given height image file to a normal+height image. More...
 

Static Public Member Functions

static MeshImporterUPtr create (Engine &engine)
 Creator function. More...
 

Static Public Attributes

static castor::String const Type
 

Protected Member Functions

C3D_API bool doImportMesh (Mesh &mesh) override
 Mesh import Function. More...
 
C3D_API bool doImportScene (castor3d::Scene &scene) override
 Scene import Function. More...
 
virtual C3D_API bool doImportMesh (Mesh &mesh)=0
 Mesh import Function. More...
 
virtual C3D_API bool doImportScene (Scene &scene)=0
 Scene import Function. More...
 

Additional Inherited Members

- Protected Attributes inherited from castor3d::MeshImporter
castor::Path m_fileName
 The file name. More...
 
castor::Path m_filePath
 The file full path. More...
 
SceneNodePtrArray m_nodes
 The loaded scene nodes. More...
 
GeometryPtrStrMap m_geometries
 The loaded geometries. More...
 
MeshPtrStrMap m_meshes
 The loaded meshes. More...
 
Parameters m_parameters
 Import configuration parameters. More...
 
std::map< TextureFlag, TextureConfigurationm_textureRemaps
 Import texture remapping parameters. More...
 

Constructor & Destructor Documentation

◆ CmshImporter()

C3D_API castor3d::CmshImporter::CmshImporter ( Engine engine)
explicit

Constructor.

Parameters
[in]engineThe core engine.

Member Function Documentation

◆ create()

static MeshImporterUPtr castor3d::CmshImporter::create ( Engine engine)
static

Creator function.

Parameters
[in]engineThe core engine.

◆ doImportMesh()

C3D_API bool castor3d::CmshImporter::doImportMesh ( Mesh mesh)
overrideprotectedvirtual

Mesh import Function.

Parameters
[out]meshReceives the imported data.
Returns
false if any problem occured.

Implements castor3d::MeshImporter.

◆ doImportScene()

C3D_API bool castor3d::CmshImporter::doImportScene ( castor3d::Scene scene)
inlineoverrideprotectedvirtual

Scene import Function.

Parameters
[out]sceneReceives the imported data.
Returns
false if any problem occured.

Implements castor3d::MeshImporter.

Member Data Documentation

◆ Type

castor::String const castor3d::CmshImporter::Type
static

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