pytecplot 1.5.2__py3-none-any.whl

tecplot/export/export_setup.py

@@ -0,0 +1,318 @@
+from builtins import int, str, super
+
+import platform
+import warnings
+
+from ..tecutil import sv
+from ..exception import *
+from ..constant import *
+from .. import session, tecutil, version
+
+
+class EPSPreviewExportSetup(session.Style):
+    def __init__(self):
+        super().__init__(sv.EXPORTSETUP, sv.EPSPREVIEWIMAGE)
+
+    def reset(self):
+        self.type = EPSPreviewImage.TIFF
+        self.width = 128
+        self.height = 128
+        self.gray_scale_depth = 0
+
+    @property
+    def type(self):
+        return self._get_style(EPSPreviewImage, sv.IMAGETYPE)
+
+    @type.setter
+    def type(self, value):
+        if value is not None:
+            self._set_style(EPSPreviewImage(value), sv.IMAGETYPE)
+
+    @property
+    def width(self):
+        return self._get_style(int, sv.IMAGEWIDTH)
+
+    @width.setter
+    def width(self, value):
+        if value is not None:
+            self._set_style(int(value), sv.IMAGEWIDTH)
+
+    @property
+    def height(self):
+        return self._get_style(int, sv.IMAGEHEIGHT)
+
+    @height.setter
+    def height(self, value):
+        if value is not None:
+            self._set_style(int(value), sv.IMAGEHEIGHT)
+
+    @property
+    def gray_scale_depth(self):
+        return self._get_style(int, sv.GRAYSCALEDEPTH)
+
+    @gray_scale_depth.setter
+    def gray_scale_depth(self, value):
+        if value is not None:
+            value = int(value)
+            if __debug__:
+                value_choices = (0, 1, 4, 8)
+                if value not in value_choices:
+                    raise TecplotLogicError(
+                        'Gray scale depth must be one of: ' +
+                        ', '.join(str(x) for x in value_choices))
+            self._set_style(int(value), sv.GRAYSCALEDEPTH)
+
+
+class ExportSetup(session.Style):
+    def __init__(self):
+        super().__init__(sv.EXPORTSETUP)
+
+    def reset(self):
+        # self.filename = None
+        # self.format = None
+        self.animation_speed = 10
+        self.convert_to_256_colors = False
+        self.gray_scale_depth = 8
+        self.jpeg_encoding = JPEGEncoding.Standard
+        self.multiple_color_tables = False
+        self.quality = 75
+        self.region = ExportRegion.AllFrames
+        self.render_type = PrintRenderType.Vector
+        self.supersample = 3
+        self.tiff_byte_order = TIFFByteOrder.Intel
+        self.width = 800
+        if version.sdk_version_info < (2021, 2):
+            if platform.system() == 'Windows':
+                self.avi_compression = AVICompression.ColorPreserving
+            else:
+                self.avi_compression = AVICompression.LinePreserving
+        else:
+            self.avi_format_options = '-vcodec mjpeg -q:v 5'
+
+        self.mpeg_format_options = '-c:v libx264 -profile:v high -crf 20 -pix_fmt yuv420p'
+        self.wmv_format_options = '-qscale 4'
+
+        self.flash_compression = FlashCompressionType.BestSpeed
+        self.flash_image_type = FlashImageType.Lossless
+
+        self.preview_image.reset()
+
+    @property
+    def preview_image(self):
+        return EPSPreviewExportSetup()
+
+    @property
+    def animation_speed(self):
+        return self._get_style(float, sv.ANIMATIONSPEED)
+
+    @animation_speed.setter
+    def animation_speed(self, value):
+        if value is not None:
+            self._set_style(float(value), sv.ANIMATIONSPEED)
+
+    @property
+    def avi_compression(self):
+        if version.sdk_version_info < (2021, 2):
+            return self._get_style(AVICompression, sv.AVICOMPRESSION)
+        else:
+            if __debug__:
+                msg = 'Compression option no longer supported for AVI'
+                msg += ' animations since ffmpeg is now used to assemble'
+                msg += ' AVI movies. Use the avi_format_options property'
+                msg += ' instead.'
+                warnings.warn(msg, TecplotDeprecationWarning)
+            return AVICompression.LinePreserving
+
+    @avi_compression.setter
+    def avi_compression(self, value):
+        if value is not None:
+            if version.sdk_version_info < (2021, 2):
+                self._set_style(AVICompression(value), sv.AVICOMPRESSION)
+            else:
+                if __debug__:
+                    msg = 'Compression option no longer supported for AVI'
+                    msg += ' animations since ffmpeg is now used to assemble'
+                    msg += ' AVI movies. Use the avi_format_options property'
+                    msg += ' instead.'
+                    warnings.warn(msg, TecplotDeprecationWarning)
+
+    @property
+    def convert_to_256_colors(self):
+        return self._get_style(bool, sv.CONVERTTO256COLORS)
+
+    @convert_to_256_colors.setter
+    def convert_to_256_colors(self, value):
+        if value is not None:
+            self._set_style(bool(value), sv.CONVERTTO256COLORS)
+
+    @property
+    def filename(self):
+        return self._get_style(str, sv.EXPORTFNAME)
+
+    @filename.setter
+    def filename(self, value):
+        if value is not None:
+            self._set_style(str(tecutil.normalize_path(value)), sv.EXPORTFNAME)
+
+    @property
+    def flash_compression(self):
+        return self._get_style(FlashCompressionType, sv.FLASHCOMPRESSIONTYPE)
+
+    @flash_compression.setter
+    def flash_compression(self, value):
+        if value is not None:
+            self._set_style(FlashCompressionType(value),
+                            sv.FLASHCOMPRESSIONTYPE)
+
+    @property
+    def flash_image_type(self):
+        return self._get_style(FlashImageType, sv.FLASHIMAGETYPE)
+
+    @flash_image_type.setter
+    def flash_image_type(self, value):
+        if value is not None:
+            self._set_style(FlashImageType(value), sv.FLASHIMAGETYPE)
+
+    @property
+    def format(self):
+        return self._get_style(ExportFormat, sv.EXPORTFORMAT)
+
+    @format.setter
+    def format(self, value):
+        self._set_style(ExportFormat(value), sv.EXPORTFORMAT)
+
+    @property
+    def gray_scale_depth(self):
+        return self._get_style(int, sv.GRAYSCALEDEPTH)
+
+    @gray_scale_depth.setter
+    def gray_scale_depth(self, value):
+        if value is not None:
+            value = int(value)
+            if __debug__:
+                value_choices = (0, 1, 4, 8)
+                if value not in value_choices:
+                    raise TecplotLogicError(
+                        'Gray scale depth must be one of: ' +
+                        ', '.join(str(x) for x in value_choices))
+            self._set_style(int(value), sv.GRAYSCALEDEPTH)
+
+    @property
+    def jpeg_encoding(self):
+        return self._get_style(JPEGEncoding, sv.JPEGENCODING)
+
+    @jpeg_encoding.setter
+    def jpeg_encoding(self, value):
+        if value is not None:
+            self._set_style(JPEGEncoding(value), sv.JPEGENCODING)
+
+    @property
+    def avi_format_options(self):
+        if __debug__:
+            if version.sdk_version_info < (2021, 2):
+                msg = 'AVI format options requires Tecplot 360' + \
+                      ' version 2021 R2 or later.'
+                raise TecplotOutOfDateEngineError((2021, 2), msg)
+        return self._get_style(str, sv.AVIFORMATOPTIONS)
+
+    @avi_format_options.setter
+    def avi_format_options(self, value):
+        if __debug__:
+            if version.sdk_version_info < (2021, 2):
+                msg = 'AVI format options requires Tecplot 360' + \
+                      ' version 2021 R2 or later.'
+                raise TecplotOutOfDateEngineError((2021, 2), msg)
+        if value is not None:
+            self._set_style(str(value), sv.AVIFORMATOPTIONS)
+
+    @property
+    def mpeg_format_options(self):
+        return self._get_style(str, sv.MPEGFORMATOPTIONS)
+
+    @mpeg_format_options.setter
+    def mpeg_format_options(self, value):
+        if value is not None:
+            self._set_style(str(value), sv.MPEGFORMATOPTIONS)
+
+    @property
+    def multiple_color_tables(self):
+        return self._get_style(bool, sv.USEMULTIPLECOLORTABLES)
+
+    @multiple_color_tables.setter
+    def multiple_color_tables(self, value):
+        if value is not None:
+            self._set_style(bool(value), sv.USEMULTIPLECOLORTABLES)
+
+    @property
+    def quality(self):
+        return self._get_style(float, sv.QUALITY)
+
+    @quality.setter
+    def quality(self, value):
+        if value is not None:
+            self._set_style(float(value), sv.QUALITY)
+    @property
+    def region(self):
+        return self._get_style(ExportRegion, sv.EXPORTREGION)
+
+    @region.setter
+    def region(self, value):
+        if value is not None:
+            self._set_style(ExportRegion(value), sv.EXPORTREGION)
+
+    @property
+    def render_type(self):
+        return self._get_style(PrintRenderType, sv.PRINTRENDERTYPE)
+
+    @render_type.setter
+    def render_type(self, value):
+        if value is not None:
+            self._set_style(PrintRenderType(value), sv.PRINTRENDERTYPE)
+
+    @property
+    def supersample(self):
+        if not self._get_style(bool, sv.USESUPERSAMPLEANTIALIASING):
+            return 1
+        else:
+            return self._get_style(int, sv.SUPERSAMPLEFACTOR)
+
+    @supersample.setter
+    def supersample(self, value):
+        if value is not None:
+            if __debug__:
+                if not (1 <= value <= 16):
+                    msg = 'supersample must be between 1 and 16'
+                    raise TecplotLogicError(msg)
+            if value < 2:
+                self._set_style(False, sv.USESUPERSAMPLEANTIALIASING)
+            else:
+                self._set_style(True, sv.USESUPERSAMPLEANTIALIASING)
+                self._set_style(int(value), sv.SUPERSAMPLEFACTOR)
+
+    @property
+    def tiff_byte_order(self):
+        return self._get_style(TIFFByteOrder, sv.TIFFBYTEORDER)
+
+    @tiff_byte_order.setter
+    def tiff_byte_order(self, value):
+        if value is not None:
+            self._set_style(TIFFByteOrder(value), sv.TIFFBYTEORDER)
+
+    @property
+    def width(self):
+        return self._get_style(int, sv.IMAGEWIDTH)
+
+    @width.setter
+    def width(self, value):
+        if value is not None:
+            self._set_style(int(value), sv.IMAGEWIDTH,
+                            assignmodifier=AssignOp.Equals)
+
+    @property
+    def wmv_format_options(self):
+        return self._get_style(str, sv.WMVFORMATOPTIONS)
+
+    @wmv_format_options.setter
+    def wmv_format_options(self, value):
+        if value is not None:
+            self._set_style(str(value), sv.WMVFORMATOPTIONS)