Atom::IModulatorSettings Class Reference

#include <AtomModulation.h>

Inheritance diagram for Atom::IModulatorSettings:

Public Member Functions
virtual	~IModulatorSettings ()=default
virtual TUniquePtr< IModulatorSettings >	Clone () const =0
virtual FModulatorId	GetModulatorId () const =0
virtual const Atom::FModulationParameter &	GetOutputParameter () const =0
virtual Atom::FModulatorTypeId	Register (Atom::FModulatorHandleId HandleId, AtomModulation::FAtomModulationSystem &InModulation) const =0

Detailed Description

Interface for cached off Modulator UObject data used as default settings to be converted to instanced proxy data per Atom runtime on the AtomRenderThread. If proxy is already active, implementation is expected to ignore register call and return existing modulator proxy's type Id & set parameter accordingly.

Constructor & Destructor Documentation

~IModulatorSettings()

virtual Atom::IModulatorSettings::~IModulatorSettings ( )

virtualdefault

Member Function Documentation

Clone()

virtual TUniquePtr< IModulatorSettings > Atom::IModulatorSettings::Clone ( ) const

pure virtual

Implemented in AtomModulation::FControlBusSettings, AtomModulation::FModulationGeneratorSettings, and AtomModulation::FModulationPatchSettings.

GetModulatorId()

virtual FModulatorId Atom::IModulatorSettings::GetModulatorId ( ) const

pure virtual

Implemented in AtomModulation::FControlBusSettings, AtomModulation::FModulationGeneratorSettings, and AtomModulation::FModulationPatchSettings.

GetOutputParameter()

virtual const Atom::FModulationParameter & Atom::IModulatorSettings::GetOutputParameter ( ) const

pure virtual

Implemented in AtomModulation::FControlBusSettings, AtomModulation::FModulationGeneratorSettings, and AtomModulation::FModulationPatchSettings.

Register()

virtual Atom::FModulatorTypeId Atom::IModulatorSettings::Register ( Atom::FModulatorHandleId HandleId, AtomModulation::FAtomModulationSystem & InModulation ) const

pure virtual

Implemented in AtomModulation::FControlBusSettings, AtomModulation::FModulationGeneratorSettings, and AtomModulation::FModulationPatchSettings.

---

The documentation for this class was generated from the following file:

• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Public/Atom/Modulation/AtomModulation.h