VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Public Attributes | Protected Attributes
makVrv::DtWindow Class Referenceabstract

Abstract Base class. More...

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

Public Member Functions

 DtWindow (DtDe &, DtWindowConfiguration &wc)
 CTOR. More...
 
virtual void realize ()
 Realize the current configured channels. More...
 
virtual ~DtWindow ()
 DTOR. More...
 
virtual bool isValid () const =0
 Check to see if the window is still valid. More...
 
virtual bool canResize () const
 Check to see if the window can be resized. More...
 
virtual void setPosition (int x, int y)=0
 Set the position of the window in screen coordinates. More...
 
virtual void resize (int width, int height)=0
 Resize the window. More...
 
virtual void sizeChanged (int width, int height)=0
 Called when the size of the window has changed. More...
 
virtual int width () const
 Get the window width. More...
 
virtual bool isChildWindow () const
 Get the window is child window flag. More...
 
virtual int height () const
 Get the window height. More...
 
virtual float pixelRatio () const
 Get the window pixel ratio for high dpi scaling. More...
 
virtual const
DtWindowConfiguration
configuration () const
 Get the window configuration. More...
 
virtual bool tick ()
 Tick the window. More...
 
virtual DtChannelManagerchannelManager ()
 Get the window's channel manager. More...
 
virtual const DtChannelManagerchannelManager () const
 Get the window's channel manager. More...
 
virtual DtChannelfindChannel (const std::string &name)
 Find a channel. More...
 
DtDede ()
 Accessor to get the de;. More...
 
virtual void clearEmptyWindow (const std::string &messageLine1, const std::string &messageLine2, const std::string &messageLine3)
 Called every tick by the renderer on windows with no channels. More...
 
virtual void toggleFullScreen ()
 toggle fullscreen mode, for windows that support it. More...
 
virtual bool isFullScreen () const
 
virtual int screenNumber () const
 Get the screen number of the screen that this window is on. More...
 

Public Attributes

boost::signalslib::signal
< void(bool)> 
signal_fullScreenModeChanged
 Signal that indicates when the window toggles between full screen and Windowed mode. More...
 
boost::signalslib::signal
< void(float)> 
signal_pixelRatioChanged
 Signal that indicates when the high dpi scaling factor has changed. More...
 

Protected Attributes

DtDemyDe
 
DtChannelManagermyChannelManager
 
DtWindowConfigurationmyWindowConfiguration
 
bool myIsChildWindow
 

Detailed Description

Abstract Base class.

Constructor & Destructor Documentation

makVrv::DtWindow::DtWindow ( DtDe ,
DtWindowConfiguration wc 
)

CTOR.

virtual makVrv::DtWindow::~DtWindow ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtWindow::realize ( )
virtual

Realize the current configured channels.

virtual bool makVrv::DtWindow::isValid ( ) const
pure virtual

Check to see if the window is still valid.

A window should become invalid if it is closed.

Implemented in DtEmbeddedMfcOsgWindow, makVrv::DtOsgWindow, makVrv::DtDeMainWindowEmbeddedOsgWindow, and makVrv::DtOsgWindowQt.

virtual bool makVrv::DtWindow::canResize ( ) const
virtual

Check to see if the window can be resized.

virtual void makVrv::DtWindow::setPosition ( int  x,
int  y 
)
pure virtual
virtual void makVrv::DtWindow::resize ( int  width,
int  height 
)
pure virtual
virtual void makVrv::DtWindow::sizeChanged ( int  width,
int  height 
)
pure virtual

Called when the size of the window has changed.

This is necessary since often the window system will allow the use to resize a window.

Implemented in DtEmbeddedMfcOsgWindow, and makVrv::DtOsgWindow.

virtual int makVrv::DtWindow::width ( ) const
virtual

Get the window width.

Reimplemented in makVrv::DtDeMainWindowEmbeddedOsgWindow, and makVrv::DtOsgWindowQt.

virtual bool makVrv::DtWindow::isChildWindow ( ) const
virtual

Get the window is child window flag.

Set this flag to true in a derived class that shares the graphics context with another window. Currently used for the DtOsgHmdWindow class

virtual int makVrv::DtWindow::height ( ) const
virtual

Get the window height.

Reimplemented in makVrv::DtDeMainWindowEmbeddedOsgWindow, and makVrv::DtOsgWindowQt.

virtual float makVrv::DtWindow::pixelRatio ( ) const
virtual

Get the window pixel ratio for high dpi scaling.

Reimplemented in makVrv::DtDeMainWindowEmbeddedOsgWindow, makVrv::DtOsgWindowQt, and makVrv::DtEmbeddedOsgWindow.

virtual const DtWindowConfiguration& makVrv::DtWindow::configuration ( ) const
virtual

Get the window configuration.

virtual bool makVrv::DtWindow::tick ( )
virtual

Tick the window.

virtual DtChannelManager& makVrv::DtWindow::channelManager ( )
virtual

Get the window's channel manager.

virtual const DtChannelManager& makVrv::DtWindow::channelManager ( ) const
virtual

Get the window's channel manager.

virtual DtChannel* makVrv::DtWindow::findChannel ( const std::string &  name)
virtual

Find a channel.

DtDe& makVrv::DtWindow::de ( )
inline

Accessor to get the de;.

virtual void makVrv::DtWindow::clearEmptyWindow ( const std::string &  messageLine1,
const std::string &  messageLine2,
const std::string &  messageLine3 
)
virtual

Called every tick by the renderer on windows with no channels.

Reimplemented in makVrv::DtOsgWindow.

virtual void makVrv::DtWindow::toggleFullScreen ( )
inlinevirtual

toggle fullscreen mode, for windows that support it.

The base class does nothing

Reimplemented in makVrv::DtDeMainWindowEmbeddedOsgWindow, and makVrv::DtOsgWindowQt.

virtual bool makVrv::DtWindow::isFullScreen ( ) const
inlinevirtual
virtual int makVrv::DtWindow::screenNumber ( ) const
inlinevirtual

Get the screen number of the screen that this window is on.

Reimplemented in makVrv::DtDeMainWindowEmbeddedOsgWindow, and makVrv::DtOsgWindowQt.

Member Data Documentation

boost::signalslib::signal<void(bool)> makVrv::DtWindow::signal_fullScreenModeChanged

Signal that indicates when the window toggles between full screen and Windowed mode.

boost::signalslib::signal<void(float)> makVrv::DtWindow::signal_pixelRatioChanged

Signal that indicates when the high dpi scaling factor has changed.

DtDe& makVrv::DtWindow::myDe
protected
DtChannelManager* makVrv::DtWindow::myChannelManager
protected
DtWindowConfiguration& makVrv::DtWindow::myWindowConfiguration
protected
bool makVrv::DtWindow::myIsChildWindow
protected

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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)