MHEG5  15.3.0
Data Structures | Typedefs | Functions
source/classes/src/mh5dynamiclineart.c File Reference

Implement the MHEG5 Dynamiclineart Class Defines means to dynamically draw vectorial graphical objects Base class: LineArt Subclasses: None Status: Concrete Class. More...

#include "mh5debug.h"
#include "mh5dynamiclineart.h"
#include "mh5object.h"
#include "mh5variable.h"
#include "mh5display.h"
#include "mh5memory.h"
#include "mh5action.h"
#include "tmcolor.h"
#include "mg_dla.h"

Data Structures

struct  sMHEG5DrawAction

Typedefs

typedef struct sMHEG5DrawAction MHEG5DrawAction

Functions

void MHEG5dynamicLineartInit (MHEG5DynamicLineart *dynamicLineart)
 Initialise a dynamicLineart object with default values.
void MHEG5dynamicLineartFree (MHEG5DynamicLineart *dynamicLineart)
 Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.
void MHEG5initDynamicLineart (MHEG5DynamicLineart *dynamicLineart)
 Create the canvas for a dynamic lineart object.
void MHEG5freeDynamicLineart (MHEG5DynamicLineart *dynamicLineart)
 Create the canvas for a dynamic lineart object.
void MHEG5dynamicLineartPrepare (MHEG5DynamicLineart *dynamicLineart)
 Apply the preparation behaviour of the dynamiclineart class Apply the preparation behaviour of the dynamiclineart class. As this class has no own preparation behaviour this function just invokes the preparation behaviour from the base class.
void MHEG5dynamicLineartActivate (MHEG5DynamicLineart *dynamicLineart)
 Apply the activation behaviour of the dynamiclineart class.
void MHEG5dynamicLineartDeactivate (MHEG5DynamicLineart *dynamicLineart)
 Apply the deactivation behaviour of the dynamiclineart class.
void MHEG5dynamicLineartDestruct (MHEG5DynamicLineart *dynamicLineart)
 Destruct a dynamiclineart object.
MHEG5ErrorCode MHEG5getLineWidth (MHEG5Root *target, MHEG5GList *params)
 Retrieve the current Line Width of the DynamicLineart object Implementation of the GetLineWidth action of the dynamiclineart class.
MHEG5ErrorCode MHEG5getLineStyle (MHEG5Root *target, MHEG5GList *params)
 Retrieve the current Line Style of the DynamicLineArt object Implementation of the GetLineStyle action of the dynamiclineart class.
MHEG5ErrorCode MHEG5getLineColour (MHEG5Root *target, MHEG5GList *params)
 Retrieve the current LineColour of the DynamicLineart Object Implementation of the GetLineColour action of the dynamiclineart class.
MHEG5ErrorCode MHEG5getFillColour (MHEG5Root *target, MHEG5GList *params)
 Retrieve the current FillColour of the Dynamic Lineart object. Implementation of the GetFillColour action of the dynamiclineart class.
MHEG5ErrorCode MHEG5drawArc (MHEG5Root *target, MHEG5GList *params)
 Draws an arc between "StartAngle" and "StartAngle" + "ArcAngle". Implementation of the DrawArc action of the dynamiclineart class.
MHEG5ErrorCode MHEG5drawSector (MHEG5Root *target, MHEG5GList *params)
 Draws a sector between "StartAngle" and "StartAngle" + "ArcAngle". Implementation of the DrawSector action of the dynamiclineart class.
MHEG5ErrorCode MHEG5drawLine (MHEG5Root *target, MHEG5GList *params)
 Draws a line between ("X1", "Y1") and ("X2", "Y2"). Implementation of the DrawLine action of the dynamiclineart class.
MHEG5ErrorCode MHEG5drawOval (MHEG5Root *target, MHEG5GList *params)
 Draws an ellipse bounded by the rectangle defined by the parameters. Implementation of the DrawOval action of the dynamiclineart class.
MHEG5ErrorCode MHEG5drawPolygon (MHEG5Root *target, MHEG5GList *params)
 Draw a closed polygon. Implementation of the DrawPolygon action of the dynamiclineart class.
MHEG5ErrorCode MHEG5drawPolyline (MHEG5Root *target, MHEG5GList *params)
 Draws series of joint lines. Implementation of the DrawPolyline action of the dynamiclineart class.
MHEG5ErrorCode MHEG5drawRectangle (MHEG5Root *target, MHEG5GList *params)
 Draws a rectangle. Implementation of the DrawRectangle action of the dynamiclineart class.
MHEG5ErrorCode MHEG5clear (MHEG5Root *target, MHEG5GList *params)
 Fills up the bounding box with the OriginalRefFillColour. Implementation of the Clear action of the dynamiclineart class.

Detailed Description

Implement the MHEG5 Dynamiclineart Class Defines means to dynamically draw vectorial graphical objects Base class: LineArt Subclasses: None Status: Concrete Class.

Date:
06/03/2002
Author:
iwillis

Function Documentation

MHEG5ErrorCode MHEG5clear ( MHEG5Root *  target,
MHEG5GList *  params 
)

Fills up the bounding box with the OriginalRefFillColour. Implementation of the Clear action of the dynamiclineart class.

Parameters:
MHEG5Root*target
MHEG5GList*params
Returns:
MHEG5ErrorCode MHEG5ErrorCode
MHEG5ErrorCode MHEG5drawArc ( MHEG5Root *  target,
MHEG5GList *  params 
)

Draws an arc between "StartAngle" and "StartAngle" + "ArcAngle". Implementation of the DrawArc action of the dynamiclineart class.

Parameters:
MHEG5Root*target
MHEG5GList*params
Returns:
MHEG5ErrorCode MHEG5ErrorCode
MHEG5ErrorCode MHEG5drawLine ( MHEG5Root *  target,
MHEG5GList *  params 
)

Draws a line between ("X1", "Y1") and ("X2", "Y2"). Implementation of the DrawLine action of the dynamiclineart class.

Parameters:
MHEG5Root*target
MHEG5GList*params
Returns:
MHEG5ErrorCode MHEG5ErrorCode
MHEG5ErrorCode MHEG5drawOval ( MHEG5Root *  target,
MHEG5GList *  params 
)

Draws an ellipse bounded by the rectangle defined by the parameters. Implementation of the DrawOval action of the dynamiclineart class.

Parameters:
MHEG5Root*target
MHEG5GList*params
Returns:
MHEG5ErrorCode MHEG5ErrorCode
MHEG5ErrorCode MHEG5drawPolygon ( MHEG5Root *  target,
MHEG5GList *  params 
)

Draw a closed polygon. Implementation of the DrawPolygon action of the dynamiclineart class.

Parameters:
MHEG5Root*target
MHEG5GList*params
Returns:
MHEG5ErrorCode MHEG5ErrorCode
MHEG5ErrorCode MHEG5drawPolyline ( MHEG5Root *  target,
MHEG5GList *  params 
)

Draws series of joint lines. Implementation of the DrawPolyline action of the dynamiclineart class.

Parameters:
MHEG5Root*target
MHEG5GList*params
Returns:
MHEG5ErrorCode MHEG5ErrorCode
MHEG5ErrorCode MHEG5drawRectangle ( MHEG5Root *  target,
MHEG5GList *  params 
)

Draws a rectangle. Implementation of the DrawRectangle action of the dynamiclineart class.

Parameters:
MHEG5Root*target
MHEG5GList*params
Returns:
MHEG5ErrorCode MHEG5ErrorCode
MHEG5ErrorCode MHEG5drawSector ( MHEG5Root *  target,
MHEG5GList *  params 
)

Draws a sector between "StartAngle" and "StartAngle" + "ArcAngle". Implementation of the DrawSector action of the dynamiclineart class.

Parameters:
MHEG5Root*target
MHEG5GList*params
Returns:
MHEG5ErrorCode MHEG5ErrorCode
void MHEG5dynamicLineartActivate ( MHEG5DynamicLineart *  dynamicLineart)

Apply the activation behaviour of the dynamiclineart class.

Parameters:
MHEG5DynamicLineart*dynamiclineart
Returns:
void
void MHEG5dynamicLineartDeactivate ( MHEG5DynamicLineart *  dynamicLineart)

Apply the deactivation behaviour of the dynamiclineart class.

Parameters:
MHEG5DynamicLineart*dynamiclineart
Returns:
void
void MHEG5dynamicLineartDestruct ( MHEG5DynamicLineart *  dynamicLineart)

Destruct a dynamiclineart object.

Parameters:
MHEG5DynamicLineart*dynamiclineart
Returns:
void
void MHEG5dynamicLineartFree ( MHEG5DynamicLineart *  dynamicLineart)

Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.

Parameters:
dynamicLineartPointer to object to free.
Returns:
Void
void MHEG5dynamicLineartInit ( MHEG5DynamicLineart *  dynamicLineart)

Initialise a dynamicLineart object with default values.

<Function description>="">

Parameters:
dynamicLineartPointer to object to initialise.
Returns:
Void
void MHEG5dynamicLineartPrepare ( MHEG5DynamicLineart *  dynamicLineart)

Apply the preparation behaviour of the dynamiclineart class Apply the preparation behaviour of the dynamiclineart class. As this class has no own preparation behaviour this function just invokes the preparation behaviour from the base class.

Parameters:
MHEG5DynamicLineart*dynamiclineart
Returns:
void
void MHEG5freeDynamicLineart ( MHEG5DynamicLineart *  dynamicLineart)

Create the canvas for a dynamic lineart object.

Parameters:
MHEG5Visible*lineart
Returns:
void
MHEG5ErrorCode MHEG5getFillColour ( MHEG5Root *  target,
MHEG5GList *  params 
)

Retrieve the current FillColour of the Dynamic Lineart object. Implementation of the GetFillColour action of the dynamiclineart class.

Parameters:
MHEG5Root*target
MHEG5GList*params
Returns:
MHEG5ErrorCode MHEG5ErrorCode
MHEG5ErrorCode MHEG5getLineColour ( MHEG5Root *  target,
MHEG5GList *  params 
)

Retrieve the current LineColour of the DynamicLineart Object Implementation of the GetLineColour action of the dynamiclineart class.

Parameters:
MHEG5Root*target
MHEG5GList*params
Returns:
MHEG5ErrorCode MHEG5ErrorCode
MHEG5ErrorCode MHEG5getLineStyle ( MHEG5Root *  target,
MHEG5GList *  params 
)

Retrieve the current Line Style of the DynamicLineArt object Implementation of the GetLineStyle action of the dynamiclineart class.

Parameters:
MHEG5Root*target
MHEG5GList*params
Returns:
MHEG5ErrorCode MHEG5ErrorCode
MHEG5ErrorCode MHEG5getLineWidth ( MHEG5Root *  target,
MHEG5GList *  params 
)

Retrieve the current Line Width of the DynamicLineart object Implementation of the GetLineWidth action of the dynamiclineart class.

Parameters:
MHEG5Root*target
MHEG5GList*params
Returns:
MHEG5ErrorCode MHEG5ErrorCode
void MHEG5initDynamicLineart ( MHEG5DynamicLineart *  dynamicLineart)

Create the canvas for a dynamic lineart object.

Parameters:
MHEG5Visible*lineart
Returns:
void
 All Data Structures Files Functions Variables Typedefs Defines