Detailed Description

A scrollbar that offers thumb size adjustment, and an auto-hide feature.

View Template Specification

Type	Labels	Property	Description
Node	Thumb	Required	Layer for the 'Thumb' that shows the scroll position.
Marker	ScrollStart	Required	The motion of a thumb between the start and end position of the scroll. When using arrow keys to scroll, the time it takes to scroll from one end to another is set using the duration of this marker.
Marker	ScrollShow	Optional	Played when the scroll bar is interacted with. The scroll bar must be configured with SetAutoHideTimeout() in order for this timeline to be played.
Marker	ScrollHide	Optional	Played a configurable delay after the scroll bar is no longer being interacted with. The scroll bar must be configured with SetAutoHideTimeout() in order for this timeline to be played.
Marker	ThumbSize	Optional	The timeline used to determine the visual state of the thumb when calling SetThumbSize(). The timeline should animate the size of the thumb between 0% and 100% of the scrollable area.

Scroll bars are automatically marked focusable when the FocusIn timeline (specified in CYISceneView) is present.

#include <view/YiScrollBarView.h>

Inheritance diagram for CYIScrollBarView:

[legend]

Classes
class	Listener
	Interface through which an object can be notified that the thumb of a specific scroll bar was moved. More...

Public Member Functions
	CYIScrollBarView ()

virtual	~CYIScrollBarView ()

virtual bool	Init () override

virtual void	FocusLost () override

void	ScrollThumbToPosition (float normalizedPosition)

void	SetThumbPosition (float normalizedPosition)

float	GetThumbPosition () const

void	SetThumbSize (float percentage)

float	GetThumbSize () const

void	AddListener (CYIScrollBarView::Listener *pListener)

void	RemoveListener (CYIScrollBarView::Listener *pListener)

void	SetAutoHideTimeout (uint64_t delayMs)

uint64_t	GetAutoHideTimeout () const

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

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

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	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< float >	Scrolled
	Emitted as the scroll bar view is moved. The float parameter indicates the current scroll percentage, expressed between 0.0f and 1.0f. More...

CYISignal	ScrolledBegin
	Emitted when the scroll bar starts to move. More...

CYISignal	ScrolledEnd
	Emitted when the scroll bar has finished moving. More...

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 Member Functions
virtual bool	HandleEvent (const std::shared_ptr< CYIEventDispatcher > &pDispatcher, CYIEvent *pEvent) override

virtual void	UpdateEnd () override

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	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)

Friends
class	CYIScrollBarViewPriv

Additional Inherited Members
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 }

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)

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

Constructor & Destructor Documentation

◆ CYIScrollBarView()

CYIScrollBarView::CYIScrollBarView ( )

◆ ~CYIScrollBarView()

virtual CYIScrollBarView::~CYIScrollBarView ( )

virtual

Member Function Documentation

◆ AddListener()

void CYIScrollBarView::AddListener ( CYIScrollBarView::Listener * pListener )

pListener will be notified when the thumb moves through user interaction.

◆ FocusLost()

virtual void CYIScrollBarView::FocusLost ( )

overridevirtual

See also: OnFocusLost

Note: The base implementation must be called.

Reimplemented from CYISceneView.

◆ GetAssetRequirements()

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

overridevirtual

The asset requirements for this class.

Reimplemented from CYISceneView.

◆ GetAutoHideTimeout()

uint64_t CYIScrollBarView::GetAutoHideTimeout ( ) const

See also: SetAutoHideTimeout

◆ GetThumbPosition()

float CYIScrollBarView::GetThumbPosition ( ) const

Returns the current thumb position, in percentage. The returned value is in the range from 0.0 to 1.0.

◆ GetThumbSize()

float CYIScrollBarView::GetThumbSize ( ) const

Returns the size of the thumb, in percentage of the scrollable area. The returned value is in the range from 0.0 to 1.0.

◆ HandleEvent()

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

overrideprotectedvirtual

Pure virtual for the child to implement according to how they wish the events to be handled.

The method is to return true if the event was processed and false otherwise.

Reimplemented from CYISceneView.

◆ Init()

virtual bool CYIScrollBarView::Init ( )

overridevirtual

Called by the framework when this class is being instanciated. Not called during normal usage of the class

Reimplemented from CYISceneView.

◆ RemoveListener()

void CYIScrollBarView::RemoveListener ( CYIScrollBarView::Listener * pListener )

pListener will no longer be notified when the thumb moves through user interaction.

◆ ScrollThumbToPosition()

void CYIScrollBarView::ScrollThumbToPosition ( float normalizedPosition )

Emulates manual scrolling of the the thumb to normalizedPosition between 0.0 and 1.0. All of the registered signal listeners will be notified of the performed scrolling event.

See also: SetThumbPosition

◆ SetAutoHideTimeout()

void CYIScrollBarView::SetAutoHideTimeout ( uint64_t delayMs )

Set the delay in milliseconds for the auto-hide timer to delayMs. The timer will be restarted each time the scroll bar is interacted with, and each time SetThumbPosition() is called. After the time elapses the "ScrollHide" animation will be played. If the scroll bar is interacted with, or SetThumbPosition() is called the "ScrollShow" timeline will be played.

◆ SetThumbPosition()

void CYIScrollBarView::SetThumbPosition ( float normalizedPosition )

Sets the thumb position to normalizedPosition between 0.0 and 1.0. None of the registered signal listeners will be notified of the performed scrolling event. If the scroll bar is configured with an auto-hide timeout the "ScrollShow" timeline will be started.

See also: SetAutoHideTimeout

◆ SetThumbSize()

void CYIScrollBarView::SetThumbSize ( float percentage )

Sets the size of the thumb in percentage of the scrollable area size. Calling this function positions the artist-specified animation labeled "ThumbSize" to percentage. 1.0 prevents the thumb from moving at all (it occupies the scrollable area). 0.0 means that the thumb can move freely all the way from the start scroll marker to the end scroll marker.

Has no effect if the "ThumbSize" timeline is not present.

◆ UpdateEnd()

virtual void CYIScrollBarView::UpdateEnd ( )

overrideprotectedvirtual

This hook provides subclasses a means to do operations subsequent to update. This hook is called after all children of the current node have been updated, and after all other update hooks have been called.

Warning: The dirty flag will be cleared prior to calling this function to allow new dirty state to be recorded from this function. If querying information about the dirty state of the node, use GetPreviousDirtyFlag().; Overrides must call the base class implementation.

See also: Update(); OnUpdateEnd()

Reimplemented from CYISceneNode.

Friends And Related Function Documentation

◆ CYIScrollBarViewPriv

friend class CYIScrollBarViewPriv

friend

Member Data Documentation

◆ Scrolled

CYISignal<float> CYIScrollBarView::Scrolled

Emitted as the scroll bar view is moved. The float parameter indicates the current scroll percentage, expressed between 0.0f and 1.0f.

◆ ScrolledBegin

CYISignal CYIScrollBarView::ScrolledBegin

Emitted when the scroll bar starts to move.

◆ ScrolledEnd

CYISignal CYIScrollBarView::ScrolledEnd

Emitted when the scroll bar has finished moving.

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

view/YiScrollBarView.h

Detailed Description

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ CYIScrollBarView()

◆ ~CYIScrollBarView()

Member Function Documentation

◆ AddListener()

◆ FocusLost()

◆ GetAssetRequirements()

◆ GetAutoHideTimeout()

◆ GetThumbPosition()

◆ GetThumbSize()

◆ HandleEvent()

◆ Init()

◆ RemoveListener()

◆ ScrollThumbToPosition()

◆ SetAutoHideTimeout()

◆ SetThumbPosition()

◆ SetThumbSize()

◆ UpdateEnd()

Friends And Related Function Documentation

◆ CYIScrollBarViewPriv

Member Data Documentation

◆ Scrolled

◆ ScrolledBegin

◆ ScrolledEnd