Castor3D 0.16.0
Multiplatform 3D engine
Fonctions membres publiques | Fonctions membres publiques statiques | Attributs protégés | Liste de tous les membres
Référence de la classe castor3d::MaterialImporterabstract

#include <MaterialImporter.hpp>

Graphe d'héritage de castor3d::MaterialImporter:
Inheritance graph
[légende]
Graphe de collaboration de castor3d::MaterialImporter:
Collaboration graph
[légende]

Fonctions membres publiques

virtual ~MaterialImporter ()=default
 
C3D_API MaterialImporter (Engine &engine)
 Constructeur.
 
C3D_API MaterialImporter (Engine &engine, ImporterFile *file)
 Constructeur.
 
C3D_API bool import (Material &material, ImporterFile *file, Parameters const &parameters, castor::Map< PassComponentTextureFlag, TextureConfiguration > const &textureRemaps)
 Fonction d'import de Scene.
 
C3D_API castor::ImageRPtr loadImage (castor::String const &name, castor::ImageCreateParams const &params) const
 Charge une image.
 
C3D_API castor::ImageRPtr loadImage (castor::Path const &path) const
 Charge une image depuis un fichier.
 
C3D_API castor::ImageRPtr loadImage (castor::String const &name, castor::String type, castor::ByteArray data) const
 Charge une texture.
 
C3D_API TextureSourceInfo loadTexture (castor::Path const &path, TextureConfiguration const &config) const
 Charge une texture.
 
C3D_API TextureSourceInfo loadTexture (castor::String name, castor::String type, castor::ByteArray data, TextureConfiguration const &config) const
 Charge une texture.
 
C3D_API void loadTexture (castor::Path const &path, TextureConfiguration const &config, PassTextureConfig const &passConfig, Pass &pass) const
 Charge une texture et l'ajoute à la passe donnée.
 
C3D_API void loadTexture (castor::String name, castor::String type, castor::ByteArray data, TextureConfiguration const &config, PassTextureConfig const &passConfig, Pass &pass) const
 Charge une texture et l'ajoute à la passe donnée.
 
C3D_API bool convertToNormalMap (castor::Path &path, castor3d::TextureConfiguration &config) const
 Convertit le fichier d'image de hauteur en une image normale+hauteur.
 
ImporterFile const * getImporterFile () const noexcept
 
- Fonctions membres publiques hérités de castor::OwnedBy< Engine >
Engine * getOwner () const
 L'objet propriétaire.
 

Fonctions membres publiques statiques

static C3D_API bool import (Material &material, castor::Path const &pathFile, Parameters const &parameters, castor::Map< PassComponentTextureFlag, TextureConfiguration > const &textureRemaps)
 Fonction d'import de Scene.
 

Attributs protégés

ImporterFilem_file {}
 
Parameters m_parameters
 
castor::Map< PassComponentTextureFlag, TextureConfigurationm_textureRemaps
 

Membres hérités additionnels

- Fonctions membres protégées hérités de castor::OwnedBy< Engine >
 OwnedBy (Engine &owner)
 Constructeur.
 

Documentation des constructeurs et destructeur

◆ ~MaterialImporter()

virtual castor3d::MaterialImporter::~MaterialImporter ( )
virtualdefault

◆ MaterialImporter() [1/2]

C3D_API castor3d::MaterialImporter::MaterialImporter ( Engine & engine)
explicit

Constructeur.

Paramètres
[in]engineLe moteur.

◆ MaterialImporter() [2/2]

C3D_API castor3d::MaterialImporter::MaterialImporter ( Engine & engine,
ImporterFile * file )
explicit

Constructeur.

Paramètres
[in]engineLe moteur.
[in]fileLe fichier à importer.

Documentation des fonctions membres

◆ convertToNormalMap()

C3D_API bool castor3d::MaterialImporter::convertToNormalMap ( castor::Path & path,
castor3d::TextureConfiguration & config ) const

Convertit le fichier d'image de hauteur en une image normale+hauteur.

Paramètres
[in,out]pathLe chemin vers l'image (peut être relatif ou absolu), reçoit le chemin de l'image normale+hauteur.
[in,out]configLa configuration de la texture.
Renvoie
false en cas d'erreur.

◆ getImporterFile()

ImporterFile const * castor3d::MaterialImporter::getImporterFile ( ) const
inlinenoexcept

Références m_file.

◆ import() [1/2]

