IGroomTranslator

Choose your operating system:

Windows

macOS

Linux

References

Module

HairStrandsEditor

Header

/Engine/Plugins/Runtime/HairStrands/Source/HairStrandsEditor/Public/HairStrandsTranslator.h

Include

#include "HairStrandsTranslator.h"

Syntax

class IGroomTranslator

Destructors

Name Description

Public function Virtual

~IGroomTranslator()

Functions

Name Description

Public function Virtual

bool

 

BeginTranslation

(
    const FString& FilePath
)

Open a file for multiple translations at different frame indices

Public function

bool

 

CanTranslate

(
    const FString& FilePath
)

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

Public function Virtual

void

 

EndTranslation()

Clean up after finishing translations

Public function Const

FString

 

GetSupportedFormat()

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

Public function Const

bool

 

IsFileExtensionSupported

(
    const FString& FileExtension
)

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

Public function

bool

 

Translate

(
    const FString& FilePath,
    FHairDescription& OutHairDescripti...,
    const FGroomConversionSettings& Co...
)

Translate a given file into a HairDescription; return true if successful

Public function Virtual

bool

 

Translate

(
    float FrameTime,
    FHairDescription& OutHairDescripti...,
    const FGroomConversionSettings& Co...
)

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

Public function Virtual

bool

 

Translate

(
    const FString& FilePath,
    FHairDescription& OutHairDescripti...,
    const FGroomConversionSettings& Co...,
    FGroomAnimationInfo* OutAnimIn...
)

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

Deprecated Functions

Name Description

Public function Virtual

bool

 

Translate

(
    uint32 FrameIndex,
    FHairDescription& OutHairDescripti...,
    const FGroomConversionSettings& Co...
)

Translate by frame index is deprecated. Use Translate by frame time instead.