Detailed Description

A class that provides streaming functionality in a scrolling view.

View Template Specification

The 'placeholder' property may be applied to contents of the view template in order to prevent their instantiation. Since the items of CYIListView are dynamically populated at run-time, they can be configured using the view template, or by configuring placeholders. The placeholder properties can be retreived from the list using GetItemProperties() with the CYIViewTemplate name for the placeholder's layout. The preview tool will make use of these placeholders in the CYIListView's preview.

Layout

A layout must be assigned to a list view before it can be used, as the layout defines the ordering of items within the list view. If a layout is not specified when the list view is initialized, an instance of CYIColumnLayout is assigned automatically.

The initial size of streamable items within a list view is set through the associated adapter.

The layout configuration object for the streamable items can also be configured through the associated adapter. By default, for view-specific adapters, the layout configuration for the streamable items is read from the view's template and the placeholder layers in the list.

Limitations

If an item is streamed in that is smaller than its initial size (as declared in the associated adapter), it may cause more items to get streamed in on the next frame. This can cause visual glitches where items appear in the visible region after a few frames. To avoid this, ensure that the initial size of the item is the minimum possible size for that item.
If an item is streamed in that is smaller or larger than its initial size (as declared in the associated adapter), it may cause the current scroll position to get offset. This typically only happens when scrolling 'back' towards the start of the list view.

#include <view/YiListView.h>

Inheritance diagram for CYIListView:

[legend]

Public Member Functions
	CYIListView ()

virtual	~CYIListView ()

virtual bool	Init () override

void	SetAdapter (std::unique_ptr< CYINodeAdapter > pAdapter)

const CYINodeAdapter *	GetAdapter () const

CYINodeAdapter *	GetAdapter ()

bool	RequestFocusOnItem (uint32_t uIndex, CYIFocus::FOCUS_DIRECTION eDirection=CYIFocus::FOCUS_FORWARD, CYIFocus::FOCUS_ROOT_RULE eFocusRootRule=CYIFocus::FOCUS_ROOT_DESCENDANTS_UPDATE_CONTEXT, const CYIAABB &previousFocusRect=CYIAABB())

bool	IsStreamedIn (uint32_t uIndex) const

CYISceneNode *	GetStreamedNode (uint32_t uIndex) const

uint32_t	GetItemIndex (CYISceneNode *pStreamedItem) const

void	SetStreamingRegionFactor (float fFactor)

float	GetStreamingRegionFactor () const

void	SetItemProperties (const CYIString &viewTemplateName, std::unique_ptr< IYIPropertiesSource > pProperties)

IYIPropertiesSource *	GetItemProperties (const CYIString &viewTemplateName) const

virtual void	RevealItem (uint32_t uIndex, uint32_t uDuration, CYITimeInterpolator *pInterpolator=nullptr)

bool	IsInVisibleRegion (uint32_t uIndex) const

Public Member Functions inherited from CYIScrollingView
	CYIScrollingView ()

virtual	~CYIScrollingView ()

void	ScrollToHorizontalPosition (float fNormalizedPosition, uint32_t uDurationMs, CYITimeInterpolator *pInterpolator=nullptr)

void	ScrollToHorizontalPosition (float fNormalizedPosition)

void	ScrollToVerticalPosition (float fNormalizedPosition, uint32_t uDurationMs, CYITimeInterpolator *pInterpolator=nullptr)

void	ScrollToVerticalPosition (float fNormalizedPosition)

void	ScrollToPosition (const glm::vec2 &fNormalizedPositions, uint32_t uDurationMs=0, CYITimeInterpolator *pInterpolator=nullptr)

float	GetHorizontalPosition () const

float	GetVerticalPosition () const

void	Reveal (CYISceneNode pNode, uint32_t uDurationMs, CYITimeInterpolator pInterpolator=nullptr)

void	DisableHorizontalScrolling ()

void	EnableHorizontalScrolling ()

void	SetHorizontalScrollingEnabled (bool bEnabled)

bool	IsHorizontalScrollingEnabled () const

void	DisableVerticalScrolling ()

void	EnableVerticalScrolling ()

void	SetVerticalScrollingEnabled (bool bEnabled)

bool	IsVerticalScrollingEnabled () const

void	SetHorizontalOverpullDistance (float fDistance)

float	GetHorizontalOverpullDistance () const

void	SetVerticalOverpullDistance (float fDistance)

float	GetVerticalOverpullDistance () const

void	SetHorizontalOverpullRule (OVERPULL_RULE eRule)

void	SetVerticalOverpullRule (OVERPULL_RULE eRule)

OVERPULL_RULE	GetHorizontalOverpullRule () const

OVERPULL_RULE	GetVerticalOverpullRule () const

void	SetHorizontalScrollingAreaLayoutMode (LAYOUT_MODE eMode)

void	SetVerticalScrollingAreaLayoutMode (LAYOUT_MODE eMode)

LAYOUT_MODE	GetHorizontalScrollingAreaLayoutMode () const

LAYOUT_MODE	GetVerticalScrollingAreaLayoutMode () const

bool	HasHorizontalOverflow () const

bool	HasVerticalOverflow () const

const CYIAABB &	GetScrollableRegion () const

void	StopScrolling ()

void	StopHorizontalScrolling ()

void	StopVerticalScrolling ()

void	SetHorizontalCarouselRule (CAROUSEL_RULE eCarouselRule)

void	SetVerticalCarouselRule (CAROUSEL_RULE eCarouselRule)

CAROUSEL_RULE	GetHorizontalCarouselRule () const

CAROUSEL_RULE	GetVerticalCarouselRule () const

void	SetCascadeTimelineGroupDelay (uint32_t uDelayMs)

uint32_t	GetCascadeTimelineGroupDelay () const

CYITimelineGroup *	GetCascadeTimelineGroup (TIMELINE_TYPE eType=TIMELINE_IN)

bool	IsInVisibleRegion (CYISceneNode *pCandidate) const

void	SetHorizontalMagnets (const Magnets &magnets)

void	RemoveHorizontalMagnets ()

Magnets	GetHorizontalMagnets () const

void	SetHorizontalSwipeOneItemEnabled (bool bSwipeOneItem)

bool	IsHorizontalSwipeOneItemEnabled () const

void	SetVerticalMagnets (const Magnets &magnets)

void	RemoveVerticalMagnets ()

Magnets	GetVerticalMagnets () const

void	SetVerticalSwipeOneItemEnabled (bool bSwipeOneItem)

bool	IsVerticalSwipeOneItemEnabled () const

void	EnableMagnetism (CYISceneNode *pNode)

void	DisableMagnetism (CYISceneNode *pChild)

bool	IsMagnetic (const CYISceneNode *pNode) const

bool	IsScrollingHorizontally () const

bool	IsScrollingVertically () const

float	GetHorizontalTrackpadLeaveFriction () const

void	SetHorizontalTrackpadLeaveFriction (float fFriction)

float	GetVerticalTrackpadLeaveFriction () const

void	SetVerticalTrackpadLeaveFriction (float fFriction)

virtual void	BuildDrawList (std::vector< IYIRenderer::Command > &children, CYIAbstractCameraSceneNode *pCameraToDrawWith=nullptr) override

virtual bool	HandlesFocusInDescendants () const override

virtual bool	ContainsFocusableDescendant (const CYIFocusSearchOptions &options=CYIFocusSearchOptions()) 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

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

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

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

virtual void	SetSize (const glm::vec3 &vSize, bool bDirtyLayout=true)

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)

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

Public Attributes
CYISignal< uint32_t, CYISceneNode * >	ItemEnteredVisibleRegion

CYISignal< uint32_t, CYISceneNode * >	ItemLeftVisibleRegion

CYISignal< uint32_t, CYISceneNode * >	ItemGainedFocus

CYISignal< uint32_t, CYISceneNode * >	ItemLostFocus

Public Attributes inherited from CYIScrollingView
CYISignal	InteractionBegan

CYISignal	HorizontalScrollingBegan

CYISignal	VerticalScrollingBegan

CYISignal< float >	HorizontalPositionChanged

CYISignal< float >	VerticalPositionChanged

CYISignal	InteractionEnded

CYISignal	HorizontalScrollingEnded

CYISignal	VerticalScrollingEnded

CYISignal< bool >	HorizontalOverflowChanged

CYISignal< bool >	VerticalOverflowChanged

CYISignal< CYISceneNode * >	ChildEnteredVisibleRegion

CYISignal< CYISceneNode * >	ChildLeftVisibleRegion

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

Protected Member Functions
virtual void	OnStreamedIn (uint32_t uIndex, CYISceneNode *pStreamedItem) override

virtual void	OnStreamedOut (uint32_t uIndex, CYISceneNode *pStreamedItem) override

virtual void	FocusGainedForItem (uint32_t uIndex) override

virtual void	OnFocusGainedForItem (uint32_t uIndex) override

virtual void	FocusLostForItem (uint32_t uIndex) override

virtual void	OnFocusLostForItem (uint32_t uIndex) override

virtual void	WorldBoundingBoxUpdated () override

virtual void	ApplyMeasurements () override

void	UpdateStreamedStateOfAllItems ()

virtual void	ParseProperties () override

virtual void	ChildVisibilityInVisibleRegionChanged (CYISceneNode *pChild, bool bIsInVisibleRegion) override

virtual void	ChildMovedInVisibleRegion (CYISceneNode *pChild, const glm::vec2 &normalizedPosition) override

virtual CYIAbstractTimeline *	GetCascadeTimelineFor (TIMELINE_TYPE eType, CYISceneView *pView) override

Protected Member Functions inherited from CYIScrollingView
CYIScrollController *	GetScrollController (DIRECTION eDirection) const

void	ConfigureScrollControllers ()

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

void	ConfigureScrollingRange (DIRECTION eDirection, float fContentSize)

void	ConfigureOverpull (DIRECTION eDirection, float fViewSize)

void	ConfigureMagnets (DIRECTION eDirection, float fViewSize, float fOldViewSize)

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

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

virtual void	SizeChanged () override

virtual void	ChildAdded (CYISceneNode *pChild) override

virtual void	ChildRemoved (CYISceneNode *pChild) override

virtual void	Reveal (CYISceneNode pNode, uint32_t uDurationMs, SCROLL_DIRECTION eHorizontalDirection, SCROLL_DIRECTION eVerticalDirection, CYITimeInterpolator pInterpolator=nullptr)

virtual CYIAABB	CalculateScrollableRegion () const

CYIAABB	CalculateContentSize () const

bool	IsInExpandedVisibleRegion (CYISceneNode *pCandidate, float fVisibleRegionMultiplier) const

void	CheckAndNotifyVisibilityInVisibilityRegion (CYISceneNode *pChild)

virtual void	OnChildVisibilityInVisibleRegionChanged (CYISceneNode *pChild, bool bIsInVisibleRegion)

virtual void	OnChildMovedInVisibleRegion (CYISceneNode *pChild, const glm::vec2 &normalizedPosition)

virtual void	OnScrollAuto (CYIScrollController *pController) override

virtual void	OnScrollStarted (CYIScrollController *pController) override

virtual void	OnScrolled (CYIScrollController *pController, YI_SCROLLED_INFO scrolledInfo) override

virtual void	OnScrollEnded (CYIScrollController *pController) override

virtual void	UpdateEnd () override

bool	IsCarouseling (DIRECTION eDirection) const

CYITimelineGroup *	GetCascadeTimelineGroup (TIMELINE_TYPE eType, bool bUpdateTimeline)

virtual std::map< CYISceneView *, uint64_t >	GetTotalCascadeDelayFor (TIMELINE_TYPE eType, const std::vector< ViewAndDistance > &visibleViews)

Protected Member Functions inherited from CYISceneView
void	UpdateClipping ()

virtual void	WorldScaleUpdated () 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	ChildNeedsLayout () override

virtual void	LayoutDirtied () 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	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	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

Additional Inherited Members
Public Types inherited from CYIScrollingView
enum	OVERPULL_RULE { OVERPULL_ALWAYS, OVERPULL_IF_OVERFLOWING }

enum	LAYOUT_MODE { LAYOUT_FIT_CONTENT, LAYOUT_FIT_CONTENT_IF_OVERFLOWING, LAYOUT_FILL_VIEW }

enum	CAROUSEL_RULE { CAROUSEL_NEVER, CAROUSEL_ALWAYS, CAROUSEL_IF_OVERFLOWING }

enum	TIMELINE_TYPE { TIMELINE_IN, TIMELINE_OUT }

enum	MAGNETS_TYPE { MAGNETS_NONE, MAGNETS_EDGES, MAGNETS_CENTER, MAGNETS_BEGIN, MAGNETS_END }

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

Static Public Attributes inherited from CYISceneNode
static const float	OPACITY_NOT_VISIBLE_EPSILON

Protected Types inherited from CYIScrollingView
enum	DIRECTION { HORIZONTAL, VERTICAL, DIRECTION_MAX }

enum	SCROLL_DIRECTION { SCROLL_CLOSEST, SCROLL_FORWARD, SCROLL_REVERSE }

Static Protected Member Functions inherited from CYIScrollingView
static const CYIString &	DirectionToString (DIRECTION eDirection)

Protected Attributes inherited from CYIScrollingView
uint32_t	m_uFocusScrollDuration

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

