Detailed Description

Provides an implementation of a button which maintains a state based on user interaction.

This toggle button can be used to accept user interaction and trigger an event based on signals emitted by this class at various stages of interaction. Once pressed the toggle button will remain in the toggled on state until the user presses the button again to toggle the button into the toggled off state.

The class maintains the various state timelines and plays them at the various stages of interaction, see below for supported timelines:

View Template Specification

Type	Labels	Property	Description
Marker	Press	Optional	The timeline to play when pressed down in the unchecked state. Releasing will cause the state of the toggle button to go from unchecked to checked, and the 'Toggle-On' marker to be played.
Marker	Press-Checked	Optional	The timeline to play when pressed down in the checked state. Releasing will cause the state of the toggle button to go from checked to unchecked, and the 'Toggle-Off' marker to be played.
Marker	Toggle-On	Optional	The timeline to play when going from the unchecked to checked state. The reverse will be played if 'Toggle-Off' marker is not provided.
Marker	Toggle-Off	Optional	The timeline to play when going from the checked to unchecked state. The reverse will be played if 'Toggle-On' marker is not provided.
Marker	Disable	Optional	The timeline to play when disabled in the unchecked state. The reverse will be played when going from disabled to enabled state.
Marker	Disable-Checked	Optional	The timeline to play when disabled in the checked state. The reverse will be played when going from disabled to enabled state.
Marker	Up-Over	Optional	The timeline to play when a cursor enters the button area in the unchecked state. If this marker is not provided, the reverse of 'Over-Up' marker will be played.
Marker	Up-Over-Checked	Optional	The timeline to play when a cursor enters the button area in the checked state. If this marker is not provided, the reverse of 'Over-Up-Checked' marker will be played.
Marker	Over-Up	Optional	The timeline to play when a cursor leaves the button area in the unchecked state. If this marker is not provided, the reverse of 'Up-Over' marker will be played.
Marker	Over-Up-Checked	Optional	The timeline to play when a cursor leaves the button area in the checked state. If this marker is not provided, the reverse of 'Up-Over-Checked' marker will be played.
Marker	Down-Up	Optional	The timeline to play when a cursor leaves the button area while being pressed in the unchecked state. If this marker is not provided, the reverse of 'Press' will be played. The state of the toggle button will not change.
Marker	Down-Up-Checked	Optional	The timeline to play when a cursor leaves the button area while being pressed in the checked state. If this marker is not provided, the reverse of 'Press-Checked' will be played. The state of the toggle button will not change.
Marker	FocusIn-Checked	Optional	An alternative to CYISceneView's 'FocusIn' timeline, that will be played when the button gains focus in the checked state. If this marker is not provided, 'FocusIn' will be played instead.
Marker	FocusOut-Checked	Optional	An alternative to CYISceneView's 'FocusOut' timeline, that will be played when the button loses focus in the checked state. If this marker is not provided, 'FocusOut' will be played instead. If 'FocusOut' is not provided either, the next fallback is 'FocusIn-Checked' played in reverse, and failing that, 'FocusIn' played in reverse.
Marker	FocusIn-Toggle-Transition	Optional	A transition animation for focus states. Meant to provide a way to make the change from FocusIn to FocusIn-Checked look visually correct. Automatically played when a button toggles on and it has focus.
Marker	FocusIn-Checked-Toggle-Transition	Optional	A transition animation for focus states. Meant to provide a way to make the change from FocusIn-Checked to FocusIn look visually correct. Automatically played when a button toggles off and it has focus.
Node	Text OR Placeholder-Text	Optional	Text displayed on the button, which can be set using SetText().
Node	TextPressed OR Placeholder-TextPressed	Optional	Text displayed on the button when pressed, which can be set using SetText(). This is useful if you want a different font or color when pressed.
Comment	text	Optional	Corresponds to: SetText(). Contains a quoted string, which will be set as the text of this button, assuming the correct text nodes are present.

Toggle buttons are automatically marked focusable when the 'FocusIn' timeline (specified in CYISceneView) is present. The enter or select keys are used to activate a focused button.

#include <view/YiToggleButtonView.h>

Inheritance diagram for CYIToggleButtonView:

[legend]

Public Types
enum	ToggleState { ToggleState::Off = 0, ToggleState::On }

Public Types inherited from CYIAbstractButtonView
enum	EnableState { EnableState::Disabled = 0, EnableState::Enabled }

enum	PressState { PressState::Released = 0, PressState::Pressed }

enum	OverState { OverState::Away = 0, OverState::Over }

Public Types inherited from CYISceneView
enum	TimelineGetMode { TimelineGetMode::GetDefault, TimelineGetMode::GetTimeline, TimelineGetMode::GetTimelineGroup, TimelineGetMode::GetComponentOfTimelineGroup }

enum	InitialFocusLifetime { InitialFocusLifetime::Persistent, InitialFocusLifetime::ClearOnEntry }

Public Types inherited from CYISceneNode
enum	LayoutDirtyFlag : uint8_t { LayoutDirtyFlag::Clean, LayoutDirtyFlag::ChildDirty, LayoutDirtyFlag::Dirty }

enum	LayoutConfigFetchMode { LayoutConfigFetchMode::DoNotLazyInstantiate = 0, LayoutConfigFetchMode::LazyInstantiate }

enum	MeasureMode { MeasureMode::Unspecified, MeasureMode::UpTo, MeasureMode::Exactly }

enum	FetchType { FetchType::Optional = 0, FetchType::Mandatory }

typedef std::reverse_iterator< Iterator >	ReverseIterator

typedef uint16_t	DirtyFlag

Public Types inherited from CYIEventTarget
enum	SpecialEventTargetType : uint8_t { SpecialEventTargetType::None = 0x00, SpecialEventTargetType::NoPick = 0x20 }

enum	Phase : uint8_t { Phase::Bubble, Phase::Capture }

Public Member Functions
	CYIToggleButtonView ()

virtual	~CYIToggleButtonView ()

virtual bool	Init () override

void	SetToggled (bool isToggled)

void	ToggleOn ()

void	ToggleOff ()

bool	IsToggledOn () const

void	SetState (CYIAbstractButtonView::EnableState enabledState, ToggleState toggleState)

Public Member Functions inherited from CYIAbstractButtonView
	CYIAbstractButtonView ()

virtual	~CYIAbstractButtonView ()

void	Enable ()

void	Disable ()

void	SetEnabled (bool enabled)

bool	IsEnabled () const

bool	IsPressed () const

bool	IsOver () const

void	SetText (const CYIString &text)

const CYIString &	GetText () const

void	SetButtonID (int32_t buttonID)

int32_t	GetButtonID () const

Public Member Functions inherited from CYISceneView
	CYISceneView ()

virtual	~CYISceneView ()

bool	BuildFromTemplate (CYISceneManager *pSceneManager, const std::shared_ptr< CYIAssetViewTemplate > &pAssetViewTemplate, CYISceneManager::MissingClassHandlingMode missingHandlingMode=CYISceneManager::MissingClassHandlingMode::Abort)

