1. Epic GamesDeveloper
  3. IGroomTranslator

IGroomTranslator

API > API/Plugins > API/Plugins/HairStrandsEditor

   
Name IGroomTranslator
Type class
Header File /Engine/Plugins/Runtime/HairStrands/Source/HairStrandsEditor/Public/HairStrandsTranslator.h
Include Path #include "HairStrandsTranslator.h"

Syntax

class IGroomTranslator

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IGroomTranslator()

   HairStrandsTranslator.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool BeginTranslation ( const FString& FilePath
)

 Open a file for multiple translations at different frame indices HairStrandsTranslator.h  

bool CanTranslate ( const FString& FilePath
)

 Return true if a given file can be translated (by checking its content if necessary) HairStrandsTranslator.h  

virtual void EndTranslation()

 Clean up after finishing translations HairStrandsTranslator.h  

FString GetSupportedFormat()

 Return the file format supported by the translator in the form "ext;file format description" HairStrandsTranslator.h  

bool IsFileExtensionSupported ( const FString& FileExtension
) const

 Return true if a given file extension is supported by the translator HairStrandsTranslator.h  

bool Translate ( const FString& FilePath,
FHairDescription& OutHairDescription,
const FGroomConversionSettings& ConversionSettings
)

 Translate a given file into a HairDescription; return true if successful HairStrandsTranslator.h  

virtual bool Translate ( uint32 FrameIndex,
FHairDescription& OutHairDescription,
const FGroomConversionSettings& ConversionSettings
)

 Translate a given file into a HairDescription at the requested frame index; return true if successful HairStrandsTranslator.h  

virtual bool Translate ( float FrameTime,
FHairDescription& OutHairDescription,
const FGroomConversionSettings& ConversionSettings
)

 Translate a given file into a HairDescription at the requested frame time (in seconds); return true if successful HairStrandsTranslator.h  

virtual bool Translate ( const FString& FilePath,
FHairDescription& OutHairDescription,
const FGroomConversionSettings& ConversionSettings,
FGroomAnimationInfo* OutAnimInfo
)

 Translate a given file into a HairDescription with info about Groom animation if OutAnimInfo is not null; return true if successful HairStrandsTranslator.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page