Detailed Description

A dev widget that displays a scene view when activated.

This class provides an easy way to display a scene view when the dev widget is activated. At a minimum, the CreateView() function must be implemented to create the desired view. This function is called when the widget is activated, and the view is automatically deleted when the widget is deactivated. If the created view has an 'In' (and, optionally, an 'Out') timeline, then that timeline is used to animate the view in and out when the widget is activated.

#include <debug/YiDevWidgetWithView.h>

Inheritance diagram for CYIDevWidgetWithView:

[legend]

Public Member Functions
	CYIDevWidgetWithView (const CYIString &title, const CYIString &subtitle="")

virtual	~CYIDevWidgetWithView ()

virtual void	RefreshState () override

virtual void	OnPanelItemClicked () override

Public Member Functions inherited from CYIDevWidget
	CYIDevWidget (const CYIString &title, const CYIString &subtitle="")

virtual	~CYIDevWidget ()

bool	IsUsingIndicator () const

bool	IsUsingSimulatedKeys () const

bool	IsCapturingAllEvents () const

bool	IsUsingConfigurationItems () const

STATE	GetState () const

virtual const CYIString &	GetTitle () const

virtual const CYIString &	GetSubtitle () const

void	SetParentPanel (CYIDevPanel *pPanel, uint32_t uIndexInPanel)

uint32_t	GetIndexInPanel () const

void	UpdateWidgetState ()

virtual void	OnConfigureButtonClicked ()

virtual void	OnConfigurationItemClicked (int32_t nButtonID)

virtual void	OnConfigurationSubpanelClosed ()

virtual void	OnDraw ()

virtual bool	OnUpdate (bool *pbSkipUpdate=nullptr)

virtual bool	OnHandleKeyInputs (const CYIKeyEvent &keyEvent)

virtual bool	OnHandleActionInputs (int32_t nX, int32_t nY, int32_t nWheelDelta, uint8_t uButton, YI_EVENT_TYPE eEventType, uint8_t uPointerID, bool bHover)

virtual bool	OnPreFilterEvent (const std::shared_ptr< CYIEventDispatcher > &pDispatcher, CYIEvent pEvent, CYIEventHandler pDestination)

void	SimulatePanelItemClicked ()

bool	SimulateKeyPress (const CYIKeyEvent &keyEvent)

void	SimulatedKeyPressesEnded ()

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

	CYIScriptableObject (const CYIScriptableObject &other)

CYIScriptableObject &	operator= (const CYIScriptableObject &other)

virtual	~CYIScriptableObject ()

CYIBindingImplementation *	GetBindingImplementation () const

void	SetBindingImplementation (CYIBindingImplementation *pBindingImplementation)

virtual const CYIRuntimeTypeInfo *	GetRuntimeTypeInfoForScriptObject () const

Protected Member Functions
virtual std::unique_ptr< CYISceneView >	CreateView ()=0

virtual void	DeleteView ()

virtual void	OnShow ()

virtual void	OnHide ()

Protected Member Functions inherited from CYIDevWidget
void	SetUseSimulatedKeys (bool bUseSimulatedKeys)

void	SetCaptureAllEvents (bool bCaptureAllEvents)

void	SetUsesConfigurationItems (bool bUsesConfigurationItems)

virtual std::vector< std::pair< CYIString, CYIString > >	GetConfigurationButtonTitles ()

CYISceneNode *	GetLogicalRoot () const

Protected Attributes
CYIAnimationToggleController	m_toggleController

CYISceneView *	m_pView

Protected Attributes inherited from CYIDevWidget
CYIDevPanel *	m_pParentPanel

uint32_t	m_uIndexInPanel

STATE	m_eState

CYIString	m_title

CYIString	m_subtitle

Additional Inherited Members
Public Types inherited from CYIDevWidget
enum	STATE { OFF, ON, STATELESS, DISABLED }

Constructor & Destructor Documentation

CYIDevWidgetWithView::CYIDevWidgetWithView	(	const CYIString &	title,
		const CYIString &	subtitle = `""`
	)

virtual CYIDevWidgetWithView::~CYIDevWidgetWithView ( )

virtual

Member Function Documentation

virtual std::unique_ptr<CYISceneView> CYIDevWidgetWithView::CreateView ( )

protectedpure virtual

Creates and returns the view that is to be managed by this dev widget. After creating, the view will be available through the m_pView member variable. Note that views can be created multiple times through the lifetime of the widget, as the widget can be activated and deactivated multiple times.

virtual void CYIDevWidgetWithView::DeleteView ( )

protectedvirtual

Deletes the view held by this widget. This is called by the widget when the view's 'Out' animation completes. The default implementation just deletes the scene view, but sub-classes may override this function to perform more complex deletion.

virtual void CYIDevWidgetWithView::OnHide ( )

inlineprotectedvirtual

Called when the widget has been deactivated and the view has finished animating out. This is called prior to the view being deleted.

virtual void CYIDevWidgetWithView::OnPanelItemClicked ( )

overridevirtual

Handles automatically creating/destroying a scene view when the widget is activated/deactivated. Sub-classes should not override this.

Implements CYIDevWidget.

virtual void CYIDevWidgetWithView::OnShow ( )

inlineprotectedvirtual

Called when the widget is activated and the view has started animating in. When this function is called, the view has been created but may not yet be visible due to the 'In' animation playing.

virtual void CYIDevWidgetWithView::RefreshState ( )

overridevirtual

Refreshes the state of the widget.

Reimplemented from CYIDevWidget.

Member Data Documentation

CYISceneView* CYIDevWidgetWithView::m_pView

protected

CYIAnimationToggleController CYIDevWidgetWithView::m_toggleController

protected

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

debug/YiDevWidgetWithView.h

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation