neuray API Programmer's Manual

mi::neuraylib::IFunctor_base Class Reference

[Functors]

Description

Base class for functors. This base class provides common support for options handling and similar things. Functors are interfaces whose purpose is a single computation, like a conventional function call.

mi::base::Interface_declare\< ..., neuraylib::IFunctor_base \>Mixin class template for deriving new interface declarations. mi::base::Interface_declare\< ..., neuraylib::IFunctor_base \>Mixin class template for deriving new interface declarations. mi::base::Interface_declare\< ..., neuraylib::IFunctor_base \>Mixin class template for deriving new interface declarations. mi::base::Interface_declare\< ... \>Mixin class template for deriving new interface declarations. The basic extensible interface.The basic extensible interface. Functor to tessellate a polygon mesh into a triangle mesh.Functor to tessellate a polygon mesh into a triangle mesh. Functor to simplify a triangle mesh.Functor to simplify a triangle mesh. Functor to weld a triangle mesh.Functor to weld a triangle mesh.

Public Member Functions

virtual const char* error_text() const =0
Returns a descriptive string for the last error. More...
virtual IDictionary* get_default_options() const =0
Returns the default options for this functor. More...
virtual const IDictionary* get_options_description() const =0
Returns the descriptions of all options. More...
virtual const IDictionary* get_options_type() const =0
Returns the types of all options. More...
virtual bool  options_valid( const IDictionary* options) =0
Checks whether the options are valid for the functor. More...

Member Functions

virtual const char* mi::​neuraylib::​IFunctor_base::error_text() const [pure virtual]

Returns a descriptive string for the last error. The returned pointer is valid until the next function call or until this interface is released, whichever happens first.

Returns

A description of the error from the last function call, or NULL if the last function call was successful.

virtual IDictionary* mi::​neuraylib::​IFunctor_base::get_default_options() const [pure virtual]

Returns the default options for this functor.

Returns

A dictionary that contains all permissible options keys and their default values for this functor.

virtual const IDictionary* mi::​neuraylib::​IFunctor_base::get_options_description() const [pure virtual]

Returns the descriptions of all options.

Returns

A dictionary that maps the key names of the default options to a corresponding description describing the meaning of the value.

virtual const IDictionary* mi::​neuraylib::​IFunctor_base::get_options_type() const [pure virtual]

Returns the types of all options.

Returns

A dictionary that maps the key names of the default options to the corresponding types.

virtual bool mi::​neuraylib::​IFunctor_base::options_valid( const IDictionary* options) [pure virtual]

Checks whether the options are valid for the functor.

Returns

true if and only if the options are valid, i.e., all keys and their values are permissible for the functor.