##########################################################################
#
#  Copyright (c) 2008-2011, 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 Image Engine Design 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.
#
##########################################################################

from FnParameterisedHolder import FnParameterisedHolder

import maya.cmds

class FnOpHolder( FnParameterisedHolder ) :

	def __init__( self, objectOrObjectName ) :

		FnParameterisedHolder.__init__( self, objectOrObjectName )

	## Creates a new node holding a new instance of the op of the specified
	# type and version. Returns an FnOpHolder instance attached to this node.
	@staticmethod
	def create( nodeName, opType, opVersion=None ) :

		holder = maya.cmds.createNode( "ieOpHolderNode", name=nodeName, skipSelect=True )

		fnOH = FnOpHolder( holder )
		# not asking for undo, as this way we end up with a single undo action which will
		# delete the node. otherwise we get two undo actions, one to revert the setParameterised()
		# one to revert the createNode().
		fnOH.setOp( opType, opVersion, undoable=False )

		return fnOH

	## Convenience function which calls setParameterised( opType, opVersion, "IECORE_OP_PATHS" )
	def setOp( self, opType, opVersion=None, undoable=True ) :

		self.setParameterised( opType, opVersion, "IECORE_OP_PATHS", undoable )

	## Convenience function which returns getParameterised()[0]
	def getOp( self ) :

		return self.getParameterised()[0]


	## Returns the maya node type that this function set operates on
	@classmethod
	def _mayaNodeType( cls ):

		return "ieOpHolderNode"