bool	IsInitialized () const

void	SetClippingAreaNode (CYISceneNode *pClippingNode)

virtual CYIOptional< CYIStringView >	GetProperty (CYIStringView propertyName) const override

bool	GetProperty (CYIStringView propertyName, CYIString *pValue) const

virtual std::map< CYIString, CYIString >	GetProperties () const override

virtual void	ForEachProperty (const std::function< void(const CYIString &, const CYIString &)> &action) const override

virtual bool	HasProperties () const override

void	EnableDefaultHitZone ()

bool	IsResponsiveLayoutEnabled () const

void	EnableResponsiveLayout ()

void	DisableResponsiveLayout ()

void	AddAnchor (EYIAnchorType anchorType)

YI_ANCHOR_DATA	GetAnchor (EYIAnchorType anchorType) const

virtual const CYISceneView::AssetRequirement *	GetAssetRequirements (uint32_t *pRequirementCount)

CYIAbstractTimeline *	GetInTimeline () const

CYIAbstractTimeline *	GetOutTimeline () const

CYIAbstractTimeline *	GetFocusInTimeline () const

CYIAbstractTimeline *	GetFocusOutTimeline () const

virtual bool	HandlesFocusInDescendants () const

virtual bool	RequestFocus (CYIFocus::Direction direction=CYIFocus::Direction::Forward, CYIFocus::FocusRootRule focusRootRule=CYIFocus::FocusRootRule::DescendantsUpdateContext, const CYIAABB &previousFocusRect=CYIAABB(), const CYIFocusSearchOptions &options=CYIFocusSearchOptions())

bool	HasFocus () const

void	SetFocusable (bool focusable)

bool	IsFocusable () const

bool	CanBeFocused () const

void	SetNextFocus (CYISceneView *pView, CYIFocus::Direction direction)

CYISceneView *	GetNextFocus (CYIFocus::Direction direction) const

virtual void	SetInitiallyFocusedView (CYISceneView *pView, InitialFocusLifetime initialFocusLifetime=InitialFocusLifetime::Persistent)

CYISceneView *	GetInitiallyFocusedView () const

CYISceneView::InitialFocusLifetime	GetInitialFocusLifetime () const

CYISceneView *	FindNextFocus (CYIFocus::Direction direction, const CYIFocusSearchOptions &options=CYIFocusSearchOptions()) const

CYISceneView *	FindNextFocus (CYIFocus::Direction direction, CYIAABB &screenSpaceFocusRegion, const CYIFocusSearchOptions &options=CYIFocusSearchOptions()) const

virtual CYISceneView *	FindNextFocusInDescendants (const CYISceneView *pCurrentFocusView, CYIFocus::Direction direction, CYIAABB &screenSpaceFocusRegion, const CYIFocusSearchOptions &options=CYIFocusSearchOptions()) const

const CYISceneNode *	GetFocusRoot () const

CYISceneView *	GetFocusHandler () const

virtual void	OnFocusGained ()

virtual void	FocusGained ()

virtual void	OnFocusLost ()

virtual void	FocusLost ()

virtual void	FocusGainedInDescendants (CYISceneNode pNewNodeWithFocus, CYISceneNode pPreviousNodeWithFocus) override

virtual bool	ContainsFocusableDescendant (const CYIFocusSearchOptions &options=CYIFocusSearchOptions()) const override

const std::shared_ptr< CYIAssetViewTemplate > &	GetViewTemplate () const

const std::vector< CYIString > &	GetChildTemplateNames ()

template<typename T >
T *	BuildTimeline (const CYIString &markerName)

CYITimeline *	BuildTimeline (const CYIString &markerName, int32_t startOffset, int32_t duration)

CYIAbstractTimeline *	GetTimeline (CYIMarkerData::ID id)

virtual CYIAbstractTimeline *	GetTimeline (CYIStringView markerName, TimelineGetMode mode=TimelineGetMode::GetDefault)

std::map< CYIString, CYITimeline * >	GetSimpleTimelines () const

std::map< CYIString, CYIAbstractTimeline * >	GetTimelines () const

bool	FindTimeline (CYIAbstractTimeline *&pTimeline, CYIStringView markerName, FetchType type, const CYIString &tag="", TimelineGetMode mode=TimelineGetMode::GetDefault)

CYITimelineGroup *	GetTimelineGroup (CYIStringView markerName)

void	BuildAnchorList ()

virtual void	Reset ()

void	SetLayout (std::unique_ptr< CYILayout > pLayout)

const CYILayout *	GetLayout () const

CYILayout *	GetLayout ()

virtual void	Measure (const MeasureSpec &widthSpec, const MeasureSpec &heightSpec, const MeasureSpec &depthSpec) override

virtual void	ApplyMeasurements () override

Public Member Functions inherited from CYISceneNode
	CYISceneNode ()

virtual	~CYISceneNode ()

bool	IsInitialized () const

void	ForceDirty ()

void	SetDirtyFlag (DirtyFlag dirtyFlag)

DirtyFlag	GetDirtyFlag () const

DirtyFlag	GetPreviousDirtyFlag () const

const CYIString &	GetName () const

CYIString	GetUniqueName () const

void	SetSceneManager (CYISceneManager *pSceneManager)

void	SetName (const CYIString &name)

int32_t	GetID () const

void	SetID (int32_t id)

uint64_t	GetUniqueID () const

bool	AddChild (std::unique_ptr< CYISceneNode > pSceneNode)

bool	AddChild (std::unique_ptr< CYISceneNode >, size_t index)

bool	InsertChildAfter (CYISceneNode *pRefNode, std::unique_ptr< CYISceneNode > pSceneNode)

std::unique_ptr< CYISceneNode >	RemoveChild (CYISceneNode *pSceneNode)

bool	ReorderChild (size_t fromIndex, size_t toIndex)

CYITransform *	GetTransform ()

CYISceneNode *	GetParent () const

bool	ChangeParent (CYISceneNode *pParent)

CYISceneNode *	GetDrawParent () const

bool	IsAncestorOf (const CYISceneNode *pNode) const

CYISceneManager *	GetSceneManager () const

size_t	GetChildCount () const

uint32_t	GetChildCountRecursive () const

CYISceneNode *	GetChild (size_t index) const

Iterator	begin (Iterator::Mode mode=Iterator::Mode::ImmediateChildren) const

Iterator	end (Iterator::Mode mode=Iterator::Mode::ImmediateChildren) const

ReverseIterator	rbegin (Iterator::Mode mode=Iterator::Mode::ImmediateChildren) const

ReverseIterator	rend (Iterator::Mode mode=Iterator::Mode::ImmediateChildren) const

CYISceneNode *	GetChild (const CYIString &name) const

size_t	GetDrawChildCount () const

CYISceneNode *	GetDrawChild (size_t index) const

CYISceneNode *	GetDrawChildByID (int32_t id) const

