========================================================================== More...

#include <RE_Window.h>

Classes
class	DrawablePassKey
	Pass key class to help restrict method access to drawable classes. More...

Public Member Functions
	RE_Window (RE_Server server, RE_WindowType type=RE_WINDOW_NORMAL, RE_VisualType visType=RE_NORMAL_VIS, RE_WindowOwner owner=nullptr)

virtual	~RE_Window ()

void	setName (const char *name)

void	setIconName (const char *name)

void	setParentWindow (RE_Window *parent)

const RE_Window *	getParentWindow () const

void	setDialogParentHint (RE_IDType parent_hint)

RE_Server *	getServer ()

RE_Visual *	getVisual ()

RE_Render *	getRender ()

void	setRender (UT_UniquePtr< RE_Render > r)

RE_IDType	openWindow ()

RE_IDType	openWindow (bool show)

void	showWindow ()

void	closeWindow ()

void	initMaxSize (int w, int h)

void	initMinSize (int w, int h)

void	initVisual (RE_Visual *visual)

void	setLimitPositions (bool limitpos)

bool	getLimitPositions () const

void	moveWindow (int x, int y)

void	sizeWindow (int w, int h)

void	setWindowOpacity (fpreal opacity)

void	maximizeWindow ()

void	restoreWindow ()

bool	isMaximized () const

void	fullscreenWindow (bool full)

bool	isFullscreenWindow () const

void	lowerWindow ()

void	raiseWindow ()

void	setHasWindowFrame (bool b)

bool	hasWindowFrame () const

int	getBorderWidth () const

int	getBorderHeight () const

int	getBorderTopSize () const

int	getBorderLeftSize () const

int	getBorderBottomSize () const

int	getBorderRightSize () const

UT_DimRect	findLocation () const

UT_DimRect	getNormalGeometry () const

void	setWindowAlwaysOnTop (bool newstate)

int	getWindowAlwaysOnTop () const

void	setWindowFloatOnTop (bool on_top)

RE_DisplayMode	getMode () const

RE_VisualType	getVisualType () const

void	setVisualType (RE_VisualType t)

void	setWindowType (RE_WindowType t)

RE_WindowType	getWindowType (bool extra=false) const

void	setWindowID (RE_IDType id)

RE_IDType	getWindowID () const

int	matchID (RE_IDType wid) const

virtual RE_IDType	getBufferID () const

bool	needsOpenGL () const

RE_WindowDrawable *	getDrawable () const

void	setDrawable (RE_WindowDrawable *d)

RE_QPainterDrawable *	getQPainterDrawable () const

void	setQPainterDrawable (RE_QPainterDrawable *d)

OGLDrawable	getGraphicsDrawable () const
	===================================================================== More...

void	setGraphicsDrawable (OGLDrawable d)

void	setIMESupport (bool enable)
	===================================================================== More...

bool	isActiveWindow () const
	Returns true if this window is the active window. More...

void	setWindowBorders (int left, int right, int top, int bottom)

void	updateMaximizedFlag (bool is_maximized)

bool	isQuadBufferStereo () const

int	screen () const

fpreal	screenToDeviceScale () const
	Get screen-to-window scale. More...

void	requestRender (bool immediate=false)
	Request that the window render it's contents. More...

void	render (const DrawablePassKey &k)

virtual bool	shouldApplyDevicePixelRatio () const

bool	useHoloStyle () const
	Return true if the drawable should use the holo style. More...

bool	hasPendingLayoutsForPaint () const

void	deferPaintForPendingLayouts ()

void	processPendingLayoutsForPaint ()
	Process any pending UI layouts in the window. More...

void	handleScreenChanged ()
	Handle when the window has moved to another screen. More...

Static Public Member Functions
static QWidget *	mainQtWindow ()
	Return the Qt main window. More...

static void	initQtWindow (QWidget &window, RE_WindowType win_type, bool always_on_top)

static QWidget *	createQtWindow (RE_WindowType win_type)

static bool	appActive ()
	Returns true if Houdini or any of its sub windows are focused. More...

static bool	isTabFocusEnabled ()

static void	enableTabFocus (bool enable)

static const char *	windowTag ()

static RE_Window *	immediateRenderWindow ()

static void	setImmediateRenderWindow (RE_Window *window)

static const int *	getDefaultWindowBorderSizes ()
	===================================================================== More...

static int	getDefaultWindowTitleBarHeight ()

Detailed Description

==========================================================================

Definition at line 56 of file RE_Window.h.

Constructor & Destructor Documentation

RE_Window::RE_Window	(	RE_Server *	server,
		RE_WindowType	type = `RE_WINDOW_NORMAL`,
		RE_VisualType	visType = `RE_NORMAL_VIS`,
		RE_WindowOwner *	owner = `nullptr`
	)

virtual RE_Window::~RE_Window ( )

virtual

Member Function Documentation

static bool RE_Window::appActive ( )

static

Returns true if Houdini or any of its sub windows are focused.

void RE_Window::closeWindow ( )

static QWidget* RE_Window::createQtWindow ( RE_WindowType win_type )

static

Create a Qt window widget for the given window type. The caller takes ownership of the returned object.

void RE_Window::deferPaintForPendingLayouts ( )

static void RE_Window::enableTabFocus ( bool enable )

static

UT_DimRect RE_Window::findLocation ( ) const

void RE_Window::fullscreenWindow ( bool full )

int RE_Window::getBorderBottomSize ( ) const

inline

Definition at line 132 of file RE_Window.h.

int RE_Window::getBorderHeight ( ) const

inline

Definition at line 126 of file RE_Window.h.

int RE_Window::getBorderLeftSize ( ) const

inline

Definition at line 130 of file RE_Window.h.

int RE_Window::getBorderRightSize ( ) const

inline

Definition at line 134 of file RE_Window.h.

int RE_Window::getBorderTopSize ( ) const

inline

Definition at line 128 of file RE_Window.h.

int RE_Window::getBorderWidth ( ) const

inline

Definition at line 124 of file RE_Window.h.

virtual RE_IDType RE_Window::getBufferID ( ) const

inlinevirtual

Definition at line 166 of file RE_Window.h.

static const int* RE_Window::getDefaultWindowBorderSizes ( )

static

=====================================================================

Get Default Window Border Sizes

static int RE_Window::getDefaultWindowTitleBarHeight ( )

static

RE_WindowDrawable* RE_Window::getDrawable ( ) const

inline

Definition at line 173 of file RE_Window.h.

OGLDrawable RE_Window::getGraphicsDrawable ( ) const

inline

=====================================================================

===================================================================== For OpenGL 2D UI drawing.

Definition at line 183 of file RE_Window.h.

bool RE_Window::getLimitPositions ( ) const

inline

Definition at line 93 of file RE_Window.h.

RE_DisplayMode RE_Window::getMode ( ) const

UT_DimRect RE_Window::getNormalGeometry ( ) const

const RE_Window* RE_Window::getParentWindow ( ) const

inline

Definition at line 70 of file RE_Window.h.

RE_QPainterDrawable* RE_Window::getQPainterDrawable ( ) const

inline

Definition at line 177 of file RE_Window.h.

RE_Render* RE_Window::getRender ( )

RE_Server* RE_Window::getServer ( )

inline

Definition at line 75 of file RE_Window.h.

RE_Visual* RE_Window::getVisual ( )

inline

Definition at line 76 of file RE_Window.h.

RE_VisualType RE_Window::getVisualType ( ) const

inline

Definition at line 149 of file RE_Window.h.

int RE_Window::getWindowAlwaysOnTop ( ) const

inline

Definition at line 143 of file RE_Window.h.

RE_IDType RE_Window::getWindowID ( ) const

inline

Definition at line 161 of file RE_Window.h.

RE_WindowType RE_Window::getWindowType ( bool extra = false ) const

void RE_Window::handleScreenChanged ( )

Handle when the window has moved to another screen.

bool RE_Window::hasPendingLayoutsForPaint ( ) const

bool RE_Window::hasWindowFrame ( ) const

static RE_Window* RE_Window::immediateRenderWindow ( )

static

Return the window currently being immediately rendered, if any. While set, no other window should paint.

void RE_Window::initMaxSize	(	int	w,
		int	h
	)

void RE_Window::initMinSize	(	int	w,
		int	h
	)

static void RE_Window::initQtWindow	(	QWidget &	window,
		RE_WindowType	win_type,
		bool	always_on_top
	)

static

Initialize the given widget window with the desired Houdini window properties, look and feel.

void RE_Window::initVisual ( RE_Visual * visual )

bool RE_Window::isActiveWindow ( ) const

Returns true if this window is the active window.

bool RE_Window::isFullscreenWindow ( ) const

bool RE_Window::isMaximized ( ) const

bool RE_Window::isQuadBufferStereo ( ) const

static bool RE_Window::isTabFocusEnabled ( )

static

void RE_Window::lowerWindow ( )

static QWidget* RE_Window::mainQtWindow ( )

static

Return the Qt main window.

int RE_Window::matchID ( RE_IDType wid ) const

inline

Definition at line 163 of file RE_Window.h.

void RE_Window::maximizeWindow ( )

void RE_Window::moveWindow	(	int	x,
		int	y
	)

bool RE_Window::needsOpenGL ( ) const

===================================================================== For new 2D UI drawing.

RE_IDType RE_Window::openWindow ( )

RE_IDType RE_Window::openWindow ( bool show )

void RE_Window::processPendingLayoutsForPaint ( )

Process any pending UI layouts in the window.

void RE_Window::raiseWindow ( )

void RE_Window::render ( const DrawablePassKey & k )

Render the window's contents. This method is meant to be called only from RE drawable classes.

void RE_Window::requestRender ( bool immediate = false )

Request that the window render it's contents.

===================================================================== For new 2D UI drawing.

void RE_Window::restoreWindow ( )

int RE_Window::screen ( ) const

Return the screen number containing this window. If the underlying platform window has not been created yet then return the primary screen number.

fpreal RE_Window::screenToDeviceScale ( ) const

Get screen-to-window scale.

void RE_Window::setDialogParentHint ( RE_IDType parent_hint )

void RE_Window::setDrawable ( RE_WindowDrawable * d )

void RE_Window::setGraphicsDrawable ( OGLDrawable d )

inline

Definition at line 184 of file RE_Window.h.

void RE_Window::setHasWindowFrame ( bool b )

void RE_Window::setIconName ( const char * name )

void RE_Window::setIMESupport ( bool enable )

=====================================================================

static void RE_Window::setImmediateRenderWindow ( RE_Window * window )

static

void RE_Window::setLimitPositions ( bool limitpos )

inline

Definition at line 91 of file RE_Window.h.

void RE_Window::setName ( const char * name )

void RE_Window::setParentWindow ( RE_Window * parent )

void RE_Window::setQPainterDrawable ( RE_QPainterDrawable * d )

void RE_Window::setRender ( UT_UniquePtr< RE_Render > r )

inline

Definition at line 80 of file RE_Window.h.

void RE_Window::setVisualType ( RE_VisualType t )

inline

Definition at line 151 of file RE_Window.h.

void RE_Window::setWindowAlwaysOnTop ( bool newstate )

void RE_Window::setWindowBorders	(	int	left,
		int	right,
		int	top,
		int	bottom
	)

inline

Definition at line 209 of file RE_Window.h.

void RE_Window::setWindowFloatOnTop ( bool on_top )

void RE_Window::setWindowID ( RE_IDType id )

inline

Definition at line 160 of file RE_Window.h.

void RE_Window::setWindowOpacity ( fpreal opacity )

void RE_Window::setWindowType ( RE_WindowType t )

inline

Definition at line 154 of file RE_Window.h.

virtual bool RE_Window::shouldApplyDevicePixelRatio ( ) const

virtual

Return true if the window's screen's device pixel ratio should be applied when painting the windows contents. Return false otherwise.

void RE_Window::showWindow ( )

void RE_Window::sizeWindow	(	int	w,
		int	h
	)

void RE_Window::updateMaximizedFlag ( bool is_maximized )

inline

Definition at line 219 of file RE_Window.h.

bool RE_Window::useHoloStyle ( ) const

Return true if the drawable should use the holo style.

static const char* RE_Window::windowTag ( )

inlinestatic

Return the string tag used to identify whether a Qt widget is the window for an RE_Window object.

Definition at line 229 of file RE_Window.h.

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

RE/RE_Window.h

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation