from lnx.logicnode.lnx_nodes import *


class WriteGifNode(LnxLogicTreeNode):
    """Writes the given image to the given file. If the image
    already exists, the existing content of the image is overwritten.

    Aspect ratio must match display resolution ratio.

    Render2D flag to include render draws.

    @input Image File: the name of the image
    @input Camera: the render target image of the camera to write to the image file.
    @input Width: width of the image file.
    @input Height: heigth of the image file.
    @input sX: sub position of first x pixel of the sub image (0 for start).
    @input sY: sub position of first y pixel of the sub image (0 for start).
    @input sWidth: width of the sub image.
    @input sHeight: height of the sub image.
    @input Render2D: include Render 2D draws.

    @seeNode Read File
    """
    bl_idname = 'LNWriteGifNode'
    bl_label = 'Write Gif'
    lnx_section = 'file'
    lnx_version = 1

    def lnx_init(self, context):
        self.add_input('LnxNodeSocketAction', 'Start')
        self.add_input('LnxNodeSocketAction', 'Stop')
        self.add_input('LnxStringSocket', 'Image File')
        self.add_input('LnxNodeSocketObject', 'Camera')
        self.add_input('LnxIntSocket', 'Width')
        self.add_input('LnxIntSocket', 'Height')
        self.add_input('LnxIntSocket', 'sX')
        self.add_input('LnxIntSocket', 'sY')
        self.add_input('LnxIntSocket', 'sWidth')
        self.add_input('LnxIntSocket', 'sHeight')
        self.add_input('LnxBoolSocket', 'Render2D')
        self.add_input('LnxFloatSocket', 'Frame duration')

        self.add_output('LnxNodeSocketAction', 'Out')