template<class YI_SCENE_NODE_SUBCLASS >
YI_SCENE_NODE_SUBCLASS *	GetChild (uint32_t targetMatchedNodeCount=1) const

template<class YI_SCENE_NODE_SUBCLASS >
std::list< YI_SCENE_NODE_SUBCLASS * >	GetChildren () const

template<class YI_SCENE_NODE_SUBCLASS >
std::list< YI_SCENE_NODE_SUBCLASS * >	GetDrawChildren () const

size_t	GetIndexOfChild (const CYISceneNode *pSceneNode) const

size_t	GetIndexOfDrawChild (const CYISceneNode *pSceneNode) const

void	Show ()

void	Hide ()

void	SetVisibility (bool visible)

void	SetOpacity (float opacity)

float	GetCompositeOpacity () const

float	GetLocalOpacity () const

bool	IsVisible () const

bool	IsTrulyVisible () const

bool	IsPerceptible () const

CYISceneNode *	GetNode (CYIStringView name)

CYISceneNode *	GetNode (CYIStringView name, const CYIRuntimeTypeInfo &enforceClassType)

CYISceneNode *	GetNode (const CYIRuntimeTypeInfo &enforceClassType)

CYISceneNode *	GetNodeAfterTarget (const CYIRuntimeTypeInfo &enforceClassType, CYISceneNode *pStartAfterTarget)

template<class YI_SCENE_NODE_SUBCLASS >
YI_SCENE_NODE_SUBCLASS *	GetNode (CYIStringView name)

CYISceneNode *	GetNode (const int32_t id)

CYISceneNode *	GetNode (const int32_t id, const CYIRuntimeTypeInfo &enforceClassType)

CYISceneNode *	GetNodeWithUniqueID (uint64_t uniqueID)

template<class YI_SCENE_NODE_SUBCLASS >
bool	FindNode (YI_SCENE_NODE_SUBCLASS *&pNode, CYIStringView nodeName, FetchType type, const CYIString &tag)

std::list< CYISceneNode * >	GetNodes (CYIStringView name)

std::list< CYISceneNode * >	GetNodes (int32_t id)

std::list< CYISceneNode * >	GetNodes (const CYIRuntimeTypeInfo &enforceClassType)

template<class YI_SCENE_NODE_SUBCLASS >
const YI_SCENE_NODE_SUBCLASS *	GetNode (uint32_t targetMatchedNodeCount=1) const

template<class YI_SCENE_NODE_SUBCLASS >
YI_SCENE_NODE_SUBCLASS *	GetNode (uint32_t targetMatchedNodeCount=1)

void	SetMesh (const std::shared_ptr< CYIMesh > &pMesh)

bool	SetNPatchBitmap (const std::shared_ptr< CYIBitmap > &pNPatchBitmap)

void	ClearNPatch ()

void	SetMaterial (const std::shared_ptr< CYIMaterial > &pMaterial, size_t index=0)

void	AddEffect (const std::shared_ptr< CYIEffect > &pEffect)

void	RemoveEffect (const std::shared_ptr< CYIEffect > &pEffect)

size_t	GetEffectCount () const

const std::shared_ptr< CYIEffect > &	GetEffect (size_t index) const

void	ConnectEffectsToTimelines (const CYITimelineTrack *pTrack)

void	AddMask (std::unique_ptr< CYIMask > pMask)

std::unique_ptr< CYIMask >	RemoveMask (const CYIMask *pMask)

size_t	GetMaskCount () const

const CYIMask *	GetMask (size_t index) const

CYIMask *	GetMask (size_t index)

const std::shared_ptr< CYIMesh > &	GetMesh () const

const std::shared_ptr< CYIBitmap > &	GetNPatchBitmap () const

size_t	GetMaterialCount () const

const std::shared_ptr< CYIMaterial > &	GetMaterial (size_t index=0) const

const std::shared_ptr< IYIUniformBufferObject > &	GetShaderUniforms () const

void	SetMeshTransform (const glm::mat4 &transform)

void	DestroyChildren ()

glm::mat4	GetLocalTransform () const

glm::mat4	GetWorldTransform () const

bool	Intersects (const CYISceneNode *pNode) const

void	SetRenderTarget (const std::shared_ptr< CYIRenderTarget > &pRenderTarget)

const std::shared_ptr< CYIRenderTarget > &	GetRenderTarget () const

virtual void	OnPreBuildDrawList (std::vector< IYIRenderer::Command > pDrawList, std::vector< CYIAbstractCameraSceneNode > *pDrawWithCameraList)

virtual void	OnPostBuildDrawList (std::vector< IYIRenderer::Command > *pDrawList)

const CYIAABB &	GetWorldAABB () const

const CYIAABB &	GetLocalAABB () const

void	SetAnchorPoint (const glm::vec3 &anchorPoint)

void	SetAnchorPoint (float x, float y, float z)

void	SetAnchorPointX (float x)

void	SetAnchorPointY (float y)

void	SetAnchorPointZ (float z)

void	SetPosition (const glm::vec3 &position)

void	SetPosition (float x, float y, float z)

void	SetPositionX (float x)

void	SetPositionY (float y)

void	SetPositionZ (float z)

void	SetRotation (const glm::vec3 &rotation)

void	SetRotation (float pitchDegrees, float yawDegrees, float rollDegrees)

void	SetRotationX (float pitchDegrees)

void	SetRotationY (float yawDegrees)

void	SetRotationZ (float rollDegrees)

void	SetOrientation (float pitchDegrees, float yawDegrees, float rollDegrees)

void	SetOrientation (const glm::quat &orientation)

void	SetScale (const glm::vec3 &scale)

void	SetScale (float factorX, float factorY, float factorZ)

void	SetScaleX (float factor)

void	SetScaleY (float factor)

void	SetScaleZ (float factor)

const glm::vec3 &	GetPosition () const

const glm::vec3 &	GetScale () const

const glm::vec3 &	GetWorldScale () const

const glm::vec3 &	GetWorldSurfaceScale () const

const glm::vec3 &	GetRotation () const

const glm::quat &	GetOrientation () const

const glm::vec3 &	GetAnchorPoint () const

virtual void	SetSize (const glm::vec3 &size, bool dirtyLayout=true)

const glm::vec3 &	GetSize () const

const glm::vec3 &	GetInitialSize () const

void	SetMeasuredSize (const glm::vec3 &measuredSize)

const glm::vec3 &	GetMeasuredSize () const

void	SetInternalCustomTimelineValue (uint32_t trackID, const CYIVariant &value)

virtual void	SetCustomTimelineValue (uint32_t trackID, const CYIVariant &value)

void	SetClippingOn ()

void	SetClippingOff ()

bool	GetClipping () const

void	SetClippingBox (const CYIAABB &worldBox)

const CYIAABB &	GetClippingBox () const

void	StartPropertyAnimation (PropertyAnimation::Type propType, float from, float to, uint32_t durMs, CYITimeInterpolator *pTimeInterpolator=nullptr, bool dirtyLayout=true)

void	StopPropertyAnimation (PropertyAnimation::Type propType)

void	UpdateLocalSpaceCollision (CYIActionEvent *pActionEvent)

virtual bool	BroadcastEvent (const std::shared_ptr< CYIEventDispatcher > &pDispatcher, CYIEvent *pEvent)

void	UpdateEventForLocalSpace (CYIActionEvent *pActionEvent, glm::vec3 &rayOrigin, glm::vec3 &rayNonOriginPoint) const

bool	IsBoundingBoxHit (const CYIRay &worldSpaceRay) const

bool	IsMeshHit (const CYIRay &worldSpaceRay) const

void	DumpTree () const

void	StartCaptureKeyboardEvents ()

void	StopCaptureKeyboardEvents ()

void	StartCaptureTrackpadEvents ()

void	StopCaptureTrackpadEvents ()

void	StartCapturePointerEvents (uint8_t pointerID)

void	StopCapturePointerEvents (uint8_t pointerID)

bool	DrawBehindChildren (CYISceneNode pSceneNode, bool pChanged=nullptr)

bool	DrawInFrontOfChildren (CYISceneNode pSceneNode, bool pChanged=nullptr)

bool	DrawBehind (CYISceneNode pSceneNode, bool pChanged=nullptr)

bool	DrawInFront (CYISceneNode pSceneNode, bool pChanged=nullptr)

bool	IsFocusRoot () const

void	SetIsFocusRoot (bool isFocusRoot)

virtual void	OnFocusGainedInDescendants (CYISceneNode pNewNodeWithFocus, CYISceneNode pPreviousNodeWithFocus)

virtual void	OnFocusLostInDescendants (CYISceneNode pNewNodeWithFocus, CYISceneNode pPreviousNodeWithFocus)

virtual void	FocusLostInDescendants (CYISceneNode pNewNodeWithFocus, CYISceneNode pPreviousNodeWithFocus)

virtual void	OnFocusChangedInDescendants (CYISceneNode pNewNodeWithFocus, CYISceneNode pPreviousNodeWithFocus)

virtual void	FocusChangedInDescendants (CYISceneNode pNewNodeWithFocus, CYISceneNode pPreviousNodeWithFocus)

void	SetUseLocalTransformAndAlpha (bool use)

bool	GetProperty (CYIStringView propertyName, CYIString *pValue) const

void	SetProperty (const CYIString &propertyName, const CYIString &propertyValue)

std::shared_ptr< CYISceneNodeProxy >	GetSceneNodeProxy () const

void	SetLayoutConfig (std::unique_ptr< CYILayoutConfig > pLayoutConfig)

const CYILayoutConfig *	GetLayoutConfig (LayoutConfigFetchMode fetchMode=LayoutConfigFetchMode::LazyInstantiate) const

CYILayoutConfig *	GetLayoutConfig (LayoutConfigFetchMode fetchMode=LayoutConfigFetchMode::LazyInstantiate)

void	SetLayoutState (std::unique_ptr< CYILayoutState > pLayoutState)

const CYILayoutState *	GetLayoutState () const

CYILayoutState *	GetLayoutState ()

void	RequestLayout ()

LayoutDirtyFlag	GetLayoutDirtyFlag () const

virtual void	SetLayoutDirtyFlag (LayoutDirtyFlag flag)

virtual CYIAbstractCameraSceneNode *	FindActiveCamera (const CYISceneNode *pTargetSceneNode=nullptr) const

CYIAccessibilityAttributes::Accessible	GetAccessible () const

void	SetAccessible (CYIAccessibilityAttributes::Accessible accessible)

const CYIAccessibilityAttributes *	GetAccessibilityAttributes () const

std::unique_ptr< CYIAccessibilityAttributes >	TakeAccessibilityAttributes ()

void	SetAccessibilityAttributes (std::unique_ptr< CYIAccessibilityAttributes > pAttributes)

const CYIRenderable *	GetRenderable () const

template<typename T >
bool	CanCastTo () const

CYIAdjustmentLayerSceneNode *	GetLastAdjustmentLayer () const

Public Member Functions inherited from CYIEventTarget
	CYIEventTarget ()

virtual	~CYIEventTarget ()

bool	AddEventListener (CYIEvent::Type eventType, CYIEventHandler *pListener, CYIEventTarget::Phase phase=CYIEventTarget::Phase::Bubble)

bool	RemoveEventListener (CYIEvent::Type eventType, CYIEventHandler *pListener, CYIEventTarget::Phase phase=CYIEventTarget::Phase::Bubble)

void	SetSpecialTypeFlag (SpecialEventTargetType type)

void	ClearSpecialTypeFlag (SpecialEventTargetType type)

SpecialEventTargetType	GetSpecialTypes () const

const std::shared_ptr< CYIEventTargetProxy > &	GetProxy () const

Public Member Functions inherited from CYISignalHandler
	CYISignalHandler ()

	CYISignalHandler (const CYISignalHandler &signalHandler)

virtual	~CYISignalHandler ()

CYISignalHandler &	operator= (const CYISignalHandler &signalHandler)

void	MoveToThread (CYIThread *pThread)
	This function allows the user to override the default thread affinity to any CYIThread that may or may not be running. More...

CYIThreadHandle	GetThreadAffinity () const

void	SetThreadAffinity (const CYIThreadHandle &threadAffinity)

virtual bool	IsConnected () const

virtual bool	IsConnected (const CYISignalBase &signal) const

void	Disconnect (CYISignalBase &signal)

void	DisconnectFromAllSignals ()

Public Member Functions inherited from CYIThread::Listener
	Listener ()

virtual	~Listener ()

virtual void	OnThreadStarted (CYIThread *)

virtual void	OnThreadTerminated (CYIThread *)

virtual void	OnThreadFinished (CYIThread *)

Public Member Functions inherited from IYIPropertiesSource
virtual	~IYIPropertiesSource ()=default

bool	GetProperty (CYIStringView propertyName, CYIString *pValue) const

Public Member Functions inherited from CYIEventHandler
	CYIEventHandler ()

	CYIEventHandler (const CYIEventHandler &)

virtual	~CYIEventHandler ()

CYIEventHandler &	operator= (const CYIEventHandler &)

bool	RegisterEventFilter (CYIEventFilter *pFilter)

bool	UnregisterEventFilter (CYIEventFilter *pFilter)

bool	PreFilter (const std::shared_ptr< CYIEventDispatcher > &pDispatcher, CYIEvent *pEvent)

bool	PostFilter (const std::shared_ptr< CYIEventDispatcher > &pDispatcher, CYIEvent *pEvent)

bool	AreEventsEnabled () const

void	EnableEvents (bool enable)

Public Attributes
CYISignal< bool, int32_t >	ButtonPressing

CYISignal< int32_t >	ButtonPressingOn

CYISignal< int32_t >	ButtonPressingOff

CYISignal< bool, int32_t >	ButtonPressed

CYISignal< int32_t >	ButtonPressedOn

CYISignal< int32_t >	ButtonPressedOff

CYISignal< bool, int32_t >	ButtonToggled

