#include <AtomModulationStatics.h>

UAtomModulationStatics の継承関係図

公開メンバ関数
	UAtomModulationStatics (const FObjectInitializer &ObjectInitializer)

静的公開メンバ関数
static CRI_API void	ActivateBus (const UObject WorldContextObject, UAtomModulationControlBus Bus)
static CRI_API void	ActivateBusMix (const UObject WorldContextObject, UAtomModulationControlBusMix Mix)
static CRI_API void	ActivateGenerator (const UObject WorldContextObject, UAtomModulationGenerator Generator)
static CRI_API void	ClearAllGlobalBusMixValues (const UObject *WorldContextObject, float FadeTime=-1.0f)
static CRI_API void	ClearGlobalBusMixValue (const UObject WorldContextObject, UAtomModulationControlBus Bus, float FadeTime=-1.0f)
static CRI_API FAtomModulationControlBusMixStage	CreateBusMixStage (const UObject WorldContextObject, UAtomModulationControlBus Bus, float Value, float AttackTime=0.1f, float ReleaseTime=0.1f)
static CRI_API void	DeactivateAllBusMixes (const UObject *WorldContextObject)
static CRI_API void	DeactivateBus (const UObject WorldContextObject, UAtomModulationControlBus Bus)
static CRI_API void	DeactivateBusMix (const UObject WorldContextObject, UAtomModulationControlBusMix Mix)
static CRI_API void	DeactivateGenerator (const UObject WorldContextObject, UAtomModulationGenerator Generator)
static CRI_API UWorld *	GetAudioWorld (const UObject *WorldContextObject)
static CRI_API AtomModulation::FAtomModulationSystem *	GetModulation (UWorld *World)
static CRI_API void	SaveMixToProfile (const UObject WorldContextObject, UAtomModulationControlBusMix Mix, int32 ProfileIndex=0)
static CRI_API void	SetGlobalBusMixValue (const UObject WorldContextObject, UAtomModulationControlBus Bus, float Value, float FadeTime=-1.0f)
static CRI_API	UPARAM (DisplayName="Bus") UAtomModulationControlBus CreateBus(UObject WorldContextObject
static CRI_API	UPARAM (DisplayName="BusMix") UAtomModulationControlBusMix CreateBusMix(UObject WorldContextObject
static CRI_API	UPARAM (DisplayName="Destination") UAtomModulationDestination CreateModulationDestination(UObject WorldContextObject
static CRI_API	UPARAM (DisplayName="Generator") UAtomModulationGeneratorADEnvelope CreateADEnvelopeGenerator(UObject WorldContextObject
static CRI_API	UPARAM (DisplayName="Generator") UAtomModulationGeneratorEnvelopeFollower CreateEnvelopeFollowerGenerator(UObject WorldContextObject
static CRI_API	UPARAM (DisplayName="Generator") UAtomModulationGeneratorLFO CreateLFOGenerator(UObject WorldContextObject
static CRI_API	UPARAM (DisplayName="Is Active") bool IsControlBusMixActive(const UObject *WorldContextObject
static CRI_API	UPARAM (DisplayName="Mix") UAtomModulationControlBusMix CreateBusMixFromValue(const UObject WorldContextObject
static CRI_API	UPARAM (DisplayName="Modulators") TSet< UAtomModulatorBase * > GetModulatorsFromDestination(const FAtomSoundModulationSettings &Destination)
static CRI_API	UPARAM (DisplayName="Parameter") UAtomModulationParameter CreateModulationParameter(UObject WorldContextObject
static CRI_API	UPARAM (DisplayName="Stages") TArray< FAtomModulationControlBusMixStage > LoadMixFromProfile(const UObject *WorldContextObject
static CRI_API	UPARAM (DisplayName="Value") float GetModulatorValue(const UObject *WorldContextObject
static CRI_API void	UpdateMix (const UObject WorldContextObject, UAtomModulationControlBusMix Mix, TArray< FAtomModulationControlBusMixStage > Stages, float FadeTime=-1.0f, double Duration=-1.0, bool bRetriggerOnActivation=false)
static CRI_API void	UpdateMixByFilter (const UObject WorldContextObject, UAtomModulationControlBusMix Mix, FString AddressFilter, TSubclassOf< UAtomModulationParameter > ParamClassFilter, UAtomModulationParameter *ParamFilter, float Value=1.0f, float FadeTime=-1.0f)
static CRI_API void	UpdateMixFromObject (const UObject WorldContextObject, UAtomModulationControlBusMix Mix, float FadeTime=-1.0f)
static CRI_API void	UpdateModulator (const UObject WorldContextObject, UAtomModulatorBase Modulator)

公開変数類
static CRI_API FName TArray< FAtomModulationControlBusMixStage > bool	Activate
static CRI_API FName UAtomModulationParameter bool	Activate = false)
static CRI_API FName const TArray< UAtomModulationControlBus * > float float	AttackTime = 0.1f
static CRI_API UAtomModulationControlBusMix bool	bActivate = true
static CRI_API FName const TArray< UAtomModulationControlBus * > float float float bool	bActivate = true)
static CRI_API FName TArray< FAtomModulationControlBusMixStage > bool double bool	bRetriggerOnActivation = false)
static CRI_API FName const TArray< UAtomModulationControlBus * > &	Buses
static CRI_API FName TSubclassOf< UAtomModulationParameter > float	DefaultValue
static CRI_API FName TArray< FAtomModulationControlBusMixStage > bool double	Duration = -1.0
static CRI_API UAtomModulationControlBusMix *	Mix
static CRI_API UAtomModulatorBase *	Modulator
static CRI_API FName UAtomModulatorBase *	Modulator
static CRI_API FName	Name
static CRI_API FName TSubclassOf< UAtomModulationParameter >	ParamClass
static CRI_API FName UAtomModulationParameter *	Parameter
static CRI_API FName const FAtomModulationADEnvelopeParams &	Params
static CRI_API FName FAtomModulationLFOParams	Params
static CRI_API FName FAtomEnvelopeFollowerGeneratorParams	Params
static CRI_API UAtomModulationControlBusMix bool int32	ProfileIndex = 0)
static CRI_API FName const TArray< UAtomModulationControlBus * > float float float	ReleaseTime = 0.1f
static CRI_API FName TArray< FAtomModulationControlBusMixStage >	Stages
static CRI_API FName const TArray< UAtomModulationControlBus * > float	Value = 1.0f

構築子と解体子

◆ UAtomModulationStatics()

UAtomModulationStatics::UAtomModulationStatics ( const FObjectInitializer & ObjectInitializer )

関数詳解

◆ ActivateBus()

void UAtomModulationStatics::ActivateBus	(	const UObject *	WorldContextObject,
		UAtomModulationControlBus *	Bus )

static

Manually activates a modulation bus. If called, deactivation will only occur if bus is manually deactivated or destroyed (i.e. will not deactivate when all references become inactive).

◆ ActivateBusMix()

void UAtomModulationStatics::ActivateBusMix	(	const UObject *	WorldContextObject,
		UAtomModulationControlBusMix *	Mix )

static

Manually activates a bus modulator mix. If called, deactivation will only occur if mix is manually deactivated and not referenced or destroyed (i.e. will not deactivate when all references become inactive).

引数

BusMix - Mix to activate

◆ ActivateGenerator()

void UAtomModulationStatics::ActivateGenerator	(	const UObject *	WorldContextObject,
		UAtomModulationGenerator *	Generator )

static

Manually activates a modulation generator. If called, deactivation will only occur if generator is manually deactivated and not referenced or destroyed (i.e. will not deactivate when all references become inactive).

引数

Modulator - Modulator to activate

◆ ClearAllGlobalBusMixValues()

void UAtomModulationStatics::ClearAllGlobalBusMixValues	(	const UObject *	WorldContextObject,
		float	FadeTime = -1.0f )

static

Clears all global control bus mix values if set, using the applied fade time to return all to their respective bus's parameter default value.

引数

FadeTime - Fade time to user when interpolating between current value and new values. If non-positive, change is immediate.

◆ ClearGlobalBusMixValue()

void UAtomModulationStatics::ClearGlobalBusMixValue	(	const UObject *	WorldContextObject,
		UAtomModulationControlBus *	Bus,
		float	FadeTime = -1.0f )

static

Clears global control bus mix if set, using the applied fade time to return to the provided bus's parameter default value.

引数

Bus	- Bus associated with mix to update
FadeTime	- Fade time to user when interpolating between current value and new values. If non-positive, change is immediate.

◆ CreateBusMixStage()

FAtomModulationControlBusMixStage UAtomModulationStatics::CreateBusMixStage	(	const UObject *	WorldContextObject,
		UAtomModulationControlBus *	Bus,
		float	Value,
		float	AttackTime = 0.1f,
		float	ReleaseTime = 0.1f )

static

Creates a stage used to mix a control bus.

引数

Bus	- Bus stage is in charge of applying mix value to.
Value	- Value for added bus stage to target when mix is active.
AttackTime	- Time in seconds for stage to mix in.
ReleaseTime	- Time in seconds for stage to mix out.

◆ DeactivateAllBusMixes()

void UAtomModulationStatics::DeactivateAllBusMixes ( const UObject * WorldContextObject )

static

Deactivates all currently active Control Bus Mixes. This includes the Global Control Bus Mixes.

◆ DeactivateBus()

void UAtomModulationStatics::DeactivateBus	(	const UObject *	WorldContextObject,
		UAtomModulationControlBus *	Bus )

static

Deactivates a bus. Does nothing if the provided bus is already inactive.

引数

Bus	- Scope of modulator

◆ DeactivateBusMix()

void UAtomModulationStatics::DeactivateBusMix	(	const UObject *	WorldContextObject,
		UAtomModulationControlBusMix *	Mix )

static

Deactivates a modulation bus mix. Does nothing if an instance of the provided bus mix is already inactive.

引数

BusMix - Mix to deactivate

◆ DeactivateGenerator()

void UAtomModulationStatics::DeactivateGenerator	(	const UObject *	WorldContextObject,
		UAtomModulationGenerator *	Generator )

static

Deactivates a modulation generator. Does nothing if an instance of the provided generator is already inactive.

引数

Generator	- Generator to activate
Scope	- Scope of modulator

◆ GetAudioWorld()

UWorld * UAtomModulationStatics::GetAudioWorld ( const UObject * WorldContextObject )

static

Returns world associated with provided context object

◆ GetModulation()

AtomModulation::FAtomModulationSystem * UAtomModulationStatics::GetModulation ( UWorld * World )

static

Returns modulation implementation associated with the provided world

◆ SaveMixToProfile()

void UAtomModulationStatics::SaveMixToProfile	(	const UObject *	WorldContextObject,
		UAtomModulationControlBusMix *	Mix,
		int32	ProfileIndex = 0 )

static

Saves control bus mix to a profile, serialized to an ini file. If mix is loaded, uses current proxy's state. If not, uses default UObject representation.

引数

BusMix	- Mix object to serialize to profile .ini.
ProfileIndex	- Index of profile, allowing multiple profiles can be saved for single mix object. If 0, saves to default ini profile (no suffix).

◆ SetGlobalBusMixValue()

void UAtomModulationStatics::SetGlobalBusMixValue	(	const UObject *	WorldContextObject,
		UAtomModulationControlBus *	Bus,
		float	Value,
		float	FadeTime = -1.0f )

static

Sets a Global Control Bus Mix with a single stage associated with the provided Bus to the given float value. This call should be reserved for buses that are to be always active. It is NOT recommended for transient buses, as not calling clear can keep buses active indefinitely.

引数

Bus	- Bus associated with mix to update
Value	- Value to set global stage to.
FadeTime	- Fade time to user when interpolating between current value and new value. If negative, falls back to last fade time set on stage. If fade time never set on stage, defaults to 100ms.

◆ UPARAM() [1/12]

CRI_API UAtomModulationStatics::UPARAM ( DisplayName = "Bus" )

static

Creates a modulation bus with the provided default value.

引数

Name	- Name of bus
Parameter	- Default value for created bus
Activate	- Whether or not to activate bus on creation. If true, deactivation will only occur if returned bus is manually deactivated and not referenced or destroyed (i.e. will not deactivate when all references become inactive).

戻り値: Capture this in a Blueprint variable to prevent it from being automatically garbage collected.

◆ UPARAM() [2/12]

CRI_API UAtomModulationStatics::UPARAM ( DisplayName = "BusMix" )

static

Creates a modulation bus mix, with a bus stage set to the provided target value.

引数

Name	- Name of mix.
Stages	- Stages mix is responsible for.
Activate	- Whether or not to activate mix on creation. If true, deactivation will only occur if returned mix is manually deactivated and not referenced or destroyed (i.e. will not deactivate when all references become inactive).

戻り値: Capture this in a Blueprint variable to prevent it from being automatically garbage collected.

◆ UPARAM() [3/12]

CRI_API UAtomModulationStatics::UPARAM ( DisplayName = "Destination" )

static

Creates a modulation destination, which activates the given modulator (if not already active) and provides a function to retrieve the last value computed of the given modulator on the modulation processing thread.

◆ UPARAM() [4/12]

CRI_API UAtomModulationStatics::UPARAM ( DisplayName = "Generator" )

static

Creates a modulation generator based on an Attack/Decay Envelope.

引数

Name	- Name of generator.
Params	- The AD Envelope Settings.

戻り値: Capture this in a Blueprint variable to prevent it from being garbage collected.

◆ UPARAM() [5/12]

CRI_API UAtomModulationStatics::UPARAM ( DisplayName = "Generator" )

static

Creates a modulation generator based on an Envelope Follower with the given parameters.

引数

Name	- Name of generator.
Params	- The Envelope Follower settings, including what data to follow.

戻り値: Capture this in a Blueprint variable to prevent it from being garbage collected.

◆ UPARAM() [6/12]

CRI_API UAtomModulationStatics::UPARAM ( DisplayName = "Generator" )

static

Creates a modulation generator based on an LFO with the given parameters.

引数

Name	- Name of generator.
Params	- The LFO Settings.

戻り値: Capture this in a Blueprint variable to prevent it from being garbage collected.

◆ UPARAM() [7/12]

CRI_API UAtomModulationStatics::UPARAM ( DisplayName = "Is Active" ) const

static

Returns whether or not a Control Bus Mix is currently active.

引数

Mix	- the Control Bus Mix to check.

戻り値: Whether or not the Bus Mix is currently active.

◆ UPARAM() [8/12]

CRI_API UAtomModulationStatics::UPARAM ( DisplayName = "Mix" ) const

static

Create a mix with stages created for each provided bus that are initialized to the supplied value and timing parameters.

引数

Buses	- Buses to assign stages within new mix to
Value	- Initial value for all stages created within the new mix.
AttackTime	- Fade time to user when mix activates.
ReleaseTime	- Fade time to user when mix deactivates.

◆ UPARAM() [9/12]

CRI_API UAtomModulationStatics::UPARAM ( DisplayName = "Modulators" ) const &

static

Gets the list of modulators currently applied to a Modulation Destination.

引数

Destination - The Modulation Destination.

戻り値: Modulators - The set of Modulators.

◆ UPARAM() [10/12]

CRI_API UAtomModulationStatics::UPARAM ( DisplayName = "Parameter" )

static

Creates a modulation parameter of a given class.

引数

Name	- Name of parameter.
ParamClass	- The type of Modulation Parameter to create.
DefaultValue	- The default normalized value of the parameter (range 0-1).

戻り値: Capture this in a Blueprint variable to prevent it from being garbage collected.

◆ UPARAM() [11/12]

CRI_API UAtomModulationStatics::UPARAM ( DisplayName = "Stages" ) const

static

Loads control bus mix from a profile into UObject mix definition, deserialized from an ini file.

引数

BusMix	- Mix object to deserialize profile .ini to.
bActivate	- If true, activate mix upon loading from profile.
ProfileIndex	- Index of profile, allowing multiple profiles to be loaded to single mix object. If <= 0, loads from default profile (no suffix).

戻り値: Stages - Stage values loaded from profile (empty if profile did not exist or had no values serialized).

◆ UPARAM() [12/12]

CRI_API UAtomModulationStatics::UPARAM ( DisplayName = "Value" ) const

static

Gets the (normalized) value of the given modulator.

戻り値: Value - The current value of the modulator. If the modulator is not active, returns 1.0.

◆ UpdateMix()

void UAtomModulationStatics::UpdateMix	(	const UObject *	WorldContextObject,
		UAtomModulationControlBusMix *	Mix,
		TArray< FAtomModulationControlBusMixStage >	Stages,
		float	FadeTime = -1.0f,
		double	Duration = -1.0,
		bool	bRetriggerOnActivation = false )

static

Sets a Control Bus Mix with the provided stage data, if the stages are provided in an active instance proxy of the mix. Does not update UObject definition of the mix.

引数

Mix	- Mix to update
Stages	- Stages to set. If stage's bus is not referenced by mix, stage's update request is ignored.
FadeTime	- Fade time to user when interpolating between current value and new values. If negative, falls back to last fade time set on stage. If fade time never set on stage, uses attack time set on stage in mix asset.

◆ UpdateMixByFilter()

void UAtomModulationStatics::UpdateMixByFilter	(	const UObject *	WorldContextObject,
		UAtomModulationControlBusMix *	Mix,
		FString	AddressFilter,
		TSubclassOf< UAtomModulationParameter >	ParamClassFilter,
		UAtomModulationParameter *	ParamFilter,
		float	Value = 1.0f,
		float	FadeTime = -1.0f )

static

Sets filtered stages of a given class to a provided target value for active instance of mix. Does not update UObject definition of mix.

引数

Mix	- Mix to modify
AddressFilter	- (Optional) Address filter to apply to provided mix's stages.
ParamClassFilter	- (Optional) Filters buses by parameter class.
ParamFilter	- (Optional) Filters buses by parameter.
Value	- Target value to mix filtered stages to.
FadeTime	- If non-negative, updates the fade time for the resulting bus stages found matching the provided filter.

◆ UpdateMixFromObject()

void UAtomModulationStatics::UpdateMixFromObject	(	const UObject *	WorldContextObject,
		UAtomModulationControlBusMix *	Mix,
		float	FadeTime = -1.0f )

static

Commits updates from a UObject definition of a bus mix to active instance in audio thread (ignored if mix has not been activated).

引数

Mix	- Mix to update
FadeTime	- Fade time to user when interpolating between current value and new values. If negative, falls back to last fade time set on stage. If fade time never set on stage, uses attack time set on stage in mix asset.

◆ UpdateModulator()

void UAtomModulationStatics::UpdateModulator	(	const UObject *	WorldContextObject,
		UAtomModulatorBase *	Modulator )

static

Commits updates from a UObject definition of a modulator (e.g. Bus, Bus Mix, Generator) to active instance in audio thread (ignored if modulator type has not been activated).

引数

Modulator - Modulator to update

メンバ詳解

◆ Activate [1/2]

CRI_API FName TArray<FAtomModulationControlBusMixStage> bool UAtomModulationStatics::Activate

◆ Activate [2/2]

CRI_API FName UAtomModulationParameter bool UAtomModulationStatics::Activate = false)

◆ AttackTime

CRI_API FName const TArray<UAtomModulationControlBus*> float float UAtomModulationStatics::AttackTime = 0.1f

◆ bActivate [1/2]

CRI_API UAtomModulationControlBusMix bool UAtomModulationStatics::bActivate = true

◆ bActivate [2/2]

CRI_API FName const TArray<UAtomModulationControlBus*> float float float bool UAtomModulationStatics::bActivate = true)

◆ bRetriggerOnActivation

CRI_API FName TArray<FAtomModulationControlBusMixStage> bool double bool UAtomModulationStatics::bRetriggerOnActivation = false)

◆ Buses

CRI_API FName const TArray<UAtomModulationControlBus*>& UAtomModulationStatics::Buses

◆ DefaultValue

CRI_API FName TSubclassOf<UAtomModulationParameter> float UAtomModulationStatics::DefaultValue

◆ Duration

CRI_API FName TArray<FAtomModulationControlBusMixStage> bool double UAtomModulationStatics::Duration = -1.0

◆ Mix

CRI_API UAtomModulationControlBusMix * UAtomModulationStatics::Mix

◆ Modulator [1/2]

CRI_API UAtomModulatorBase* UAtomModulationStatics::Modulator

◆ Modulator [2/2]

CRI_API FName UAtomModulatorBase* UAtomModulationStatics::Modulator

◆ Name

CRI_API FName UAtomModulationStatics::Name

◆ ParamClass

CRI_API FName TSubclassOf<UAtomModulationParameter> UAtomModulationStatics::ParamClass

◆ Parameter

CRI_API FName UAtomModulationParameter* UAtomModulationStatics::Parameter

◆ Params [1/3]

CRI_API FName const FAtomModulationADEnvelopeParams& UAtomModulationStatics::Params

◆ Params [2/3]

CRI_API FName FAtomModulationLFOParams UAtomModulationStatics::Params

◆ Params [3/3]

CRI_API FName FAtomEnvelopeFollowerGeneratorParams UAtomModulationStatics::Params

◆ ProfileIndex

CRI_API UAtomModulationControlBusMix bool int32 UAtomModulationStatics::ProfileIndex = 0)

◆ ReleaseTime

CRI_API FName const TArray<UAtomModulationControlBus*> float float float UAtomModulationStatics::ReleaseTime = 0.1f

◆ Stages

CRI_API FName TArray<FAtomModulationControlBusMixStage> UAtomModulationStatics::Stages

◆ Value

CRI_API FName const TArray<UAtomModulationControlBus*> float UAtomModulationStatics::Value = 1.0f

このクラス詳解は次のファイルから抽出されました:

C:/git/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Public/Atom/Modulation/AtomModulationStatics.h
C:/git/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Private/Atom/Modulation/AtomModulationStatics.cpp

公開メンバ関数

静的公開メンバ関数

公開変数類

構築子と解体子

◆ UAtomModulationStatics()

関数詳解

◆ ActivateBus()

◆ ActivateBusMix()

◆ ActivateGenerator()

◆ ClearAllGlobalBusMixValues()

◆ ClearGlobalBusMixValue()

◆ CreateBusMixStage()

◆ DeactivateAllBusMixes()

◆ DeactivateBus()

◆ DeactivateBusMix()

◆ DeactivateGenerator()

◆ GetAudioWorld()

◆ GetModulation()

◆ SaveMixToProfile()

◆ SetGlobalBusMixValue()

◆ UPARAM() [1/12]

◆ UPARAM() [2/12]

◆ UPARAM() [3/12]

◆ UPARAM() [4/12]

◆ UPARAM() [5/12]

◆ UPARAM() [6/12]

◆ UPARAM() [7/12]

◆ UPARAM() [8/12]

◆ UPARAM() [9/12]

◆ UPARAM() [10/12]

◆ UPARAM() [11/12]

◆ UPARAM() [12/12]

◆ UpdateMix()

◆ UpdateMixByFilter()

◆ UpdateMixFromObject()

◆ UpdateModulator()

メンバ詳解

◆ Activate [1/2]

◆ Activate [2/2]

◆ AttackTime

◆ bActivate [1/2]

◆ bActivate [2/2]

◆ bRetriggerOnActivation

◆ Buses

◆ DefaultValue

◆ Duration

◆ Mix

◆ Modulator [1/2]

◆ Modulator [2/2]

◆ Name

◆ ParamClass

◆ Parameter

◆ Params [1/3]

◆ Params [2/3]

◆ Params [3/3]

◆ ProfileIndex

◆ ReleaseTime

◆ Stages

◆ Value