Cortex  10.0.0-a4
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
IECoreMaya::FromMayaPlugConverter Class Reference

#include <FromMayaPlugConverter.h>

+ Inheritance diagram for IECoreMaya::FromMayaPlugConverter:

Classes

class  Description
 

Public Member Functions

 IE_CORE_DECLARERUNTIMETYPEDEXTENSION (FromMayaPlugConverter, FromMayaPlugConverterTypeId, FromMayaConverter)
 
const MPlug & plug () const
 The MPlug which will be converted by the convert() function.
 
- 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

static FromMayaConverterPtr create (const MPlug &plug, 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 Member Functions

 FromMayaPlugConverter (const MPlug &plug)
 
- Protected Member Functions inherited from IECoreMaya::FromMayaConverter
 FromMayaConverter (const std::string &description)
 
- Protected Member Functions inherited from IECore::ToCoreConverter
 ToCoreConverter (const std::string &description)
 
virtual IECore::ObjectPtr doConversion (IECore::ConstCompoundObjectPtr operands) const =0
 
- Protected Member Functions inherited from IECore::Converter
 Converter (const std::string &description)
 

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
 
- 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

The FromMayaPlugConverter class allows conversion from MPlug values to an IECore Object.

Member Function Documentation

static FromMayaConverterPtr IECoreMaya::FromMayaPlugConverter::create ( const MPlug &  plug,
IECore::TypeId  resultType = IECore::InvalidTypeId 
)
static

Creates a converter to convert the plug value to the an IECore type. If resultType is specified then only converters which would create that type will be considered. May return 0 if no converter can be found. Note that this returns a generic FromMayaConverterPtr rather than a FromMayaPlugConverterPtr so that a FromMayaObjectConverterPtr may be returned for the case of a plug holding an MObject.


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