Skip to content

File SwitchContainer.h

File List > Amplitude > Sound > SwitchContainer.h

Go to the documentation of this file

// Copyright (c) 2021-present Sparky Studios. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once

#ifndef _AM_SOUND_SWITCH_CONTAINER_H
#define _AM_SOUND_SWITCH_CONTAINER_H

#include <SparkyStudios/Audio/Amplitude/Sound/Fader.h>
#include <SparkyStudios/Audio/Amplitude/Sound/SoundObject.h>
#include <SparkyStudios/Audio/Amplitude/Sound/Switch.h>

namespace SparkyStudios::Audio::Amplitude
{
    struct SwitchContainerItem
    {
        AmObjectID m_id;

        bool m_continueBetweenStates;

        AmTime m_fadeInDuration;

        AmString m_fadeInAlgorithm;

        AmTime m_fadeOutDuration;

        AmString m_fadeOutAlgorithm;

        RtpcValue m_gain;

        RtpcValue m_pitch;
    };

    class AM_API_PUBLIC SwitchContainer
        : public SoundObject
        , public Asset<AmSwitchContainerID>
    {
    public:
        [[nodiscard]] virtual const Switch* GetSwitch() const = 0;

        [[nodiscard]] virtual std::shared_ptr<FaderInstance> GetFaderIn(AmObjectID id) const = 0;

        [[nodiscard]] virtual std::shared_ptr<FaderInstance> GetFaderOut(AmObjectID id) const = 0;

        [[nodiscard]] virtual const std::vector<SwitchContainerItem>& GetSoundObjects(AmObjectID stateId) const = 0;
    };
} // namespace SparkyStudios::Audio::Amplitude

#endif // _AM_SOUND_SWITCH_CONTAINER_H