FFOscillator

Defines oscillation of a single number.

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Camera/CameraShake.h

Include

#include "Camera/CameraShake.h"

Syntax

struct FFOscillator

Remarks

Defines oscillation of a single number.

Variables

Name Description

Public variable

float

 

Amplitude

Amplitude of the sinusoidal oscillation.

Public variable

float

 

Frequency

Frequency of the sinusoidal oscillation.

Public variable

TEnumAsByte< en...

 

InitialOffset

Defines how to begin (either at zero, or at a randomized value.

Public variable

EOscillatorWave...

 

Waveform

Type of waveform to use for oscillation.

Constructors

Name Description

Public function

FFOscillator()

Functions

Name Description

Public function Static

float

 

GetInitialOffset

(
    FFOscillator const& Osc
)

Returns the initial value of the oscillator.

Public function Static

float

 

GetOffsetAtTime

(
    FFOscillator const& Osc,
    float InitialOffset,
    float Time
)

Returns the offset at the given time

Public function Static

float

 

UpdateOffset

(
    FFOscillator const& Osc,
    float& CurrentOffset,
    float DeltaTime
)

Advances the oscillation time and returns the current value.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss