UWindDirectionalSourceComponent

Component that provides a directional wind source. Only affects SpeedTree assets.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Components/WindDirectionalSourceComponent.h

Include

#include "Components/WindDirectionalSourceComponent.h"

Syntax

class UWindDirectionalSourceComponent : public USceneComponent

Remarks

Component that provides a directional wind source. Only affects SpeedTree assets.

Variables

Name Description

Public variable

uint32: 1

 

bPointWind

Public variable

float

 

MaxGustAmount

Public variable

float

 

MinGustAmount

Public variable

float

 

Radius

Public variable

FWindSourceScen...

 

SceneProxy

Public variable

float

 

Speed

Public variable

float

 

Strength

Constructors

Name Description

Public function

UWindDirectionalSourceComponent

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Virtual Const

FWindSourceS...

 

CreateSceneProxy()

Creates a proxy to represent the primitive to the scene manager in the rendering thread.

Public function Const

bool

 

GetWindParameters

(
    const FVector& EvaluatePosition,
    FWindData& OutData,
    float& Weight
)

Calculate wind parameters from the data on this component, safe to call on game thread

Public function

void

 

SetMaximumGustAmount

(
    float InNewMaxGust
)

Set maximum deviation for wind gusts

Public function

void

 

SetMinimumGustAmount

(
    float InNewMinGust
)

Set minimum deviation for wind gusts

Public function

void

 

SetRadius

(
    float InNewRadius
)

Set the effect radius for point wind

Public function

void

 

SetSpeed

(
    float InNewSpeed
)

Sets the windspeed of the generated wind

Public function

void

 

SetStrength

(
    float InNewStrength
)

Because the actual data used to query wind is stored on the render thread in an instance of FWindSourceSceneProxy all of our properties are read only.

Public function

void

 

SetWindType

(
    EWindSourceType InNewType
)

Set the type of wind generator to use

Overridden from UActorComponent

Name Description

Protected function Virtual

void

 

Activate

(
    bool bReset
)

Activates the SceneComponent, should be overridden by native child classes.

Protected function Virtual

void

 

CreateRenderState_Concurrent

(
    FRegisterComponentContext* Con...
)

Used to create any rendering thread information for this component

Protected function Virtual

void

 

Deactivate()

Deactivates the SceneComponent.

Protected function Virtual

void

 

DestroyRenderState_Concurrent()

Used to shut down any rendering thread structure for this component

Protected function Virtual

void

 

SendRenderDynamicData_Concurrent()

Called to send dynamic data for this component to the rendering thread

Protected function Virtual

void

 

SendRenderTransform_Concurrent()

Called to send a transform update for this component to the rendering thread
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss