You.i Engine
Public Member Functions | List of all members
CYIScrollingTextView Class Reference
Scene Views

Detailed Description

A class that implements a scrolling text block. Each paragraph of text is split into a separate view that is dynamically streamed in and out as needed to improve performance.

Before text can be set in this view, the SetListItemTemplateName() function must be called with a template name. That template will be used to build each paragraph of text, and the template's composition must include a text node named 'Placeholder-Text'.

The scrolling text view supports resizing: when the view is resized, its list item views are also resized such that their width matches the scrolling text view's width. The box width of the text nodes in those list item views is also resized proportionally.

View Template Specification

As this class extends the yi::deprecated::CYIListView class, it requires that a 'ListRoot' null object be present on the view's composition.

Type Labels Property Description
Node Placeholder-Text Required must be CYITextSceneNode class

Notes

Ideally, the list item should contain a single text scene node layer, aligned to the top-left portion of the composition. The composition should be high enough to accommodate the largest paragraph that could be added to this text view. The text layer should be paragraph text with the same width and height as the composition. Note that if the composition or text layer height is too low, paragraphs may get rendered incorrectly.

This view must be focusable (and have a FocusIn timeline) in order for it to be scrollable using arrow keys or trackpad gestures.

#include <view/YiScrollingTextView.h>

Inheritance diagram for CYIScrollingTextView:
Inheritance graph
[legend]

Public Member Functions

 CYIScrollingTextView ()
 
virtual ~CYIScrollingTextView ()
 
virtual bool Init () override
 
bool SetListItemTemplateName (const CYIString &templateName)
 
void SetText (const CYIString &text)
 
const CYIString & GetText () const
 
void SetMarkedUpText (const CYIString &rMarkedUpText, CYITextMarkupParser *pMarkupParser=nullptr, const CYICustomMarkupTagsProvider *pExternalTagsProvider=nullptr)
 
const CYIString & GetMarkedUpText () const
 
virtual bool HandleEvent (const std::shared_ptr< CYIEventDispatcher > &pDispatcher, CYIEvent *pEvent) override
 
virtual bool HandlesFocusInDescendants () const override
 
virtual bool RequestFocus (CYIFocus::FOCUS_DIRECTION eDirection=CYIFocus::FOCUS_FORWARD, CYIFocus::FOCUS_ROOT_RULE eFocusRootRule=CYIFocus::FOCUS_ROOT_DESCENDANTS_UPDATE_CONTEXT, const CYIAABB &previousFocusRect=CYIAABB(), const CYIFocusSearchOptions &options=CYIFocusSearchOptions()) override
 
- Public Member Functions inherited from yi::deprecated::CYIListView
 CYIListView ()
 
virtual ~CYIListView ()
 
void SetListLayout (std::unique_ptr< CYIListLayout > pListLayout)
 
CYIListLayout * GetListLayout () const
 
virtual void SetSize (const glm::vec3 &vSize, bool bDirtyLayout=true) override
 
void UpdateListSize (float fSize)
 
int32_t GetListItemCount () const
 
CYIListItem * GetHighlightedListItem () const
 
void SetPageSize (float fPageSize, bool bAlwaysCenterOnPage=false, bool bSwipeToNextPage=false)
 
float GetPageSize ()
 
bool GetAlwaysCenterOnPage () const
 
int32_t GetCurPage ()
 
void ShowPage (int32_t nPage, bool bAnim, SCROLL_DIRECTION eDirection, int32_t nDuration=500)
 
void ShowNextPage (bool bAnim)
 
void ShowPrevPage (bool bAnim)
 
void Center ()
 
int32_t GetItemPage (int32_t nItemIndex) const
 
int32_t GetPageCount () const
 
int32_t FindNextHighlightedListItem (SELECTION_DIRECTION eDir) const
 
void HighlightItem (int32_t nIndex)
 
void SetType (TYPE eType, bool bIsCarousel=false)
 
TYPE GetType () const
 
bool GetIsCarousel () const
 
void SetMaxOutOfRange (float fOutOfRangeStart, float fOutOfRangeEnd)
 
float GetMaxOutOfRangeStart () const
 
float GetMaxOutOfRangeEnd () const
 
int32_t GetMouseWheelScrollSpeed () const
 
void SetMouseWheelScrollSpeed (int32_t nSpeed)
 
int32_t GetScrollThreshold () const
 
void SetScrollThreshold (int32_t nThreshold)
 
void SetScrollMaxVelocityCoeff (float fMaxVelocityCoeff)
 
CYISceneNode * GetRootNode () const
 
yi::deprecated::CYIStreamer * GetStreamer () const
 
glm::vec3 GetRootStartPosition () const
 
void Add (std::unique_ptr< CYIListItem > pItem, bool bAnimate)
 
void Add (std::vector< std::unique_ptr< CYIListItem >> &itemsToAdd, bool bAnimate)
 
