FotoSHOCK
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | Public Attributes | Friends | List of all members
FotoSHOCKcore::UpdateInfo Class Reference

Stores the information used for updates within GraphManager. More...

#include <UpdateInfo.hpp>

Public Member Functions

 UpdateInfo ()
 Default constructor. More...
 
 UpdateInfo (ROIinfo ROI)
 A constructor. More...
 
 UpdateInfo (unsigned int x, unsigned int y, unsigned int sizeX, unsigned int sizeY, const int mipmapLevel)
 
void update ()
 Update the ROI in all predecessors. More...
 

Public Attributes

boost::shared_ptr< ROIinfoROI
 Region of interest. More...
 

Friends

class GraphNode
 
class GraphManager
 
class Graph_private
 
class ImageOperation
 

Detailed Description

Stores the information used for updates within GraphManager.

The UpdateInfo class is contains the information necessary for correct updates of GraphNodes in the GraphManager. Each UpdateInfo contains pointer to it's child so it's possible to determine which UpdateInfos depend on each other.

Constructor & Destructor Documentation

FotoSHOCKcore::UpdateInfo::UpdateInfo ( )

Default constructor.

Creates an UpdateInfo object without initializing UpdateInfo::ROI.

FotoSHOCKcore::UpdateInfo::UpdateInfo ( ROIinfo  ROI)

A constructor.

Creates a new object with a specified ROI. They ROI is not shared.

Parameters
ROIROIinfo to use with created UpdateInfo object

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Member Function Documentation

void FotoSHOCKcore::UpdateInfo::update ( )

Update the ROI in all predecessors.

When the ROI is changed, it is necessary that all regions it depends on are changed accordingly. This function ensures this update.

The updateROI() is called eg. when the preview has changed. This function needs to be called everytime ROI or m_mipmapLevel is changed.

Note that this function has to be called on the most recent object in the tree of UpdateInfo objects.

Member Data Documentation

boost::shared_ptr<ROIinfo> FotoSHOCKcore::UpdateInfo::ROI

Region of interest.

The region which should be recalculated or redrawn. The ROI also specifies the mipmap level for which it applies.


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