You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
o3de/Gems/LyShine/Code/Source/UiRadioButtonComponent.h

111 lines
3.9 KiB
C++

/*
* 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 "UiInteractableComponent.h"
#include <LyShine/Bus/UiRadioButtonBus.h>
#include <LyShine/Bus/UiRadioButtonCommunicationBus.h>
#include <LyShine/Bus/UiInitializationBus.h>
#include <LyShine/Bus/UiInteractableBus.h>
#include <LyShine/UiComponentTypes.h>
////////////////////////////////////////////////////////////////////////////////////////////////////
class UiRadioButtonComponent
: public UiInteractableComponent
, public UiRadioButtonBus::Handler
, public UiRadioButtonCommunicationBus::Handler
, public UiInitializationBus::Handler
{
public: // member functions
AZ_COMPONENT(UiRadioButtonComponent, LyShine::UiRadioButtonComponentUuid, AZ::Component);
UiRadioButtonComponent();
~UiRadioButtonComponent() override;
// UiRadioButtonInterface
bool GetState() override;
AZ::EntityId GetGroup() override;
AZ::EntityId GetCheckedEntity() override;
void SetCheckedEntity(AZ::EntityId entityId) override;
AZ::EntityId GetUncheckedEntity() override;
void SetUncheckedEntity(AZ::EntityId entityId) override;
const LyShine::ActionName& GetTurnOnActionName() override;
void SetTurnOnActionName(const LyShine::ActionName& actionName) override;
const LyShine::ActionName& GetTurnOffActionName() override;
void SetTurnOffActionName(const LyShine::ActionName& actionName) override;
const LyShine::ActionName& GetChangedActionName() override;
void SetChangedActionName(const LyShine::ActionName& actionName) override;
// ~UiRadioButtonInterface
// UiRadioButtonCommunicationInterface
void SetState(bool isOn, bool sendNotifications) override;
void SetGroup(AZ::EntityId group) override;
// ~UiRadioButtonCommunicationInterface
// UiInitializationInterface
void InGamePostActivate() override;
// ~UiInitializationInterface
// UiInteractableInterface
bool HandleReleased(AZ::Vector2 point) override;
bool HandleEnterReleased() override;
// ~UiInteractableInterface
protected: // member functions
// AZ::Component
void Activate() override;
void Deactivate() override;
// ~AZ::Component
static void GetProvidedServices(AZ::ComponentDescriptor::DependencyArrayType& provided)
{
provided.push_back(AZ_CRC("UiInteractableService", 0x1d474c98));
provided.push_back(AZ_CRC("UiStateActionsService"));
provided.push_back(AZ_CRC("UiNavigationService"));
}
static void GetIncompatibleServices(AZ::ComponentDescriptor::DependencyArrayType& incompatible)
{
incompatible.push_back(AZ_CRC("UiInteractableService", 0x1d474c98));
incompatible.push_back(AZ_CRC("UiNavigationService"));
incompatible.push_back(AZ_CRC("UiStateActionsService"));
}
static void GetRequiredServices(AZ::ComponentDescriptor::DependencyArrayType& required)
{
required.push_back(AZ_CRC("UiElementService", 0x3dca7ad4));
required.push_back(AZ_CRC("UiTransformService", 0x3a838e34));
}
static void Reflect(AZ::ReflectContext* context);
private: // member functions
AZ_DISABLE_COPY_MOVE(UiRadioButtonComponent);
using EntityComboBoxVec = AZStd::vector< AZStd::pair< AZ::EntityId, AZStd::string > >;
EntityComboBoxVec PopulateChildEntityList();
EntityComboBoxVec PopulateGroupsEntityList();
bool HandleReleasedCommon(const AZ::Vector2& point);
private: // data
bool m_isOn;
AZ::EntityId m_group; //!< The group this radio button belongs to.
AZ::EntityId m_optionalCheckedEntity; //!< The optional child element to show when ON.
AZ::EntityId m_optionalUncheckedEntity; //!< The optional child element to show when OFF.
LyShine::ActionName m_turnOnActionName;
LyShine::ActionName m_turnOffActionName;
LyShine::ActionName m_changedActionName;
};