void Insert (std::unique_ptr< CYIListItem > pItem, int32_t nInsertIndex, bool bAnimate)
 
void Remove (uint32_t nIndex, bool bAnimate)
 
void Clear (bool bDeleteItemsLater=false)
 
CYIListItem * GetFirstListItem () const
 
CYIListItem * GetFirstVisibleItem () const
 
CYIListItem * GetListItem (int32_t nIndex) const
 
CYIListItem * GetLastListItem () const
 
CYIListItem * GetListItemWithFocus () const
 
float GetContentSize () const
 
virtual void Layout (bool bAnimate)
 
void Cells2SizeAndPos (const YI_RECT_REL *pCellsRect, YI_POINT2D *pSize, YI_POINT2D *pPos) const
 
void SetOutOfRangeListener (OutOfRangeListener *pListener)
 
void SetScrollListener (ScrollListener *pListener)
 
float GetCurrentPercentage () const
 
void SetCurrentPercentage (float fPercentageScrolled, uint64_t uDuration=0, CYITimeInterpolator *pInterpolator=nullptr)
 
void ScrollToItem (CYIListItem *pItem, SCROLL_HINT eScrollHint=LEFT, int32_t nDuration=0, SCROLL_DIRECTION eDirection=CLOSEST, CYITimeInterpolator *pInterpolator=nullptr)
 
void SetVisibleRangeEnabled ()
 
void SetVisibleRangeDisabled ()
 
bool GetVisibleRangeEnabled ()
 
CYITimelineGroup * GetInTimelineGroup () const
 
CYITimelineGroup * GetOutTimelineGroup () const
 
void EnableTimelineGroupsAsInOutTimelines ()
 
void RemapTimeline (const CYIString &markerName)
 
- Public Member Functions inherited from CYISceneView
 CYISceneView ()
 
virtual ~CYISceneView ()
 
bool BuildFromTemplate (CYISceneManager *pSceneManager, const std::shared_ptr< CYIAssetViewTemplate > &pAssetViewTemplate, CYISceneManager::MISSING_CLASS_HANDLING_MODE eMissingHandlingMode=CYISceneManager::ABORT)
 
bool IsInitialized () const
 
void SetClippingAreaNode (CYISceneNode *pClippingNode)
 
virtual bool GetProperty (const CYIString &propertyName, CYIString *pValue) const override
 
void EnableDefaultHitZone ()
 
bool IsResponsiveLayoutEnabled () const
 
void EnableResponsiveLayout ()
 
void DisableResponsiveLayout ()
 
void AddAnchor (YI_ANCHOR_TYPE anchorType)
 
YI_ANCHOR_DATA GetAnchor (YI_ANCHOR_TYPE anchorType) const
 
virtual const CYISceneView::AssetRequirement * GetAssetRequirements (uint32_t *pRequirementCount)
 
CYIAbstractTimeline * GetInTimeline () const
 
CYIAbstractTimeline * GetOutTimeline () const
 
CYIAbstractTimeline * GetFocusInTimeline () const
 
CYIAbstractTimeline * GetFocusOutTimeline () const
 
bool HasFocus () const
 
void SetFocusable (bool bFocusable)
 
bool IsFocusable () const
 
bool CanBeFocused () const
 
void SetNextFocus (CYISceneView *pView, CYIFocus::FOCUS_DIRECTION eDirection)
 
CYISceneView * GetNextFocus (CYIFocus::FOCUS_DIRECTION eDirection) const
 
void SetInitiallyFocusedView (CYISceneView *pView)
 
CYISceneView * GetInitiallyFocusedView () const
 
CYISceneView * FindNextFocus (CYIFocus::FOCUS_DIRECTION eDirection, const CYIFocusSearchOptions &options=CYIFocusSearchOptions()) const
 
CYISceneView * FindNextFocus (CYIFocus::FOCUS_DIRECTION eDirection, 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 ()
 
const std::shared_ptr< CYIAssetViewTemplate > & GetViewTemplate () const
 
const std::vector< CYIString > & GetChildTemplateNames ()
 
virtual CYIAbstractTimeline * GetTimeline (const CYIString &rMarkerName, TIMELINE_GET_MODE eMode=GET_DEFAULT)
 
CYIAbstractTimeline * GetTimeline (CYIMarkerData::MARKER_ID eID, TIMELINE_GET_MODE eMode=GET_DEFAULT)
 
std::map< CYIString, CYITimeline * > GetTimelines () const
 
bool FindTimeline (CYIAbstractTimeline *&pTimeline, const CYIString &markerName, FETCH_TYPE eType, const CYIString &tag="", TIMELINE_GET_MODE eMode=GET_DEFAULT)
 
CYITimelineGroup * GetTimelineGroup (const CYIString &markerName)
 
std::unique_ptr< CYITimelineGroup > BuildTimelineGroup (const CYIString &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
 
virtual void BuildDrawList (std::vector< IYIRenderer::Command > &children, CYIAbstractCameraSceneNode *pCameraToDrawWith=nullptr) override
 
- Public Member Functions inherited from CYISceneNode
 CYISceneNode ()
 
virtual ~CYISceneNode ()
 
void ForceDirty ()
 
void ClearDirtyFlag ()
 
void SetDirtyFlag (DirtyFlag eDirtyFlag)
 
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 nID)
 
uint64_t GetUniqueID () const
 
bool AddChild (std::unique_ptr< CYISceneNode > pSceneNode)
 
bool AddChild (std::unique_ptr< CYISceneNode >, int32_t nIndex)
 
bool InsertChildAfter (CYISceneNode *pRefNode, std::unique_ptr< CYISceneNode > pSceneNode)
 
std::unique_ptr< CYISceneNode > RemoveChild (CYISceneNode *pSceneNode)
 
bool ReorderChild (uint32_t uFromIndex, uint32_t uToIndex)
 
CYISceneNode * GetParent () const
 
bool ChangeParent (CYISceneNode *pParent)
 
CYISceneNode * GetDrawParent () const
 
bool IsAncestorOf (const CYISceneNode *pNode) const
 
CYISceneManager * GetSceneManager () const
 
uint32_t GetChildCount () const
 
uint32_t GetChildCountRecursive () const
 
CYISceneNode * GetChild (uint32_t nIndex) const
 
Iterator begin (Iterator::ITERATION_MODE eMode=Iterator::IMMEDIATE_CHILDREN) const
 
Iterator end (Iterator::ITERATION_MODE eMode=Iterator::IMMEDIATE_CHILDREN) const
 
ReverseIterator rbegin (Iterator::ITERATION_MODE eMode=Iterator::IMMEDIATE_CHILDREN) const
 
ReverseIterator rend (Iterator::ITERATION_MODE eMode=Iterator::IMMEDIATE_CHILDREN) const
 
CYISceneNode * GetChild (const CYIString &sName) const
 
uint32_t GetDrawChildCount () const
 
CYISceneNode * GetDrawChild (uint32_t uIndex) const
 
CYISceneNode * GetDrawChildByID (int32_t nID) const
 
template<class YI_SCENE_NODE_SUBCLASS >
YI_SCENE_NODE_SUBCLASS * GetChild (uint32_t uTargetMatchedNodeCount=1) const
 
template<class YI_SCENE_NODE_SUBCLASS >
std::list< YI_SCENE_NODE_SUBCLASS * > GetChildren () const
 
int32_t GetIndexOfChild (const CYISceneNode *pSceneNode) const
 
void Show ()
 
void Hide ()
 
void SetVisibility (bool bVisible)
 
void SetOpacity (float fOpacity)
 
float GetCompositeOpacity () const
 
float GetLocalOpacity () const
 
bool IsVisible () const
 
bool IsTrulyVisible () const
 
CYISceneNode * GetNode (const CYIString &name)
 
CYISceneNode * GetNode (const CYIString &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 (const CYIString &name)
 
CYISceneNode * GetNode (const int32_t nID)
 
CYISceneNode * GetNode (const int32_t nID, const CYIRuntimeTypeInfo &enforceClassType)
 
template<class YI_SCENE_NODE_SUBCLASS >
bool FindNode (YI_SCENE_NODE_SUBCLASS *&pNode, const CYIString &nodeName, FETCH_TYPE eType, const CYIString &tag)
 
std::list< CYISceneNode * > GetNodes (const CYIString &name)
 
std::list< CYISceneNode * > GetNodes (int32_t nID)
 
std::list< CYISceneNode * > GetNodes (const CYIRuntimeTypeInfo &enforceClassType)
 
template<class YI_SCENE_NODE_SUBCLASS >
const YI_SCENE_NODE_SUBCLASS * GetNode (uint32_t uTargetMatchedNodeCount=1) const
 
template<class YI_SCENE_NODE_SUBCLASS >
YI_SCENE_NODE_SUBCLASS * GetNode (uint32_t uTargetMatchedNodeCount=1)
 
void SetMesh (const std::shared_ptr< CYIMesh > &pMesh)
 
void SetMaterial (const std::shared_ptr< CYIMaterial > &pMaterial, uint32_t nIndex=0)
 
void AddEffect (const std::shared_ptr< CYIEffect > &pEffect)
 
void RemoveEffect (const std::shared_ptr< CYIEffect > &pEffect)
 
uint32_t GetEffectCount () const
 
std::shared_ptr< CYIEffect > GetEffect (uint32_t uIndex) const
 
void ConnectEffectsToTimelines (const CYITimelineTrack *pTrack)
 
void AddMask (std::unique_ptr< CYIMask > pMask)
 
std::unique_ptr< CYIMask > RemoveMask (const CYIMask *pMask)
 
uint32_t GetMaskCount () const
 
const CYIMask * GetMask (uint32_t uIndex) const
 
CYIMask * GetMask (uint32_t uIndex)
 
const std::shared_ptr< CYIMesh > & GetMesh () const
 
uint32_t GetMaterialCount () const
 
const std::shared_ptr< CYIMaterial > GetMaterial (uint32_t nIndex=0) const
 
const std::shared_ptr< IYIUniformBufferObject > & GetShaderUniforms () const
 
void SetMeshTransform (const glm::mat4 &rTransform)
 
void DestroyChildren ()
 
const glm::mat4 & GetLocalTransform () const
 
const glm::mat4 & GetEffectTransform () const
 
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
 
const CYIAABB & GetWorldAABB () const
 
const CYIAABB & GetLocalAABB () const
 
void SetAnchorPoint (const glm::vec3 &ref)
 
void SetAnchorPoint (float fX, float fY, float fZ)
 
void SetAnchorPointX (float fX)
 
void SetAnchorPointY (float fY)
 
void SetAnchorPointZ (float fZ)
 
void SetPosition (const glm::vec3 &ref)
 
void SetPosition (float fX, float fY, float fZ)
 
void SetPositionX (float fX)
 
void SetPositionY (float fY)
 
void SetPositionZ (float fZ)
 
void SetRotation (const glm::vec3 &fEulerDegrees)
 
void SetRotation (float fPitchDegrees, float fYawDegrees, float fRollDegrees)
 
void SetRotationX (float fPitchDegrees)
 
void SetRotationY (float fYawDegrees)
 
void SetRotationZ (float fRollDegrees)
 
void SetOrientation (float fPitchDegrees, float fYawDegrees, float fRollDegrees)
 
void SetOrientation (const glm::quat &orient)
 
void SetScale (const glm::vec3 &fScaleFactors)
 
void SetScale (float fFactorX, float fFactorY, float fFactorZ)
 
void SetScaleX (float fFactor)
 
void SetScaleY (float fFactor)
 
void SetScaleZ (float fFactor)
 
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
 
const glm::vec3 & GetSize () const
 
const glm::vec3 & GetInitialSize () const
 
void SetMeasuredSize (const glm::vec3 &vMeasuredSize)
 
const glm::vec3 & GetMeasuredSize () const
 
void SetInternalCustomTimelineValue (uint32_t nTrackID, const CYIVariant &value)
 
virtual void SetCustomTimelineValue (uint32_t nTrackID, const CYIVariant &value)
 
void SetClippingOn ()
 
void SetClippingOff ()
 
bool GetClipping () const
 
void SetClippingBox (const CYIAABB &rWorldBox)
 
const CYIAABB & GetClippingBox () const
 
void StartPropertyAnimation (YI_NODE_PROPERTY_TYPE ePropType, float fFrom, float fTo, uint32_t nDurMs, CYITimeInterpolator *pTimeInterpolator=nullptr, bool bDirtyLayout=true)
 
void StopPropertyAnimation (YI_NODE_PROPERTY_TYPE ePropType)
 
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 &rWorldSpaceRay) const
 
bool IsMeshHit (const CYIRay &rWorldSpaceRay) const
 
void DumpTree () const
 
void StartCaptureKeyboardEvents ()
 
void StopCaptureKeyboardEvents ()
 
void StartCaptureTrackpadEvents ()
 
void StopCaptureTrackpadEvents ()
 
void StartCapturePointerEvents (uint8_t uPointerID)
 
void StopCapturePointerEvents (uint8_t uPointerID)
 
bool DrawBehindChildren (CYISceneNode *pSceneNode)
 
bool DrawInFrontOfChildren (CYISceneNode *pSceneNode)
 
bool DrawBehind (CYISceneNode *pSceneNode)
 
bool DrawInFront (CYISceneNode *pSceneNode)
 
bool IsFocusRoot () const
 
void SetIsFocusRoot (bool bIsFocusRoot)
 
virtual void OnFocusGainedInDescendants ()
 
virtual void OnFocusLostInDescendants ()
 
virtual void FocusLostInDescendants ()
 
virtual void OnFocusChangedInDescendants ()
 
void ShowPointerDebugNode (CYIActionEvent *pActionEvent)
 
void SetUseLocalTransformAndAlpha (bool bUse)
 
virtual const std::map< CYIString, CYIString > & GetProperties () const override
 
void SetProperty (const CYIString &rPropertyName, const CYIString &rPropertyValue)
 
const std::shared_ptr< CYISceneNodeProxy > & GetSceneNodeProxy () const
 
void SetLayoutConfig (std::unique_ptr< CYILayoutConfig > pLayoutConfig)
 
const CYILayoutConfig * GetLayoutConfig (LayoutConfigFetchMode eFetchMode=LAYOUT_CONFIG_LAZY_INSTANTIATE) const
 
CYILayoutConfig * GetLayoutConfig (LayoutConfigFetchMode eFetchMode=LAYOUT_CONFIG_LAZY_INSTANTIATE)
 
void SetLayoutState (std::unique_ptr< CYILayoutState > pLayoutState)
 
const CYILayoutState * GetLayoutState () const
 
CYILayoutState * GetLayoutState ()
 
void RequestLayout ()
 
LayoutDirtyFlag GetLayoutDirtyFlag () const
 
virtual void SetLayoutDirtyFlag (LayoutDirtyFlag eFlag)
 
CYIAbstractCameraSceneNode * FindActiveCamera () const
 
template<typename T >
bool CanCastTo () const
 
- Public Member Functions inherited from CYIEventTarget
 CYIEventTarget ()
 
virtual ~CYIEventTarget ()
 
bool AddEventListener (YI_EVENT_TYPE eEventType, CYIEventHandler *pListener, EVENT_PHASE ePhase=BUBBLE)
 
bool RemoveEventListener (YI_EVENT_TYPE eEventType, CYIEventHandler *pListener, EVENT_PHASE ePhase=BUBBLE)
 
void SetSpecialTypeFlag (YI_SPECIAL_EVENT_TARGET_TYPE eType)
 
void ClearSpecialTypeFlag (YI_SPECIAL_EVENT_TARGET_TYPE eType)
 
YI_SPECIAL_EVENT_TARGET_TYPE GetSpecialTypes () const
 
- Public Member Functions inherited from CYIScriptableRTTIObject
 CYIScriptableRTTIObject ()
 
virtual ~CYIScriptableRTTIObject ()
 
virtual const CYIRuntimeTypeInfo * GetRuntimeTypeInfoForScriptObject () const override
 
- Public Member Functions inherited from CYIScriptableObject
 CYIScriptableObject ()
 
 CYIScriptableObject (const CYIScriptableObject &other)
 
CYIScriptableObject & operator= (const CYIScriptableObject &other)
 
virtual ~CYIScriptableObject ()
 
CYIBindingImplementation * GetBindingImplementation () const
 
void SetBindingImplementation (CYIBindingImplementation *pBindingImplementation)
 
- Public Member Functions inherited from CYISignalHandler
 CYISignalHandler ()
 
 CYISignalHandler (const CYISignalHandler &rSignalHandler)
 
virtual ~CYISignalHandler ()
 
CYISignalHandler & operator= (const CYISignalHandler &rSignalHandler)
 
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 &rThreadAffinity)
 
