##########################################################################
#
#  Copyright (c) 2022, Image Engine Design Inc. All rights reserved.
#
#  Redistribution and use in source and binary forms, with or without
#  modification, are permitted provided that the following conditions are
#  met:
#
#      * Redistributions of source code must retain the above
#        copyright notice, this list of conditions and the following
#        disclaimer.
#
#      * Redistributions in binary form must reproduce the above
#        copyright notice, this list of conditions and the following
#        disclaimer in the documentation and/or other materials provided with
#        the distribution.
#
#      * Neither the name of John Haddon nor the names of
#        any other contributors to this software may be used to endorse or
#        promote products derived from this software without specific prior
#        written permission.
#
#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
#  IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
#  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
#  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
#  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
#  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
#  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
#  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
#  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
#  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
#  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
##########################################################################

import Gaffer
import GafferImage

Gaffer.Metadata.registerNode(

	GafferImage.FormatQuery,

	"description",
	"""
	Extracts the format of an input image, for driving the format input of another image node, or
	driving expressions.
	""",
	"layout:section:Settings.Out:collapsed", False,

	plugs = {

		"image" : [

			"description",
			"""
			The image to query.
			""",

		],

		"view" : [

			"description",
			"""
			The view to be queried.
			""",

			"nodule:type", "",
			"plugValueWidget:type", "GafferImageUI.ViewPlugValueWidget",
			"viewPlugValueWidget:allowUseCurrentContext", True,

		],

		"format" : [

			"description",
			"""
			The format of the image ( as a FormatPlug, compatible with inputs on Constant or Resize ).
			""",
			"nodule:type", "GafferUI::CompoundNodule",
			"layout:section", "Settings.Out",

		],
		"format.displayWindow" : [
			"nodule:type", "GafferUI::CompoundNodule",
		],

		"center" : [

			"description",
			"""
			The middle of the displayWindow.  Stored as V2f, since it could be a half-pixel.
			""",
			"layout:section", "Settings.Out",

		],

		"size" : [

			"description",
			"""
			The size of the displayWindow as V2i.
			""",
			"layout:section", "Settings.Out",

		],

	}

)
