tachyon::InteractionState Class Reference

The hovered, active, focused and captured elements, the active window, the one-shot click, hover suppression and the focus scroll axis. More...

#include <gui_core/state/gui_interaction_state.h>

Public Member Functions
ID	GetHoveredID () const
ID	GetHoveredDisabledID () const
	The disabled element under the cursor when nothing is hovered: it takes no input, but shows its tooltip (one saying why it is disabled).
ID	GetActiveID () const
ID	GetCaptureID () const
ID	GetFocusedID () const
ID	GetActiveWindowID () const
void	SetActiveWindowID (ID id)
void	SetCaptureID (ID id)
void	ReleaseCaptureID ()
void	SetFocusID (ID id)
void	SetFocusIDNoScroll (ID id)
void	SetFocusIDScrollAxis (ID id, ScrollAxis a)
ScrollAxis	ConsumeFocusScrollAxis ()
void	SetFocusVisible (bool visible)
	Shows the focus ring (:focus-visible), e.g. on a dialog's default button.
bool	IsFocusVisible () const
void	SuppressHover ()
void	ClearHoverSuppression ()
bool	IsHoverSuppressed () const
bool	HasBeenClicked (ID id) const
void	SetClicked (ID id)
void	SetFrameTime (float secs)
	The frame time in seconds that FlashActive is timed against; set once at BeginFrame.
float	GetFrameTime () const
void	FlashActive (ID id)
	Reports id as Active for about 120 ms: the pressed look of a keyboard or programmatic activation.
ID	GetActiveFlashID () const
bool	IsActiveFlashing (ID id) const
const std::vector< ID > &	GetPropagatedHoverIDs () const
const std::vector< ID > &	GetPropagatedFocusedIDs () const
void	SetPropagatedHoverIDs (std::vector< ID > v)
void	SetPropagatedFocusedIDs (std::vector< ID > v)
void	EndFrame (ID overID, MouseButtons mouseButtons, ID disabledID=ID::Invalid())
	Applies hover, active-ID edges and deferred capture release; clears the click and expired flash.

Detailed Description

The hovered, active, focused and captured elements, the active window, the one-shot click, hover suppression and the focus scroll axis.

Owned by GUIStateManager.

Member Function Documentation

GetHoveredID()

ID tachyon::InteractionState::GetHoveredID ( ) const

inline

GetHoveredDisabledID()

ID tachyon::InteractionState::GetHoveredDisabledID ( ) const

inline

The disabled element under the cursor when nothing is hovered: it takes no input, but shows its tooltip (one saying why it is disabled).

GetActiveID()

ID tachyon::InteractionState::GetActiveID ( ) const

inline

GetCaptureID()

ID tachyon::InteractionState::GetCaptureID ( ) const

inline

GetFocusedID()

ID tachyon::InteractionState::GetFocusedID ( ) const

inline

GetActiveWindowID()

ID tachyon::InteractionState::GetActiveWindowID ( ) const

inline

SetActiveWindowID()

void tachyon::InteractionState::SetActiveWindowID ( ID id )

inline

SetCaptureID()

void tachyon::InteractionState::SetCaptureID ( ID id )

inline

ReleaseCaptureID()

void tachyon::InteractionState::ReleaseCaptureID ( )

inline

SetFocusID()

void tachyon::InteractionState::SetFocusID ( ID id )

inline

SetFocusIDNoScroll()

void tachyon::InteractionState::SetFocusIDNoScroll ( ID id )

inline

SetFocusIDScrollAxis()

void tachyon::InteractionState::SetFocusIDScrollAxis ( ID id, ScrollAxis a )

inline

ConsumeFocusScrollAxis()

ScrollAxis tachyon::InteractionState::ConsumeFocusScrollAxis ( )

inline

SetFocusVisible()

void tachyon::InteractionState::SetFocusVisible ( bool visible )

inline

Shows the focus ring (:focus-visible), e.g. on a dialog's default button.

IsFocusVisible()

bool tachyon::InteractionState::IsFocusVisible ( ) const

inline

SuppressHover()

void tachyon::InteractionState::SuppressHover ( )

inline

ClearHoverSuppression()

void tachyon::InteractionState::ClearHoverSuppression ( )

inline

IsHoverSuppressed()

bool tachyon::InteractionState::IsHoverSuppressed ( ) const

inline

HasBeenClicked()

bool tachyon::InteractionState::HasBeenClicked ( ID id ) const

inline

SetClicked()

void tachyon::InteractionState::SetClicked ( ID id )

inline

SetFrameTime()

void tachyon::InteractionState::SetFrameTime ( float secs )

inline

The frame time in seconds that FlashActive is timed against; set once at BeginFrame.

GetFrameTime()

float tachyon::InteractionState::GetFrameTime ( ) const

inline

FlashActive()

void tachyon::InteractionState::FlashActive ( ID id )

inline

Reports id as Active for about 120 ms: the pressed look of a keyboard or programmatic activation.

GetActiveFlashID()

ID tachyon::InteractionState::GetActiveFlashID ( ) const

inline

IsActiveFlashing()

bool tachyon::InteractionState::IsActiveFlashing ( ID id ) const

inline

GetPropagatedHoverIDs()

const std::vector< ID > & tachyon::InteractionState::GetPropagatedHoverIDs ( ) const

inline

GetPropagatedFocusedIDs()

const std::vector< ID > & tachyon::InteractionState::GetPropagatedFocusedIDs ( ) const

inline

SetPropagatedHoverIDs()

void tachyon::InteractionState::SetPropagatedHoverIDs ( std::vector< ID > v )

inline

SetPropagatedFocusedIDs()

void tachyon::InteractionState::SetPropagatedFocusedIDs ( std::vector< ID > v )

inline

EndFrame()

void tachyon::InteractionState::EndFrame	(	ID	overID,
		MouseButtons	mouseButtons,
		ID	disabledID = ID::Invalid() )

Applies hover, active-ID edges and deferred capture release; clears the click and expired flash.

disabledID: a disabled element under the cursor.

---

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

• gui_core/state/gui_interaction_state.h