OrsViewAnimator

Manages the 2D animations

author:ORS Team
contact:http://theobjects.com
email:info@theobjects.com
organization:Object Research Systems (ORS), Inc.
address:460 Ste-Catherine Ouest, suite 600, Montréal, Québec, Canada, H3B 1A7
copyright:Object Research Systems (ORS), Inc. All rights reserved 2021.
date:Dec 26 2016 11:52
dragonflyVersion:
 2.1.0.200 (D)
UUID:ffba6e18761d11e7aac6448a5b5d70c0

Class Code

class OrsPythonPlugins.OrsViewAnimator.OrsViewAnimator.OrsViewAnimator(varname=None)
SLICE_ANIMATION = 0
TIME_ANIMATION = 1
UIDescriptors = [<ORSServiceClass.OrsPlugin.uidescriptor.UIDescriptor object>]
allow2DAnimation()
exportAnimation()
getAnimationType()
getCurrentIndex()
getIsAnimationOnTimeAxis()
getKeyForViewAndAnimation(view: ORSModel.ors.View)
getLargestFPS()
classmethod getMainFormClass()

Gets the class of the main form

Returns:output –
getRangeEnabled(view: ORSModel.ors.View)
getSliceBoundaries(view: ORSModel.ors.View)
getViewActive(view: ORSModel.ors.View)
getViewFps(view: ORSModel.ors.View)
getViewInteractorCount()
getViewReverse(view: ORSModel.ors.View)
keepAlive = False
classmethod makeMovie(view: ORSModel.ors.View, box, fps, startFrame, endFrame, onTime)
classmethod makeMovieWithFilename(view: ORSModel.ors.View, box, fps, filename, quality=7, startFrame=None, endFrame=None, onTime=False)
multiple = False
orsCurrentDisplayChange()
orsSelectedObjectsChanged()
processAllInteractors()
resetBoundary(view: ORSModel.ors.View)
savable = True
interfacemethod saveMovieAsAPNG(view: ORSModel.ors.View, box, fps, filename, outXSize, outYSize, reverse, progress, startFrame, endFrame, onTime=False)

Save a view as an animated png (.png)

Changed in version Adding: onTime argument

Parameters:
  • view (ORSModel.ors.View) – the view to extract
  • box (ORSModel.ors.Box) –
  • fps (int) – frame rate
  • filename (file saving) – fully qualified file name
  • outXSize (int) – The size in X of the output
  • outYSize (int) – The size in Y of the output
  • reverse (bool) – Will start from the endFrame while in reverse
  • progress (ORSModel.ors.Progress) – an optional progress object (a Progress)
  • startFrame (int) – Frame to Start at.
  • endFrame (int) – Frame to End at.
  • onTime (bool) – Movie done on time axis if True otherwise on slice
interfacemethod saveMovieAsGIF(view: ORSModel.ors.View, box, fps, filename, outXSize, outYSize, reverse, progress, startFrame, endFrame, onTime=False)

Save a view in the Graphics Interchange Format (.gif)

Changed in version Adding: onTime argument

Parameters:
  • view (ORSModel.ors.View) – the view to extract
  • box (ORSModel.ors.Box) –
  • fps (int) – frame rate
  • filename (file saving) – fully qualified file name
  • outXSize (int) – The size in X of the output
  • outYSize (int) – The size in Y of the output
  • reverse (bool) – Will start from the endFrame while in reverse
  • progress (ORSModel.ors.Progress) – an optional progress object (a Progress)
  • startFrame (int) – Frame to Start at.
  • endFrame (int) – Frame to End at.
  • onTime (bool) – Movie done on time axis if True otherwise on slice
interfacemethod saveMovieAsVideoFile(view: ORSModel.ors.View, box, fps, filename, outXSize, outYSize, reverse, progress, quality, startFrame, endFrame, onTime=False)

Save a view as a video file.

Changed in version Adding: onTime argument

Parameters:
  • view (ORSModel.ors.View) – the view to extract
  • box (ORSModel.ors.Box) –
  • fps (int) – frame rate
  • filename (file saving) – fully qualified file name
  • outXSize (int) – The size in X of the output
  • outYSize (int) – The size in Y of the output
  • reverse (bool) – Will start from the endFrame while in reverse
  • progress (ORSModel.ors.Progress) – an optional progress object (a Progress)
  • quality (int) – Quality of the movie
  • startFrame (int) – Frame to Start at.
  • endFrame (int) – Frame to End at.
  • onTime (bool) – Movie done on time axis if True otherwise on slice
setAnimationType(animationType)
setMaximumIndex(view: ORSModel.ors.View, value: int)
setMinimumIndex(view: ORSModel.ors.View, value: int)
setRangeEnabled(view: ORSModel.ors.View, value: bool)
setSliceBoundaries(view: ORSModel.ors.View, start, end)
setViewFps(view: ORSModel.ors.View, fps: float)
startStopAnimation()
startStopAnimationAction()
viewStart(view: ORSModel.ors.View, fps, currentIndex=0)
viewStop(view: ORSModel.ors.View)