1. Epic GamesDeveloper
  3. UWindDirectionalSourceComponent

UWindDirectionalSourceComponent

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

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Components

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Components/WindDirectionalSourceComponent.h
Include #include "Components/WindDirectionalSourceComponent.h"

Syntax

UCLASS (CollapseCategories, HideCategories=(Object, Mobility), EditInlineNew, MinimalAPI)  
class UWindDirectionalSourceComponent : public USceneComponent

Remarks

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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadOnly uint32: 1 bPointWind  
Public variable UProperty Category, Interp BlueprintReadOnly float MaxGustAmount  
Public variable UProperty Category, Interp BlueprintReadOnly float MinGustAmount  
Public variable UProperty Category, Interp, Meta float Radius  
Public variable FWindSourceSceneProxy * SceneProxy  
Public variable UProperty Category, Interp float Speed  
Public variable UProperty Category, Interp float Strength  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Virtual Const FWindSourceSceneProxy * 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 UFunction BlueprintCallable, Category void

SetMaximumGustAmount ( float InNewMaxGust
)

 Set maximum deviation for wind gusts
Public function UFunction BlueprintCallable, Category void

SetMinimumGustAmount ( float InNewMinGust
)

 Set minimum deviation for wind gusts
Public function UFunction BlueprintCallable, Category void

SetRadius ( float InNewRadius
)

 Set the effect radius for point wind
Public function UFunction BlueprintCallable, Category void

SetSpeed ( float InNewSpeed
)

 Sets the windspeed of the generated wind
Public function UFunction BlueprintCallable, Category 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 UFunction BlueprintCallable, Category void Set the type of wind generator to use

Overridden from UActorComponent

  Type Name Description
Protected function Virtual void

Activate ( bool bReset
)

 Activates the SceneComponent, should be overridden by native child classes.
Protected function Virtual void Used to create any rendering thread information for this component
Protected function Virtual void Deactivates the SceneComponent.
Protected function Virtual void Used to shut down any rendering thread structure for this component
Protected function Virtual void Called to send dynamic data for this component to the rendering thread
Protected function Virtual void Called to send a transform update for this component to the rendering thread

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page