Cortex  10.0.0-a4
Public Member Functions | List of all members
IECore.RelativePreset Class Reference

Implements a Preset that represents changes between two Parameter objects. More...

+ Inheritance diagram for IECore.RelativePreset:

Public Member Functions

def __init__
 
def applicableTo (self, parameterised, rootParameter)
 
def getDiffData (self)
 
def setDiffData (self, data)
 
def __call__ (self, parameterised, rootParameter)
 
- Public Member Functions inherited from IECore.Preset
def __init__
 
def metadata (self)
 
def applicableTo (self, parameterised, rootParameter)
 
def __call__ (self, parameterised, rootParameter)
 Applies the preset to the specified parameterised and root parameter. More...
 
- Public Member Functions inherited from IECore::Parameterised
 IE_CORE_DECLARERUNTIMETYPED (Parameterised, RunTimeTyped)
 
 Parameterised (const std::string &description)
 
 Parameterised (const std::string &description, CompoundParameterPtr compoundParameter)
 Another constructor added later on that gives defines the CompoundParameter object to be hold in this Parameterised instance.
 
const std::string & description () const
 Returns a description for this parameterised object.
 
CompoundParameterparameters () override
 
const CompoundParameterparameters () const override
 Returns the parameters for query.
 
CompoundObjectuserData ()
 Returns an object that anyone can use for storing anything.
 
const CompoundObjectuserData () const
 Read only version of the above.
 
- Public Member Functions inherited from IECore::RunTimeTyped
 IE_CORE_DECLAREMEMBERPTR (RunTimeTyped)
 
virtual TypeId typeId () const
 
virtual const char * typeName () const
 
virtual bool isInstanceOf (TypeId typeId) const
 
virtual bool isInstanceOf (const char *typeName) const
 
- Public Member Functions inherited from IECore::RefCounted
 IE_CORE_DECLAREMEMBERPTR (RefCounted)
 
void addRef () const
 Add a reference to the current object.
 
void removeRef () const
 Remove a reference from the current object.
 
RefCount refCount () const
 Returns the current reference count.
 

Additional Inherited Members

- Public Types inherited from IECore::RunTimeTyped
typedef RefCounted BaseClass
 A typedef for the class this class derives from. All RunTimeTyped classes define this typedef.
 
- Public Types inherited from IECore::RefCounted
typedef size_t RefCount
 
- Static Public Member Functions inherited from IECore::RunTimeTyped
static TypeId staticTypeId ()
 Returns the TypeId for this class, without needing an instance.
 
static const char * staticTypeName ()
 Returns the type name for this class, without needing an instance.
 
static TypeId baseTypeId ()
 
static const char * baseTypeName ()
 
static bool inheritsFrom (TypeId typeId)
 Returns true if this class inherits from the specified type.
 
static bool inheritsFrom (const char *typeName)
 Returns true if this class inherits from the specified type.
 
static bool inheritsFrom (TypeId type, TypeId baseType)
 Returns true if type inherits from baseType.
 
static bool inheritsFrom (const char *typeName, const char *baseTypeName)
 Returns true if typeName inherits from baseTypeName.
 
static TypeId baseTypeId (TypeId typeId)
 Returns the base type of the given type, or InvalidTypeId if no such base exists.
 
static const std::vector< TypeId > & baseTypeIds (TypeId typeId)
 
static const std::set< TypeId > & derivedTypeIds (TypeId typeId)
 
static TypeId typeIdFromTypeName (const char *typeName)
 
static const char * typeNameFromTypeId (TypeId typeId)
 
static void registerType (TypeId derivedTypeId, const char *derivedTypeName, TypeId baseTypeId)
 Allows external modules to register their own type ids.
 
- Protected Types inherited from IECore::RunTimeTyped
typedef std::map< TypeId, TypeIdBaseTypeRegistryMap
 
typedef std::map< TypeId, std::vector< TypeId > > BaseTypesRegistryMap
 
typedef std::map< TypeId, std::set< TypeId > > DerivedTypesRegistryMap
 
typedef tbb::spin_rw_mutex Mutex
 
typedef std::map< TypeId, std::string > TypeIdsToTypeNamesMap
 
typedef std::map< std::string, TypeIdTypeNamesToTypeIdsMap
 
- Static Protected Member Functions inherited from IECore::RunTimeTyped
static BaseTypeRegistryMap & baseTypeRegistry ()
 
static DerivedTypesRegistryMap & derivedTypesRegistry ()
 
static BaseTypesRegistryMap & completeBaseTypesRegistry ()
 
static DerivedTypesRegistryMap & completeDerivedTypesRegistry ()
 
static void derivedTypeIdsWalk (TypeId typeId, std::set< TypeId > &)
 
static TypeIdsToTypeNamesMap & typeIdsToTypeNames ()
 
static TypeNamesToTypeIdsMap & typeNamesToTypeIds ()
 
- Static Protected Attributes inherited from IECore::RunTimeTyped
static Mutex g_baseTypeIdsMutex
 
static Mutex g_derivedTypeIdsMutex
 

Detailed Description

Implements a Preset that represents changes between two Parameter objects.

The comparison on elements in a ClassVectorParameters takes in consideration both the parameter name and the loaded class name in order to consider the "same" element. We do that do try to work around the fact that the parameter names ("p0", "p1", etc) are very simple and easy to reapper after a sequence of removal/addition operations in a ClassVectorParameter. The method is not 100% safe but should work for most cases.

Todo:
Consider adding a protected member that is responsible for that comparison and enable derived classes to do other kinds of comparisons, for example, using additional parameters such as user labels.

Constructor & Destructor Documentation

def IECore.RelativePreset.__init__ (   self,
  currParameter = None,
  oldParameter = None,
  compareFilter = None 
)
Parameters
currParameter,IECore.Parameter,representsthe parameter state after all changes have been made.
oldParameter,IECore.Parameter,representsthe parameter state before any changes.
compareFilter,callablefunction that receives currParameter and oldParameter child and it should return a boolean to indicate if the difference should be computed or not.

References IECore.RelativePreset.__compareFilter, IECore.RelativePreset.__data, and IECore.RelativePreset.__grabParameterChanges().

Member Function Documentation

def IECore.RelativePreset.__call__ (   self,
  parameterised,
  rootParameter 
)
See also
IECore.Preset.__call__

References IECore.RelativePreset.__applyParameterChanges(), IECore.RelativePreset.__compareFilter, IECore.RelativePreset.__data, IECore.RelativePreset.__grabClassParameterChanges(), IECore.RelativePreset.__grabClassVectorParameterChanges(), IECore.RelativePreset.__grabCompoundParameterChanges(), IECore.RelativePreset.__grabParameterChanges(), IECore.RelativePreset.__grabSimpleParameterChanges(), IECore.Preset.applicableTo(), IECore::Parameterised.parameters(), and IECore.registerRunTimeTyped().

def IECore.RelativePreset.applicableTo (   self,
  parameterised,
  rootParameter 
)
See also
IECore.Preset.applicableTo

References IECore.RelativePreset.__data.

def IECore.RelativePreset.getDiffData (   self)
Returns a IECore.CompoundObject instance that contains the description of all the differences between the two parameters provided when creating this preset.
def IECore.RelativePreset.setDiffData (   self,
  data 
)
Use this function to recreate a RelativePreset from data previously returned by getDiffData().

References IECore.RelativePreset.__data.


The documentation for this class was generated from the following file: