mh5lineart.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 _MH5LINEART_H
#define _MH5LINEART_H

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

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

#define MHEG_LINE_STYLE_SOLID       (1)
#define MHEG_LINE_STYLE_DASHED      (2)
#define MHEG_LINE_STYLE_DOTTED      (3)

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

/*---Global type defs for public use-----------------------------------------*/
/* LineArt, Rectangle, DynamicLineArt
 */
typedef struct
{
   /* Base class */
   MHEG5Visible visible;

   /* Exchanged attributes */
   MHEG5Bool borderedBoundingBox;
   MHEG5Int originalLineWidth;
   MHEG5Int originalLineStyle;
   MHEG5Colour originalRefLineColour;
   MHEG5Colour originalRefFillColour;

   /* Internal attributes */
   MHEG5Int lineWidth;
   MHEG5Int lineStyle;
   MHEG5Colour refLineColour;
   MHEG5Colour refFillColour;
} MHEG5Lineart;

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

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

/*
     Lineart Clone
 */
void MHEG5lineartClone(MHEG5Lineart *destination, MHEG5Lineart *source);


void MHEG5lineartInit(MHEG5Lineart *lineart);


void MHEG5lineartFree(MHEG5Lineart *lineart);

/*
    Internal behaviours
 */
void MHEG5lineartPrepare(MHEG5Lineart *lineart);
void MHEG5lineartActivate(MHEG5Lineart *lineart);
void MHEG5lineartDeactivate(MHEG5Lineart *lineart);
void MHEG5lineartDestruct(MHEG5Lineart *lineart);

/*
    Actions
 */
MHEG5ErrorCode MHEG5setLineWidth(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5setLineStyle(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5setLineColour(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5setFillColour(MHEG5Root *target, MHEG5GList *params);

/*
   Debug
 */
#ifdef MH5PRINTOUT

void MHEG5lineartPrint(MHEG5Lineart *lineart, char *out);
#endif

#endif /*_MH5LINEART_H*/