UiSliderInterface Class Reference

Inherits AZ::ComponentBus.

Public Types
typedef AZStd::function< void(AZ::EntityId, float)>	ValueChangeCallback
	params: sending entity id, newValue, newPosition

Public Member Functions
virtual float	GetValue ()=0
virtual void	SetValue (float value)=0
virtual float	GetMinValue ()=0
virtual void	SetMinValue (float value)=0
virtual float	GetMaxValue ()=0
virtual void	SetMaxValue (float value)=0
virtual float	GetStepValue ()=0
virtual void	SetStepValue (float step)=0
virtual ValueChangeCallback	GetValueChangingCallback ()=0
	Get the callback invoked while the value is changing.
virtual void	SetValueChangingCallback (ValueChangeCallback onChange)=0
	Set the callback invoked while the value is changing.
virtual const LyShine::ActionName &	GetValueChangingActionName ()=0
	Get the action triggered while the value is changing.
virtual void	SetValueChangingActionName (const LyShine::ActionName &actionName)=0
	Set the action triggered while the value is changing.
virtual ValueChangeCallback	GetValueChangedCallback ()=0
	Get the callback invoked when the value is done changing.
virtual void	SetValueChangedCallback (ValueChangeCallback onChange)=0
	Set the callback invoked when the value is done changing.
virtual const LyShine::ActionName &	GetValueChangedActionName ()=0
	Get the action triggered when the value is done changing.
virtual void	SetValueChangedActionName (const LyShine::ActionName &actionName)=0
	Set the action triggered when the value is done changing.
virtual void	SetTrackEntity (AZ::EntityId entityId)=0
	Set the optional track entity.
virtual AZ::EntityId	GetTrackEntity ()=0
	Get the optional track entity.
virtual void	SetFillEntity (AZ::EntityId entityId)=0
	Set the optional fill entity.
virtual AZ::EntityId	GetFillEntity ()=0
	Get the optional fill entity.
virtual void	SetManipulatorEntity (AZ::EntityId entityId)=0
	Set the optional manipulator entity.
virtual AZ::EntityId	GetManipulatorEntity ()=0
	Get the optional manipulator entity.

Static Public Attributes
static const AZ::EBusHandlerPolicy	HandlerPolicy = AZ::EBusHandlerPolicy::Single
	Only one component on a entity can implement the events.

Member Function Documentation

GetValue()

virtual float UiSliderInterface::GetValue ( )

pure virtual

Query the value of the slider

Returns

The current value for the slider.

SetValue()

virtual void UiSliderInterface::SetValue ( float  value )

pure virtual

Manually override the value of the slider

Parameters

isOn	The new desired value of the slider.

---

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

• Gems/LyShine/Code/Include/LyShine/Bus/UiSliderBus.h