ScreenShot.py

Go to the documentation of this file.

#
# Copyright 2009, MeVis Medical Solutions AG
#
# The user may use this file in accordance with the license agreement provided with
# the Software or, alternatively, in accordance with the terms contained in a
# written agreement between the user and MeVis Medical Solutions AG.
#
# For further information use the contact form at https://www.mevislab.de/contact
#
 
 
 
# -- system imports ----------------------------------------------------------------------------{{{-
import os
import sys
import traceback
import time
# ----------------------------------------------------------------------------------------------}}}-
 
# -- local imports -----------------------------------------------------------------------------{{{-
import mevis
 
from TestSupport.TestHelper import TestHelper
from . import Base, Fields, Image, Logging
# ----------------------------------------------------------------------------------------------}}}-
 
# -- def createOffscreenScreenShot -------------------------------------------------------------{{{-
 
def createOffscreenScreenShot (SONodeName, filename=None, transparencyType=None, size=None, backgroundColor=None):
  context = TestHelper.getInstance().getHelperContext()
  modOffRend = context.module('oSSOffscreenRender')
  if not modOffRend.field('supported').value:
    Logging.warning('Offscreen rendering is not supported on this hardware. Cannot create screenshot.')
    return None
 
  resultDirectory = Base.getResultDirectory()
 
  # If no filename was given generate one.
  if not filename:
    i = 0
    filename = os.path.join(resultDirectory, "Screenshot_%03d.png")
    while os.path.isfile(filename % (i)):
      i += 1
    path = filename % (i)
  else:
    path = os.path.join(resultDirectory, filename)
 
  if os.path.isfile(path):
    Logging.error("File with name %s already exists!" % (path))
    return None
 
  changeSet = Fields.ChangeSet(context=context)
  if transparencyType:
    changeSet.setFieldValue("oSSOffscreenRender.transparencyType", transparencyType)
  if size:
    changeSet.setFieldValue("oSSOffscreenRender.size", size)
  if backgroundColor:
    changeSet.setFieldValue("oSSOffscreenRender.bgColor", backgroundColor)
 
  modImgSave = context.module('oSSImgSave')
 
  modOffRend.field("sceneGraph").connectFrom(Base.getTestCaseContext().field(SONodeName))
  mevis.MLAB.processInventorQueue()
  modOffRend.field("update").touch()
  if not modOffRend.field('output0').isValid():
    Logging.error('Creation of screenshot failed.')
    return None
 
  modImgSave.field("format").value = "PNG"
  modImgSave.field('filename').value = path
  modImgSave.field('save').touch()
 
  return path
# ----------------------------------------------------------------------------------------------}}}-
 
# -- def createScreenShot ----------------------------------------------------------------------{{{-
 
def createScreenShot (window, filename):
  helperModule = TestHelper.getInstance().getHelperContext()
 
  pathname = Base.getResultDirectory()
 
  if not window:
    Logging.error("ScreenShot failed (no window available)")
    return
 
  tabview = window.getTabViewControl()
  if tabview == None:
    return
 
  window.raiseWindow()
  window.updateFrame()
  
  for i in range(10):
    time.sleep(0.002)
    mevis.MLAB.processEvents(True)
 
  imgList = []
  for i in range(0, tabview.countTabs()):
    tabview.selectTabAtIndex(i)
 
    mevis.MLAB.priv().repaintWidget(tabview.widget())
 
    imgName = os.path.join(pathname, filename+"."+str(i)+".png")
 
    if not window.createScreenshot(imgName):
      Logging.warning("ScreenShot failed")
    else:
      imgList.append(imgName)
  return imgList
# ----------------------------------------------------------------------------------------------}}}-
 
# -- def createScreenShot ----------------------------------------------------------------------{{{-
 
def canCreateScreenshot():
  context = TestHelper.getInstance().getHelperContext()  
  return context.field('oSSOffscreenRender.supported').value
 
# ----------------------------------------------------------------------------------------------}}}-