Method __init__

python/IECore/BasicPreset.py:72–123

( self, pathOrDataOrParameterised, rootParameter=None, parameters=(), referenceData=False )

	##				copies any parameter values so the preset is not dependent on the source
	##				parameters state at the time of application.
	def __init__( self, pathOrDataOrParameterised, rootParameter=None, parameters=(), referenceData=False ) :

		self._header = None
		self._data = None
		self._cob = None

		IECore.Preset.__init__( self )

		self.parameters().addParameters(

			[
				IECore.BoolParameter(
					name = "overwriteMatchingComponents",
					description = "When off, the preset will always append items to a " + \
					"ClassVectorParameter, otherwise, it will replace the existing " + \
					"classes with the same names, if they don't match the preset. " + \
					"This does not affect and parameter values, these are always set " + \
					"to match the preset.",
					defaultValue = False
				),
			]
		)

		if isinstance( pathOrDataOrParameterised, str ) :

			self._cob = pathOrDataOrParameterised

		elif isinstance( pathOrDataOrParameterised, IECore.CompoundObject ) :

			self._data = pathOrDataOrParameterised

		elif hasattr( pathOrDataOrParameterised, "parameters" ):

			data = IECore.CompoundObject()

			if rootParameter is None:
				rootParameter = pathOrDataOrParameterised.parameters()

			BasicPreset._grabHierarchy( data, rootParameter, parameters )

			# We need to prune any class entries without parameters, so that
			# we don't meddle with classes the user asked us not to copy parameters for.
			BasicPreset._pruneHierarchy( data )

			if referenceData:
				self._data = data
			else:
				self._data = data.copy()

		else :

			raise ValueError( "IECore.BasicPreset.__init__: Unsupported object passed: %s." % pathOrDataOrParameterised )

	## \return a dictionary of metatdata about the preset. BasicPresets
	## provide the following keys, when a preset has been saved to disk.