interface/overlay/POIOverlay.h
changeset 0 c316ab048e9d
equal deleted inserted replaced
-1:000000000000 0:c316ab048e9d
       
     1 /*
       
     2  * Name        : POIOverlay.h
       
     3  * Description : ECOM interface definition
       
     4  * Project     : This file is part of OpenMAR, an Open Mobile Augmented Reality browser
       
     5  * Website     : http://OpenMAR.org
       
     6  *
       
     7  * Copyright (c) 2010 David Caabeiro
       
     8  *
       
     9  * All rights reserved. This program and the accompanying materials are made available 
       
    10  * under the terms of the Eclipse Public License v1.0 which accompanies this 
       
    11  * distribution, and is available at http://www.eclipse.org/legal/epl-v10.html
       
    12  *
       
    13  */
       
    14 
       
    15 #ifndef POIOVERLAY_H_
       
    16 #define POIOVERLAY_H_
       
    17 
       
    18 #include "InterfaceUid.hrh"
       
    19 
       
    20 #include <ecom/ecom.h>
       
    21 
       
    22 class RWindow;
       
    23 class TRect;
       
    24 class CFbsBitmap;
       
    25 
       
    26 namespace OpenMAR {
       
    27 
       
    28 /**
       
    29  * @brief POI overlay interface definition
       
    30  * 
       
    31  * The overlay is in charge of getting input from sensors for position and orientation
       
    32  * estimation, and retrieving proper POIs from providers.
       
    33  *
       
    34  */
       
    35 class CPOIOverlay : public CBase
       
    36 {
       
    37 public:
       
    38     struct SParameter {
       
    39         RWindow& iWindow;
       
    40         const TRect& iRect;
       
    41     };
       
    42 
       
    43 public:
       
    44     static CPOIOverlay* NewL(const TDesC8& aMatch, SParameter& aParam);
       
    45     static CPOIOverlay* NewL(const TUid aImplementationUid, SParameter& aParam);
       
    46     ~CPOIOverlay();
       
    47 
       
    48     virtual void StartL() = 0;
       
    49     virtual void Stop() = 0;
       
    50     virtual const CFbsBitmap& RenderScene() = 0;
       
    51 
       
    52     virtual TInt GetFocusedPOI() = 0;
       
    53 
       
    54 private:
       
    55     TUid iDtor_ID_Key;
       
    56 };
       
    57 
       
    58 #include "POIOverlay.inl"
       
    59 
       
    60 }
       
    61 
       
    62 #endif  // POIOVERLAY_H_