CYISignal< int32_t >	ButtonToggledOn

CYISignal< int32_t >	ButtonToggledOff

CYISignal< bool, int32_t >	ButtonReleasing

CYISignal< int32_t >	ButtonReleasingOn

CYISignal< int32_t >	ButtonReleasingOff

CYISignal< bool, int32_t >	ButtonReleased

CYISignal< int32_t >	ButtonReleasedOn

CYISignal< int32_t >	ButtonReleasedOff

Public Attributes inherited from CYISceneView
CYISignal< CYISceneView , CYISceneView >	GainedFocus
	Emitted when focus has entered this view. The first signal argument is the view that gained focus (e.g. the current view) and the second signal argument is the view that lost focus. More...

CYISignal< CYISceneView , CYISceneView >	LostFocus
	Emitted when focus has left this view. The first signal argument is the view that lost focus (e.g. the current view) and the second signal argument is the view that gained focus. More...

Public Attributes inherited from CYISceneNode
CYISignal< CYISceneNode *, PropertyAnimation::Type >	PropertyAnimationComplete

CYISignal< CYISceneNode , CYISceneNode >	DescendantGainedFocus
	Emitted when focus has entered this tree. The first signal parameter is the new node with focus, and the second signal parameter is the previous node with focus. More...

CYISignal< CYISceneNode , CYISceneNode >	DescendantLostFocus
	Emitted when focus has left this tree. The first signal parameter is the new node with focus, and the second signal parameter is the previous node with focus. More...

CYISignal< CYISceneNode , CYISceneNode >	DescendantsChangedFocus
	Emitted when focus has changed within this tree. This signal is called only if focus was previously within this tree and focus is now on a different node (but still within this tree). The first signal parameter is the new node with focus, and the second signal parameter is the previous node with focus. More...

CYISignal< CYIAccessibilityAttributes::Accessible >	AccessibleStateChanged
	Emitted when accessible state changed. More...

Protected Types
enum	EmitSignals { EmitSignals::Emit, EmitSignals::DoNotEmit }

Protected Member Functions
virtual void	OnEnable () override

virtual void	OnDisable () override

virtual void	OnPress () override

virtual void	OnRelease () override

virtual void	OnEnter () override

virtual void	OnLeave () override

virtual void	OnCancel () override

virtual void	OnToggleOn (EmitSignals signals)

virtual void	OnToggleOff (EmitSignals signals)

virtual void	FinishAllPlayingTimelines () override

virtual void	FinishAllPlayingFocusTimelines ()

void	ToggleOn (EmitSignals signals)

void	ToggleOff (EmitSignals signals)

void	OnPressOnCompleted ()

void	OnPressOffCompleted ()

void	OnReleaseOnCompleted ()

void	OnReleaseOffCompleted ()

virtual bool	HandleEvent (const std::shared_ptr< CYIEventDispatcher > &pDispatcher, CYIEvent *pEvent) override

Protected Member Functions inherited from CYIAbstractButtonView
void	StartTimelineForward (CYIAbstractTimeline pTimeline, const char pFunctionName=nullptr, const char *pTimelineName=nullptr)

void	StartTimelineReverse (CYIAbstractTimeline pTimeline, const char pFunctionName=nullptr, const char *pTimelineName=nullptr)

Protected Member Functions inherited from CYISceneView
void	UpdateClipping ()

virtual void	WorldScaleUpdated () override

virtual void	WorldBoundingBoxUpdated () override

virtual void	OnViewReflowed (const glm::vec3 &worldScale)

virtual void	ViewReflowed (const glm::vec3 &worldScale)

virtual bool	ProcessEvent (const std::shared_ptr< CYIEventDispatcher > &pDispatcher, CYIEvent *pEvent) override

void	UpdateResponsiveLayoutAnchors ()

virtual void	SizeChanged () override

virtual void	ChildNeedsLayout () override

virtual void	LayoutDirtied () override

virtual void	ChildAdded (CYISceneNode *pChild) override

virtual void	ChildRemoved (CYISceneNode *pChild) override

virtual void	ChildVisibilityChanged (CYISceneNode *pChild) override

void	OnViewIsInAnimatedPosition ()

void	OnViewIsGoingOutOfAnimatedPosition ()

void	SetInTimeline (CYIAbstractTimeline *pTimeline)

void	SetOutTimeline (CYIAbstractTimeline *pTimeline)

virtual void	OnInit ()

bool	TryRequestFocusOnInitiallyFocusedView ()

Protected Member Functions inherited from CYISceneNode
void	Update ()

virtual void	OnUpdateBegin ()

virtual void	UpdateBegin ()

virtual void	OnUpdateEnd ()

virtual void	UpdateEnd ()

virtual void	OnDirtyFlagChanged ()

virtual void	DirtyFlagChanged ()

virtual void	OnTransformUpdated ()

virtual void	TransformUpdated ()

virtual void	OnWorldScaleUpdated ()

virtual void	OnWorldSurfaceScaleUpdated ()

virtual void	WorldSurfaceScaleUpdated ()

virtual void	OnVisibilityUpdated ()

virtual void	VisibilityUpdated ()

virtual void	OnCompositeOpacityUpdated ()

virtual void	CompositeOpacityUpdated ()

virtual void	OnWorldBoundingBoxUpdated ()

virtual void	OnLocalBoundingBoxUpdated ()

virtual void	LocalBoundingBoxUpdated ()

virtual void	OnChildAdded (CYISceneNode *pChild)

virtual void	OnChildRemoved (CYISceneNode *pChild)

virtual void	OnSizeChanged ()

virtual void	OnChildVisibilityChanged (CYISceneNode *pChild)

virtual void	OnDrawOrderChanged ()

LayoutDirtyFlag	GetCurrentLayoutDirtyFlag () const

virtual CYIString	GetDumpTreeString () const

void	DumpTree (int32_t indentLevel) const

virtual void	SetCustomUniforms ()

template<class T >
void	SetNodeType ()

virtual CYISceneNode *	GetNodeFromChildren (CYIStringView name)

virtual CYISceneNode *	GetNodeFromChildren (const int32_t id)

virtual CYISceneNode *	GetNodeFromChildren (const CYIRuntimeTypeInfo &enforceClassType)

CYISceneNode *	GetNodeFromChildrenAfterTarget (const CYIRuntimeTypeInfo &enforceClassType, bool pTargetReached, CYISceneNode pStartAfterTarget)

Protected Attributes
ToggleState	m_toggleState

CYIAbstractTimeline *	m_pPressAnim

CYIAbstractTimeline *	m_pPressCheckedAnim

CYIAbstractTimeline *	m_pToggleOnAnim

CYIAbstractTimeline *	m_pToggleOffAnim

CYIAbstractTimeline *	m_pDisableAnim

CYIAbstractTimeline *	m_pDisableCheckedAnim

CYIAbstractTimeline *	m_pUpOverAnim

CYIAbstractTimeline *	m_pUpOverCheckedAnim

