VizKit::ProcessMonitorActor Class Reference

This actor displays textual and graphical information useful for debugging, diagnostics and monitoring purposes. More...

#include <ProcessMonitorActor.h>

Inheritance diagram for VizKit::ProcessMonitorActor:

List of all members.

Public Member Functions
	ProcessMonitorActor ()
	The constructor.
	~ProcessMonitorActor (void)
	The destructor.
virtual void	init (void)
	Initialization.
virtual void	show (const VisualPlayerState &visualPlayerState)
	Performs the show of the process monitor.
void	handleNotification (VisualNotification &aNotification)
	The actor receives a notification about an event that occured.
void	setState (VisualActorState aVisualActorState)
	Sets the state of the process monitor actor.
void	registerProcessMonitorInfoMap (const std::map< std::string, std::string > *const processMonitorInfoMap)
	The processMonitorInfoMap is registered.
bool	isAudioInfoShown (void)
	Answers the question whether the audio info is shown or not.
void	setShowAudioInfo (bool requestedAudioInfoState)
	Sets the state of the audio info.
Private Attributes
ProcessMonitor *	processMonitor
	A pointer to the process monitor action.
bool	showAudioInfoBool
	Should the audio info be shown?
uint32	elapsedAudioTime
	The elapsed time of the current audio track in milliseconds.
uint32	remainingAudioTime
	The remaining time of the current audio track in milliseconds.

---

Detailed Description

This actor displays textual and graphical information useful for debugging, diagnostics and monitoring purposes.

Visual plug-ins can be debugged by writing output to stdout. If it is neccessary to monitor reoccuring and changing data in realtime the data can be registered with the ProcessMonitorActor and refreshed with each render call. The registered output is displayed on screen.

---

Constructor & Destructor Documentation

ProcessMonitorActor::ProcessMonitorActor

(

)

The constructor.

ProcessMonitorActor::~ProcessMonitorActor

(

void

)

The destructor.

---

Member Function Documentation

void ProcessMonitorActor::handleNotification

(

VisualNotification &

aNotification

)

[virtual]

The actor receives a notification about an event that occured.

Parameters:

aNotification

The notification passed in.

Reimplemented from VizKit::VisualActor.

void ProcessMonitorActor::init

(

void

)

[virtual]

Initialization.

Reimplemented from VizKit::VisualActor.

bool ProcessMonitorActor::isAudioInfoShown

(

void

)

Answers the question whether the audio info is shown or not.

Returns:

True if audio info is shown, false if not.

void ProcessMonitorActor::registerProcessMonitorInfoMap

(

const std::map< std::string, std::string > *const

processMonitorInfoMap

)

The processMonitorInfoMap is registered.

Parameters:

processMonitorInfoMap

All associative key-value-pairs of the process monitor info map.

void ProcessMonitorActor::setShowAudioInfo

(

bool

requestedAudioInfoState

)

Sets the state of the audio info.

Parameters:

requestedAudioInfoState

True if audio info show be shown, false if it should be hidden.

void ProcessMonitorActor::setState

(

VisualActorState

aVisualActorState

)

[virtual]

Sets the state of the process monitor actor.

Parameters:

aVisualActorState

The state of the process monitor actor.

Reimplemented from VizKit::VisualActor.

void ProcessMonitorActor::show

(

const VisualPlayerState &

visualPlayerState

)

[virtual]

Performs the show of the process monitor.

Parameters:

visualPlayerState

Read-only access to the VisualPlayerState.

Reimplemented from VizKit::VisualActor.

---

Member Data Documentation

uint32 VizKit::ProcessMonitorActor::elapsedAudioTime [private]

The elapsed time of the current audio track in milliseconds.

ProcessMonitor* VizKit::ProcessMonitorActor::processMonitor [private]

A pointer to the process monitor action.

uint32 VizKit::ProcessMonitorActor::remainingAudioTime [private]

The remaining time of the current audio track in milliseconds.

bool VizKit::ProcessMonitorActor::showAudioInfoBool [private]

Should the audio info be shown?

---

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

• vizkit/source/Actors/ProcessMonitorActor.h
• vizkit/source/Actors/ProcessMonitorActor.cpp