Castor3D 0.16.0
Multiplatform 3D engine
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
castor3d::SkeletonImporter Class Referenceabstract

#include <SkeletonImporter.hpp>

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

Public Member Functions

virtual ~SkeletonImporter ()=default
 
C3D_API SkeletonImporter (Engine &engine)
 Constructor.
 
C3D_API bool import (Skeleton &skeleton, ImporterFile *file, Parameters const &parameters)
 Skeleton import Function.
 
- Public Member Functions inherited from castor::OwnedBy< Engine >
Engine * getOwner () const
 

Static Public Member Functions

static C3D_API bool import (Skeleton &skeleton, castor::Path const &pathFile, Parameters const &parameters)
 Skeleton import Function.
 

Protected Member Functions

virtual C3D_API bool doImportSkeleton (Skeleton &skeleton)=0
 Skeleton import Function.
 
- Protected Member Functions inherited from castor::OwnedBy< Engine >
 OwnedBy (Engine &owner)
 Constructor.
 

Protected Attributes

ImporterFilem_file {}
 
Parameters m_parameters
 

Constructor & Destructor Documentation

◆ ~SkeletonImporter()

virtual castor3d::SkeletonImporter::~SkeletonImporter ( )
virtualdefault

◆ SkeletonImporter()

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

Constructor.

Parameters
[in]engineThe engine.

Member Function Documentation

◆ doImportSkeleton()

virtual C3D_API bool castor3d::SkeletonImporter::doImportSkeleton ( Skeleton & skeleton)
protectedpure virtual

Skeleton import Function.

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

Implemented in castor3d::CmshSkeletonImporter.

◆ import() [1/2]

static C3D_API bool castor3d::SkeletonImporter::import ( Skeleton & skeleton,
castor::Path const & pathFile,
Parameters const & parameters )
static

Skeleton import Function.

Parameters
[out]skeletonReceives the imported data.
[in]pathFileThe location of the file to import.
[in]parametersImport configuration parameters.
Returns
false if any problem occured.

◆ import() [2/2]

C3D_API bool castor3d::SkeletonImporter::import ( Skeleton & skeleton,
ImporterFile * file,
Parameters const & parameters )

Skeleton import Function.

Parameters
[out]skeletonReceives the imported data.
[in]fileThe location of the file to import.
[in]parametersImport configuration parameters.
Returns
false if any problem occured.

Member Data Documentation

◆ m_file

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

◆ m_parameters

Parameters castor3d::SkeletonImporter::m_parameters
protected

Import configuration parameters.


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