OpenSceneGraph 2.8.3

osgIntrospection::CustomAttributeProvider Class Reference

This is the base class for custom attribute providers, that is objects that can be assigned a list of custom attributes. More...

Inheritance diagram for osgIntrospection::CustomAttributeProvider:

List of all members.

Public Member Functions

const CustomAttributeListgetCustomAttributes () const
 Returns the const list of custom attributes.
CustomAttributeListgetCustomAttributes ()
 Returns the list of custom attributes.
CustomAttributeProvideraddAttribute (const CustomAttribute *attr)
 Adds a new attribute to the list.
bool isDefined (const Type &type, bool inherit) const
 Returns whether at least one attribute of the given type is present in the attribute list.
template<typename T >
bool isDefined (bool inherit) const
 Returns whether at least one attribute of the given type is present in the attribute list.
const CustomAttributegetAttribute (const Type &type, bool inherit) const
 Searchs for an attribute of the given type and returns a pointer to it if found, a null pointer otherwise.
template<typename T >
const T * getAttribute (bool inherit) const
 Searchs for an attribute of the given type and returns a pointer to it if found, a null pointer otherwise.

Protected Member Functions

virtual void getInheritedProviders (CustomAttributeProviderList &providers) const =0
virtual ~CustomAttributeProvider ()

Detailed Description

This is the base class for custom attribute providers, that is objects that can be assigned a list of custom attributes.

Methods defined in this class provide the means for adding, retrieving and searching for attributes.


Constructor & Destructor Documentation

virtual osgIntrospection::CustomAttributeProvider::~CustomAttributeProvider ( ) [inline, protected, virtual]

Member Function Documentation

const CustomAttribute* osgIntrospection::CustomAttributeProvider::getAttribute ( const Type type,
bool  inherit 
) const

Searchs for an attribute of the given type and returns a pointer to it if found, a null pointer otherwise.

If the inherit parameter is set to true, the search is forwarded to base types.

template<typename T >
const T* osgIntrospection::CustomAttributeProvider::getAttribute ( bool  inherit) const [inline]

Searchs for an attribute of the given type and returns a pointer to it if found, a null pointer otherwise.

If the inherit parameter is set to true, the search is forwarded to base types. [template version]

CustomAttributeList& osgIntrospection::CustomAttributeProvider::getCustomAttributes ( ) [inline]

Returns the list of custom attributes.

const CustomAttributeList& osgIntrospection::CustomAttributeProvider::getCustomAttributes ( ) const [inline]

Returns the const list of custom attributes.

virtual void osgIntrospection::CustomAttributeProvider::getInheritedProviders ( CustomAttributeProviderList providers) const [protected, pure virtual]
template<typename T >
bool osgIntrospection::CustomAttributeProvider::isDefined ( bool  inherit) const [inline]

Returns whether at least one attribute of the given type is present in the attribute list.

If the inherit parameter is set to true, the search is forwarded to base types. [template version]

bool osgIntrospection::CustomAttributeProvider::isDefined ( const Type type,
bool  inherit 
) const

Returns whether at least one attribute of the given type is present in the attribute list.

If the inherit parameter is set to true, the search is forwarded to base types.


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

osg logo
Generated at Tue Mar 22 2011 13:20:26 for the OpenSceneGraph by doxygen 1.7.3.