MHEngine Class Reference

#include <Engine.h>

Inheritance diagram for MHEngine:

Collaboration diagram for MHEngine:

Public Member Functions
	MHEngine (MHContext *context)
	~MHEngine () override
void	SetBooting () override
void	DrawDisplay (QRegion toDraw) override
void	BootApplication (const char *fileName)
void	TransitionToScene (const MHObjectRef &target)
bool	Launch (const MHObjectRef &target, bool fIsSpawn=false)
void	Spawn (const MHObjectRef &target)
void	Quit ()
MHRoot *	FindObject (const MHObjectRef &oRef, bool failOnNotFound=true)
void	EventTriggered (MHRoot *pSource, enum EventType ev)
void	EventTriggered (MHRoot *pSource, enum EventType ev, const MHUnion &evData)
void	AddActions (const MHActionSequence &actions)
void	AddToDisplayStack (MHVisible *pVis)
void	RemoveFromDisplayStack (MHVisible *pVis)
void	Redraw (const QRegion &region)
void	BringToFront (const MHRoot *pVis)
void	SendToBack (const MHRoot *pVis)
void	PutBefore (const MHRoot *pVis, const MHRoot *pRef)
void	PutBehind (const MHRoot *pVis, const MHRoot *pRef)
void	LockScreen ()
void	UnlockScreen ()
int	RunAll (void) override
void	RunActions ()
void	GenerateUserAction (int nCode) override
void	EngineEvent (int nCode) override
void	StreamStarted (MHStream *stream, bool bStarted) override
void	RequestExternalContent (MHIngredient *pRequester)
void	CancelExternalContentRequest (MHIngredient *pRequester)
bool	LoadStorePersistent (bool fIsLoad, const MHOctetString &fileName, const MHSequence< MHObjectRef * > &variables)
void	AddLink (MHLink *pLink)
void	RemoveLink (MHLink *pLink)
bool	InTransition ()
bool	GetEngineSupport (const MHOctetString &feature)
int	GetDefaultCharSet ()
void	GetDefaultBGColour (MHColour &colour)
void	GetDefaultTextColour (MHColour &colour)
void	GetDefaultButtonRefColour (MHColour &colour)
void	GetDefaultHighlightRefColour (MHColour &colour)
void	GetDefaultSliderRefColour (MHColour &colour)
int	GetDefaultTextCHook ()
int	GetDefaultStreamCHook ()
int	GetDefaultBitmapCHook ()
void	GetDefaultFontAttrs (MHOctetString &str)
void	SetInputRegister (int nReg)
MHOctetString &	GetGroupId ()
MHContext *	GetContext ()
QString	GetPathName (const MHOctetString &str)
MHInteractible *	GetInteraction (void)
void	SetInteraction (MHInteractible *p)
int	GetTuneInfo ()
void	SetTuneInfo (int tuneinfo)
Public Member Functions inherited from MHEG
virtual	~MHEG ()=default

Static Public Attributes
static const char *	MHEGEngineProviderIdString = "MHGGNU001"

Protected Member Functions
void	CheckLinks (const MHObjectRef &sourceRef, enum EventType ev, const MHUnion &un)
MHGroup *	ParseProgram (QByteArray &text)
void	DrawRegion (const QRegion &toDraw, int nStackPos)
MHApplication *	CurrentApp ()
MHScene *	CurrentScene ()
void	CheckContentRequests ()

Protected Attributes
QRegion	m_redrawRegion
QStack< MHApplication * >	m_ApplicationStack
QStack< MHElemAction * >	m_ActionStack
QQueue< MHAsynchEvent * >	m_EventQueue
QList< MHLink * >	m_LinkTable
QList< MHExternContent * >	m_ExternContentTable
MHOwnPtrSequence< MHPSEntry >	m_PersistentStore
bool	m_fInTransition {false}
MHOctetString	m_CurrentGroupId
MHContext *	m_Context {nullptr}
bool	m_fBooting {true}
MHInteractible *	m_Interacting {nullptr}

Detailed Description

Definition at line 71 of file Engine.h.

Constructor & Destructor Documentation

MHEngine()

MHEngine::MHEngine ( MHContext *  context )

explicit

Definition at line 48 of file Engine.cpp.

~MHEngine()

MHEngine::~MHEngine ( )

override

Definition at line 59 of file Engine.cpp.

Member Function Documentation

SetBooting()

void MHEngine::SetBooting ( )

inlineoverridevirtual

Implements MHEG.

Definition at line 76 of file Engine.h.

DrawDisplay()

void MHEngine::DrawDisplay ( QRegion  toDraw )

overridevirtual

Implements MHEG.

Definition at line 886 of file Engine.cpp.

BootApplication()

void MHEngine::BootApplication

(

const char *

fileName

)

TransitionToScene()

void MHEngine::TransitionToScene

(

const MHObjectRef &

target

)

Definition at line 419 of file Engine.cpp.

Referenced by MHTransitionTo::Perform().

Launch()

bool MHEngine::Launch	(	const MHObjectRef &	target,
		bool	fIsSpawn = false
	)

Definition at line 274 of file Engine.cpp.

Referenced by MHLaunch::Perform(), RunAll(), and Spawn().

Spawn()

void MHEngine::Spawn ( const MHObjectRef &  target )

inline

Definition at line 84 of file Engine.h.

Referenced by MHSpawn::Perform().

Quit()

void MHEngine::Quit

(

)

Definition at line 378 of file Engine.cpp.

Referenced by MHQuit::Perform().

FindObject()

MHRoot * MHEngine::FindObject	(	const MHObjectRef &	oRef,
		bool	failOnNotFound = true
	)

Definition at line 574 of file Engine.cpp.

Referenced by MHTokenGroup::Activation(), MHClone::CallAction(), MHResidentProgram::CallProgram(), MHListGroup::GetCellItem(), MHListGroup::GetItemStatus(), MHListGroup::GetListItem(), MHGenericBoolean::GetValue(), MHGenericInteger::GetValue(), MHGenericOctetString::GetValue(), MHGenericObjectRef::GetValue(), MHGenericContentRef::GetValue(), LoadStorePersistent(), MHActionObjectRef::Perform(), MHSetData::Perform(), MHActionObjectRef2::Perform(), MHActionGenericObjectRef::Perform(), MHSetVariable::Perform(), MHActionGenericObjectRefFix::Perform(), MHTestVariable::Perform(), MHSendEvent::Perform(), MHIntegerAction::Perform(), MHAddItem::Perform(), MHPersistent::Perform(), MHAppend::Perform(), MHGetEngineSupport::Perform(), MHGetAvailabilityStatus::Perform(), MHListGroup::Preparation(), SetSuccessFlag(), and MHElemAction::Target().

EventTriggered() [1/2]

void MHEngine::EventTriggered ( MHRoot *  pSource, enum EventType  ev  )

inline

Definition at line 93 of file Engine.h.

Referenced by MHVariable::Activation(), MHStream::Activation(), MHProgram::Activation(), MHVisible::Activation(), MHLink::Activation(), MHTokenGroup::Activation(), MHAudio::Activation(), MHScene::Activation(), MHApplication::Activation(), MHStream::BeginPlaying(), MHResidentProgram::CallProgram(), MHGroup::CheckTimers(), MHText::ContentArrived(), MHBitmap::ContentArrived(), MHStream::ContentPreparation(), MHIngredient::ContentPreparation(), MHVideo::ContentPreparation(), MHRoot::Deactivation(), MHTokenGroup::Deactivation(), MHSlider::Decrement(), MHListGroup::Deselect(), MHRoot::Destruction(), EngineEvent(), GenerateUserAction(), MHSlider::Increment(), MHInteractible::InteractSetHighlightStatus(), MHInteractible::InteractSetInteractionStatus(), MHSlider::KeyEvent(), MHSendEvent::Perform(), MHRoot::Preparation(), MHListGroup::Select(), MHSlider::SetPortion(), MHSlider::SetSliderParameters(), MHSlider::SetSliderValue(), MHSlider::Step(), MHStream::StopPlaying(), StreamStarted(), MHBooleanVar::TestVariable(), MHIntegerVar::TestVariable(), MHOctetStrVar::TestVariable(), MHObjectRefVar::TestVariable(), MHContentRefVar::TestVariable(), MHTokenGroup::TransferToken(), and MHListGroup::Update().

EventTriggered() [2/2]

void MHEngine::EventTriggered	(	MHRoot *	pSource,
		enum EventType	ev,
		const MHUnion &	evData
	)

Definition at line 640 of file Engine.cpp.

AddActions()

void MHEngine::AddActions

(

const MHActionSequence &

actions

)

Definition at line 724 of file Engine.cpp.

Referenced by MHGroup::Activation(), MHApplication::Activation(), MHTokenGroup::CallActionSlot(), MHGroup::Deactivation(), Launch(), and MHLink::MatchEvent().

AddToDisplayStack()

void MHEngine::AddToDisplayStack

(

MHVisible *

pVis

)

Definition at line 734 of file Engine.cpp.

Referenced by MHVisible::Preparation().

RemoveFromDisplayStack()

void MHEngine::RemoveFromDisplayStack

(

MHVisible *

pVis

)

Definition at line 746 of file Engine.cpp.

Referenced by MHVisible::Destruction().

Redraw()

void MHEngine::Redraw

(

const QRegion &

region

)

Definition at line 899 of file Engine.cpp.

Referenced by MHVisible::Activation(), AddToDisplayStack(), BringToFront(), MHBitmap::CreateContent(), MHText::CreateContent(), MHVisible::Deactivation(), MHSlider::Decrement(), MHDynamicLineArt::DrawArcSector(), MHDynamicLineArt::DrawLine(), MHDynamicLineArt::DrawOval(), MHDynamicLineArt::DrawPoly(), MHDynamicLineArt::DrawRectangle(), MHSlider::Increment(), MHSlider::InteractionCompleted(), MHInteractible::InteractSetHighlightStatus(), PutBefore(), PutBehind(), RemoveFromDisplayStack(), MHBitmap::ScaleBitmap(), MHVideo::ScaleVideo(), SendToBack(), MHText::SetBackgroundColour(), MHBitmap::SetBitmapDecodeOffset(), MHVisible::SetBoxSize(), MHLineArt::SetFillColour(), MHText::SetFontAttributes(), MHLineArt::SetLineColour(), MHLineArt::SetLineStyle(), MHLineArt::SetLineWidth(), MHVisible::SetPaletteRef(), MHSlider::SetPortion(), MHVisible::SetPosition(), MHSlider::SetSliderParameters(), MHSlider::SetSliderValue(), MHText::SetTextColour(), MHVideo::SetVideoDecodeOffset(), and MHSlider::Step().

BringToFront()

void MHEngine::BringToFront

(

const MHRoot *

pVis

)

Definition at line 760 of file Engine.cpp.

Referenced by MHVisible::BringToFront().

SendToBack()

void MHEngine::SendToBack

(

const MHRoot *

pVis

)

Definition at line 775 of file Engine.cpp.

Referenced by MHVisible::SendToBack().

PutBefore()

void MHEngine::PutBefore	(	const MHRoot *	pVis,
		const MHRoot *	pRef
	)

Definition at line 790 of file Engine.cpp.

Referenced by MHVisible::PutBefore().

PutBehind()

void MHEngine::PutBehind	(	const MHRoot *	pVis,
		const MHRoot *	pRef
	)

Definition at line 821 of file Engine.cpp.

Referenced by MHVisible::PutBehind().

LockScreen()

void MHEngine::LockScreen ( )

inline

Definition at line 109 of file Engine.h.

Referenced by MHLockScreen::Perform().

UnlockScreen()

void MHEngine::UnlockScreen

(

)

Definition at line 905 of file Engine.cpp.

Referenced by MHUnlockScreen::Perform().

RunAll()

int MHEngine::RunAll ( void  )

overridevirtual

Implements MHEG.

Definition at line 81 of file Engine.cpp.

RunActions()

void MHEngine::RunActions

(

)

Definition at line 614 of file Engine.cpp.

Referenced by MHGroup::Activation(), MHApplication::Activation(), MHGroup::Deactivation(), Launch(), and RunAll().

GenerateUserAction()

void MHEngine::GenerateUserAction ( int  nCode )

overridevirtual

Implements MHEG.

Definition at line 915 of file Engine.cpp.

EngineEvent()

void MHEngine::EngineEvent ( int  nCode )

overridevirtual

Implements MHEG.

Definition at line 955 of file Engine.cpp.

Referenced by CheckContentRequests(), GenerateUserAction(), Launch(), RequestExternalContent(), and TransitionToScene().

StreamStarted()

void MHEngine::StreamStarted ( MHStream *  stream, bool  bStarted  )

overridevirtual

Implements MHEG.

Definition at line 963 of file Engine.cpp.

RequestExternalContent()

void MHEngine::RequestExternalContent

(

MHIngredient *

pRequester

)

Definition at line 969 of file Engine.cpp.

Referenced by MHIngredient::ContentPreparation().

CancelExternalContentRequest()

void MHEngine::CancelExternalContentRequest

(

MHIngredient *

pRequester

)

Definition at line 1028 of file Engine.cpp.

Referenced by MHIngredient::ContentPreparation(), MHIngredient::Destruction(), and RequestExternalContent().

LoadStorePersistent()

bool MHEngine::LoadStorePersistent	(	bool	fIsLoad,
		const MHOctetString &	fileName,
		const MHSequence< MHObjectRef * > &	variables
	)

Definition at line 1110 of file Engine.cpp.

Referenced by MHPersistent::Perform().

AddLink()

void MHEngine::AddLink

(

MHLink *

pLink

)

Definition at line 713 of file Engine.cpp.

Referenced by MHLink::Activation().

RemoveLink()

void MHEngine::RemoveLink

(

MHLink *

pLink

)

Definition at line 718 of file Engine.cpp.

Referenced by MHLink::Deactivation().

InTransition()

bool MHEngine::InTransition ( )

inline

Definition at line 134 of file Engine.h.

GetEngineSupport()

bool MHEngine::GetEngineSupport

(

const MHOctetString &

feature

)

Definition at line 1188 of file Engine.cpp.

Referenced by MHGetEngineSupport::Perform().

GetDefaultCharSet()

int MHEngine::GetDefaultCharSet

(

)

Definition at line 1344 of file Engine.cpp.

GetDefaultBGColour()

void MHEngine::GetDefaultBGColour

(

MHColour &

colour

)

Definition at line 1355 of file Engine.cpp.

Referenced by MHText::Preparation().

GetDefaultTextColour()

void MHEngine::GetDefaultTextColour

(

MHColour &

colour

)

Definition at line 1369 of file Engine.cpp.

Referenced by MHText::Preparation().

GetDefaultButtonRefColour()

void MHEngine::GetDefaultButtonRefColour

(

MHColour &

colour

)

Definition at line 1383 of file Engine.cpp.

GetDefaultHighlightRefColour()

void MHEngine::GetDefaultHighlightRefColour

(

MHColour &

colour

)

Definition at line 1397 of file Engine.cpp.

Referenced by MHInteractible::Initialise().

GetDefaultSliderRefColour()

void MHEngine::GetDefaultSliderRefColour

(

MHColour &

colour

)

Definition at line 1411 of file Engine.cpp.

Referenced by MHSlider::Initialise().

GetDefaultTextCHook()

int MHEngine::GetDefaultTextCHook

(

)

Definition at line 1425 of file Engine.cpp.

GetDefaultStreamCHook()

int MHEngine::GetDefaultStreamCHook

(

)

Definition at line 1436 of file Engine.cpp.

GetDefaultBitmapCHook()

int MHEngine::GetDefaultBitmapCHook

(

)

Definition at line 1447 of file Engine.cpp.

Referenced by MHBitmap::CreateContent().

GetDefaultFontAttrs()

void MHEngine::GetDefaultFontAttrs

(

MHOctetString &

str

)

Definition at line 1458 of file Engine.cpp.

Referenced by MHText::Preparation().

SetInputRegister()

void MHEngine::SetInputRegister

(

int

nReg

)

Definition at line 518 of file Engine.cpp.

Referenced by MHScene::SetInputRegister(), and TransitionToScene().

GetGroupId()

MHOctetString& MHEngine::GetGroupId ( )

inline

Definition at line 152 of file Engine.h.

Referenced by MHGroup::Initialise(), and MHObjectRef::Initialise().

GetContext()

MHContext* MHEngine::GetContext ( )

inline

Definition at line 153 of file Engine.h.

Referenced by MHAudio::Activation(), MHVideo::Activation(), MHStream::BeginPlaying(), MHAudio::BeginPlaying(), MHVideo::BeginPlaying(), MHResidentProgram::CallProgram(), MHAudio::Deactivation(), MHVideo::Deactivation(), MHText::Display(), MHVideo::Display(), MHRectangle::Display(), MHSlider::Display(), MHStream::GetCounterMaxPosition(), MHStream::GetCounterPosition(), MHDynamicLineArt::Initialise(), MHText::Initialise(), MHBitmap::Initialise(), MHText::Preparation(), MHStream::SetCounterPosition(), MHStream::SetSpeed(), MHStream::StopPlaying(), MHAudio::StopPlaying(), and MHVideo::StopPlaying().

GetPathName()

QString MHEngine::GetPathName

(

const MHOctetString &

str

)

Definition at line 524 of file Engine.cpp.

Referenced by MHResidentProgram::CallProgram(), MHObjectRef::Equal(), MHContentRef::Equal(), FindObject(), Launch(), RequestExternalContent(), and TransitionToScene().

GetInteraction()

MHInteractible* MHEngine::GetInteraction ( void  )

inline

Definition at line 160 of file Engine.h.

Referenced by MHInteractible::InteractSetInteractionStatus().

SetInteraction()

void MHEngine::SetInteraction ( MHInteractible *  p )

inline

Definition at line 161 of file Engine.h.

Referenced by MHInteractible::Interaction(), MHInteractible::InteractSetInteractionStatus(), and MHSlider::KeyEvent().

GetTuneInfo()

int MHEngine::GetTuneInfo ( )

inline

Definition at line 163 of file Engine.h.

Referenced by MHResidentProgram::CallProgram().

SetTuneInfo()

void MHEngine::SetTuneInfo ( int  tuneinfo )

inline

Definition at line 164 of file Engine.h.

Referenced by MHResidentProgram::CallProgram().

CheckLinks()

void MHEngine::CheckLinks ( const MHObjectRef &  sourceRef, enum EventType  ev, const MHUnion &  un  )

protected

Definition at line 706 of file Engine.cpp.

Referenced by EventTriggered(), and RunAll().

ParseProgram()

MHGroup * MHEngine::ParseProgram ( QByteArray &  text )

protected

Definition at line 195 of file Engine.cpp.

Referenced by Launch(), and TransitionToScene().

DrawRegion()

void MHEngine::DrawRegion ( const QRegion &  toDraw, int  nStackPos  )

protected

Definition at line 852 of file Engine.cpp.

Referenced by DrawDisplay().

CurrentApp()

MHApplication* MHEngine::CurrentApp ( )

inlineprotected

Definition at line 175 of file Engine.h.

Referenced by AddToDisplayStack(), BringToFront(), CurrentScene(), DrawDisplay(), DrawRegion(), EngineEvent(), FindObject(), GetDefaultBGColour(), GetDefaultBitmapCHook(), GetDefaultButtonRefColour(), GetDefaultCharSet(), GetDefaultFontAttrs(), GetDefaultHighlightRefColour(), GetDefaultSliderRefColour(), GetDefaultStreamCHook(), GetDefaultTextCHook(), GetDefaultTextColour(), GetPathName(), GetTuneInfo(), Launch(), LockScreen(), PutBefore(), PutBehind(), Quit(), RemoveFromDisplayStack(), RunAll(), SendToBack(), SetTuneInfo(), TransitionToScene(), and UnlockScreen().

CurrentScene()

MHScene* MHEngine::CurrentScene ( )

inlineprotected

Definition at line 180 of file Engine.h.

Referenced by FindObject(), GenerateUserAction(), Launch(), Quit(), RunAll(), and TransitionToScene().

CheckContentRequests()

void MHEngine::CheckContentRequests ( )

protected

Definition at line 1049 of file Engine.cpp.

Referenced by RunAll().

Member Data Documentation

MHEGEngineProviderIdString

const char * MHEngine::MHEGEngineProviderIdString = "MHGGNU001"

static

Definition at line 157 of file Engine.h.

Referenced by MHResidentProgram::CallProgram(), and GetEngineSupport().

m_redrawRegion

QRegion MHEngine::m_redrawRegion

protected

Definition at line 171 of file Engine.h.

Referenced by Redraw(), RunAll(), and TransitionToScene().

m_ApplicationStack

QStack<MHApplication*> MHEngine::m_ApplicationStack

protected

Definition at line 174 of file Engine.h.

Referenced by CurrentApp(), Launch(), Quit(), RunAll(), and ~MHEngine().

m_ActionStack

QStack<MHElemAction*> MHEngine::m_ActionStack

protected

Definition at line 185 of file Engine.h.

Referenced by AddActions(), Launch(), RunActions(), RunAll(), and TransitionToScene().

m_EventQueue

QQueue<MHAsynchEvent*> MHEngine::m_EventQueue

protected

Definition at line 189 of file Engine.h.

Referenced by EventTriggered(), Launch(), Quit(), RunAll(), TransitionToScene(), and ~MHEngine().

m_LinkTable

QList<MHLink*> MHEngine::m_LinkTable

protected

Definition at line 192 of file Engine.h.

Referenced by AddLink(), CheckLinks(), RemoveLink(), and RunAll().

m_ExternContentTable

QList<MHExternContent*> MHEngine::m_ExternContentTable

protected

Definition at line 196 of file Engine.h.

Referenced by CancelExternalContentRequest(), CheckContentRequests(), RequestExternalContent(), RunAll(), and ~MHEngine().

m_PersistentStore

MHOwnPtrSequence<MHPSEntry> MHEngine::m_PersistentStore

protected

Definition at line 199 of file Engine.h.

Referenced by LoadStorePersistent(), and MHEngine().

m_fInTransition

bool MHEngine::m_fInTransition {false}

protected

Definition at line 201 of file Engine.h.

Referenced by InTransition(), Launch(), Quit(), and TransitionToScene().

m_CurrentGroupId

MHOctetString MHEngine::m_CurrentGroupId

protected

Definition at line 205 of file Engine.h.

Referenced by GetGroupId().

m_Context

MHContext* MHEngine::m_Context {nullptr}

protected

Definition at line 207 of file Engine.h.

Referenced by CheckContentRequests(), DrawRegion(), GetContext(), GetEngineSupport(), Launch(), RequestExternalContent(), RunAll(), SetInputRegister(), and TransitionToScene().

m_fBooting

bool MHEngine::m_fBooting {true}

protected

Definition at line 208 of file Engine.h.

Referenced by DrawDisplay(), EngineEvent(), Launch(), Quit(), RunAll(), and SetBooting().

m_Interacting

MHInteractible* MHEngine::m_Interacting {nullptr}

protected

Definition at line 210 of file Engine.h.

Referenced by GenerateUserAction(), GetInteraction(), SetInteraction(), and TransitionToScene().

---

The documentation for this class was generated from the following files:

• Engine.h
• Engine.cpp