CustusX  2023.01.05-dev+develop.0da12
An IGT application
cx::LayoutData Class Reference

#include <cxLayoutData.h>

Public Types

typedef std::vector< LayoutViewDataViewDataContainer
 
typedef ViewDataContainer::iterator iterator
 
typedef ViewDataContainer::const_iterator const_iterator
 

Public Member Functions

 LayoutData ()
 
QString getUid () const
 
QString getName () const
 
bool getOffScreenRendering () const
 
void setOffScreenRendering (bool val)
 
void setName (const QString &name)
 
void resetUid (const QString &uid)
 
void setView (int group, PLANE_TYPE type, LayoutRegion region)
 
void setView (int group, View::Type type, LayoutRegion region)
 
LayoutViewDataget (LayoutPosition pos)
 
iterator begin ()
 
iterator end ()
 
const_iterator begin () const
 
const_iterator end () const
 
iterator find (LayoutPosition pos)
 
bool isEmpty () const
 
void split (iterator iter)
 
void split (LayoutRegion region)
 
bool merge (LayoutRegion region)
 
void resize (int rows, int cols)
 
LayoutPosition size () const
 
void addXml (QDomNode node) const
 save state to xml More...
 
void parseXml (QDomNode node)
 load state from xml More...
 

Static Public Member Functions

static LayoutData createHeader (QString uid, QString name)
 
static LayoutData create (QString uid, QString name, int rows, int cols)
 

Static Public Attributes

static const int MaxGridSize = 20
 

Detailed Description

Represents one specific layout of the views, and what kind of information they contain, i.e 3D/2D, slice plane definition, image group.

Definition at line 76 of file cxLayoutData.h.

Member Typedef Documentation

typedef ViewDataContainer::const_iterator cx::LayoutData::const_iterator

Definition at line 81 of file cxLayoutData.h.

typedef ViewDataContainer::iterator cx::LayoutData::iterator

Definition at line 80 of file cxLayoutData.h.

Definition at line 79 of file cxLayoutData.h.

Constructor & Destructor Documentation

cx::LayoutData::LayoutData ( )

Definition at line 75 of file cxLayoutData.cpp.

Member Function Documentation

void cx::LayoutData::addXml ( QDomNode  node) const

save state to xml

Definition at line 252 of file cxLayoutData.cpp.

iterator cx::LayoutData::begin ( )
inline

Definition at line 97 of file cxLayoutData.h.

const_iterator cx::LayoutData::begin ( ) const
inline

Definition at line 99 of file cxLayoutData.h.

LayoutData cx::LayoutData::create ( QString  uid,
QString  name,
int  rows,
int  cols 
)
static

Definition at line 66 of file cxLayoutData.cpp.

LayoutData cx::LayoutData::createHeader ( QString  uid,
QString  name 
)
static

Definition at line 61 of file cxLayoutData.cpp.

iterator cx::LayoutData::end ( )
inline

Definition at line 98 of file cxLayoutData.h.

const_iterator cx::LayoutData::end ( ) const
inline

Definition at line 100 of file cxLayoutData.h.

LayoutData::iterator cx::LayoutData::find ( LayoutPosition  pos)

Definition at line 241 of file cxLayoutData.cpp.

LayoutViewData & cx::LayoutData::get ( LayoutPosition  pos)

Definition at line 236 of file cxLayoutData.cpp.

QString cx::LayoutData::getName ( ) const
inline

Definition at line 89 of file cxLayoutData.h.

bool cx::LayoutData::getOffScreenRendering ( ) const
inline

Definition at line 90 of file cxLayoutData.h.

QString cx::LayoutData::getUid ( ) const
inline

Definition at line 88 of file cxLayoutData.h.

bool cx::LayoutData::isEmpty ( ) const
inline

Definition at line 102 of file cxLayoutData.h.

bool cx::LayoutData::merge ( LayoutRegion  region)

Merge all views inside input region. Previously merged views partially inside the new region will be split.

Prerequisite: input is inside old boundaries.

Definition at line 117 of file cxLayoutData.cpp.

void cx::LayoutData::parseXml ( QDomNode  node)

load state from xml

Definition at line 274 of file cxLayoutData.cpp.

void cx::LayoutData::resetUid ( const QString &  uid)

Definition at line 83 of file cxLayoutData.cpp.

void cx::LayoutData::resize ( int  rows,
int  cols 
)

Resize layout to be of dimension rows x cols.

Definition at line 194 of file cxLayoutData.cpp.

void cx::LayoutData::setName ( const QString &  name)
inline

Definition at line 92 of file cxLayoutData.h.

void cx::LayoutData::setOffScreenRendering ( bool  val)
inline

Definition at line 91 of file cxLayoutData.h.

void cx::LayoutData::setView ( int  group,
PLANE_TYPE  type,
LayoutRegion  region 
)

Allows easy definition of a view inside the layout. region must be inside layout bounds.

Definition at line 92 of file cxLayoutData.cpp.

void cx::LayoutData::setView ( int  group,
View::Type  type,
LayoutRegion  region 
)

Definition at line 102 of file cxLayoutData.cpp.

LayoutPosition cx::LayoutData::size ( ) const
inline

Definition at line 108 of file cxLayoutData.h.

void cx::LayoutData::split ( iterator  iter)

Split the region given by iter into 1x1 views.

Definition at line 167 of file cxLayoutData.cpp.

void cx::LayoutData::split ( LayoutRegion  region)

Split all views wholly or partially within input region into 1x1 views.

Definition at line 151 of file cxLayoutData.cpp.

Member Data Documentation

const int cx::LayoutData::MaxGridSize = 20
static

Definition at line 82 of file cxLayoutData.h.


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