Cortex
10.0.0-a4
|
#include <NameStateComponent.h>
Public Member Functions | |
IE_CORE_DECLARERUNTIMETYPEDEXTENSION (IECoreGL::NameStateComponent, NameStateComponentTypeId, StateComponent) | |
NameStateComponent (const std::string &name="unnamed") | |
const std::string & | name () const |
The name in string form. | |
GLuint | glName () const |
void | bind () const override |
Calls Selector::currentSelector()->loadName() as necessary. | |
![]() | |
IE_CORE_DECLARERUNTIMETYPEDEXTENSION (IECoreGL::StateComponent, StateComponentTypeId, Bindable) | |
![]() | |
IE_CORE_DECLARERUNTIMETYPEDEXTENSION (IECoreGL::Bindable, BindableTypeId, 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 |
![]() | |
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 const std::string & | nameFromGLName (GLuint glName) |
static GLuint | glNameFromName (const std::string &name, bool createIfMissing=false) |
Returns the internal GL name used for the given public (string) name. If no. More... | |
![]() | |
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. | |
Additional Inherited Members | |
![]() | |
typedef RefCounted | BaseClass |
A typedef for the class this class derives from. All RunTimeTyped classes define this typedef. | |
![]() | |
typedef size_t | RefCount |
![]() | |
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 NameStateComponent class is used to specify the names of objects being rendered. It maps from a public name stored as a string to an integer name which is used with the Selector::loadName() method to perform selection of rendered objects.
GLuint IECoreGL::NameStateComponent::glName | ( | ) | const |
The name in integer form. The value 0 is reserved to represent an invalid name, and will never be returned here.
|
static |
Returns the internal GL name used for the given public (string) name. If no.
internal name has been created yet then throws an Exception, unless createIfMissing is true in which case an appropriate GL name is created. The value 0 represents an invalid name and will never be returned.
|
static |
Returns the public (string) name from the internal OpenGL name value, which typically will come from the contents of the select buffer. Raises an Exception if glName does not map to a NameStateComponent name.