CYIListView::CYIListView ( )

virtual CYIListView::~CYIListView ( )

virtual

Member Function Documentation

virtual void CYIListView::ApplyMeasurements ( )

overrideprotectedvirtual

Applies the measured sizes of this node's children.

Note: Typically, if ApplyMeasurements is overridden then Measure must also be overridden.; Measurements should be applied before calculating position for layout.

Warning: Subclasses that override this function must ensure that the ApplyMeasurements function of ALL children of this scene node is called.

Note: Subclasses that override this function should make use of the GetCurrentLayoutDirtyFlag() function (rather than GetLayoutDirtyFlag() ).

Reimplemented from CYIScrollingView.

virtual void CYIListView::ChildMovedInVisibleRegion	(	CYISceneNode *	pChild,
		const glm::vec2 &	normalizedPosition
	)

overrideprotectedvirtual

Reimplemented from CYIScrollingView.

virtual void CYIListView::ChildVisibilityInVisibleRegionChanged	(	CYISceneNode *	pChild,
		bool	bIsInVisibleRegion
	)

overrideprotectedvirtual

A function called when the visibility of a child within the visible region changes.

Warning: Overrides must call the base class implementation.

See also: OnChildVisibilityInVisibleRegionChanged()

Reimplemented from CYIScrollingView.

virtual void CYIListView::FocusGainedForItem ( uint32_t uIndex )

overrideprotectedvirtual

See also: CYIStreamer::OnFocusGainedForItem

Warning: Overrides must call the base class implementation.

See also: OnFocusGainedForItem

Reimplemented from CYIStreamer.

virtual void CYIListView::FocusLostForItem ( uint32_t uIndex )

overrideprotectedvirtual

See also: CYIStreamer::OnFocusLostForItem

Warning: Overrides must call the base class implementation.

See also: OnFocusLostForItem

Reimplemented from CYIStreamer.

const CYINodeAdapter* CYIListView::GetAdapter ( ) const

See also: CYIStreamer::GetAdapter()

CYINodeAdapter* CYIListView::GetAdapter ( )

See also: CYIStreamer::GetAdapter()

virtual CYIAbstractTimeline* CYIListView::GetCascadeTimelineFor	(	TIMELINE_TYPE	eType,
		CYISceneView *	pView
	)

overrideprotectedvirtual

Returns the cascade timeline of type eType for view pView. When eType is TIMELINE_IN, the timeline with marker name 'CascadeIn' is returned. When eType is TIMELINE_OUT, the timeline with marker name 'CascadeOut' is returned. This function returns nullptr if the relevant timeline could not be located in pView.

Reimplemented from CYIScrollingView.

uint32_t CYIListView::GetItemIndex ( CYISceneNode * pStreamedItem ) const

Returns the index of the streamed-in item pStreamedItem. If pStreamedItem is not a node that's currently streamed in by this list, std::numeric_limits<uint32_t>::max() is returned.

Note: pStreamedItem must be a pointer to the root of the view, that is to say it must be the pointer that was returned from the adapter.

IYIPropertiesSource* CYIListView::GetItemProperties ( const CYIString & viewTemplateName ) const

Returns a IYIPropertiesSource for the CYIViewTemplate named viewTemplateName or null if there is no IYIPropertiesSource for viewTemplateName.

See also: SetItemProperties; CYIViewTemplate::GetName

CYISceneNode* CYIListView::GetStreamedNode ( uint32_t uIndex ) const

See also: CYIStreamer::GetStreamedNode(uint32_t) const

float CYIListView::GetStreamingRegionFactor ( ) const

See also: SetStreamingRegionFactor

virtual bool CYIListView::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 CYIScrollingView.

bool CYIListView::IsInVisibleRegion ( uint32_t uIndex ) const

Returns true if streamable item with index uIndex is within the bounds of this view, defined by its size.

See also: IsInVisibleRegion(CYISceneNode*) const

bool CYIListView::IsStreamedIn ( uint32_t uIndex ) const

See also: CYIStreamer::IsStreamedIn(uint32_t) const

virtual void CYIListView::OnFocusGainedForItem ( uint32_t uIndex )

overrideprotectedvirtual

See also: CYIStreamer::OnFocusGainedForItem

Reimplemented from CYIStreamer.

virtual void CYIListView::OnFocusLostForItem ( uint32_t uIndex )

overrideprotectedvirtual

See also: CYIStreamer::OnFocusLostForItem

Reimplemented from CYIStreamer.

virtual void CYIListView::OnStreamedIn	(	uint32_t	uIndex,
		CYISceneNode *	pStreamedItem
	)

