YiFocus.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_FOCUS_H_
#define _YI_FOCUS_H_

#include "utility/YiFocusSearchOptions.h"

class CYIAABB;
class CYISceneNode;
class CYISceneView;

class CYIFocus
{
public:
    enum FOCUS_DIRECTION
    {
        FOCUS_UP, 
        FOCUS_DOWN, 
        FOCUS_RIGHT, 
        FOCUS_LEFT, 
        FOCUS_FORWARD, 
        FOCUS_REVERSE, 
        FOCUS_MAX 
    };

    enum FOCUS_ROOT_RULE
    {
        FOCUS_ROOT_DESCENDANTS, 
        FOCUS_ROOT_DESCENDANTS_UPDATE_CONTEXT, 
        FOCUS_ROOT_ANY 
    };

    static CYISceneView *FindNextFocus(const CYISceneNode *pSearchRoot, const CYIAABB &previousFocusRect, FOCUS_DIRECTION eDirection, const CYIFocusSearchOptions &options = CYIFocusSearchOptions());

    static CYISceneView *FindInitialFocus(const CYISceneNode *pSearchRoot, const CYIFocusSearchOptions &options = CYIFocusSearchOptions());

    static CYISceneView *FindNextFocusInRegion(const CYISceneNode *pSearchRoot, const CYIAABB &previousFocusRect, FOCUS_DIRECTION eDirection, const CYIAABB &searchRegion, const CYIFocusSearchOptions &options = CYIFocusSearchOptions());

    static CYIAABB GetScreenSpaceFocusRegion(const CYISceneView *pView);

    static bool IsRelativeDirection(FOCUS_DIRECTION eDirection);

    static bool IsAbsoluteDirection(FOCUS_DIRECTION eDirection);

private:
    CYIFocus();
};

#endif // _YI_FOCUS_H_