Implementation of the Ingredient class. More...

#include <string.h>
#include "mh5ingredient.h"
#include "mh5object.h"
#include "mh5final.h"
#include "mh5display.h"
#include "mh5visible.h"
#include "mh5fileorm.h"
#include "mh5streamevent.h"
#include "mh5memory.h"
#include "mh5queue.h"
#include "mh5scene.h"
#include "mh5application.h"
#include "mh5variable.h"
#include "mh5hypertext.h"
#include "mh5listgroup.h"
#include "mh5stream.h"
#include "mh5video.h"
#include "mh5debug.h"
#include "mh5palette.h"
#include "mh5cursorshape.h"
#include "mh5font.h"
#include "mh5program.h"
#include "mh5audio.h"
#include "mh5rtgraphics.h"
#include "mh5slider.h"
#include "mh5dynamiclineart.h"
#include "mh5entryfield.h"
#include "mh5hotspot.h"
#include "mh5pushbutton.h"
#include "mh5switchbutton.h"
#include "mh5profile.h"
#include "mg_api.h"
#include "mg_fontapi.h"
#include "mh5drawtext.h"

Functions
	if (target->clazz==MHEG5BITMAP)
	MHEG5ingredientContentPrepare ((MHEG5Ingredient *) target)
MHEG5ErrorCode	MHEG5clone (MHEG5Root target, MHEG5GList params)
	Implementation of the Clone action Clone (CloneRefVar) If the engine supports the Cloning option the effect of this action is described below. Engines that do not support the Cloning option shall ignore this action. This action copies the Target adding the copy to the same group that contains the Target using a unique ObjectReference obtained from the engine. The ObjectReference referring to the copy is returned in the ObjectRefVariable referenced by CloneRefVar. Execute the following sequence of actions: 1. Determine a unique ObjectReference within the same group as the Target. 2. Create a copy of the Target, taking into account only the exchanged attributes and not the internal attributes. The ObjectIdentifier attribute inherited from the Root class is not copied, but set to the ObjectReference determined in step 1. 3. Add the copy to the group containing the Target object. 4. Set the ObjectRefVariable referenced by CloneRefVar to the ObjectReference determined in step 1. 5. Apply the Preparation behaviour to the copy. An object created using this action is deactivated/destroyed when the group that contains that object is deactivated/destroyed. The objects are deactivated/destroyed along with other static Ingredients in the reverse order of creation. A dynamically created Ingredient can also be destroyed using the Unload elementary action if its Content attribute is not Null. Provision of use: The Target object shall be an available Ingredient. CloneRefVar shall be an active ObjectRefVariable. Clone --> Target, CloneRefVar Target --> GenericObjectReference CloneRefVar --> ObjectReference.
MHEG5ErrorCode	MHEG5preload (MHEG5Root target, MHEG5GList params)
	Implementation of the Preload action Preload Prepares an Ingredient and provides a hint to the MHEG-5 engine to prepare the content data of an Ingredient for future use. Execute the following sequence of actions: 1. Apply the Preparation behaviour. 2. The MHEG-5 engine may optionally retrieve and/or decode the content data associated with the target Ingredient object. Provisions of use: The Target object shall be non-available Ingredient object. The Content attribute of the target Ingredient shall be different from Null. Preload --> Target Target --> GenericObjectReference.
MHEG5ErrorCode	MHEG5unload (MHEG5Root target, MHEG5GList params)
	Implementation of the Unload action Unload Destroys an Ingredient and provides a hint to the MHEG-5 engine to free resources allocated to an Ingredient. Execute the following sequence of actions: 1. Apply the Destruction behaviour. Provisions of use: The Target object shall be an available and inactive Ingredient object. The Content attribute of the target Ingredient shall be different from Null. Unload --> Target Target --> GenericObjectReference.
Variables
return	MHEG5ERR_NOERROR

Detailed Description

Implementation of the Ingredient class.

Date:: 01/02/2002

Author:: R.Freeman

Function Documentation

MHEG5ErrorCode MHEG5clone	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Implementation of the Clone action Clone (CloneRefVar) If the engine supports the Cloning option the effect of this action is described below. Engines that do not support the Cloning option shall ignore this action. This action copies the Target adding the copy to the same group that contains the Target using a unique ObjectReference obtained from the engine. The ObjectReference referring to the copy is returned in the ObjectRefVariable referenced by CloneRefVar. Execute the following sequence of actions: 1. Determine a unique ObjectReference within the same group as the Target. 2. Create a copy of the Target, taking into account only the exchanged attributes and not the internal attributes. The ObjectIdentifier attribute inherited from the Root class is not copied, but set to the ObjectReference determined in step 1. 3. Add the copy to the group containing the Target object. 4. Set the ObjectRefVariable referenced by CloneRefVar to the ObjectReference determined in step 1. 5. Apply the Preparation behaviour to the copy. An object created using this action is deactivated/destroyed when the group that contains that object is deactivated/destroyed. The objects are deactivated/destroyed along with other static Ingredients in the reverse order of creation. A dynamically created Ingredient can also be destroyed using the Unload elementary action if its Content attribute is not Null. Provision of use: The Target object shall be an available Ingredient. CloneRefVar shall be an active ObjectRefVariable. Clone --> Target, CloneRefVar Target --> GenericObjectReference CloneRefVar --> ObjectReference.

Parameters:

target	target object for this action
params	Action parameters

Returns:: MHEG5ErrorCode - See mh5base.h

MHEG5ErrorCode MHEG5preload	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Implementation of the Preload action Preload Prepares an Ingredient and provides a hint to the MHEG-5 engine to prepare the content data of an Ingredient for future use. Execute the following sequence of actions: 1. Apply the Preparation behaviour. 2. The MHEG-5 engine may optionally retrieve and/or decode the content data associated with the target Ingredient object. Provisions of use: The Target object shall be non-available Ingredient object. The Content attribute of the target Ingredient shall be different from Null. Preload --> Target Target --> GenericObjectReference.

Returns:: MHEG5ErrorCode - See mh5base.h

MHEG5PROFILE_UK1_06

MHEG5ErrorCode MHEG5unload	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Implementation of the Unload action Unload Destroys an Ingredient and provides a hint to the MHEG-5 engine to free resources allocated to an Ingredient. Execute the following sequence of actions: 1. Apply the Destruction behaviour. Provisions of use: The Target object shall be an available and inactive Ingredient object. The Content attribute of the target Ingredient shall be different from Null. Unload --> Target Target --> GenericObjectReference.

Returns:: MHEG5ErrorCode - See mh5base.h

Functions

Variables

Detailed Description

Function Documentation