UGroomAsset

Implements an asset that can be used to store hair strands

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

HairStrandsCore

Header

/Engine/Plugins/Experimental/HairStrands/Source/HairStrandsCore/Public/GroomAsset.h

Include

#include "GroomAsset.h"

Syntax

UCLASS (BlueprintType, HideCategories=(Object))
class UGroomAsset :
    public UObject ,
    public IInterface_AssetUserData

Remarks

Implements an asset that can be used to store hair strands

Variables

Name Description

Public variable UProperty Category instanced, visibleanywhere

UAssetImportDat ...

 

AssetImportData

Asset data to be used when re-importing

Public variable UProperty Category, EditAnywhere, AdvancedDisplay instanced

TArray < UAssetU ...

 

AssetUserData

Array of user data stored with the asset

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite editfixedsize

bool

 

EnableGlobalInterpolation

Enable radial basis function interpolation to be used instead of the local skin rigid transform

Public variable

TArray < FHairGr ...

 

HairGroupsData

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite editfixedsize

TArray < FHairGr ...

 

HairGroupsInfo

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite editfixedsize

TArray < FHairGr ...

 

HairGroupsPhysics

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite editfixedsize

EGroomInterpola ...

 

HairInterpolationType

Type of interpolation used

Public variable UProperty Category, Meta BlueprintReadWrite

float

 

HairToGuideDensity

Density factor for converting hair into guide curve if no guides are provided.

Public variable

FOnGroomAssetCh ...

 

OnGroomAssetChanged

Private :

Constructors

Name Description

Public function

UGroomAsset

(
    const FObjectInitializer & ObjectIn...
)

Functions

Name Description

Public function

bool

 

CacheDerivedData

(
    const FGroomBuildSettings * Bui...
)

Caches the computed groom data with the given build settings from/to the Derived Data Cache, building it if needed

Public function Const

bool

 

CanRebuildFromDescription()

Returns true if the asset has the HairDescription needed to recompute its groom data

Public function

void

 

CommitHairDescription

(
    FHairDescription && HairDescription
)

Commits a HairDescription to buffer for serialization

Public function Const

int32

 

GetNumHairGroups()

Public function

FOnGroomAsse ...

 

GetOnGroomAssetChanged()

Public function

void

 

InitResource()

Initialize resources.

Public function Const

bool

 

IsValid()

Public function

void

 

ReleaseResource()

Release the hair strands resource.

Public function

void

 

Reset()

Public function

void

 

UpdateResource()

Update resources.

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Public function Virtual Const

void

 

GetAssetRegistryTags

(
    TArray < FAssetRegistryTag >& OutTa...
)

Retrievde the asset tags

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent & PropertyCha...
)

Part of Uobject interface

Public function Virtual

void

 

PostInitProperties()

Part of Uobject interface

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Public function Virtual

void

 

Serialize

(
    FArchive & Ar
)

Handles reading, writing, and reference collecting using FArchive .

Overridden from IInterface_AssetUserData

Name Description

Public function Virtual

void

 

AddAssetUserData

(
    UAssetUserData * InUserData
)

Public function Virtual Const

const TArray ...

 

GetAssetUserDataArray()

Public function Virtual

UAssetUserDa ...

 

GetAssetUserDataOfClass

(
    TSubclassOf < UAssetUserData > InUse...
)

Public function Virtual

void

 

RemoveUserDataOfClass

(
    TSubclassOf < UAssetUserData > InUse...
)

Typedefs

Name

Description

FOnGroomAssetChanged

Notification when anything changed

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback