# encoding: utf-8
# module vtkmodules.vtkIOImage
# from C:\Users\xukai\Downloads\发票2\venv\Lib\site-packages\vtkmodules\vtkIOImage.cp311-win_amd64.pyd
# by generator 1.147
# no doc

# imports
import vtkmodules.vtkCommonCore as __vtkmodules_vtkCommonCore
import vtkmodules.vtkCommonExecutionModel as __vtkmodules_vtkCommonExecutionModel


from .vtkImageReader import vtkImageReader

class vtkBMPReader(vtkImageReader):
    """
    vtkBMPReader - read Windows BMP files
    
    Superclass: vtkImageReader
    
    vtkBMPReader is a source object that reads Windows BMP files. This
    includes indexed and 24bit bitmaps Usually, all BMPs are converted to
    24bit RGB, but BMPs may be output as 8bit images with a LookupTable
    if the Allow8BitBMP flag is set.
    
    BMPReader creates structured point datasets. The dimension of the
    dataset depends upon the number of files read. Reading a single file
    results in a 2D image, while reading more than one file results in a
    3D volume.
    
    To read a volume, files must be of the form "FileName.<number>"
    (e.g., foo.bmp.0, foo.bmp.1, ...). You must also specify the image
    range. This range specifies the beginning and ending files to read
    (range can be any pair of non-negative numbers).
    
    The default behavior is to read a single file. In this case, the form
    of the file is simply "FileName" (e.g., foo.bmp).
    
    @sa
    vtkBMPWriter
    """
    def Allow8BitBMPOff(self): # real signature unknown; restored from __doc__
        """
        Allow8BitBMPOff(self) -> None
        C++: virtual void Allow8BitBMPOff()
        """
        pass

    def Allow8BitBMPOn(self): # real signature unknown; restored from __doc__
        """
        Allow8BitBMPOn(self) -> None
        C++: virtual void Allow8BitBMPOn()
        """
        pass

    def CanReadFile(self, fname): # real signature unknown; restored from __doc__
        """
        CanReadFile(self, fname:str) -> int
        C++: int CanReadFile(const char *fname) override;
        
        Is the given file a BMP file?
        """
        return 0

    def GetAllow8BitBMP(self): # real signature unknown; restored from __doc__
        """
        GetAllow8BitBMP(self) -> int
        C++: virtual vtkTypeBool GetAllow8BitBMP()
        """
        return 0

    def GetColors(self): # real signature unknown; restored from __doc__
        """
        GetColors(self) -> Pointer
        C++: virtual unsigned char *GetColors()
        
        Returns the color lut.
        """
        pass

    def GetDepth(self): # real signature unknown; restored from __doc__
        """
        GetDepth(self) -> int
        C++: virtual int GetDepth()
        
        Returns the depth of the BMP, either 8 or 24.
        """
        return 0

    def GetDescriptiveName(self): # real signature unknown; restored from __doc__
        """
        GetDescriptiveName(self) -> str
        C++: const char *GetDescriptiveName() override;
        
        Return a descriptive name for the file format that might be
        useful in a GUI.
        """
        return ""

    def GetFileExtensions(self): # real signature unknown; restored from __doc__
        """
        GetFileExtensions(self) -> str
        C++: const char *GetFileExtensions() override;
        
        Get the file extensions for this format. Returns a string with a
        space separated list of extensions in the format .extension
        """
        return ""

    def GetLookupTable(self): # real signature unknown; restored from __doc__
        """
        GetLookupTable(self) -> vtkLookupTable
        C++: virtual vtkLookupTable *GetLookupTable()
        """
        pass

    def GetNumberOfGenerationsFromBase(self, type): # real signature unknown; restored from __doc__
        """
        GetNumberOfGenerationsFromBase(self, type:str) -> int
        C++: vtkIdType GetNumberOfGenerationsFromBase(const char *type)
            override;
        
        Given the name of a base class of this class type, return the
        distance of inheritance between this class type and the named
        class (how many generations of inheritance are there between this
        class and the named class). If the named class is not in this
        class's inheritance tree, return a negative value. Valid
        responses will always be nonnegative. This method works in
        combination with vtkTypeMacro found in vtkSetGet.h.
        """
        return 0

    def GetNumberOfGenerationsFromBaseType(self, type): # real signature unknown; restored from __doc__
        """
        GetNumberOfGenerationsFromBaseType(type:str) -> int
        C++: static vtkIdType GetNumberOfGenerationsFromBaseType(
            const char *type)
        
        Given a the name of a base class of this class type, return the
        distance of inheritance between this class type and the named
        class (how many generations of inheritance are there between this
        class and the named class). If the named class is not in this
        class's inheritance tree, return a negative value. Valid
        responses will always be nonnegative. This method works in
        combination with vtkTypeMacro found in vtkSetGet.h.
        """
        return 0

    def IsA(self, type): # real signature unknown; restored from __doc__
        """
        IsA(self, type:str) -> int
        C++: vtkTypeBool IsA(const char *type) override;
        
        Return 1 if this class is the same type of (or a subclass of) the
        named class. Returns 0 otherwise. This method works in
        combination with vtkTypeMacro found in vtkSetGet.h.
        """
        return 0

    def IsTypeOf(self, type): # real signature unknown; restored from __doc__
        """
        IsTypeOf(type:str) -> int
        C++: static vtkTypeBool IsTypeOf(const char *type)
        
        Return 1 if this class type is the same type of (or a subclass
        of) the named class. Returns 0 otherwise. This method works in
        combination with vtkTypeMacro found in vtkSetGet.h.
        """
        return 0

    def NewInstance(self): # real signature unknown; restored from __doc__
        """
        NewInstance(self) -> vtkBMPReader
        C++: vtkBMPReader *NewInstance()
        """
        return vtkBMPReader

    def SafeDownCast(self, o): # real signature unknown; restored from __doc__
        """
        SafeDownCast(o:vtkObjectBase) -> vtkBMPReader
        C++: static vtkBMPReader *SafeDownCast(vtkObjectBase *o)
        """
        return vtkBMPReader

    def SetAllow8BitBMP(self, _arg): # real signature unknown; restored from __doc__
        """
        SetAllow8BitBMP(self, _arg:int) -> None
        C++: virtual void SetAllow8BitBMP(vtkTypeBool _arg)
        
        If this flag is set and the BMP reader encounters an 8bit file,
        the data will be kept as unsigned chars and a lookuptable will be
        exported
        """
        pass

    def __delattr__(self, *args, **kwargs): # real signature unknown
        """ Implement delattr(self, name). """
        pass

    def __getattribute__(self, *args, **kwargs): # real signature unknown
        """ Return getattr(self, name). """
        pass

    def __init__(self, *args, **kwargs): # real signature unknown
        pass

    @staticmethod # known case of __new__
    def __new__(*args, **kwargs): # real signature unknown
        """ Create and return a new object.  See help(type) for accurate signature. """
        pass

    def __repr__(self, *args, **kwargs): # real signature unknown
        """ Return repr(self). """
        pass

    def __setattr__(self, *args, **kwargs): # real signature unknown
        """ Implement setattr(self, name, value). """
        pass

    def __str__(self, *args, **kwargs): # real signature unknown
        """ Return str(self). """
        pass

    __this__ = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """Pointer to the C++ object."""


    __dict__ = None # (!) real value is 'mappingproxy({\'__vtkname__\': \'vtkBMPReader\', \'IsTypeOf\': <method \'IsTypeOf\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'IsA\': <method \'IsA\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'SafeDownCast\': <method \'SafeDownCast\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'NewInstance\': <method \'NewInstance\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'GetNumberOfGenerationsFromBaseType\': <method \'GetNumberOfGenerationsFromBaseType\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'GetNumberOfGenerationsFromBase\': <method \'GetNumberOfGenerationsFromBase\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'GetDepth\': <method \'GetDepth\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'CanReadFile\': <method \'CanReadFile\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'GetFileExtensions\': <method \'GetFileExtensions\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'GetDescriptiveName\': <method \'GetDescriptiveName\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'SetAllow8BitBMP\': <method \'SetAllow8BitBMP\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'GetAllow8BitBMP\': <method \'GetAllow8BitBMP\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'Allow8BitBMPOn\': <method \'Allow8BitBMPOn\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'Allow8BitBMPOff\': <method \'Allow8BitBMPOff\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'GetLookupTable\': <method \'GetLookupTable\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'GetColors\': <method \'GetColors\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'__new__\': <built-in method __new__ of type object at 0x00007FF8393B0230>, \'__repr__\': <slot wrapper \'__repr__\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'__str__\': <slot wrapper \'__str__\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'__getattribute__\': <slot wrapper \'__getattribute__\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'__setattr__\': <slot wrapper \'__setattr__\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'__delattr__\': <slot wrapper \'__delattr__\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'__dict__\': <attribute \'__dict__\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'__this__\': <attribute \'__this__\' of \'vtkmodules.vtkIOImage.vtkBMPReader\' objects>, \'__doc__\': \'vtkBMPReader - read Windows BMP files\\n\\nSuperclass: vtkImageReader\\n\\nvtkBMPReader is a source object that reads Windows BMP files. This\\nincludes indexed and 24bit bitmaps Usually, all BMPs are converted to\\n24bit RGB, but BMPs may be output as 8bit images with a LookupTable\\nif the Allow8BitBMP flag is set.\\n\\nBMPReader creates structured point datasets. The dimension of the\\ndataset depends upon the number of files read. Reading a single file\\nresults in a 2D image, while reading more than one file results in a\\n3D volume.\\n\\nTo read a volume, files must be of the form "FileName.<number>"\\n(e.g., foo.bmp.0, foo.bmp.1, ...). You must also specify the image\\nrange. This range specifies the beginning and ending files to read\\n(range can be any pair of non-negative numbers).\\n\\nThe default behavior is to read a single file. In this case, the form\\nof the file is simply "FileName" (e.g., foo.bmp).\\n\\n@sa\\nvtkBMPWriter\\n\\n\'})'
    __vtkname__ = 'vtkBMPReader'


