neuray API Programmer's Manual

mi::neuraylib::IPlugin_api Class Reference

[Extensions and Plugins]

Description

This abstract interface gives access to the neuray API to plugins. It offers functionality similar to INeuray, but does not allow to start or shutdown the library. On the other hand it allows the registration of user-defined classes.

mi::base::Interface_declare\< ... \>Mixin class template for deriving new interface declarations. The basic extensible interface.The basic extensible interface.

Public Member Functions

virtual base::​IInterface* get_api_component( const base::​Uuid& uuid) const =0
Returns an API component from the neuray API. More...
template< class T>T* get_api_component() const
Returns an API component from the neuray API. More...
virtual Uint32 get_interface_version() const =0
Returns the interface version of the . More...
virtual const char* get_version() const =0
Returns the product version of the . More...
virtual Sint32 register_api_component( const base::​Uuid& uuid, base::​IInterface* api_component) =0
Registers an API component with the neuray API. More...
template< class T>Sint32 register_api_component( T* api_component)
Registers an API component with the neuray API. More...
virtual Sint32 unregister_api_component( const base::​Uuid& uuid) =0
Unregisters an API component with the neuray API. More...
template< class T>Sint32 unregister_api_component()
Unregisters an API component with the neuray API. More...

Member Functions

virtual base::​IInterface* mi::​neuraylib::​IPlugin_api::get_api_component( const base::​Uuid& uuid) const [pure virtual]

Returns an API component from the neuray API.

See also:

mi_neuray_api_components for a list of built-in API components.

register_api_component(), unregister_api_component()

Parameters

uuid
The UUID under which the API components was registered. For built-in API components this is the interface ID of the corresponding interface.

Returns

A pointer to the API component or NULL if the API component is not supported or currently not available.

template< class T>

T* mi::​neuraylib::​IPlugin_api::get_api_component() const [inline]

Returns an API component from the neuray API. This template variant requires that the API component is registered under the interface ID of the corresponding interface (which is the case for built-in API components).

See also:

mi_neuray_api_components for a list of built-in API components.

register_api_component(), unregister_api_component()

Returns

A pointer to the API component or NULL if the API component is not supported or currently not available.

virtual Uint32 mi::​neuraylib::​IPlugin_api::get_interface_version() const [pure virtual]

Returns the interface version of the . This number changes whenever the abstract interfaces of the neuray API change.

virtual const char* mi::​neuraylib::​IPlugin_api::get_version() const [pure virtual]

Returns the product version of the . This string contains the product version, build number, build date, etc. of the current library.

virtual Sint32 mi::​neuraylib::​IPlugin_api::register_api_component( const base::​Uuid& uuid, base::​IInterface* api_component) [pure virtual]

Registers an API component with the neuray API. API components are a way for plugins to provide access to their functionality. The registration makes the API component available for subsequent calls of get_api_component().

Parameters

uuid
The ID of the API component to register, e.g., the interface ID of the corresponding interface.
api_component
The API component to register.

Returns

  • 0: Success.
  • -1: Invalid parameters (NULL pointer).
  • -2: There is already an API component registered under the ID uuid.

template< class T>

Sint32 mi::​neuraylib::​IPlugin_api::register_api_component( T* api_component) [inline]

Registers an API component with the neuray API. API components are a way for plugins to provide access to their functionality. The registration makes the API component available for subsequent calls of get_api_component().

This template variant registers the API component under the interface ID of the corresponding interface.

Parameters

api_component
The API component to register.

Returns

  • 0: Success.
  • -1: Invalid parameters (NULL pointer).
  • -2: There is already an API component registered under the ID T::IID().
virtual Sint32 mi::​neuraylib::​IPlugin_api::unregister_api_component( const base::​Uuid& uuid) [pure virtual]

Unregisters an API component with the neuray API. The API component will no longer be accessible via get_api_component().

Parameters

uuid
The ID of the API component to unregister.

Returns

  • 0: Success.
  • -1: There is no API component registered under the ID uuid.

template< class T>

Sint32 mi::​neuraylib::​IPlugin_api::unregister_api_component() [inline]

Unregisters an API component with the neuray API. The API component will no longer be accessible via get_api_component().

This template variant requires that the API component was registered under the interface ID of the corresponding interface (which is the case for the template variant of register_api_component()).

Returns

  • 0: Success.
  • -1: There is no API component registered under the ID T::IID().