o3de/Gems/LmbrCentral/Code/Source/Audio/AudioSwitchComponent.h

/*
 * Copyright (c) Contributors to the Open 3D Engine Project.
 * For complete copyright and license terms please see the LICENSE at the root of this distribution.
 *
 * SPDX-License-Identifier: Apache-2.0 OR MIT
 *
 */

#pragma once

#include <AzCore/std/string/string.h>
#include <AzCore/Component/Component.h>

#include <LmbrCentral/Audio/AudioSwitchComponentBus.h>

#include <IAudioInterfacesCommonData.h>

namespace LmbrCentral
{
    /*!
     * AudioSwitchComponent
     * A 'Switch' is something that can be in one 'State' at a time, but "switched" at run-time.
     * For example, a Switch called 'SurfaceMaterial' might have States such as 'Grass', 'Snow', 'Metal', 'Wood'.
     * But a Footstep sound would only be in one of those States at a time.
     */
    class AudioSwitchComponent
        : public AZ::Component
        , public AudioSwitchComponentRequestBus::Handler
    {
    public:
        /*!
         * AZ::Component
         */
        AZ_COMPONENT(AudioSwitchComponent, "{85FD9037-A5EA-4783-B49A-7959BBB34011}");
        void Activate() override;
        void Deactivate() override;

        AudioSwitchComponent() = default;
        AudioSwitchComponent(const AZStd::string& switchName, const AZStd::string& stateName);

        /*!
         * AudioSwitchComponentRequestBus::Handler Interface
         */
        void SetState(const char* stateName) override;
        void SetSwitchState(const char* switchName, const char* stateName) override;

        static void GetProvidedServices(AZ::ComponentDescriptor::DependencyArrayType& provided)
        {
            provided.push_back(AZ_CRC_CE("AudioSwitchService"));
        }

        static void GetRequiredServices(AZ::ComponentDescriptor::DependencyArrayType& required)
        {
            required.push_back(AZ_CRC_CE("AudioProxyService"));
        }

        static void GetDependentServices(AZ::ComponentDescriptor::DependencyArrayType& dependent)
        {
            dependent.push_back(AZ_CRC_CE("AudioPreloadService"));
        }

        static void GetIncompatibleServices(AZ::ComponentDescriptor::DependencyArrayType& incompatible)
        {
            incompatible.push_back(AZ_CRC_CE("AudioSwitchService"));
        }

        static void Reflect(AZ::ReflectContext* context);

    private:
        //! Editor callbacks
        void OnDefaultSwitchChanged();
        void OnDefaultStateChanged();

        //! Transient data
        Audio::TAudioControlID m_defaultSwitchID;
        Audio::TAudioControlID m_defaultStateID;

        //! Serialized data
        AZStd::string m_defaultSwitchName;
        AZStd::string m_defaultStateName;
    };
}