source/classes/inc/mh5scene.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 * Copyright © 2000 Koninklijke Philips Electronics N.V
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 *
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 *
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
#ifndef _MH5SCENE_H_
#define _MH5SCENE_H_

/*---includes for this file--------------------------------------------------*/
#include "mh5group.h"

/*---Constant and macro definitions for public use---------------------------*/

/*---Enumerations for public use---------------------------------------------*/

/*---Global type defs for public use-----------------------------------------*/
typedef struct
{
   /* Base class */
   MHEG5Group group;

   /* Exchanged attributes */
   MHEG5Int inputEventRegister;
   MHEG5Int sceneCoordinateSystem[2];
   MHEG5SceneRatio_t aspectRatio;
   MHEG5Bool movingCursor;
   ParamList nextScenes;
   MHEG5String inputMask;
   /* Engine data */
   MHEG5Root *currentInteractible;
} MHEG5Scene;

/*---Global variable declarations for public use-----------------------------*/

/*---Global Function prototypes for public use-------------------------------*/

#ifdef MH5PRINTOUT

void MHEG5scenePrint(MHEG5Scene *scene, char *out);

#endif /* MH5PRINTOUT */

/*
    grant access to curent Scene
 */
MHEG5Scene* MHEG5getCurrentScene(void);

void MHEG5sceneInit(MHEG5Scene *scene);


void MHEG5sceneFree(MHEG5Scene *scene);

/*
     Internal behaviours
 */
void MHEG5scenePrepare(MHEG5Scene *scene);
void MHEG5sceneDestruct(MHEG5Scene *scene);
void MHEG5sceneActivate(MHEG5Scene *scene);
void MHEG5sceneDeactivate(MHEG5Scene *scene);

/*
    Actions
 */
MHEG5ErrorCode MHEG5transitionTo(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5sendEventAction(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5setCursorShape(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5setCursorPosition(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5getCursorPosition(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5setInputRegister(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5setInputMask(MHEG5Root *target, MHEG5GList *params);


#endif /*_MH5SCENE_H_*/