VR-Forces 4.0.4 Class Documentation
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes
makVrv::DtWindowConfiguration Class Reference

This owns a list of channel configurations. More...

Inheritance diagram for makVrv::DtWindowConfiguration:
Inheritance graph
[legend]

List of all members.

Public Types

enum  WindowType { NoWindow, Window, FullscreenWindow, EmbeddedWindow }

Public Member Functions

 DtWindowConfiguration (const std::string &name=DefaultWindowString)
 CTOR A window will start with a single default channel configuration.
 DtWindowConfiguration (const DtWindowConfiguration &copy)
 Copy CTOR All channels configurations are duplicated (not shared).
DtWindowConfigurationoperator= (const DtWindowConfiguration &copy)
 Assignment OP All channels configurations are duplicated (not shared).
 ~DtWindowConfiguration ()
 DTOR.
WindowType windowType () const
 WindowType accessor.
void setWindowType (WindowType wt)
 WindowType setter.
int screenNumber () const
 Get the window number the window is configured for.
void setScreenNumber (int number)
 Set the window number to place the window.
int x () const
 Get the x coordinate (screen space) of the window's top left corner.
int y () const
 Get the y coordinate (screen space) of the window's top left corner.
void setPosition (int x, int y)
 Set the x & y coordinates (screen space) of the window's top left corner.
unsigned int width () const
 Get the width.
unsigned int height () const
 Get the height.
void setSize (unsigned int width, unsigned int height)
 Set the window size.
bool isFixedSize () const
 Get if the window should be fixed size.
void setFixedSize (bool fixed)
 Set if the window is fixed size.
DtChannelConfigurationschannelConfigurations ()
 Get the channel configurations for this window.
const DtChannelConfigurationschannelConfigurations () const
 Get the channel configurations for this window.

Static Public Attributes

static const char * DefaultWindowString

Protected Member Functions

template<class Archive >
void _serialize (Archive &ar, const unsigned int version)
 Declare serialize functions Call via serialize(Archive ar, unsigned int version); Where Archive can be any of : xml_oarchive,xml_iarchive,binary_oarchive binary_iarchive,text_oarchive, or text_iarchive.

Protected Attributes

DtChannelConfigurations myChannelConfigurations
 All copy semantics members.
WindowType myWindowType
 Default is Window.
int myScreenNumber
 Default is 0.
int myX
 Default is 100.
int myY
 Default is 100.
unsigned int myWidth
 Default is 300.
unsigned int myHeight
 Default is 300.
bool myFixedSizeFlag
 Default is False.

Detailed Description

This owns a list of channel configurations.

Examples

Member Enumeration Documentation

Enumerator:
NoWindow 
Window 
FullscreenWindow 
EmbeddedWindow 

Constructor & Destructor Documentation

CTOR A window will start with a single default channel configuration.

Copy CTOR All channels configurations are duplicated (not shared).

DTOR.


Member Function Documentation

DtWindowConfiguration& makVrv::DtWindowConfiguration::operator= ( const DtWindowConfiguration copy)

Assignment OP All channels configurations are duplicated (not shared).

Get the channel configurations for this window.

Get the channel configurations for this window.

WindowType accessor.

WindowType setter.

Get the window number the window is configured for.

Set the window number to place the window.

If the system is configured with only one window this number is ignored.

Get the x coordinate (screen space) of the window's top left corner.

Get the y coordinate (screen space) of the window's top left corner.

void makVrv::DtWindowConfiguration::setPosition ( int  x,
int  y 
)

Set the x & y coordinates (screen space) of the window's top left corner.

unsigned int makVrv::DtWindowConfiguration::width ( ) const

Get the width.

unsigned int makVrv::DtWindowConfiguration::height ( ) const

Get the height.

void makVrv::DtWindowConfiguration::setSize ( unsigned int  width,
unsigned int  height 
)

Set the window size.

Get if the window should be fixed size.

Set if the window is fixed size.

template<class Archive >
void makVrv::DtWindowConfiguration::_serialize ( Archive &  ar,
const unsigned int  version 
) [inline, protected]

Declare serialize functions Call via serialize(Archive ar, unsigned int version); Where Archive can be any of : xml_oarchive,xml_iarchive,binary_oarchive binary_iarchive,text_oarchive, or text_iarchive.

Reimplemented from makVrv::DtConfiguration.

References DT_SERIALIZE_BASE, and DT_SERIALIZE_MEMBER.


Member Data Documentation

All copy semantics members.

Default has a single default channel.

Default is Window.

Default is 0.

Default is 100.

Default is 100.

unsigned int makVrv::DtWindowConfiguration::myWidth [protected]

Default is 300.

unsigned int makVrv::DtWindowConfiguration::myHeight [protected]

Default is 300.

Default is False.


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)