mh5lineart.c

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
 *******************************************************************************/
/*---includes for this file--------------------------------------------------*/
#include "mh5lineart.h"
#include "mh5object.h"          /* for actions                  */
#include "mh5variable.h"        /* for actions                  */
#include "mh5display.h"         /* for actions                  */
#include "mh5memory.h"          /* for constructor/destructor   */
#include "mh5debug.h"
#include "tmcolor.h"

#ifdef MH5PRINTOUT
#include <string.h>
#endif  /* #ifdef MH5PRINTOUT */

/*---constant definitions for this file--------------------------------------*/


/*---local typedef structs for this file-------------------------------------*/

/*---local (static) variable declarations for this file----------------------*/

/*---local function definitions----------------------------------------------*/

/*---global function definitions---------------------------------------------*/

/*
   Debug
 */
#ifdef MH5PRINTOUT

void MHEG5lineartPrint(MHEG5Lineart *lineart, char *out)
{
   MHEG5visiblePrint(&lineart->visible, out);
   if (((MHEG5Root *)lineart)->clazz != MHEG5RECTANGLE)
   {
      if (!lineart->borderedBoundingBox)
      {
         MHEG5indent(out);
         MHEG_PRINT(out, ":BBBox false");
         MHEG5newLine(out);
      }
   }
   if (lineart->originalLineWidth != 1)
   {
      MHEG5indent(out);
      MHEG_PRINT(out, ":OrigLineWidth ");
      MHEG5intPrint(lineart->originalLineWidth, out);
      MHEG5newLine(out);
   }
   if (lineart->originalLineStyle != 1)
   {
      MHEG5indent(out);
      MHEG_PRINT(out, ":OrigLineStyle ");
      MHEG5intPrint(lineart->originalLineStyle, out);
      MHEG5newLine(out);
   }
   if (lineart->originalRefLineColour.value.i != OSDgetColour(BLACKCOLOR))
   {
      MHEG5indent(out);
      MHEG_PRINT(out, ":OrigRefLineColour ");
      MHEG5colourPrint(lineart->originalRefLineColour, out);
      MHEG5newLine(out);
   }
   if (lineart->originalRefFillColour.value.i != OSDgetColour(TRANSPARENTCOLOR))
   {
      MHEG5indent(out);
      MHEG_PRINT(out, ":OrigRefFillColour ");
      MHEG5colourPrint(lineart->originalRefFillColour, out);
      MHEG5newLine(out);
   }
   /* Internal Attributes
      if (lineart->lineWidth) {
      MHEG5indent(out);
      MHEG_PRINT(out,"//:LineWidth ");
      MHEG5intPrint(lineart->lineWidth,out);
      MHEG5newLine(out);
      }
      if (lineart->lineStyle) {
      MHEG5indent(out);
      MHEG_PRINT(out,"//:LineStyle ");
      MHEG5intPrint(lineart->lineStyle,out);
      MHEG5newLine(out);
      }
      if (!lineart->refLineColour.indirect) {
      MHEG5indent(out);
      MHEG_PRINT(out,"//:RefLineColour ");
      MHEG5colourPrint(lineart->refLineColour,out);
      MHEG5newLine(out);
      }
      if (!lineart->refFillColour.indirect) {
      MHEG5indent(out);
      MHEG_PRINT(out,"//:RefFillColour ");
      MHEG5colourPrint(lineart->refFillColour,out);
      MHEG5newLine(out);
      }
    */
}

#endif


static MHEG5Bool MHEG5lineartIs(MHEG5Root *target)
{
   if ((target->clazz == MHEG5LINEART) ||
       (target->clazz == MHEG5RECTANGLE) ||
       (target->clazz == MHEG5DYNAMICLINEART))
      return MHEG5TRUE;
   return MHEG5FALSE;
}

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

   MHEG5visibleClone(&destination->visible, &source->visible);

   destination->borderedBoundingBox = source->borderedBoundingBox;
   destination->originalLineWidth = source->originalLineWidth;
   destination->originalLineStyle = source->originalLineStyle;
   MHEG5genericCopy(&destination->originalRefLineColour, &source->originalRefLineColour);
   MHEG5genericCopy(&destination->originalRefFillColour, &source->originalRefFillColour);
}

/*
     Constructor
 */

void MHEG5lineartInit(MHEG5Lineart *lineart)
{
   assert(lineart);

   MHEG5visibleInit(&lineart->visible);

   lineart->borderedBoundingBox = MHEG5TRUE;
   lineart->originalLineWidth = 1;
   lineart->originalLineStyle = 1;
   MHEG5colourInit(&lineart->originalRefLineColour, OSDgetColour(BLACKCOLOR));
   MHEG5colourInit(&lineart->originalRefFillColour, OSDgetColour(TRANSPARENTCOLOR));
}

void MHEG5lineartFree(MHEG5Lineart *lineart)
{
   assert(lineart);

   MHEG5visibleFree(&lineart->visible);

   MHEG5colourDestruct(&lineart->originalRefLineColour);
   MHEG5colourDestruct(&lineart->originalRefFillColour);
}

/*
     Internal behaviours
 */
/*
     33.3 Internal behaviours
     this class has the same behaviours as its base class, with identical semantics.
 */
void MHEG5lineartPrepare(MHEG5Lineart *lineart)
{
   assert(lineart);

   lineart->lineWidth = lineart->originalLineWidth;
   lineart->lineStyle = lineart->originalLineStyle;
   MHEG5genericCopy(&lineart->refLineColour, &lineart->originalRefLineColour);
   MHEG5genericCopy(&lineart->refFillColour, &lineart->originalRefFillColour);

   MHEG5visiblePrepare(&lineart->visible);
}

void MHEG5lineartActivate(MHEG5Lineart *lineart)
{
   assert(lineart);

   if (!lineart->visible.ingredient.root.availabilityStatus)
   {
      MHEG5lineartPrepare( lineart );
   }
   MHEG5visibleActivate(&lineart->visible);
}

void MHEG5lineartDeactivate(MHEG5Lineart *lineart)
{
   assert(lineart);

   MHEG5visibleDeactivate(&lineart->visible);
}

void MHEG5lineartDestruct(MHEG5Lineart *lineart)
{
   assert(lineart);

   MHEG5visibleDestruct(&lineart->visible);

   MHEG5colourDestruct(&lineart->refLineColour);
   MHEG5colourDestruct(&lineart->refFillColour);
}

/*
     Actions
 */
/*
     SetLineWidth (NewLineWidth)
     Change the width of lines of a LineArt object.
     Execute the following sequence of actions:
     1. Set the value of the LineWidth attribute to NewLineWidth.
     2. If the target LineArt object is active, redraw immediately the target object by
        taking into account the new value of the LineWidth attribute and according to its
        position in the DisplayStack of the active Application object.

     Provisions of use:
     The Target object shall be an available LineArt object.
     NewLineWidth shall be set or refer to a positive integer value.
 */
MHEG5ErrorCode MHEG5setLineWidth(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5Int i = -1;

   assert(target);

   if (!MHEG5lineartIs(target))
   {
      return MHEG5ERR_WRONGTARGET;
   }

   if (!params)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }
   MHEG5resolveGenericInteger(params, &i);

   if ((i >= 0))
   {
      ((MHEG5Lineart *) target)->lineWidth = i;
      MHEG5displayRedraw((MHEG5Visible *) target);
   }

   return MHEG5ERR_NOERROR;
}

/*
     SetLineStyle (NewLineStyle)
     Change the line style of a LineArt object.
     Execute the following sequence of actions:
     1. Set the value of the LineStyle attribute to NewLineStyle.
     2. If the target LineArt object is active, redraw immediately the target object by
        taking into account the new value of the LineStyle attribute and according to its
        position in the DisplayStack of the active Application object.

     Provisions of use:
     The Target object shall be an available LineArt object.
     NewLineStyle shall be set or refer to a positive integer value: 1, 2 or 3.
 */
MHEG5ErrorCode MHEG5setLineStyle(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5Int i = 0;

   assert(target);

   if (!MHEG5lineartIs(target))
   {
      return MHEG5ERR_WRONGTARGET;
   }

   if (!params)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }
   MHEG5resolveGenericInteger(params, &i);

   if ((i > 0) && (i < 4))
   {
      ((MHEG5Lineart *) target)->lineStyle = i;

      MHEG5displayRedraw((MHEG5Visible *) target);
   }
   return MHEG5ERR_NOERROR;
}

/*
     SetLineColour (NewColour)
     Change the colour of lines of a LineArt object.
     Execute the following sequence of actions:
     1. Set the value of the RefLineColour attribute to NewColour.
     2. If the target object is active, redraw immediately the target object by taking into
        account the new value of the LineWidth attribute and according to its position in
        the DisplayStack of the active Application object.
    NewColour may be either an absolute colour value or the zero-based index of a
    colour in the look-up table referenced by the PaletteRef attribute.

     Provisions of use:
     The Target object shall be an available LineArt object.
     If RefLineColour is currently set to an absolute colour value, NewColour shall be
     set or refer to an absolute colour value.
     If RefLineColour is currently set to an index of a colour look-up table, NewColour
     shall be set or refer to an index of a colour look-up table.
 */
MHEG5ErrorCode MHEG5setLineColour(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5Generic g;

   assert(target);

   if (!MHEG5lineartIs(target))
   {
      return MHEG5ERR_WRONGTARGET;
   }

   if (!params)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }
   MHEG5resolveGenericGeneric(params, &g);

   if (!((g.type == MHEG5INT) || (g.type == MHEG5OCTETSTRING)))
   {
      return MHEG5ERR_WRONGPARAM;
   }

   MHEG5genericDestruct(&((MHEG5Lineart *) target)->refLineColour);
   MHEG5genericCopy(&((MHEG5Lineart *) target)->refLineColour, &g);

   MHEG5displayRedraw((MHEG5Visible *) target);

   return MHEG5ERR_NOERROR;
}

/*
     SetFillColour (NewColour)
     Change the fill-in colour of a LineArt object.
     Execute the following sequence of actions:
     1. Set the value of the RefFillColour attribute to NewColour.
     2. If the target object is active, redraw immediately the target object by taking into
        account the new value of the RefFillColour attribute and according to its position
        in the DisplayStack of the active Application object.
     NewColour may be either an absolute colour value or the zero-based index of a
     colour in the look-up table referenced by the PaletteRef attribute.
     If NewColour is not encoded, the RefFillColour attribute shall be set to
     «transparent».

     Provisions of use:
     The Target object shall be an available LineArt object.
     If RefFillColour is not currently set, NewColour shall be set or refer to an absolute
     colour value.
     If RefFillColour is currently set to an absolute colour value, NewColour shall be
     set or refer to an absolute colour value.
     If RefFillColour is currently set to an index of a colour look-up table, NewColour
     shall be set or refer to an index of a colour look-up table.
 */
MHEG5ErrorCode MHEG5setFillColour(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5Generic g;

   assert(target);

   if (!MHEG5lineartIs(target))
   {
      return MHEG5ERR_WRONGTARGET;
   }

   if (params)
   {
      MHEG5resolveGenericGeneric(params, &g);
   }
   else
   {
      MHEG5genericSet(&g, RGBT(0, 0, 0, 0xff));
   }

   if (!((g.type == MHEG5INT) || (g.type == MHEG5OCTETSTRING)))
   {
      return MHEG5ERR_WRONGPARAM;
   }

   MHEG5genericDestruct(&((MHEG5Lineart *) target)->refFillColour);
   MHEG5genericCopy(&((MHEG5Lineart *) target)->refFillColour, &g);

   MHEG5displayRedraw((MHEG5Visible *) target);

   return MHEG5ERR_NOERROR;
}