ezAnimationClipAssetDocumentGenerator Class Reference

Inheritance diagram for ezAnimationClipAssetDocumentGenerator:

Public Member Functions
virtual void	GetImportModes (ezStringView sAbsInputFile, ezDynamicArray< ezAssetDocumentGenerator::ImportMode > &out_modes) const override
	Used to fill out which import modes may be available for the given asset.
virtual ezStringView	GetDocumentExtension () const override
	Returns the target asset document file extension.
virtual ezStringView	GetGeneratorGroup () const override
	Allows to merge the import modes of multiple generators in the UI in one group.
virtual bool	NeedsImport (ezStringView sInputFileAbs, ezStringView sMode) const override
	Whether Import() should run Generate() at all.
virtual ezStatus	Generate (ezStringView sInputFileAbs, ezStringView sMode, ezDynamicArray< ezDocument * > &out_generatedDocuments) override
	Tells the generator to create a new asset document with the chosen mode.
Public Member Functions inherited from ezAssetDocumentGenerator
ezStatus	Import (ezStringView sInputFileAbs, ezStringView sMode, bool bOpenDocument, ImportResult *out_pResult=nullptr, ezStringBuilder *out_pDocumentPath=nullptr)
	Imports the given file with the mode. Must be a mode that the generator supports.
ezStringBuilder	GetImportTargetPath (ezStringView sInputFileAbs) const
	Returns the path of the document that importing the given file would produce.
bool	SupportsFileType (ezStringView sFile) const
	Returns whether this generator supports the given file type for import.
Public Member Functions inherited from ezReflectedClass
virtual const ezRTTI *	GetDynamicRTTI () const
bool	IsInstanceOf (const ezRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.
template<typename T >
EZ_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.

Additional Inherited Members
Public Types inherited from ezAssetDocumentGenerator
enum class	ImportResult { Imported , AlreadyExists }
Static Public Member Functions inherited from ezAssetDocumentGenerator
static void	GetSupportsFileTypes (ezSet< ezString > &out_extensions)
	Creates a list of all importable file extensions. Note that this is an expensive function so the the result should be cached.
static void	ImportAssets ()
	Opens a file browse dialog to let the user choose which files to import.
static void	ImportAssets (const ezDynamicArray< ezString > &filesToImport)
	Opens the "Asset Import" dialog to let the user choose how to import the given files.
static void	CreateGenerators (ezDynamicArray< ezAssetDocumentGenerator * > &out_generators)
	Instantiates all currently available generators.
static void	DestroyGenerators (const ezDynamicArray< ezAssetDocumentGenerator * > &generators)
	Destroys the previously instantiated generators.
Static Public Member Functions inherited from ezNoBase
static const ezRTTI *	GetStaticRTTI ()
Protected Member Functions inherited from ezAssetDocumentGenerator
void	AddSupportedFileType (ezStringView sExtension)

Member Function Documentation

Generate()

ezStatus ezAnimationClipAssetDocumentGenerator::Generate ( ezStringView  sInputFileAbs, ezStringView  sMode, ezDynamicArray< ezDocument * > &  out_generatedDocuments  )

overridevirtual

Tells the generator to create a new asset document with the chosen mode.

Import() only calls this when NeedsImport() said there is something to do, so an implementation that maps one file to one document doesn't have to check whether its target already exists. Returning success with an empty array means nothing was left to create, which Import() reports as ImportResult::AlreadyExists.

Implements ezAssetDocumentGenerator.

GetDocumentExtension()

virtual ezStringView ezAnimationClipAssetDocumentGenerator::GetDocumentExtension ( ) const

inlineoverridevirtual

Returns the target asset document file extension.

Implements ezAssetDocumentGenerator.

GetGeneratorGroup()

virtual ezStringView ezAnimationClipAssetDocumentGenerator::GetGeneratorGroup ( ) const

inlineoverridevirtual

Allows to merge the import modes of multiple generators in the UI in one group.

Not really used anymore, but theoretically allows to show the same file multiple times in the import dialog, such that one can import it as multiple different asset types.

Implements ezAssetDocumentGenerator.

GetImportModes()

void ezAnimationClipAssetDocumentGenerator::GetImportModes ( ezStringView  sAbsInputFile, ezDynamicArray< ezAssetDocumentGenerator::ImportMode > &  out_modes  ) const

overridevirtual

Used to fill out which import modes may be available for the given asset.

Note: sAbsInputFile may be empty, in this case it should fill out the array for "general purpose" import (any file of the supported types).

Implements ezAssetDocumentGenerator.

NeedsImport()

bool ezAnimationClipAssetDocumentGenerator::NeedsImport ( ezStringView  sInputFileAbs, ezStringView  sMode  ) const

overridevirtual

Whether Import() should run Generate() at all.

The default returns false if GetImportTargetPath() already exists, which is the correct answer for every generator that turns one source file into one document.

Override this for modes where one source file produces multiple documents: there the primary path existing says nothing about whether the others do, so the generator has to decide, or return true and skip individual documents while generating.

Reimplemented from ezAssetDocumentGenerator.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/EditorPlugins/Assets/EditorPluginAssets/AnimationClipAsset/AnimationClipAsset.h
• /home/runner/work/ezEngine/ezEngine/Code/EditorPlugins/Assets/EditorPluginAssets/AnimationClipAsset/AnimationClipAsset.cpp