Cortex  10.0.0-a4
Classes | Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | List of all members
IECoreMaya::FromMayaObjectConverter Class Referenceabstract

#include <FromMayaObjectConverter.h>

+ Inheritance diagram for IECoreMaya::FromMayaObjectConverter:

Classes

class  FromMayaObjectConverterDescription
 

Public Member Functions

 IE_CORE_DECLARERUNTIMETYPEDEXTENSION (FromMayaObjectConverter, FromMayaObjectConverterTypeId, FromMayaConverter)
 
const MObject & object () const
 
bool objectIsAlive () const
 
Parameters

Parameters which affect the conversion process.

IECore::StringParameterPtr blindDataAttrPrefixParameter ()
 
IECore::ConstStringParameterPtr blindDataAttrPrefixParameter () const
 
IECore::BoolParameterPtr blindDataRemoveNamespaceParameter ()
 
IECore::ConstBoolParameterPtr blindDataRemoveNamespaceParameter () const
 
- Public Member Functions inherited from IECoreMaya::FromMayaConverter
 IE_CORE_DECLARERUNTIMETYPEDEXTENSION (FromMayaConverter, FromMayaConverterTypeId, IECore::ToCoreConverter)
 
- Public Member Functions inherited from IECore::ToCoreConverter
 IE_CORE_DECLARERUNTIMETYPED (ToCoreConverter, Converter)
 
IECore::ObjectPtr convert () const
 
- Public Member Functions inherited from IECore::Converter
 IE_CORE_DECLARERUNTIMETYPED (Converter, Parameterised)
 
- 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.
 

Static Public Member Functions

Factory
static FromMayaObjectConverterPtr create (const MObject &object, IECore::TypeId resultType=IECore::InvalidTypeId)
 
- 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

typedef FromMayaObjectConverterPtr(* CreatorFn) (const MObject &object)
 
- 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
 

Protected Member Functions

 FromMayaObjectConverter (const std::string &description, const MObject &object)
 
virtual IECore::ObjectPtr doConversion (IECore::ConstCompoundObjectPtr operands) const
 
virtual IECore::ObjectPtr doConversion (const MObject &object, IECore::ConstCompoundObjectPtr operands) const =0
 
- Protected Member Functions inherited from IECoreMaya::FromMayaConverter
 FromMayaConverter (const std::string &description)
 
- Protected Member Functions inherited from IECore::ToCoreConverter
 ToCoreConverter (const std::string &description)
 
- Protected Member Functions inherited from IECore::Converter
 Converter (const std::string &description)
 

Static Protected Member Functions

static void registerConverter (const MFn::Type fromType, IECore::TypeId resultType, bool defaultConversion, CreatorFn creator)
 
- 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 ()
 

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 Protected Attributes inherited from IECore::RunTimeTyped
static Mutex g_baseTypeIdsMutex
 
static Mutex g_derivedTypeIdsMutex
 

Detailed Description

The FromMayaConverter class forms an abstract base class for all classes able to perform some kind of conversion from a Maya datatype to an IECore datatype.

Member Function Documentation

static FromMayaObjectConverterPtr IECoreMaya::FromMayaObjectConverter::create ( const MObject &  object,
IECore::TypeId  resultType = IECore::InvalidTypeId 
)
static

Creates a converter which will convert the given object to an IECore::Object. If resultType is specified then only converters which create objects of that type will be returned - the default value allows any suitable converter to be created. If no matching converters exist then returns 0.

virtual IECore::ObjectPtr IECoreMaya::FromMayaObjectConverter::doConversion ( IECore::ConstCompoundObjectPtr  operands) const
protectedvirtual

Implemented to call doConversion as defined below only if object() has a suitable value - otherwise returns 0.

Implements IECore::ToCoreConverter.

virtual IECore::ObjectPtr IECoreMaya::FromMayaObjectConverter::doConversion ( const MObject &  object,
IECore::ConstCompoundObjectPtr  operands 
) const
protectedpure virtual
const MObject& IECoreMaya::FromMayaObjectConverter::object ( ) const

The MObject which will be converted by the convert() function. Will return MObject::kNullObj if objectIsAlive() is false.

Referenced by IECoreMaya.FnParameterisedHolder::fullPathName(), IECoreMaya.FnProceduralHolder::selectedComponentNames(), and IECoreMaya.FnSceneShape::selectedComponentNames().

bool IECoreMaya::FromMayaObjectConverter::objectIsAlive ( ) const

If you allow the MObject passed to the constructor or create() call to die then the Converter is unable to convert it and return 0 from convert(). This function tells you if the object is still alive or not, and therefore what return value you can expect.


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