virtual bool IsConnected () const
 
virtual bool IsConnected (const CYISignalBase &rSignal) const
 
void Disconnect (CYISignalBase &rSignal)
 
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 ()
 
- 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 bEnable)
 
- Public Member Functions inherited from CYIScrollController::ScrollListener
virtual ~ScrollListener ()
 
virtual void OnScrollAuto (CYIScrollController *)
 
- Public Member Functions inherited from CYIScrollController::OutOfRangeListener
virtual ~OutOfRangeListener ()
 

Additional Inherited Members

- Public Types inherited from yi::deprecated::CYIListView
enum  TYPE {
  VERTICAL,
  HORIZONTAL
}
 
enum  SELECTION_DIRECTION {
  NONE = 0,
  NORTH,
  EAST,
  SOUTH,
  WEST
}
 
enum  STATE {
  DEFAULT,
  SCROLLING
}
 Used by HandleEvent() to track when the list is scrolling. More...
 
enum  SCROLL_HINT {
  TOP,
  LEFT = TOP,
  BOTTOM,
  RIGHT = BOTTOM,
  CENTER
}
 Used by ScrollToItem() to position the item in the list. More...
 
enum  SCROLL_DIRECTION {
  CLOSEST,
  FORWARD,
  REVERSE
}
 
- Public Types inherited from CYISceneView
enum  ASSET_REQUIREMENT_TYPE {
  REQUIRES_NODE,
  REQUIRES_TIMELINE
}
 
enum  TIMELINE_GET_MODE {
  GET_DEFAULT,
  GET_TIMELINE,
  GET_TIMELINE_GROUP,
  GET_COMPONENT_OF_TIMELINE_GROUP
}
 
- Public Types inherited from CYISceneNode
enum  DirtyFlag {
  DirtyClean = 0x0000,
  DirtySceneGraph = 0x0001,
  DirtyVisibility = 0x0002,
  DirtyOpacity = 0x0004,
  DirtyLocalTransform = 0x0008,
  DirtyWorldTransform = 0x0010,
  DirtyUniform = 0x0020,
  DirtyWorldBoundingBox = 0x0040,
  DirtyMesh = 0x0080,
  DirtyWorldSurfaceScale = 0x0100,
  DirtyWorldScale = 0x0200,
  DirtyLocalBoundingBox = 0x0400,
  DirtyEverything = (DirtySceneGraph | DirtyVisibility | DirtyOpacity | DirtyLocalTransform | DirtyWorldTransform | DirtyUniform | DirtyWorldBoundingBox | DirtyWorldSurfaceScale | DirtyWorldScale | DirtyLocalBoundingBox)
}
 
enum  LayoutDirtyFlag {
  LayoutClean,
  LayoutChildDirty,
  LayoutDirty
}
 
