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.
79 lines
3.0 KiB
C++
79 lines
3.0 KiB
C++
/*
|
|
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
|
* its licensors.
|
|
*
|
|
* For complete copyright and license terms please see the LICENSE at the root of this
|
|
* distribution (the "License"). All use of this software is governed by the License,
|
|
* or, if provided, by the license below or the license accompanying this file. Do not
|
|
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
*
|
|
*/
|
|
#pragma once
|
|
|
|
#include <AzCore/Component/ComponentBus.h>
|
|
#include <AzCore/Math/Vector2.h>
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
//! Interface class that a scrollable component needs to implement. A scrollable component is one
|
|
//! that provides functionality to scroll its content
|
|
//! (e.g. UiScrollBoxComponent)
|
|
class UiScrollableInterface
|
|
: public AZ::ComponentBus
|
|
{
|
|
public: // member functions
|
|
|
|
virtual ~UiScrollableInterface() {}
|
|
|
|
//! Get the ratio between the scrollable content size and the size of its parent
|
|
virtual bool GetScrollableParentToContentRatio(AZ::Vector2& ratioOut) = 0;
|
|
|
|
public: // static member data
|
|
|
|
//! Only one component on a entity can implement the events
|
|
static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single;
|
|
};
|
|
|
|
typedef AZ::EBus<UiScrollableInterface> UiScrollableBus;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
//! Interface class that listeners need to implement in order to get notifications when values of the
|
|
//! scrollable change
|
|
class UiScrollableNotifications
|
|
: public AZ::ComponentBus
|
|
{
|
|
public: // member functions
|
|
|
|
virtual ~UiScrollableNotifications(){}
|
|
|
|
//! Called when the scroll value (0 - 1) is changing
|
|
virtual void OnScrollableValueChanging(AZ::Vector2 value) = 0;
|
|
|
|
//! Called when the scroll value (0 - 1) has been changed
|
|
virtual void OnScrollableValueChanged(AZ::Vector2 value) = 0;
|
|
};
|
|
|
|
typedef AZ::EBus<UiScrollableNotifications> UiScrollableNotificationBus;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
//! Interface class that scrollers need to implement in order to get notifications of changes
|
|
//! created by the scrollable
|
|
class UiScrollableToScrollerNotifications
|
|
: public AZ::ComponentBus
|
|
{
|
|
public: // member functions
|
|
|
|
virtual ~UiScrollableToScrollerNotifications(){}
|
|
|
|
//! Called when the scrollable is changing the scroll value (0 - 1)
|
|
virtual void OnValueChangingByScrollable(AZ::Vector2 value) = 0;
|
|
|
|
//! Called when the scrollable is done changing the scroll value (0 - 1)
|
|
virtual void OnValueChangedByScrollable(AZ::Vector2 value) = 0;
|
|
|
|
//! Called when the content size or content parent size has been changed
|
|
virtual void OnScrollableParentToContentRatioChanged(AZ::Vector2 parentToContentRatio) = 0;
|
|
};
|
|
|
|
typedef AZ::EBus<UiScrollableToScrollerNotifications> UiScrollableToScrollerNotificationBus;
|