static C3D_API bool castor3d::MaterialImporter::import ( Material & material,
castor::Path const & pathFile,
Parameters const & parameters,
castor::Map< PassComponentTextureFlag, TextureConfiguration > const & textureRemaps )
static

Fonction d'import de Scene.

Paramètres
[out]materialReçoit les données importées.
[in]pathFileLe chemin vers le fichier à importer.
[in]parametersParamètres de configuration de l'import.
[in]textureRemapsLes paramètres de reaffectation des textures importées.
Renvoie
false si un problème quelconque est survenu.

◆ import() [2/2]

C3D_API bool castor3d::MaterialImporter::import ( Material & material,
ImporterFile * file,
Parameters const & parameters,
castor::Map< PassComponentTextureFlag, TextureConfiguration > const & textureRemaps )

Fonction d'import de Scene.

Paramètres
[out]materialReçoit les données importées.
[in]fileLe fichier à importer.
[in]parametersParamètres de configuration de l'import.
[in]textureRemapsLes paramètres de reaffectation des textures importées.
Renvoie
false si un problème quelconque est survenu.

◆ loadImage() [1/3]

C3D_API castor::ImageRPtr castor3d::MaterialImporter::loadImage ( castor::Path const & path) const

Charge une image depuis un fichier.

Paramètres
[in]pathLe chemin vers l'image (peut être relatif ou absolu).
Renvoie
L'image.

◆ loadImage() [2/3]

C3D_API castor::ImageRPtr castor3d::MaterialImporter::loadImage ( castor::String const & name,
castor::ImageCreateParams const & params ) const

Charge une image.

Paramètres
[in]nameLe nom de l'image.
[in]paramsLes paramètres de création de l'image.
Renvoie
L'image.

◆ loadImage() [3/3]

C3D_API castor::ImageRPtr castor3d::MaterialImporter::loadImage ( castor::String const & name,
castor::String type,
castor::ByteArray data ) const

Charge une texture.

Paramètres
[in]nameLe nom de l'image.
[in]typeLe type des données de l'image.
[in]dataLes données de l'image.
Renvoie
L'unité de texture.

◆ loadTexture() [1/4]

C3D_API TextureSourceInfo castor3d::MaterialImporter::loadTexture ( castor::Path const & path,
TextureConfiguration const & config ) const

Charge une texture.

Paramètres
[in]pathLe chemin vers l'image (peut être relatif ou absolu).
[in]configLa configuration de la texture.
Renvoie
L'unité de texture.

◆ loadTexture() [2/4]

C3D_API void castor3d::MaterialImporter::loadTexture ( castor::Path const & path,
TextureConfiguration const & config,
PassTextureConfig const & passConfig,
Pass & pass ) const

Charge une texture et l'ajoute à la passe donnée.

Paramètres
[in]pathLe chemin vers l'image (peut être relatif ou absolu).
[in]configLa configuration de la texture.
[in]passConfigLa configuration de l'unité de texture.
[in,out]passReçoit l'image chargée.

◆ loadTexture() [3/4]

C3D_API TextureSourceInfo castor3d::MaterialImporter::loadTexture ( castor::String name,
castor::String type,
castor::ByteArray data,
TextureConfiguration const & config ) const

Charge une texture.

Paramètres
[in]nameLe nom de l'image.
[in]typeLe type des données de l'image.
[in]dataLes données de l'image.
[in]configLa configuration de la texture.
Renvoie
L'unité de texture.

◆ loadTexture() [4/4]

C3D_API void castor3d::MaterialImporter::loadTexture ( castor::String name,
castor::String type,
castor::ByteArray data,
TextureConfiguration const & config,
PassTextureConfig const & passConfig,
Pass & pass ) const

Charge une texture et l'ajoute à la passe donnée.

Paramètres
[in]nameLe nom de l'image.
[in]typeLe type des données de l'image.
[in]dataLes données de l'image.
[in]configLa configuration de la texture.
[in]passConfigLa configuration de l'unité de texture.
[in,out]passReçoit l'image chargée.

Documentation des données membres

◆ m_file

ImporterFile* castor3d::MaterialImporter::m_file {}
protected

Référencé par getImporterFile().

◆ m_parameters

Parameters castor3d::MaterialImporter::m_parameters
protected

◆ m_textureRemaps

castor::Map< PassComponentTextureFlag, TextureConfiguration > castor3d::MaterialImporter::m_textureRemaps
protected

La documentation de cette classe a été générée à partir du fichier suivant :