Cortex  10.0.0-a4
Public Member Functions | Static Public Member Functions | List of all members
IECoreGL::NameStateComponent Class Reference

#include <NameStateComponent.h>

+ Inheritance diagram for IECoreGL::NameStateComponent:

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.
 
- Public Member Functions inherited from IECoreGL::StateComponent
 IE_CORE_DECLARERUNTIMETYPEDEXTENSION (IECoreGL::StateComponent, StateComponentTypeId, Bindable)
 
- Public Member Functions inherited from IECoreGL::Bindable
 IE_CORE_DECLARERUNTIMETYPEDEXTENSION (IECoreGL::Bindable, BindableTypeId, IECore::RunTimeTyped)
 
- 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 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 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.
 

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

Member Function Documentation

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 GLuint IECoreGL::NameStateComponent::glNameFromName ( const std::string &  name,
bool  createIfMissing = false 
)
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 const std::string& IECoreGL::NameStateComponent::nameFromGLName ( GLuint  glName)
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.


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