Cortex
10.0.0-a4
|
#include <ToGLConverter.h>
Classes | |
class | ConverterDescription |
Public Types | |
typedef IECore::Object | InputType |
typedef IECore::RunTimeTyped | ResultType |
![]() | |
typedef RefCounted | BaseClass |
A typedef for the class this class derives from. All RunTimeTyped classes define this typedef. | |
![]() | |
typedef size_t | RefCount |
Public Member Functions | |
IE_CORE_DECLARERUNTIMETYPEDEXTENSION (IECoreGL::ToGLConverter, ToGLConverterTypeId, IECore::FromCoreConverter) | |
IECore::RunTimeTypedPtr | convert () |
![]() | |
IE_CORE_DECLARERUNTIMETYPED (FromCoreConverter, Converter) | |
ObjectParameterPtr | srcParameter () |
The parameter holding the object to be converted. | |
ConstObjectParameterPtr | srcParameter () const |
![]() | |
IE_CORE_DECLARERUNTIMETYPED (Converter, 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. | |
CompoundParameter * | parameters () override |
const CompoundParameter * | parameters () const override |
Returns the parameters for query. | |
CompoundObject * | userData () |
Returns an object that anyone can use for storing anything. | |
const CompoundObject * | userData () const |
Read only version of the above. | |
![]() | |
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 |
![]() | |
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 ToGLConverterPtr | create (IECore::ConstObjectPtr object, IECore::TypeId resultType=IECore::RunTimeTypedTypeId) |
![]() | |
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 | |
ToGLConverter (const std::string &description, IECore::TypeId supportedType) | |
virtual IECore::RunTimeTypedPtr | doConversion (IECore::ConstObjectPtr src, IECore::ConstCompoundObjectPtr operands) const =0 |
![]() | |
FromCoreConverter (const std::string &description, TypeId supportedType) | |
FromCoreConverter (const std::string &description, const ObjectParameter::TypeIdSet &supportedTypes) | |
FromCoreConverter (const std::string &description, const TypeId *supportedTypes) | |
![]() | |
Converter (const std::string &description) | |
Additional Inherited Members | |
![]() | |
typedef std::map< TypeId, TypeId > | BaseTypeRegistryMap |
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, TypeId > | TypeNamesToTypeIdsMap |
![]() | |
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 Mutex | g_baseTypeIdsMutex |
static Mutex | g_derivedTypeIdsMutex |
The ToGLConverter class is a to be used as a base for all classes able to perform some kind of conversion from an IECore datatype to an IECoreGL datatype.
These typedefs describe the input and output types of the conversion supported by this class. Derived classes /must/ override these typedefs to more accurately describe their particular conversion in detail - they will be used the by the ConverterDescription to register the converter with the factory mechanism.
IECore::RunTimeTypedPtr IECoreGL::ToGLConverter::convert | ( | ) |
Returns the object in srcParameter() converted to an appropriate IECoreGL type.
|
static |
Creates a converter which will convert the given IECore object to a GL 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.
|
protectedpure virtual |
Called by convert() to actually perform the operation. operands contains the result of parameters()->getValidatedValue() - this function will never be called when the contents of the parameters are in a bad state. Must be implemented in derived classes.
Implemented in IECoreGL::ToGLTextureConverter, IECoreGL::ToGLStateConverter, IECoreGL::ToGLBufferConverter, IECoreGL::ToGLCurvesConverter, IECoreGL::ToGLMeshConverter, IECoreGL::ToGLPointsConverter, IECoreGL::SplineToGLTextureConverter, IECoreGL::ToGLSphereConverter, and IECoreGL::ToGLCameraConverter.