Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Mezzanine::UI::WidgetUpdateWorkUnit Class Reference

This is a Mezzanine::Threading::iWorkUnit for the updating of widgets in the UI system. More...

#include <uimanager.h>

+ Inheritance diagram for Mezzanine::UI::WidgetUpdateWorkUnit:
+ Collaboration diagram for Mezzanine::UI::WidgetUpdateWorkUnit:

Public Member Functions

 WidgetUpdateWorkUnit (UIManager *Target)
 Class constructor. More...
 
virtual ~WidgetUpdateWorkUnit ()
 Class destructor.
 
virtual void DoWork (Threading::DefaultThreadSpecificStorage::Type &CurrentThreadStorage)
 This does any required update of the Graphical Scene graph and REnders one frame. More...
 
- Public Member Functions inherited from Mezzanine::Threading::DefaultWorkUnit
 DefaultWorkUnit ()
 Simple constructor.
 
virtual ~DefaultWorkUnit ()
 Virtual destructor, doesn't actually do much.
 
virtual void AddDependency (iWorkUnit *NewDependency)
 Force this WorkUnit to Start after another has completed. More...
 
virtual void ClearDependencies ()
 Drop any information about what work units this one depends on.
 
virtual iWorkUnitGetDependency (Whole Index) const
 This is used to iterate of all the dependencies. More...
 
virtual Whole GetDependencyCount () const
 How many other WorkUnits does this one depend on? More...
 
virtual Whole GetDependentCount (FrameScheduler &SchedulerToCount)
 This returns the count workunits that depend on this work unit. More...
 
virtual Whole GetImmediateDependencyCount () const
 Get the amount of dependencies that directly count on this for access purposes. More...
 
virtual Whole GetPerformance () const
 Get the internal rolling average for querying. More...
 
virtual RollingAverage< Whole > & GetPerformanceLog ()
 Get the internal rolling average for querying. More...
 
virtual RunningState GetRunningState () const
 Retrieves the current RunningState of the thread. More...
 
virtual WorkUnitKey GetSortingKey (FrameScheduler &SchedulerToCount)
 Get the sorting metadata. More...
 
virtual bool IsEveryDependencyComplete ()
 Check if this WorkUnit could concievably run right now. More...
 
virtual void operator() (DefaultThreadSpecificStorage::Type &CurrentThreadStorage)
 This does everything required to track metadata and log work. More...
 
virtual void PrepareForNextFrame ()
 This resets the running state and takes any further action required to use the WorkUnit again.
 
virtual void RemoveDependency (iWorkUnit *RemoveDependency)
 Remove a dependency. More...
 
virtual RunningState TakeOwnerShip ()
 Attempts to atomically start the work unit in the current thread. More...
 
- Public Member Functions inherited from Mezzanine::Threading::iWorkUnit
virtual ~iWorkUnit ()
 Virtual destructor.
 

Protected Member Functions

 WidgetUpdateWorkUnit (const WidgetUpdateWorkUnit &Other)
 Protected copy constructor. THIS IS NOT ALLOWED. More...
 
WidgetUpdateWorkUnitoperator= (const WidgetUpdateWorkUnit &Other)
 Protected assignment operator. THIS IS NOT ALLOWED. More...
 

Protected Attributes

UIManagerTargetManager
 A pointer to the manager this work unit is processing. More...
 
- Protected Attributes inherited from Mezzanine::Threading::DefaultWorkUnit
Int32 CurrentRunningState
 This controls do work with this after it has.
 
std::vector< iWorkUnit * > Dependencies
 A collection of of workunits that must be complete before this one can start.
 
DefaultRollingAverage< Whole >::Type PerformanceLog
 A rolling average of execution times.
 

Detailed Description

This is a Mezzanine::Threading::iWorkUnit for the updating of widgets in the UI system.

Definition at line 73 of file uimanager.h.

Constructor & Destructor Documentation

Mezzanine::UI::WidgetUpdateWorkUnit::WidgetUpdateWorkUnit ( const WidgetUpdateWorkUnit Other)
protected

Protected copy constructor. THIS IS NOT ALLOWED.

Parameters
OtherThe other work unit being copied from. WHICH WILL NEVER HAPPEN.

Definition at line 78 of file uimanager.cpp.

Mezzanine::UI::WidgetUpdateWorkUnit::WidgetUpdateWorkUnit ( UIManager Target)

Class constructor.

Parameters
TargetThe UIManager this work unit will process during the frame.

Definition at line 84 of file uimanager.cpp.

Member Function Documentation

void Mezzanine::UI::WidgetUpdateWorkUnit::DoWork ( Threading::DefaultThreadSpecificStorage::Type CurrentThreadStorage)
virtual

This does any required update of the Graphical Scene graph and REnders one frame.

Parameters
CurrentThreadStorageThe storage class for all resources owned by this work unit during it's execution.

Implements Mezzanine::Threading::iWorkUnit.

Definition at line 93 of file uimanager.cpp.

WidgetUpdateWorkUnit & Mezzanine::UI::WidgetUpdateWorkUnit::operator= ( const WidgetUpdateWorkUnit Other)
protected

Protected assignment operator. THIS IS NOT ALLOWED.

Parameters
OtherThe other work unit being copied from. WHICH WILL NEVER HAPPEN.
Returns
Returns a reference to this. WHICH WILL NEVER HAPPEN.

Definition at line 81 of file uimanager.cpp.

Member Data Documentation

UIManager* Mezzanine::UI::WidgetUpdateWorkUnit::TargetManager
protected

A pointer to the manager this work unit is processing.

Definition at line 78 of file uimanager.h.


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