CYIAbstractTimeline *	m_pOverUpAnim

CYIAbstractTimeline *	m_pOverUpCheckedAnim

CYIAbstractTimeline *	m_pDownUpAnim

CYIAbstractTimeline *	m_pDownUpCheckedAnim

CYIAbstractTimeline *	m_pFocusInCheckedAnim

CYIAbstractTimeline *	m_pFocusOutCheckedAnim

CYIAbstractTimeline *	m_pFocusInToggleTransitionAnim

CYIAbstractTimeline *	m_pFocusInCheckedToggleTransitionAnim

Protected Attributes inherited from CYIAbstractButtonView
EnableState	m_enableState

PressState	m_pressState

OverState	m_overState

int32_t	m_buttonID

CYITextSceneNode *	m_pButtonTextNode

CYITextSceneNode *	m_pButtonTextNodePress

Protected Attributes inherited from CYISceneView
bool	m_stopEventPropagation

bool	m_responsiveLayoutEnabled

bool	m_sceneTreeBuilt

bool	m_inAnimatedPosition

CYISceneNode *	m_pClippingNode

CYIAbstractTimeline *	m_pFocusInTimeline

CYIAbstractTimeline *	m_pFocusOutTimeline

std::unique_ptr< CYILayout >	m_pLayout

std::shared_ptr< CYIAssetViewTemplate >	m_pAssetViewTemplate

std::shared_ptr< CYISceneNodeProxy >	m_pInitiallyFocusedView

InitialFocusLifetime	m_initialFocusLifetime

std::multimap< EYIAnchorType, YI_ANCHOR_DATA >	m_anchors

std::map< CYIString, std::unique_ptr< CYITimeline >, std::less< void > >	m_timelines

std::map< CYIString, std::unique_ptr< CYIParallelTimelineGroup >, std::less< void > >	m_timelineGroups

std::map< CYIString, std::unique_ptr< CYIAbstractTimeline >, std::less< void > >	m_externalTimelines

Protected Attributes inherited from CYISceneNode
CYIString	m_name

CYISceneNode *	m_pParent

CYISceneNode *	m_pDrawParent

std::vector< std::unique_ptr< CYISceneNode > >	m_children

std::vector< CYISceneNode * >	m_drawChildren

std::map< CYIString, CYIString, std::less< void > >	m_Properties

std::vector< std::shared_ptr< CYIEffect > >	m_Effects

std::vector< std::unique_ptr< PropertyAnimation > >	m_propertyAnimations

float	m_localOpacity

std::unique_ptr< CYITransform >	m_pTransform

glm::vec3	m_size

glm::vec3	m_initialSize

glm::vec3	m_measuredSize

glm::vec3	m_vlsLastCollision

bool	m_clip

bool	m_localVisibility

int32_t	m_id

uint64_t	m_guid

std::unique_ptr< CYINPatch >	m_pNPatch

std::shared_ptr< CYIBitmap >	m_pNPatchBitmap

std::shared_ptr< CYIRenderable >	m_pRenderable

Protected Attributes inherited from CYIEventTarget
std::vector< EventListenerEntry >	m_listeners

SpecialEventTargetType	m_specialTypes

std::shared_ptr< CYIEventTargetProxy >	m_pEventTargetProxy

Protected Attributes inherited from CYIEventHandler
bool	m_enableEvents

Additional Inherited Members
Static Public Member Functions inherited from CYISceneView
static void	RegisterAllViews ()

Static Public Member Functions inherited from CYISceneNode
static void	RegisterAllSceneNodes ()

Static Public Attributes inherited from CYISceneNode
static const float	OPACITY_NOT_VISIBLE_EPSILON

static constexpr DirtyFlag	DirtyClean = 0x0000

static constexpr DirtyFlag	DirtySceneGraph = 0x0001

static constexpr DirtyFlag	DirtyVisibility = 0x0002

static constexpr DirtyFlag	DirtyOpacity = 0x0004

static constexpr DirtyFlag	DirtyLocalTransform = 0x0008

static constexpr DirtyFlag	DirtyWorldTransform = 0x0010

static constexpr DirtyFlag	DirtyUniform = 0x0020

static constexpr DirtyFlag	DirtyWorldBoundingBox = 0x0040

static constexpr DirtyFlag	DirtyMesh = 0x0080

static constexpr DirtyFlag	DirtyWorldSurfaceScale = 0x0100

static constexpr DirtyFlag	DirtyWorldScale = 0x0200

static constexpr DirtyFlag	DirtyLocalBoundingBox = 0x0400

static constexpr DirtyFlag	DirtyEverything = (DirtySceneGraph \| DirtyVisibility \| DirtyOpacity \| DirtyLocalTransform \| DirtyWorldTransform \| DirtyUniform \| DirtyWorldBoundingBox \| DirtyWorldSurfaceScale \| DirtyWorldScale \| DirtyLocalBoundingBox)

Member Enumeration Documentation

◆ EmitSignals

enum CYIToggleButtonView::EmitSignals

strongprotected

An enumeration representing whether or not a toggle event will emit signals. This can be used to differentiate programmatic state changes which should emit signals to those which should not.

Enumerator
Emit	The toggle state change will emit signals in the order ButtonToggled, ButtonReleasing and ButtonReleased.
DoNotEmit	No signals will be emitted.

◆ ToggleState

enum CYIToggleButtonView::ToggleState

strong

Enumeration representing the possible toggles states for the toggle button.

Enumerator
Off	State indicating that the button view is toggled off.
On	State indicating that the button view is toggled on.

Constructor & Destructor Documentation

◆ CYIToggleButtonView()

CYIToggleButtonView::CYIToggleButtonView ( )

◆ ~CYIToggleButtonView()

virtual CYIToggleButtonView::~CYIToggleButtonView ( )

virtual

Member Function Documentation

◆ FinishAllPlayingFocusTimelines()

virtual void CYIToggleButtonView::FinishAllPlayingFocusTimelines ( )

protectedvirtual

Finish playing all focus timelines which the toggle button view manages.

◆ FinishAllPlayingTimelines()

virtual void CYIToggleButtonView::FinishAllPlayingTimelines ( )

overrideprotectedvirtual

Implement to finish playing all timelines which the button view manages.

Reimplemented from CYIAbstractButtonView.

◆ HandleEvent()

virtual bool CYIToggleButtonView::HandleEvent	(	const std::shared_ptr< CYIEventDispatcher > &	pDispatcher,
		CYIEvent *	pEvent
	)

overrideprotectedvirtual

Handle events from You.i Engine's event system. This is where input events are translated to button view events and button view states are changed.

Reimplemented from CYIAbstractButtonView.

◆ Init()

virtual bool CYIToggleButtonView::Init ( )

overridevirtual

Initializes the view and all of its content. Subclasses must call CYISceneView::Init().

Note: This must be called after CYISceneView::BuildFromTemplate()

Reimplemented from CYIAbstractButtonView.

◆ IsToggledOn()

bool CYIToggleButtonView::IsToggledOn ( ) const

Returns true if the toggle button is currently in the CYIToggleButtonView::ToggleState::On state.

◆ OnCancel()

virtual void CYIToggleButtonView::OnCancel ( )

overrideprotectedvirtual

Callback occuring when the button view transitions into the CYIAbstractButtonView::AWAY state while the button was pressed. Subclasses can update the view to represent an idle state where the user hovered and pressed down on the view and then left the view without releasing.

Reimplemented from CYIAbstractButtonView.

◆ OnDisable()

virtual void CYIToggleButtonView::OnDisable ( )

overrideprotectedvirtual

Callback occuring when the button view transitions into the CYIAbstractButtonView::DISABLED state. Subclasses can update the view to represent a disabled state here.

Reimplemented from CYIAbstractButtonView.

◆ OnEnable()

virtual void CYIToggleButtonView::OnEnable ( )

overrideprotectedvirtual

Callback occuring when the button view transitions into the CYIAbstractButtonView::ENABLED state. Subclasses can update the view to represent an enabled state here.

Reimplemented from CYIAbstractButtonView.

◆ OnEnter()

virtual void CYIToggleButtonView::OnEnter ( )

overrideprotectedvirtual

Callback occuring when the button view transitions into the CYIAbstractButtonView::OVER state. Subclasses can update the view to represent a hover state here.

Reimplemented from CYIAbstractButtonView.

◆ OnLeave()

virtual void CYIToggleButtonView::OnLeave ( )

overrideprotectedvirtual

Callback occuring when the button view transitions into the CYIAbstractButtonView::AWAY state if the button was not pressed. Subclasses can update the view to represent an idle state where the user hovered over the button but did not interact with it.

Reimplemented from CYIAbstractButtonView.

◆ OnPress()

virtual void CYIToggleButtonView::OnPress ( )

overrideprotectedvirtual

Callback occuring when the button view transitions into the CYIAbstractButtonView::PRESSED state. Subclasses can update the view to represent a pressed state here.

Reimplemented from CYIAbstractButtonView.

◆ OnPressOffCompleted()

void CYIToggleButtonView::OnPressOffCompleted ( )

protected

◆ OnPressOnCompleted()

void CYIToggleButtonView::OnPressOnCompleted ( )

protected

◆ OnRelease()

virtual void CYIToggleButtonView::OnRelease ( )

overrideprotectedvirtual

Callback occuring when the button view transitions into the CYIAbstractButtonView::RELEASED state. Subclasses can update the view to represent an idle state here.

Reimplemented from CYIAbstractButtonView.

◆ OnReleaseOffCompleted()

void CYIToggleButtonView::OnReleaseOffCompleted ( )

protected

◆ OnReleaseOnCompleted()

void CYIToggleButtonView::OnReleaseOnCompleted ( )

protected

◆ OnToggleOff()

virtual void CYIToggleButtonView::OnToggleOff ( EmitSignals signals )

protectedvirtual

Callback occurring when the toggle button view transitions into the CYIToggleButtonView::ToggleState::Off state. The view is updated to represent a toggled off state here.

Note: Once the button has toggled off, it will switch its focus animations automatically from FocusIn-Checked to FocusIn. This is done using the "FocusIn-Checked-Toggle-Transition" animation. If the animation is not present, the reverse of "FocusIn-Toggle-Transition" will be applied. If both the transition animations are not present the FocusIn animation will be fast-forwarded to its end state and the FocusIn-Checked will be rewinded to the beginning to give the button its correct visual state as a fallback behaviour. This fallback behaviour will only occur if the FocusIn-Checked animation is present.

◆ OnToggleOn()

virtual void CYIToggleButtonView::OnToggleOn ( EmitSignals signals )

protectedvirtual

Callback occurring when the toggle button view transitions into the CYIToggleButtonView::ToggleState::On state. The view is updated to represent a toggled on state here.

Note: Once the button has toggled on, it will switch its focus animations automatically from FocusIn to FocusIn-Checked if it is available. This is done by using the "FocusIn-Toggle-Transition" animation. If the transition animation is not present the FocusIn-Checked animation will be fast forwarded to the end and the FocusIn animation will be rewinded to the beginning to give the button its correct visual state as a fallback behaviour. This fallback behaviour will only occur if the FocusIn-Checked animation is present.

◆ SetState()

void CYIToggleButtonView::SetState	(	CYIAbstractButtonView::EnableState	enabledState,
		ToggleState	toggleState
	)

Sets the current enabledState and toggleState for the toggle button.

Note: Toggling the button using this method will not emit a signal.

◆ SetToggled()

void CYIToggleButtonView::SetToggled ( bool isToggled )

Toggles the button state given isToggled.

Note: Toggling the button using this method will not emit a signal.

◆ ToggleOff() [1/2]

void CYIToggleButtonView::ToggleOff ( )

Toggles the button into the CYIToggleButtonView::ToggleState::Off state.

Note: Toggling the button using this method will not emit a signal.

◆ ToggleOff() [2/2]

void CYIToggleButtonView::ToggleOff ( EmitSignals signals )

protected

Transitions the toggle button into the CYIToggleButtonView::ToggleState::Off state, signals specifies if appropriate signals will be emitted. This method will have no effect if the button is already in the CYIToggleButtonView::ToggleState::Off state.

◆ ToggleOn() [1/2]

void CYIToggleButtonView::ToggleOn ( )

Toggles the button into the CYIToggleButtonView::ToggleState::On state.

Note: Toggling the button using this method will not emit a signal.

◆ ToggleOn() [2/2]

void CYIToggleButtonView::ToggleOn ( EmitSignals signals )

protected

Transitions the toggle button into the CYIToggleButtonView::ToggleState::On state, signals specifies if appropriate signals will be emitted. This method will have no effect if the button is already in the CYIToggleButtonView::ToggleState::On state.

Member Data Documentation

◆ ButtonPressed

CYISignal<bool, int32_t> CYIToggleButtonView::ButtonPressed

Emitted when the press timeline completes, or immediately after CYIToggleButtonView::ButtonPressing if no eligible timeline exists. The first parameter indicates toggle state. The second parameter is the Button ID set using SetButtonID().

◆ ButtonPressedOff

CYISignal<int32_t> CYIToggleButtonView::ButtonPressedOff

CYIToggleButtonView::ButtonPressed when the button is in the CYIToggleButtonView::ToggleState::Off state.

◆ ButtonPressedOn

CYISignal<int32_t> CYIToggleButtonView::ButtonPressedOn

CYIToggleButtonView::ButtonPressed when the button is in the CYIToggleButtonView::ToggleState::On state.

◆ ButtonPressing

CYISignal<bool, int32_t> CYIToggleButtonView::ButtonPressing

Emitted on action down event. The first parameter indicates toggle state. The second parameter is the Button ID set using SetButtonID().

◆ ButtonPressingOff

CYISignal<int32_t> CYIToggleButtonView::ButtonPressingOff

CYIToggleButtonView::ButtonPresssing when the button is in the CYIToggleButtonView::ToggleState::Off state.