overrideprotectedvirtual

A function called when the item at index uIndex is streamed in. The streamed node (as provided by the associated adapter) is provided as pStreamedItem. This function is called after the item has been attached to the scene tree. Subclasses can override this function to perform post-streaming logic.

Note: In some streamer implementations, the position of the streamed items is not set until later in the frame (e.g. after the layout pass). This function being called is only an indication that a new node has been attached to the scene tree.

Reimplemented from CYIStreamer.

virtual void CYIListView::OnStreamedOut	(	uint32_t	uIndex,
		CYISceneNode *	pStreamedItem
	)

overrideprotectedvirtual

A function called when the item at index uIndex is streamed out. The streamed node (as provided by the associated adapter) is provided as pStreamedItem. This function is called before the item has been detached from the scene tree. Subclasses can override this function to perform post-streaming logic.

Reimplemented from CYIStreamer.

virtual void CYIListView::ParseProperties ( )

overrideprotectedvirtual

The properties outlined in the table at the top are parsed and applied here.

Reimplemented from CYIScrollingView.

bool CYIListView::RequestFocusOnItem	(	uint32_t	uIndex,
		CYIFocus::FOCUS_DIRECTION	eDirection = `CYIFocus::FOCUS_FORWARD`,
		CYIFocus::FOCUS_ROOT_RULE	eFocusRootRule = `CYIFocus::FOCUS_ROOT_DESCENDANTS_UPDATE_CONTEXT`,
		const CYIAABB &	previousFocusRect = `CYIAABB()`
	)

See also: CYIStreamer::RequestFocusOnItem()

virtual void CYIListView::RevealItem	(	uint32_t	uIndex,
		uint32_t	uDuration,
		CYITimeInterpolator *	pInterpolator = `nullptr`
	)

virtual

Reveals the streamable item at index uIndex with an animation of duration uDuration.

See also: CYIScrollingView::Reveal

void CYIListView::SetAdapter ( std::unique_ptr< CYINodeAdapter > pAdapter )

See also: CYIStreamer::SetAdapter()

void CYIListView::SetItemProperties	(	const CYIString &	viewTemplateName,
		std::unique_ptr< IYIPropertiesSource >	pProperties
	)

Set the properties for views in this list created with the CYIViewTemplate named viewTemplateName to pProperties. This method is called after the list is created with the properties of each placeholder in the list. These properties will be given to the CYINodeAdapter when the adapter is set on this list.

Note: This method overwrites any properties previously set.

See also: GetItemProperties; CYINodeAdapter::SetProperties; CYIViewTemplate::GetName; CYIStreamer::SetAdapter

void CYIListView::SetStreamingRegionFactor ( float fFactor )

Sets the factor used to calculate the streaming region to fFactor. This factor is used along with the visible region of the list to calculate that region in which items would be streamed in. For example, a value of 2.0f would indicate that the streaming region should be 50% larger than the visible region on each side. A value of 1.0f indicates that the streaming region should be exactly equal to the visible region.

The streaming region factor defaults to 2.0f.

Note: Values smaller than 1.0f are not supported. If this function is called with a value smaller than 1.0f, a value of 1.0f is used instead.

void CYIListView::UpdateStreamedStateOfAllItems ( )

protected

virtual void CYIListView::WorldBoundingBoxUpdated ( )

overrideprotectedvirtual

Called by Update() when the world bounding box update process is complete. Subclasses may overload this function to do post-processing.

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(); OnWorldBoundingBoxUpdated()

Reimplemented from CYIScrollingView.

Member Data Documentation

CYISignal<uint32_t , CYISceneNode *> CYIListView::ItemEnteredVisibleRegion

Emitted when an item of the CYIListView has entered the visible region.

See also: IsInVisibleRegion

CYISignal<uint32_t , CYISceneNode *> CYIListView::ItemGainedFocus

Emitted when focus has entered the tree rooted at a particular item. The new view with focus can be found using CYISceneManager::GetViewWithFocus(const CYISceneNode *) const .

CYISignal<uint32_t , CYISceneNode *> CYIListView::ItemLeftVisibleRegion

Emitted when an item of the CYIListView has left the visible region.

See also: IsInVisibleRegion

CYISignal<uint32_t , CYISceneNode *> CYIListView::ItemLostFocus

Emitted when focus has left the tree rooted at a particular item. The new view with focus can be found using CYISceneManager::GetViewWithFocus(const CYISceneNode *) const .

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

view/YiListView.h

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation