.. index:: pair: struct; P1::ImageSdk::ValueRange
.. _doxid-struct_p1_1_1_image_sdk_1_1_value_range:

template struct P1::ImageSdk::ValueRange
========================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

A structure defining a minimum, maximum and default values. To be used for numeric properties. :ref:`More...<details-struct_p1_1_1_image_sdk_1_1_value_range>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <P1ImageConvertConfig.hpp>
	
	template <typename T>
	struct ValueRange
	{
		// fields
	
		const T :ref:`minValue<doxid-struct_p1_1_1_image_sdk_1_1_value_range_1aefed7b22eb8246bab807119fe3a2d544>`;
		const T :ref:`maxValue<doxid-struct_p1_1_1_image_sdk_1_1_value_range_1aed261fe66f4460b3a40aa396fe2490fb>`;
		const T :ref:`defaultValue<doxid-struct_p1_1_1_image_sdk_1_1_value_range_1a172231373ee647171512b69868c5529a>`;

		// construction
	
		:ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range_1ab22ec27d54610b1a7daff4344eef0f08>`(T min, T max, T def);

		// methods
	
		T :ref:`TrimmedValue<doxid-struct_p1_1_1_image_sdk_1_1_value_range_1affbf5b9f6677ccddf337d301dc5df46f>`(T input) const;
		bool :ref:`IsDefaultValue<doxid-struct_p1_1_1_image_sdk_1_1_value_range_1ab07fbf704d5e2b36833de19118c17ca9>`(T input) const;
	};
.. _details-struct_p1_1_1_image_sdk_1_1_value_range:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

A structure defining a minimum, maximum and default values. To be used for numeric properties.

Fields
------

.. index:: pair: variable; minValue
.. _doxid-struct_p1_1_1_image_sdk_1_1_value_range_1aefed7b22eb8246bab807119fe3a2d544:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const T minValue

The minimum value.

.. index:: pair: variable; maxValue
.. _doxid-struct_p1_1_1_image_sdk_1_1_value_range_1aed261fe66f4460b3a40aa396fe2490fb:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const T maxValue

The maximum value.

.. index:: pair: variable; defaultValue
.. _doxid-struct_p1_1_1_image_sdk_1_1_value_range_1a172231373ee647171512b69868c5529a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const T defaultValue

The default value.

Construction
------------

.. index:: pair: function; ValueRange
.. _doxid-struct_p1_1_1_image_sdk_1_1_value_range_1ab22ec27d54610b1a7daff4344eef0f08:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	ValueRange(T min, T max, T def)

The constructor.

Methods
-------

.. index:: pair: function; TrimmedValue
.. _doxid-struct_p1_1_1_image_sdk_1_1_value_range_1affbf5b9f6677ccddf337d301dc5df46f:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	T TrimmedValue(T input) const

Return a clamped value of the input.

.. index:: pair: function; IsDefaultValue
.. _doxid-struct_p1_1_1_image_sdk_1_1_value_range_1ab07fbf704d5e2b36833de19118c17ca9:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool IsDefaultValue(T input) const

Return true if the input matches the default value.