◆ ButtonPressingOn

CYISignal<int32_t> CYIToggleButtonView::ButtonPressingOn

CYIToggleButtonView::ButtonPresssing when the button is in the CYIToggleButtonView::ToggleState::On state.

◆ ButtonReleased

CYISignal<bool, int32_t> CYIToggleButtonView::ButtonReleased

Emitted when the release timeline completes, or immediately after CYIToggleButtonView::ButtonReleasing if no eligible timeline exists state. The first parameter indicates toggle state. The second parameter is the Button ID set using SetButtonID().

◆ ButtonReleasedOff

CYISignal<int32_t> CYIToggleButtonView::ButtonReleasedOff

CYIToggleButtonView::ButtonReleased when the button is in the CYIToggleButtonView::ToggleState::Off state.

◆ ButtonReleasedOn

CYISignal<int32_t> CYIToggleButtonView::ButtonReleasedOn

CYIToggleButtonView::ButtonReleased when the button is in the CYIToggleButtonView::ToggleState::On state.

◆ ButtonReleasing

CYISignal<bool, int32_t> CYIToggleButtonView::ButtonReleasing

Emitted immediately after ButtonToggled. The first parameter indicates toggle state. The second parameter is the Button ID set using SetButtonID().

◆ ButtonReleasingOff

CYISignal<int32_t> CYIToggleButtonView::ButtonReleasingOff

CYIToggleButtonView::ButtonReleasing when the button is in the CYIToggleButtonView::ToggleState::Off state.

◆ ButtonReleasingOn

CYISignal<int32_t> CYIToggleButtonView::ButtonReleasingOn

CYIToggleButtonView::ButtonReleasing when the button is in the CYIToggleButtonView::ToggleState::On state.

◆ ButtonToggled

CYISignal<bool, int32_t> CYIToggleButtonView::ButtonToggled

Emitted when the button is toggled (on action release event). The first parameter indicates toggle state. The second parameter is the Button ID set using SetButtonID().

◆ ButtonToggledOff

CYISignal<int32_t> CYIToggleButtonView::ButtonToggledOff

CYIToggleButtonView::ButtonToggled when the button is in the CYIToggleButtonView::ToggleState::Off state.

◆ ButtonToggledOn

CYISignal<int32_t> CYIToggleButtonView::ButtonToggledOn

CYIToggleButtonView::ButtonToggled when the button is in the CYIToggleButtonView::ToggleState::On state.

◆ m_pDisableAnim

CYIAbstractTimeline* CYIToggleButtonView::m_pDisableAnim

protected

◆ m_pDisableCheckedAnim

CYIAbstractTimeline* CYIToggleButtonView::m_pDisableCheckedAnim

protected

◆ m_pDownUpAnim

CYIAbstractTimeline* CYIToggleButtonView::m_pDownUpAnim

protected

◆ m_pDownUpCheckedAnim

CYIAbstractTimeline* CYIToggleButtonView::m_pDownUpCheckedAnim

protected

◆ m_pFocusInCheckedAnim

CYIAbstractTimeline* CYIToggleButtonView::m_pFocusInCheckedAnim

protected

◆ m_pFocusInCheckedToggleTransitionAnim

CYIAbstractTimeline* CYIToggleButtonView::m_pFocusInCheckedToggleTransitionAnim

protected

◆ m_pFocusInToggleTransitionAnim

CYIAbstractTimeline* CYIToggleButtonView::m_pFocusInToggleTransitionAnim

protected

◆ m_pFocusOutCheckedAnim

CYIAbstractTimeline* CYIToggleButtonView::m_pFocusOutCheckedAnim

protected

◆ m_pOverUpAnim

CYIAbstractTimeline* CYIToggleButtonView::m_pOverUpAnim

protected

◆ m_pOverUpCheckedAnim

CYIAbstractTimeline* CYIToggleButtonView::m_pOverUpCheckedAnim

protected

◆ m_pPressAnim

CYIAbstractTimeline* CYIToggleButtonView::m_pPressAnim

protected

◆ m_pPressCheckedAnim

CYIAbstractTimeline* CYIToggleButtonView::m_pPressCheckedAnim

protected

◆ m_pToggleOffAnim

CYIAbstractTimeline* CYIToggleButtonView::m_pToggleOffAnim

protected

◆ m_pToggleOnAnim

CYIAbstractTimeline* CYIToggleButtonView::m_pToggleOnAnim

protected

◆ m_pUpOverAnim

CYIAbstractTimeline* CYIToggleButtonView::m_pUpOverAnim

protected

◆ m_pUpOverCheckedAnim

CYIAbstractTimeline* CYIToggleButtonView::m_pUpOverCheckedAnim

protected

◆ m_toggleState

ToggleState CYIToggleButtonView::m_toggleState

protected

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

view/YiToggleButtonView.h

Detailed Description

Public Types

Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ EmitSignals

◆ ToggleState

Constructor & Destructor Documentation

◆ CYIToggleButtonView()

◆ ~CYIToggleButtonView()

Member Function Documentation

◆ FinishAllPlayingFocusTimelines()

◆ FinishAllPlayingTimelines()

◆ HandleEvent()

◆ Init()

◆ IsToggledOn()

◆ OnCancel()

◆ OnDisable()

◆ OnEnable()

◆ OnEnter()

◆ OnLeave()

◆ OnPress()

◆ OnPressOffCompleted()

◆ OnPressOnCompleted()

◆ OnRelease()

◆ OnReleaseOffCompleted()

◆ OnReleaseOnCompleted()

◆ OnToggleOff()

◆ OnToggleOn()

◆ SetState()

◆ SetToggled()

◆ ToggleOff() [1/2]

◆ ToggleOff() [2/2]

◆ ToggleOn() [1/2]

◆ ToggleOn() [2/2]

Member Data Documentation

◆ ButtonPressed

◆ ButtonPressedOff

◆ ButtonPressedOn

◆ ButtonPressing

◆ ButtonPressingOff

◆ ButtonPressingOn

◆ ButtonReleased

◆ ButtonReleasedOff

◆ ButtonReleasedOn

◆ ButtonReleasing

◆ ButtonReleasingOff

◆ ButtonReleasingOn

◆ ButtonToggled

◆ ButtonToggledOff

◆ ButtonToggledOn

◆ m_pDisableAnim

◆ m_pDisableCheckedAnim

◆ m_pDownUpAnim

◆ m_pDownUpCheckedAnim

◆ m_pFocusInCheckedAnim

◆ m_pFocusInCheckedToggleTransitionAnim

◆ m_pFocusInToggleTransitionAnim

◆ m_pFocusOutCheckedAnim

◆ m_pOverUpAnim

◆ m_pOverUpCheckedAnim

◆ m_pPressAnim

◆ m_pPressCheckedAnim

◆ m_pToggleOffAnim

◆ m_pToggleOnAnim

◆ m_pUpOverAnim

◆ m_pUpOverCheckedAnim

◆ m_toggleState