User Tools

Site Tools


DzMainWindow

The main interface widget.

More...

Inherits :

Properties

Methods

Signals

voidaboutToClose ()
voidalwaysOnTopChanged ( Boolean onOff )
voidstarted ()
voiduiLockedChanged ()

Detailed Description

There is only one of these widgets in the application, which is created and owned by DzApp. It can be accessed by using the Global::MainWindow variable.

Properties


Boolean : alwaysOnTop

Whether or not the main window is always on top of other application windows.


Boolean : toolTipsEnabled

Whether or not tool tips are enabled.

Methods


Boolean : askSaveChanges()

Presents the user with a dialog that asks if they want to save changes to the scene, and does a scene save if the user selects yes.

Return Value:

  • false if the user selects 'Cancel', true if the user selects 'Yes' or 'No'.

Boolean : askTurnOffLimits()

Presents the user with a dialog that asks if they want to turn off limits to apply the preset currently being loaded.

Return Value:

  • true if limits should be turned off, false if limits should be left alone.

Boolean : checkExistingFile( String name )

Checks to see if the given file already exists - if it does, prompts the user if they want to overwrite it.

Parameter(s):

  • name - The name of the file to look for.

Return Value:

  • true if the file does not exist or the user wants to overwrite it, false if the user needs to select a new name.

void : clearUIPopUp()

Clears a the current UI popup if there is one.


void : displayPrompt( String msg, Number millisec=-1 )

Display a message in the status bar.

Parameter(s):

  • line - Message to display
  • ms - If greater than zero, the message will be displayed for the given amount of time, otherwise the message will be displayed until another message is sent.

DzDockArea : dockArea( Point pos )

Return Value:

  • The dock area located at the goven position.

Boolean : doFileExport( QWidget parent=null )

Displays a dialog for saving the scene to a non-native file, and saves the scene if the user does not cancel.

Parameter(s):

  • parent - The widget that the file dialog will be parented to.

Return Value:

  • true if a file was selected and successfully saved, otherwise false.

Boolean : doFileImport( QWidget parent=null )

Displays a dialog for loading a non-native file, and loads the file if the user does not cancel.

Parameter(s):

  • parent - The widget that the file dialog will be parented to.

Return Value:

  • true if a file was selected and successfully loaded, otherwise false.

Boolean : doFileMerge( QWidget parent=null )

Displays a dialog for loading a native scene file, and merges the file into the current scene if the user does not cancel.

Return Value:

  • true if a file was selected and successfully loaded, otherwise false.

Boolean : doFileOpen( QWidget parent=null )

Displays a dialog for loading a native scene file, and opens the file as a new scene if the user does not cancel.

Return Value:

  • true if a file was selected and successfully loaded, otherwise false.

Boolean : doFileSave( QWidget parent=null )

Saves the scene to the current scene file - displaying a dialog to the user if a file needs to be selected.

Return Value:

  • true if a file was selected and successfully saved, otherwise false.

Image : doImageOpen( QWidget parent=null )

Displays a dialog for loading an image file, and loads the file if the user does not cancel.

Parameter(s):

  • parent - The widget that the file dialog will be parented to.

Return Value:

  • Empty image if the user cancels, or loading fails, otherwise the selected image.

Boolean : doImageSaveAs( Image image, QWidget parent=null )

Displays a dialog for saving the given image, and saves the image if the user does not cancel.

Parameter(s):

  • image - The Image to save.
  • parent - The widget that the file dialog will be parented to.

Return Value:

  • true if a file was selected and successfully saved, otherwise false.

Boolean : doNewFile()

Clears the scene


Boolean : doVideoClipSaveAs( DzVideoClip clip, QWidget parent=null )

Displays a dialog for saving the given video clip, and saves the clip if the user does not cancel.

Parameter(s):

  • clip - The video clip to save.
  • parent - The widget that the file dialog will be parented to.

Return Value:

  • true if a file was selected and successfully saved, otherwise false.

void : exitFullScreen()

Switches from full screen back to normal mode


DzActionMgr : getActionMgr()

Return Value:

  • A pointer to the global Action manager for the application interface

DzDockArea : getBottomDockArea()

Return Value:

  • The dock area located at the bottom of the main window.

DzDockArea : getCenterDockArea()

Return Value:

  • The dock area located in the center of the main window.

DzInteractiveLessonMgr : getInteractiveLessonMgr()

Return Value:

  • A pointer to the global interactive lesson manager for the application interface

DzDockArea : getLeftDockArea()

Return Value:

  • The dock area located at the left of the main window.

DzPaneMgr : getPaneMgr()

Return Value:

  • A pointer to the global pane manager for the application interface

DzDockArea : getRightDockArea()

Return Value:

  • The dock area located at the right of the main window.

DzDockArea : getTopDockArea()

Return Value:

  • The dock area located at the top of the main window.

DzUIPopUpWgt : getUIPopUp()

Return Value:

  • the current UI popup or NULL

DzViewportMgr : getViewportMgr()

Return Value:

  • A pointer to the global viewport manager for the application interface

void : goFullScreen()

Switches from normal to full screen mode


Boolean : isUILocked()

Return Value:

  • If the ui is locked.

void : positionUIPopUp( QWidget posWgt )

Position the popup according to a widget.

Parameter(s):

  • posWgt - The widget to position the popup on.

void : removePrompt()

Clear the message in the status bar.


void : repaintActive3DViewport()

A convenience method for forcing a repaint of the currently active 3D viewport (if any).


void : restoreUILockState()

Restores the state of the UI Lock variable to the setting in the registry.


void : setUILocked( Boolean onOff, Boolean storeSetting=true )

Parameter(s):

  • onOff - turn user interface locking on/off

void : showHomeDlg()

Show the Home page dialog.


DzUIPopUpWgt : showUIPopUpWgt( String filename, QWidget posWgt=null )

Parameter(s):

  • filename - The script that loads a .ui, or a .ui, file to show in the UIPopUpWgt.
  • posWgt - The widget to position the popup on.

Return Value:


DzUIPopUpWgt : toggleUIPopUpWgt( String filename, QWidget posWgt=null )

Return Value:

  • The DzUIPopUpWgt that was created. If it was toggled off, then it returns undefined

If a popup already exists with the same filename, it is cleared (toggled). Otherwise it has the same effect as calling DzMainWindow::showUIPopUpWgt()

Parameter(s):

  • filename - The script that loads a .ui, or a .ui, file to show in the UIPopUpWgt.
  • posWgt - The widget to position the popup on.

Signals


void : aboutToClose()

Signature:“aboutToClose()”

Emitted just before the main window closes.


void : alwaysOnTopChanged( Boolean onOff )

Signature:“aboutToClose()”

Emitted when the main window is switched to/from being always on top.


void : started()

Signature:“started()”

Emitted after the startup() function has finished.


void : uiLockedChanged()

Signature:“uiLockedChanged()”

Emitted when the main window is switched to/from having the ui locked.