CYIDevPanel Class Reference

Detailed Description

A class used to manipulate developer utilities.

This class is used to display an overlay on top of the app which lists dev widgets. Each widget controls a single debug utility.

The method used to activate the dev panel depends on the platform on which the app runs:

• Desktop: F3, F13 or CTRL+` (CTRL + Back Tick)
• Touch devices: triple-tap one of the corners of the screen
• Consoles: Click the right thumbstick on the gamepad
• 10-foot: These keys in sequence: up, up, down, down, left, right, left, right, select (modified Konami code), or triple-click the Play/Pause button on the remote Note that some platforms support multiple activation methods.

The dev panel is typically only available for Debug builds. However, it can be made available on Release builds by calling the CYIApp::InitializeDevPanel function.

The following describes the various components that make up the dev panel system:

• The dev panel instance holds the dev widgets, and is owned by the CYIApp instance
• The dev widget instance represents a single debug utility, and is owned by the dev panel instasnce
• The dev panel view is the rendered portion of the dev panel
• Each dev widget inserts a dev widget item in the dev panel (e.g. a button)
• Dev widgets can optionally display a widget view to the user when activated
• Dev widgets can optionally display a configuration button in the dev panel to trigger displaying configuration options
• Dev widgets which provide configuration options can either make use of the default configuration subpanel in the dev panel, or implement their own configuration view

See also

CYIDevWidget

#include <debug/YiDevPanel.h>

Inheritance diagram for CYIDevPanel:

Public Types
enum	INSERT_POSITION {   TOP,   BOTTOM }

Public Member Functions
	CYIDevPanel (CYISceneManager *pSceneManager, CYIApp *pApp)
	~CYIDevPanel ()
void	Open ()
void	Close ()
void	ToggleVisibility ()
bool	IsActive () const
bool	IsVisible () const
bool	IsConfigurationSubpanelOpen () const
void	AddWidget (std::unique_ptr< CYIDevWidget > pWidget, INSERT_POSITION eInsertPosition=TOP)
std::vector< CYIDevWidget * >	GetWidgets () const
void	UpdateWidget (uint32_t uIndexInPanel)
template<class T >
T *	GetWidget () const
CYIApp *	GetApp () const
CYISceneManager *	GetSceneManager () const
CYISceneView *	GetWidgetsContainer () const
void	SimulatePanelItemClicked (uint32_t uIndex)
void	SimulateConfigurationItemClicked (uint32_t uWidgetIndex, uint32_t uItemIndex)
void	OpenConfigurationSubpanel (CYIDevWidget *pWidget, const std::vector< std::pair< CYIString, CYIString > > &items)
void	CloseConfigurationSubpanel ()
void	ReconfigureConfigurationSubpanel (CYIDevWidget *pWidget)
bool	HandleKeyInputs (const CYIKeyEvent &keyEvent)
bool	HandleActionInputs (int32_t nX, int32_t nY, int32_t nWheelDelta, uint8_t uButton, YI_EVENT_TYPE eEventType, uint8_t uPointerID, bool bHover)
bool	Update (bool *pbSkipUpdate=nullptr)
void	Draw ()
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 CYIEventFilter
	CYIEventFilter ()
	CYIEventFilter (const CYIEventFilter &other)
virtual	~CYIEventFilter ()
CYIEventFilter &	operator= (const CYIEventFilter &other)
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

Public Attributes
CYISignal	UserActivated
CYISignal	UserDeactivated

Static Public Attributes
static const CYIString	DEV_PANEL_ASSETS_PREFIX

Member Enumeration Documentation

enum CYIDevPanel::INSERT_POSITION

Enumerator
TOP	Insert at the top of the widgets list.
BOTTOM	Insert at the bottom of the widgets list.

Constructor & Destructor Documentation

CYIDevPanel::CYIDevPanel	(	CYISceneManager *	pSceneManager,
		CYIApp *	pApp
	)

CYIDevPanel::~CYIDevPanel

(

)

Member Function Documentation

void CYIDevPanel::AddWidget	(	std::unique_ptr< CYIDevWidget >	pWidget,
		INSERT_POSITION	eInsertPosition = TOP
	)

Adds dev widget pWidget to the dev panel. The insert position can be controlled using the eInsertPosition parameter. A value of CYIDevPanel::TOP will insert the widget at the top of the widgets list, and a value of CYIDevPanel::BOTTOM will insert the widget at the end of the widgets list.

Note

It is typically safe to retain a pointer to the widget as the dev panel's life cycle is tied to the app.

void CYIDevPanel::Close

(

)

Closes the dev panel if it isn't closed already.

void CYIDevPanel::CloseConfigurationSubpanel

(

)

Closes the configuration subpanel, if it is open.

void CYIDevPanel::Draw

(

)

Draws the panel (if active) and any currently-active widgets. 

CYIApp* CYIDevPanel::GetApp

(

)

const

Returns a pointer to the app.

CYISceneManager* CYIDevPanel::GetSceneManager

(

)

const

Returns a pointer to the scene manager.

Note

This is the scene manager used by the app, and calling this function is equivalent to calling

GetApp()->GetSceneManager() 

template<class T >

T* CYIDevPanel::GetWidget

(

)

const

Finds and returns the first widget that matches type T.

Note

This function runs in O(n) time.

std::vector<CYIDevWidget *> CYIDevPanel::GetWidgets

(

)

const

CYISceneView* CYIDevPanel::GetWidgetsContainer

(

)

const

Returns a pointer to the widgets container. This is the view containing the widgets' content.

bool CYIDevPanel::HandleActionInputs	(	int32_t	nX,
		int32_t	nY,
		int32_t	nWheelDelta,
		uint8_t	uButton,
		YI_EVENT_TYPE	eEventType,
		uint8_t	uPointerID,
		bool	bHover
	)

bool CYIDevPanel::HandleKeyInputs

(

const CYIKeyEvent &

keyEvent

)

bool CYIDevPanel::IsActive

(

)

const

Returns true if the dev panel is currently active (e.g. if the user has triggered the activation method.)

Note

This function returns true if the dev panel is currently animating in, and returns false if the dev panel is currently animating out.

bool CYIDevPanel::IsConfigurationSubpanelOpen

(

)

const

Returns true if the dev panel is active and if a configuration subpanel is currently open.

bool CYIDevPanel::IsVisible

(

)

const

Returns true if the dev panel is currently visible. This differs from IsActive() in that it also returns true if the dev panel is animating in or out.

void CYIDevPanel::Open

(

)

Opens the dev panel if it isn't open already.

void CYIDevPanel::OpenConfigurationSubpanel	(	CYIDevWidget *	pWidget,
		const std::vector< std::pair< CYIString, CYIString > > &	items
	)

Opens the configuration subpanel for widget pWidget, and configures it with configuration items items.

Note

This is typically called from the base dev widget class only. The default implementation of the CYIDevWidget::OnConfigureButtonClicked calls this function to trigger the opening of the default configuration subpanel. Custom widgets may, however, wish to display a custom configuration panel and thus would not be calling this function.

void CYIDevPanel::ReconfigureConfigurationSubpanel

(

CYIDevWidget *

pWidget

)

Reconfigures the configuration subpanel for pWidget.

Note

This is typically called by dev widgets when the user has selected a configuration option and the configuration subpanel's state has to be updated. For example, the items in the configuration subpanel may need to have their title updated after the user has made a selection.

void CYIDevPanel::SimulateConfigurationItemClicked	(	uint32_t	uWidgetIndex,
		uint32_t	uItemIndex
	)

Simulates clicking a widget's configuration item.

See also

CYIDevWidget

void CYIDevPanel::SimulatePanelItemClicked

(

uint32_t

uIndex

)

Simulates clicking a dev panel item.

Note

This is typically called from the base dev widget class only. For example, a dev widget could call this function to 'activate' itself when the user selects a configuration option while the dev widget is inactive.

void CYIDevPanel::ToggleVisibility

(

)

Toggles the visibility of the dev panel.

bool CYIDevPanel::Update

(

bool *

pbSkipUpdate = nullptr

)

Updates the internal state of the panel and the widgets. Returns true if a render is required. If pbSkipUpdate is non-null, widgets can set it to true to indicate that the app update should be skipped.

void CYIDevPanel::UpdateWidget

(

uint32_t

uIndexInPanel

)

Update the title, the subtitle, and the on/off indicator of the widget located at uIndexInPanel on the panel.

Member Data Documentation

const CYIString CYIDevPanel::DEV_PANEL_ASSETS_PREFIX

static

A prefix added on dev panel-specific assets. This is used to exclude these assets from dev widgets. The prefix is also used as prefix on the name of scene nodes created by dev widgets.

CYISignal CYIDevPanel::UserActivated

A signal called when the User Signal widget is activated. If nothing is connected to this signal, the User Signal widget will be disabled in the dev panel.

See also

CYISignalWidget

CYISignal CYIDevPanel::UserDeactivated

A signal called when the User Signal widget is deactivated. If nothing is connected to this signal, the CYIDevPanel::UserActivated signal is called instead.

Note

The User Signal widget is disabled in the dev panel if there is no connection made to the CYIDevPanel::UserActivated signal, even if a connection is made to the CYIDevPanel::UserDeactivated signal.

See also

CYIDevPanel::UserActivated

CYISignalWidget

---

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

• debug/YiDevPanel.h