RasterLayerProperties
=====================

.. currentmodule:: axioma.render

.. class:: RasterLayerProperties

	Свойства растрового слоя

	Унаследован от: :class:`LayerProperties`

		.. py:method:: RasterLayerProperties()

			Конструктор со значениями по-умолчанию

		.. py:method:: RasterLayerProperties(other)

			Копирующий конструктор

			:param other: Исходный объект RasterLayerProperties, на базе которого необходимо сделать копию.
			:type other: :class:`RasterLayerProperties`

		.. py:method:: brightness()

			Установленная яркость слоя

			:return: Значение в интервале от MinBrightnessContrastValue до MaxBrightnessContrastValue
			:rtype: :class:`int`

		.. py:method:: setBrightness(value)

			Метод, позволяющий установить яркость растрового слоя

			:param  value: Значение в интервале от MinBrightnessContrastValue до MaxBrightnessContrastValue
			:type value: :class:`int`

		.. py:method:: contrast()

			Метод, позволяющий получить величину контраста растрового слоя

			:return: Значение в интервале от MinBrightnessContrastValue до MaxBrightnessContrastValue
			:rtype: :class:`int`

		.. py:method:: setContrast(value)

			Метод, позволяющий установить контрастность растрового слоя

			:param  value: Уровень контраста в интервале от MinBrightnessContrastValue до MaxBrightnessContrastValue
			:type value: :class:`int`

		.. py:method:: grayscale()

			Метод, позволяющий определить отображается ли растровый слоя в оттенках серого

			:return: True, если растровый слой отображается в оттенках серого. В противном случае False
			:rtype: :class:`bool`
			
		.. py:method:: setGrayscale(value)

			Метод, позволяющий установить метод отображения растрового слоя в оттенках серого

			:param  value: Отображать ли растровый слоя в оттенках серого
			:type value: :class:`bool`
			
		.. py:method:: useTransparentColor()

			Метод, позволяющий определить, используется ли определенный цвет как прозрачный

			:return: True, если да. В противном случае False
			:rtype: :class:`bool`

		.. py:method:: setUseTransparentColor(value)

			Метод, позволяющий использовать определенный цвет, как прозрачный

			:param  value: Цвет, используемый как прозрачный
			:type value: :class:`bool`

		.. py:method:: transparentColor()

			Метод, позволяющий получить цвет, используемый как прозрачный

			:return: Цвет, используемый как прозрачный  (Rgb значение)
			:rtype: :class:`int`

		.. py:method:: setTransparentColor(color)

			Метод, позволяющий установить определенный цвет, как прозрачный

			:param  color: Цвет, используемый как прозрачный (Rgb значение)
			:type color: :class:`int`

		.. py:method:: showUniformly()

			Метод, позволяющий определить единообразие свойства растрового слоя.

			:return: True, если растровый слой будет отображаться с установленными параметрами яркости, контрастности, использования оттенков серого и прозрачного цвета. False - свойства не будут применены к слою и он будет отображаться со своими оригинальными данными
			:rtype: :class:`bool`
	
		.. py:method:: setShowUniformly(value)

			Метод, позволяющий установить единообразные свойства.

			:param  value: В случае включения данного свойства, растровый слой будет отображаться с установленными параметрами яркости, контрастности, использования оттенков серого и прозрачного цвета.
			:type value: :class:`bool`

		.. py:method:: imageOpacity()

			Метод, позволяющий получить прозрачность растрового изображения

			:return: Прозрачность растрового изображения
			:rtype: :class:`int`
	
		.. py:method:: setImageOpacity(value)

			Метод, позволяющий установить прозрачность растрового изображения

			:param  value: Прозрачность растрового изображения в интервале от MinOpacityValue до MaxOpacityValue
			:type value: :class:`int`
	
		.. py:method:: isDefault()

			Метод, позволяющий определить являются настройки растрового слоя настройками по умолчанию.  Данные настройки являются настройками по умолчанию. При создании объекта с использованием конструктора по умолчанию, данная функция возвращает True

					.. csv-table:: В таблице представлены данные, при которых функции возвратит True:
						:header: "Характеристика", "Значение по умолчанию"

						Яркость, 0
						Контраст, 0
						Прозрачность изображения, 100
						Использовать оттенки серого, False
						Использовать прозрачный цвет, False
						Единообразные свойства, False

			:return: Результат
			:rtype: :class:`bool`
	
		.. csv-table:: Предопределенные константы
				:header: "Наименование величины", "Значение", "Описание"

				MinBrightnessContrastValue, -126, "Минимальная яркость"
				MaxBrightnessContrastValue, 127, "Максимальная яркость"
				MinOpacityValue, 0, "Минимальная прозрачность"
				MaxOpacityValue, 100, "Максимальная прозрачность"