enum  LayoutConfigFetchMode {
  LAYOUT_CONFIG_DO_NOT_LAZY_INSTANTIATE = 0,
  LAYOUT_CONFIG_LAZY_INSTANTIATE
}
 
enum  MeasureMode {
  MEASURE_UNSPECIFIED,
  MEASURE_UP_TO,
  MEASURE_EXACTLY
}
 
enum  FETCH_TYPE {
  FETCH_OPTIONAL = 0,
  FETCH_MANDATORY
}
 
typedef std::reverse_iterator< Iterator > ReverseIterator
 
- Public Types inherited from CYIEventTarget
enum  EVENT_PHASE {
  BUBBLE,
  CAPTURE
}
 
- Static Public Member Functions inherited from CYISceneView
static void RegisterAllViews ()
 
- Static Public Member Functions inherited from CYISceneNode
static void RegisterAllSceneNodes ()
 
- Public Attributes inherited from yi::deprecated::CYIListView
CYISignal< CYIListItem * > ItemHighlighted
 
CYISignal< int32_t, int32_t > PageChanged
 Emitted when the page is changed when using pages with the list. The first parameter is the index of the new page. The second parameter is the index of the previous page. More...
 
CYISignal< float > ContentSizeChanged
 Emitted when the content size changes. More...
 
- Public Attributes inherited from CYISceneView
CYISignal< CYISceneView * > GainedFocus
 Emitted when focus has entered this view. More...
 
CYISignal< CYISceneView * > LostFocus
 Emitted when focus has left this view. More...
 
- Public Attributes inherited from CYISceneNode
CYISignal< CYISceneNode *, YI_NODE_PROPERTY_TYPE > PropertyAnimationComplete
 
CYISignal DescendantGainedFocus
 Emitted when focus has entered this tree. More...
 
CYISignal DescendantLostFocus
 Emitted when focus has left this tree. More...
 
CYISignal DescendantsChangedFocus
 Emitted when focus has changed within this tree. More...
 
- Static Public Attributes inherited from CYISceneNode
static const float OPACITY_NOT_VISIBLE_EPSILON
 
- Protected Member Functions inherited from yi::deprecated::CYIListView
virtual void ViewReflowed (const glm::vec3 &worldScale) override
 
virtual void OnScrollStarted (CYIScrollController *pControl) override
 
virtual void OnScrollEnded (CYIScrollController *pControl) override
 
virtual void OnScrolled (CYIScrollController *pControl, YI_SCROLLED_INFO scrolledInfo) override
 
void SetContentsNeedUpdate ()
 
virtual void UpdateEnd () override
 
void InitScrollBar ()
 
void UpdateScrollBar ()
 
void ChangePage (int32_t nPageDelta, bool bAnim)
 
void SetState (STATE nNewState)
 
void ContentsSizeUpdated (float fNewContentSize, bool bAnimate=true)
 
void UpdateContents ()
 
void UpdateItemIndicies (int32_t nAfter)
 
bool ShouldActAsCarousel () const
 
void UpdateCarouselStatus ()
 
void AdjustListBoundaries ()
 
void ForceCarouselUpdate ()
 
void UpdateRootStartPos ()
 
virtual void OnOutOfRangeAtStart (CYIScrollController *pControl, float fOutOfRange, float fDelta) override
 
virtual void OnOutOfRangeAtEnd (CYIScrollController *pControl, float fOutOfRange, float fDelta) override
 
virtual void OnOutOfRangeAtStartDirectionChanged (CYIScrollController *pControl, float fOutOfRange, float fDelta) override
 
virtual void OnOutOfRangeAtEndDirectionChanged (CYIScrollController *pControl, float fOutOfRange, float fDelta) override
 
virtual void OnOutOfRangeAtStartSnapBack (CYIScrollController *pControl, float fOutOfRange) override
 
virtual void OnOutOfRangeAtEndSnapBack (CYIScrollController *pControl, float fOutOfRange) override
 
virtual void OnOutOfRangeAtStartBegan (CYIScrollController *pControl, float fOutOfRange, float fDelta) override
 
virtual void OnOutOfRangeAtEndBegan (CYIScrollController *pControl, float fOutOfRange, float fDelta) override
 
virtual void OnOutOfRangeAtStartFinished (CYIScrollController *pControl) override
 
virtual void OnOutOfRangeAtEndFinished (CYIScrollController *pControl) override
 
virtual CYISceneView * FindNextFocusInDescendants (const CYISceneView *pCurrentFocusView, CYIFocus::FOCUS_DIRECTION eDirection, CYIAABB &screenSpaceFocusRegion, const CYIFocusSearchOptions &options=CYIFocusSearchOptions()) const override
 
virtual void FocusChangedInDescendants () override
 
virtual void FocusGainedInDescendants () override
 
virtual bool ContainsFocusableDescendant (const CYIFocusSearchOptions &options=CYIFocusSearchOptions()) const override
 
virtual void RevealItem (CYIListItem *pItem, uint32_t uDuration, CYITimeInterpolator *pInterpolator=nullptr)
 
CYIListItem * GetItemForView (const CYISceneView *pView) const
 
- Protected Member Functions inherited from CYISceneView
void UpdateClipping ()
 
virtual void WorldScaleUpdated () override
 
virtual void WorldBoundingBoxUpdated () override
 
virtual void OnViewReflowed (const glm::vec3 &worldScale)
 
virtual bool ProcessEvent (const std::shared_ptr< CYIEventDispatcher > &pDispatcher, CYIEvent *pEvent) override
 
void UpdateResponsiveLayoutAnchors ()
 
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 (bool bForceDirty=false)
 
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 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 CalculateLocalTransform (glm::mat4 *pTransform) const
 
virtual void OnChildVisibilityChanged (CYISceneNode *pChild)
 
LayoutDirtyFlag GetCurrentLayoutDirtyFlag () const
 
virtual CYIString GetDumpTreeString () const
 
void DumpTree (int32_t nIndentLevel) const
 
void SetShaderUniforms ()
 
virtual void SetCustomUniforms ()
 
template<class T >
void SetNodeType ()
 
virtual CYISceneNode * GetNodeFromChildren (const CYIString &name)
 
virtual CYISceneNode * GetNodeFromChildren (const int32_t nID)
 
virtual CYISceneNode * GetNodeFromChildren (const CYIRuntimeTypeInfo &enforceClassType)
 
CYISceneNode * GetNodeFromChildrenAfterTarget (const CYIRuntimeTypeInfo &enforceClassType, bool *pbTargetReached, CYISceneNode *pStartAfterTarget)
 
- Protected Member Functions inherited from CYIScriptableRTTIObject
virtual std::pair< const CYIRuntimeTypeInfo *, const void * > GetRuntimeTypeInfoWithObject () const =0
 
- Protected Attributes inherited from yi::deprecated::CYIListView
TYPE m_eType
 
float m_fCurrentSize
 
bool m_bIsCarousel
 
bool m_bEnoughDataForCarousel
 
bool m_bIsEnabled
 
float m_fOutOfRangeStart
 
float m_fOutOfRangeEnd
 
CYISceneNode * m_pRootNode
 
glm::vec3 m_vRootStartPos
 
glm::vec3 m_vRootStartPosRef
 
STATE m_nCurrentState
 
float m_fScrollDownPos
 
uint64_t m_uScrollDownTime
 
float m_fLastScrollEventPos
 
int32_t m_nMouseWheelScrollSpeed
 
int32_t m_nScrollThreshold
 
int32_t m_nFocusScrollDuration
 
bool m_bDown
 
float m_fScrollBarOriginalScale
 
glm::vec3 m_vScrollBarStart
 
glm::vec3 m_vScrollBarEnd
 
CYISceneNode * m_pScrollBarNode
 
std::unique_ptr< CYIListLayout > m_pListLayout
 
OutOfRangeListener * m_pOutOfRangeListener
 
ScrollListener * m_pScrollListener
 
std::unique_ptr< yi::deprecated::CYIStreamer > m_pItems
 
CYIScrollController * m_pScrollController
 
CYITimelineGroup * m_pInTimelineGroup
 
CYITimelineGroup * m_pOutTimelineGroup
 
bool m_bVisibleRangeEnabled
 
bool m_bContentsNeedUpdate
 
- Protected Attributes inherited from CYISceneView
bool m_bStopEventPropagation
 
bool m_bResponsiveLayoutEnabled
 
bool m_bSceneTreeBuilt
 
bool m_bInAnimatedPosition
 
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
 
std::multimap< YI_ANCHOR_TYPE, YI_ANCHOR_DATA > m_anchors
 
std::map< CYIString, std::unique_ptr< CYITimeline > > m_timelines
 
std::map< CYIString, std::unique_ptr< CYIParallelTimelineGroup > > m_timelineGroups
 
- Protected Attributes inherited from CYISceneNode
CYIString m_name
 
CYISceneNode * m_pParent
 
CYISceneNode * m_pDrawParent
 
CYISceneManager * m_pSceneManager
 
std::vector< std::unique_ptr< CYISceneNode > > m_children
 
std::vector< CYISceneNode * > m_drawChildren
 
std::map< CYIString, CYIString > m_Properties
 
std::vector< std::shared_ptr< CYIMaterial > > m_pMaterials
 
std::vector< std::unique_ptr< CYIMask > > m_Masks
 
std::vector< std::shared_ptr< CYIEffect > > m_Effects
 
std::vector< PropertyAnimation * > m_propertyAnimations
 
float m_fLocalOpacity
 
CYIAABB m_WSClipBox
 
glm::mat4 m_EffectTransform
 
glm::quat m_Orientation
 
glm::vec3 m_Rotate
 
glm::vec3 m_AnchorPoint
 
glm::vec3 m_Position
 
glm::vec3 m_Scale
 
glm::vec3 m_vSize
 
glm::vec3 m_vInitialSize
 
glm::vec3 m_vMeasuredSize
 
glm::vec3 m_vlsLastCollision
 
bool m_bClip
 
bool m_bIsRotated
 
bool m_bIsOriented
 
bool m_bLocalVisibility
 
int32_t m_nID
 
uint64_t m_uGUID
 
std::shared_ptr< CYIRenderTarget > m_pRenderTarget
 
std::shared_ptr< CYIMesh > m_pMesh
 
std::shared_ptr< IYIUniformBufferObject > m_pShaderUniforms
 
- Protected Attributes inherited from CYIEventTarget
YI_SPECIAL_EVENT_TARGET_TYPE m_eSpecialTypes
 
std::vector< EventListenerEntry > m_listeners
 
- Protected Attributes inherited from CYIEventHandler
bool m_bEnableEvents
 

Constructor & Destructor Documentation

CYIScrollingTextView::CYIScrollingTextView ( )
virtual CYIScrollingTextView::~CYIScrollingTextView ( )
virtual

Member Function Documentation

const CYIString& CYIScrollingTextView::GetMarkedUpText ( ) const

Returns the marked up text. This is the unparsed text that was originally passed to the SetMarkedUpText function. If SetText was used instead of SetMarkedUpText , this function returns the same value as GetText .

const CYIString& CYIScrollingTextView::GetText ( ) const

Returns the text displayed in this scrolling view.

Note
If marked up text was assigned using the SetMarkedUpText function, this function will return the text with the markup tags removed.
virtual bool CYIScrollingTextView::HandleEvent ( const std::shared_ptr< CYIEventDispatcher > &  pDispatcher,
CYIEvent *  pEvent 
)
overridevirtual

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 yi::deprecated::CYIListView.

virtual bool CYIScrollingTextView::HandlesFocusInDescendants ( ) const
overridevirtual

Returns true to indicate that this view handles focus in its descendants.

Reimplemented from yi::deprecated::CYIListView.

virtual bool CYIScrollingTextView::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 yi::deprecated::CYIListView.

virtual bool CYIScrollingTextView::RequestFocus ( CYIFocus::FOCUS_DIRECTION  eDirection = CYIFocus::FOCUS_FORWARD,
CYIFocus::FOCUS_ROOT_RULE  eFocusRootRule = CYIFocus::FOCUS_ROOT_DESCENDANTS_UPDATE_CONTEXT,
const CYIAABB &  previousFocusRect = CYIAABB(),
const CYIFocusSearchOptions &  options = CYIFocusSearchOptions() 
)
overridevirtual

Assign initial focus within the view. This will initiate a focus search within this view.

Reimplemented from yi::deprecated::CYIListView.

bool CYIScrollingTextView::SetListItemTemplateName ( const CYIString &  templateName)

Sets the name of the template to be used for creating the paragraph list items. The asset template will be loaded, if needed, from templateName. Returns false if the template named templateName cannot be located.

void CYIScrollingTextView::SetMarkedUpText ( const CYIString &  rMarkedUpText,
CYITextMarkupParser *  pMarkupParser = nullptr,
const CYICustomMarkupTagsProvider *  pExternalTagsProvider = nullptr 
)

Sets the text to be displayed in this scrolling view to rMarkedUpText. The text will be parsed for markup. Any existing text is cleared.

If pMarkupParser is null, the default You.i Engine text markup parser is used. An 'external tags' provider can optionally be supplied through the pExternalTagsProvider pointer.

Warning
If an external tags provider is supplied, it must be compatible with the provided markup parser (or be compatible with the defualt markup parser if no markup parser is provided).
See also
SetText
void CYIScrollingTextView::SetText ( const CYIString &  text)

Sets the text to be displayed in this scrolling text view to text. Any existing text is cleared.

Warning
The SetListItemTemplateName function must have been called successfully prior to calling this function.
See also
SetMarkedUpText
The documentation for this class was generated from the following file: