HUD.HUD Class Reference

#include <class_h_u_d_1_1_h_u_d.h>

List of all members.

Public Member Functions

  __init__ ()
  cleanup ()
  moveMeasurementData ()
  initialize ()
  setSize ()
  Must be called when the size of the screen changes.
  updateViewerLayout ()
  Must be called when the viewer layout changes.
  setDrawRoot ()
  isMessageVisible ()
  setMessageVisible ()
  isInfoMessageVisible ()
  setInfoMessageVisible ()
  isFramerateVisible ()
  setFramerateVisible ()
  isCoiVisible ()
  setCoiVisible ()
  isSpeedVisible ()
  setSpeedVisible ()
  isStatusVisible ()
  setStatusVisible ()
  isPrepareModelVisible ()
  setPrepareModelVisible ()
  isImportModelVisible ()
  setImportModelVisible ()
  isMeasurementDataVisible ()
  setMeasurementDataVisible ()
  isMeasurementMessageVisible ()
  setMeasurementMessageVisible ()
  setFadeToBlackFPS ()
  setFadeToBlackStartFrame ()
  setFadeToBlackBasename ()
  setFadeToBlackMovieWriter ()
  setFadeToBlackRecordingMode ()
  setFadeToBlackStartTime ()
  startFadeToBlackTransition ()
  stopFadeToBlackTransition ()
  getFrameWidth ()
  Calculate and return width of the background image for the text.
  setMessage ()
  message ()
  setInfoMessage ()
  Sets the text to display as the information message at the center of the screen.
  infoMessage ()
  formatFrameRate ()
  setFramerate ()
  framerate ()
  setSpeed ()
  speed ()
  setStatus ()
  status ()
  setPrepareModel ()
  prepareModel ()
  setImportModel ()
  importModel ()
  getMeasurementDataPos3d ()
  setMeasurementData ()
  measurementData ()
  setMeasurementMessage ()
  measurementMessage ()
  frame ()
  The BusyLabel instances in the HUD need to have their frame() methods called on every application frame event (when they're visible) in order to implement their animation.

Member Function Documentation

HUD.HUD.__init__ ( )
HUD.HUD.cleanup ( )
HUD.HUD.moveMeasurementData ( )
HUD.HUD.initialize ( )
HUD.HUD.setSize ( )

Must be called when the size of the screen changes.

HUD.HUD.updateViewerLayout ( )

Must be called when the viewer layout changes.

Record the new viewer layout and force an update of the HUD.

HUD.HUD.setDrawRoot ( )
HUD.HUD.isMessageVisible ( )
HUD.HUD.setMessageVisible ( )
HUD.HUD.isInfoMessageVisible ( )
HUD.HUD.setInfoMessageVisible ( )
HUD.HUD.isFramerateVisible ( )
HUD.HUD.setFramerateVisible ( )
HUD.HUD.isCoiVisible ( )
HUD.HUD.setCoiVisible ( )
HUD.HUD.isSpeedVisible ( )
HUD.HUD.setSpeedVisible ( )
HUD.HUD.isStatusVisible ( )
HUD.HUD.setStatusVisible ( )
HUD.HUD.isPrepareModelVisible ( )
HUD.HUD.setPrepareModelVisible ( )
HUD.HUD.isImportModelVisible ( )
HUD.HUD.setImportModelVisible ( )
HUD.HUD.isMeasurementDataVisible ( )
HUD.HUD.setMeasurementDataVisible ( )
HUD.HUD.isMeasurementMessageVisible ( )
HUD.HUD.setMeasurementMessageVisible ( )
HUD.HUD.setFadeToBlackFPS ( )
HUD.HUD.setFadeToBlackStartFrame ( )
HUD.HUD.setFadeToBlackBasename ( )
HUD.HUD.setFadeToBlackMovieWriter ( )
HUD.HUD.setFadeToBlackRecordingMode ( )
HUD.HUD.setFadeToBlackStartTime ( )
HUD.HUD.startFadeToBlackTransition ( )
HUD.HUD.stopFadeToBlackTransition ( )
HUD.HUD.getFrameWidth ( )

Calculate and return width of the background image for the text.

HUD.HUD.setMessage ( )
HUD.HUD.message ( )
HUD.HUD.setInfoMessage ( )

Sets the text to display as the information message at the center of the screen.

The message can display on two lines, if there is a newline character embedded in the text.

For instance, if text = 'Warning: Some Message this instead.' will display in the HUD as:

Warning: Some Message Try this instead.

If there is no newline character embedded in the text, then the text will display in a single line.

HUD.HUD.infoMessage ( )
HUD.HUD.formatFrameRate ( )
HUD.HUD.setFramerate ( )
HUD.HUD.framerate ( )
HUD.HUD.setSpeed ( )
HUD.HUD.speed ( )
HUD.HUD.setStatus ( )
HUD.HUD.status ( )
HUD.HUD.setPrepareModel ( )
HUD.HUD.prepareModel ( )
HUD.HUD.setImportModel ( )
HUD.HUD.importModel ( )
HUD.HUD.getMeasurementDataPos3d ( )
HUD.HUD.setMeasurementData ( )
HUD.HUD.measurementData ( )
HUD.HUD.setMeasurementMessage ( )
HUD.HUD.measurementMessage ( )
HUD.HUD.frame ( )

The BusyLabel instances in the HUD need to have their frame() methods called on every application frame event (when they're visible) in order to implement their animation.


HUD.HUD HUD.HUD HUD.HUD HUD.HUD HUD.HUD HUD.HUD HUD.HUD HUD.HUD HUD.HUD HUD.HUD
HUD.HUD HUD.HUD HUD.HUD HUD.HUD HUD.HUD HUD.HUD HUD.HUD HUD.HUD HUD.HUD HUD.HUD