MHEG5  18.9.0
MHEG5 Documentation
Classes | Typedefs | Functions
mh5dynamiclineart.h 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 "mh5lineart.h"

Go to the source code of this file.

Classes

struct  MHEG5DynamicLineart
 

Typedefs

typedef struct sMHEG5DrawAction * pMHEG5DrawAction
 

Functions

void MHEG5dynamicLineartInit (MHEG5DynamicLineart *dla)
 <Function description>=""> More...
 
void MHEG5dynamicLineartFree (MHEG5DynamicLineart *dla)
 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. More...
 
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. More...
 
void MHEG5dynamicLineartActivate (MHEG5DynamicLineart *dynamicLineart)
 Apply the activation behaviour of the dynamiclineart class. More...
 
void MHEG5dynamicLineartDeactivate (MHEG5DynamicLineart *dynamicLineart)
 Apply the deactivation behaviour of the dynamiclineart class. More...
 
void MHEG5dynamicLineartDestruct (MHEG5DynamicLineart *dynamicLineart)
 Destruct a dynamiclineart object. More...
 
MHEG5ErrorCode MHEG5getLineWidth (MHEG5Root *target, MHEG5GList *params)
 Retrieve the current Line Width of the DynamicLineart object Implementation of the GetLineWidth action of the dynamiclineart class. More...
 
MHEG5ErrorCode MHEG5getLineStyle (MHEG5Root *target, MHEG5GList *params)
 Retrieve the current Line Style of the DynamicLineArt object Implementation of the GetLineStyle action of the dynamiclineart class. More...
 
MHEG5ErrorCode MHEG5getLineColour (MHEG5Root *target, MHEG5GList *params)
 Retrieve the current LineColour of the DynamicLineart Object Implementation of the GetLineColour action of the dynamiclineart class. More...
 
MHEG5ErrorCode MHEG5getFillColour (MHEG5Root *target, MHEG5GList *params)
 Retrieve the current FillColour of the Dynamic Lineart object. Implementation of the GetFillColour action of the dynamiclineart class. More...
 
MHEG5ErrorCode MHEG5drawArc (MHEG5Root *target, MHEG5GList *params)
 Draws an arc between "StartAngle" and "StartAngle" + "ArcAngle". Implementation of the DrawArc action of the dynamiclineart class. More...
 
MHEG5ErrorCode MHEG5drawSector (MHEG5Root *target, MHEG5GList *params)
 Draws a sector between "StartAngle" and "StartAngle" + "ArcAngle". Implementation of the DrawSector action of the dynamiclineart class. More...
 
MHEG5ErrorCode MHEG5drawLine (MHEG5Root *target, MHEG5GList *params)
 Draws a line between ("X1", "Y1") and ("X2", "Y2"). Implementation of the DrawLine action of the dynamiclineart class. More...
 
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. More...
 
MHEG5ErrorCode MHEG5drawPolygon (MHEG5Root *target, MHEG5GList *params)
 Draw a closed polygon. Implementation of the DrawPolygon action of the dynamiclineart class. More...
 
MHEG5ErrorCode MHEG5drawPolyline (MHEG5Root *target, MHEG5GList *params)
 Draws series of joint lines. Implementation of the DrawPolyline action of the dynamiclineart class. More...
 
MHEG5ErrorCode MHEG5drawRectangle (MHEG5Root *target, MHEG5GList *params)
 Draws a rectangle. Implementation of the DrawRectangle action of the dynamiclineart class. More...
 
MHEG5ErrorCode MHEG5clear (MHEG5Root *target, MHEG5GList *params)
 Fills up the bounding box with the OriginalRefFillColour. Implementation of the Clear action of the dynamiclineart class. More...
 
void MHEG5freeDynamicLineart (MHEG5DynamicLineart *dynamicLineart)
 Create the canvas for a dynamic lineart object. More...
 
void MHEG5initDynamicLineart (MHEG5DynamicLineart *dynamicLineart)
 Create the canvas for a dynamic lineart object. More...
 

Detailed Description

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

Date
05/02/2002
Author
R.Freeman

Definition in file mh5dynamiclineart.h.

Typedef Documentation

typedef struct sMHEG5DrawAction* pMHEG5DrawAction

Definition at line 41 of file mh5dynamiclineart.h.

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

Definition at line 966 of file mh5dynamiclineart.c.

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

Definition at line 790 of file mh5dynamiclineart.c.

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

Definition at line 837 of file mh5dynamiclineart.c.

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

Definition at line 862 of file mh5dynamiclineart.c.

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

Definition at line 888 of file mh5dynamiclineart.c.

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

Definition at line 914 of file mh5dynamiclineart.c.

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

Definition at line 940 of file mh5dynamiclineart.c.

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

Definition at line 814 of file mh5dynamiclineart.c.

void MHEG5dynamicLineartActivate ( MHEG5DynamicLineart *  dynamicLineart)

Apply the activation behaviour of the dynamiclineart class.

Parameters
MHEG5DynamicLineart*dynamiclineart
Returns
void

Definition at line 496 of file mh5dynamiclineart.c.

void MHEG5dynamicLineartDeactivate ( MHEG5DynamicLineart *  dynamicLineart)

Apply the deactivation behaviour of the dynamiclineart class.

Parameters
MHEG5DynamicLineart*dynamiclineart
Returns
void

Definition at line 519 of file mh5dynamiclineart.c.

void MHEG5dynamicLineartDestruct ( MHEG5DynamicLineart *  dynamicLineart)

Destruct a dynamiclineart object.

Parameters
MHEG5DynamicLineart*dynamiclineart
Returns
void

Definition at line 534 of file mh5dynamiclineart.c.

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
dlaPointer to object to free.
Returns
Void
Parameters
dynamicLineartPointer to object to free.
Returns
Void

Definition at line 408 of file mh5dynamiclineart.c.

void MHEG5dynamicLineartInit ( MHEG5DynamicLineart *  dynamicLineart)

<Function description>="">

Returns
<Return value>=""> Initialise a dynamicLineart object with default values.
Parameters
dlaPointer to object to initialise.
Returns
Void

<Function description>="">

Parameters
dynamicLineartPointer to object to initialise.
Returns
Void

Definition at line 394 of file mh5dynamiclineart.c.

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

Definition at line 484 of file mh5dynamiclineart.c.

void MHEG5freeDynamicLineart ( MHEG5DynamicLineart *  dynamicLineart)

Create the canvas for a dynamic lineart object.

Parameters
MHEG5Visible*lineart
Returns
void

Definition at line 465 of file mh5dynamiclineart.c.

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

Definition at line 723 of file mh5dynamiclineart.c.

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

Definition at line 656 of file mh5dynamiclineart.c.

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

Definition at line 607 of file mh5dynamiclineart.c.

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

Definition at line 558 of file mh5dynamiclineart.c.

void MHEG5initDynamicLineart ( MHEG5DynamicLineart *  dynamicLineart)

Create the canvas for a dynamic lineart object.

Parameters
MHEG5Visible*lineart
Returns
void

Definition at line 421 of file mh5dynamiclineart.c.

Generated by   doxygen 1.8.11