OrsViewAnimator

Manages the 2D animations

author:

Dragonfly Team

contact:

https://dragonfly.comet.tech

email:

support.dragonfly@comet.tech

organization:

Comet Technologies Canada Inc.

address:

460 Ste-Catherine Ouest, suite 600, Montréal, Québec, Canada, H3B 1A7

copyright:

Comet Technologies Canada Inc. All rights reserved 2023.

date:

Dec 26 2016 11:52

dragonflyVersion:

2.1.0.200 (D)

UUID:

ffba6e18761d11e7aac6448a5b5d70c0

Class Code

class OrsPythonPlugins.OrsViewAnimator.OrsViewAnimator.OrsViewAnimator(*args, **kwargs)
classmethod getMainFormClass()

Gets the class of the main form

Returns:

output –

interfacemethod makeMovieWithFilename(viewGenealogicalName: str, box: Box, fps: int, filename: str, quality: int = 7, startFrame: int = None, endFrame: int = None, onTime: bool = False, progress: Progress = None) → str

Makes a movie from the current view

Parameters:

  • viewGenealogicalName (str) – a genealogical name of a scene layout

  • box (ORSModel.ors.Box) – the box

  • fps (int) – the fps

  • filename (str) – the filename

  • quality (int) – the quality

  • startFrame (int) – (optional) the start frame

  • endFrame (int) – (optional) the end frame

  • onTime (bool) – (optional) make Movie done on time axis if True otherwise on slice

  • progress (ORSModel.ors.Progress) – progress object

Returns:

output (str) – errorText: if empty, no error

classmethod saveMovieAsAPNG(view: 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

Anonymize filename:

True

classmethod saveMovieAsGIF(view: 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

Anonymize filename:

True

classmethod saveMovieAsVideoFile(view: 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

Anonymize filename:

True