mi::neuraylib::IMdl_function_definition Class Reference
[Materials (MDL)]
Description
This interfaces represents a function definition. A function definition describes the formal structure of a function call, i.e. the number, types, names, and defaults of its parameters, as well as its return type. The create_function_call() method allows to create function calls based on this function definition.
See also:
mi::neuraylib::IMdl_function_call, mi::neuraylib::IMdl_module
Public Member Functions
- virtual IMdl_function_call* create_function_call( const IAttribute_container* arguments, Sint32* errors = 0) const =0
- Creates a new function call. More...
- virtual const IAttribute_container* get_annotations() const =0
- Returns the annotations of this function definition. More...
- virtual const char* get_argument_type( Uint32 index) const =0
- Returns the type of the argument at index. More...
- virtual const char* get_argument_type( const char* name) const =0
- Returns the type of an argument. More...
- virtual const IAttachable* get_default( Uint32 index) const =0
- Returns the default initializer of the parameter at index. More...
- template< class T>const T* get_default( Uint32 index) const
- Returns the default initializer of the parameter at index. More...
- virtual const IAttachable* get_default( const char* name) const =0
- Returns the default initializer of a parameter. More...
- template< class T>const T* get_default( const char* name) const
- Returns the default initializer of a parameter. More...
- virtual const char* get_module() const =0
- Returns the DB name of the module containing this function definition. More...
- virtual const char* get_name() const =0
- Returns the MDL name of the function definition. More...
- virtual const IAttribute_container* get_parameter_annotations( Uint32 index) const =0
- Returns the annotations of the parameter at index. More...
- virtual const IAttribute_container* get_parameter_annotations( const char* name) const =0
- Returns the annotations of a parameter. More...
- virtual Uint32 get_parameter_count() const =0
- Returns the number of parameters. More...
- virtual Sint32 get_parameter_index( const char* name) const =0
- Returns the index position of a parameter. More...
- virtual const char* get_parameter_name( Uint32 index) const =0
- Returns the name of the parameter at index. More...
- virtual const char* get_parameter_type( Uint32 index) const =0
- Returns the type of the parameter at index. More...
- virtual const char* get_parameter_type( const char* name) const =0
- Returns the type of a parameter. More...
- virtual const IAttribute_container* get_return_annotations() const =0
- Returns the annotations of the return type of this function definition. More...
- virtual const char* get_return_type() const =0
- Returns the return type. More...
- virtual bool is_exported() const =0
- Indicates whether the function definition is exported by its module.
- virtual bool is_parameter_type_uniform( Uint32 index) const =0
- Indicates whether the type of a parameter is uniform. More...
- virtual bool is_parameter_type_uniform( const char* name) const =0
- Indicates whether the type of a parameter is uniform. More...
- virtual bool is_return_type_varying() const =0
- Indicates whether the return type is varying. More...
Member Functions
- virtual IMdl_function_call* mi::neuraylib::IMdl_function_definition::create_function_call( const IAttribute_container* arguments, Sint32* errors = 0) const [pure virtual]
-
Creates a new function call.
Parameters
- arguments
- The arguments of the created function call. Arguments for parameters without default initializer are mandatory, otherwise optional. The type of an attribute in the attribute container must match the required type for the argument of that name (see get_argument_type()). Any argument not set by an attribute in the attribute container will be set to the default initializer of the corresponding parameter. Note that the values in arguments are copied; passing an attribute container obtained from another MDL interface does not create a link between both instances. NULL is a valid argument which is handled like an empty attribute container.
- errors
- An optional pointer to an mi::Sint32 to which an error code will be written. The error codes have the following meaning:
- 0: Success.
- -1: An argument for a non-existing parameter was provided in arguments.
- -2: The type of an argument in arguments does not have the correct type, see get_argument_type().
- -3: A parameter that has no default initializer was not provided with an argument value.
- -4: The definition can not be instantiated because it is not exported.
Returns
The created material instance, or NULL in case of errors.
- virtual const IAttribute_container* mi::neuraylib::IMdl_function_definition::get_annotations() const [pure virtual]
-
Returns the annotations of this function definition.
Returns
The function annotations.
- virtual const char* mi::neuraylib::IMdl_function_definition::get_argument_type( Uint32 index) const [pure virtual]
-
Returns the type of the argument at index. The type of a given argument is an attachable of the corresponding parameter type. For example, if get_parameter_type() returns "Sint32", this method returns "Attachable<Sint32>".
If a literal 0 is passed for index, the call is ambiguous. You need to explicitly cast the value to mi::Uint32.
Parameters
- index
- The index of the argument.
Returns
The argument type, or NULL if index is out of range.
- virtual const char* mi::neuraylib::IMdl_function_definition::get_argument_type( const char* name) const [pure virtual]
-
Returns the type of an argument. The type of a given argument is an attachable of the corresponding parameter type. For example, if get_parameter_type() returns "Sint32", this method returns "Attachable<Sint32>".
Parameters
- name
- The name of the argument.
Returns
The argument type, or NULL if name is invalid.
- virtual const IAttachable* mi::neuraylib::IMdl_function_definition::get_default( Uint32 index) const [pure virtual]
-
Returns the default initializer of the parameter at index. If a literal 0 is passed for index, the call is ambiguous. You need to explicitly cast the value to mi::Uint32.
Parameters
- index
- The index of the parameter.
Returns
The default initializer, or NULL if index is out of range or if there is no default initializer.
-
template< class T>
const T* mi::neuraylib::IMdl_function_definition::get_default( Uint32 index) const [inline] -
Returns the default initializer of the parameter at index. If a literal 0 is passed for index, the call is ambiguous. You need to explicitly cast the value to mi::Uint32.
This templated member function is a wrapper of the non-template variant for the user's convenience. It eliminates the need to call mi::base::IInterface::get_interface( const Uuid &) on the returned pointer, since the return type already is a pointer to the type T specified as template parameter.
Parameters
- index
- The index of the parameter.
Returns
The default initializer, or NULL if index is out of range or if there is no default initializer.
- virtual const IAttachable* mi::neuraylib::IMdl_function_definition::get_default( const char* name) const [pure virtual]
-
Returns the default initializer of a parameter.
Parameters
- name
- The name of the parameter.
Returns
The default initializer, or NULL if name is invalid or if there is no default initializer.
-
template< class T>
const T* mi::neuraylib::IMdl_function_definition::get_default( const char* name) const [inline] -
Returns the default initializer of a parameter. This templated member function is a wrapper of the non-template variant for the user's convenience. It eliminates the need to call mi::base::IInterface::get_interface( const Uuid &) on the returned pointer, since the return type already is a pointer to the type T specified as template parameter.
Parameters
- name
- The name of the parameter.
Returns
The default initializer, or NULL if name is invalid or if there is no default initializer.
- virtual const char* mi::neuraylib::IMdl_function_definition::get_module() const [pure virtual]
-
Returns the DB name of the module containing this function definition. The type of the module is mi::neuraylib::IMdl_module.
Returns
The DB name of the module containing the function definition.
- virtual const char* mi::neuraylib::IMdl_function_definition::get_name() const [pure virtual]
-
Returns the MDL name of the function definition.
Note:The MDL name of the function definition is different from the name of the DB element. Use mi::neuraylib::IMdl_compiler::name_of() to obtain the name of the DB element.
Returns
The MDL name of the function definition.
- virtual const IAttribute_container* mi::neuraylib::IMdl_function_definition::get_parameter_annotations( Uint32 index) const [pure virtual]
-
Returns the annotations of the parameter at index. If a literal 0 is passed for index, the call is ambiguous. You need to explicitly cast the value to mi::Uint32.
Parameters
- index
- The index of the parameter.
Returns
The parameter annotations, or NULL if index is out of range.
- virtual const IAttribute_container* mi::neuraylib::IMdl_function_definition::get_parameter_annotations( const char* name) const [pure virtual]
-
Returns the annotations of a parameter.
Parameters
- name
- The name of the parameter.
Returns
The parameter annotations, or NULL if name is invalid.
- virtual Uint32 mi::neuraylib::IMdl_function_definition::get_parameter_count() const [pure virtual]
-
Returns the number of parameters.
Returns
The number of parameters.
- virtual Sint32 mi::neuraylib::IMdl_function_definition::get_parameter_index( const char* name) const [pure virtual]
-
Returns the index position of a parameter.
Parameters
- name
- The name of the parameter.
Returns
The index of the parameter, or -1 if name is invalid.
- virtual const char* mi::neuraylib::IMdl_function_definition::get_parameter_name( Uint32 index) const [pure virtual]
-
Returns the name of the parameter at index.
Parameters
- index
- The index of the parameter.
Returns
The name of the parameter, or NULL if index is out of range.
- virtual const char* mi::neuraylib::IMdl_function_definition::get_parameter_type( Uint32 index) const [pure virtual]
-
Returns the type of the parameter at index. If a literal 0 is passed for index, the call is ambiguous. You need to explicitly cast the value to mi::Uint32.
Parameters
- index
- The index of the parameter.
Returns
The parameter type, or NULL if index is out of range.
- virtual const char* mi::neuraylib::IMdl_function_definition::get_parameter_type( const char* name) const [pure virtual]
-
Returns the type of a parameter.
Parameters
- name
- The name of the parameter.
Returns
The parameter type, or NULL if name is invalid.
- virtual const IAttribute_container* mi::neuraylib::IMdl_function_definition::get_return_annotations() const [pure virtual]
-
Returns the annotations of the return type of this function definition.
Returns
The return type annotations.
- virtual const char* mi::neuraylib::IMdl_function_definition::get_return_type() const [pure virtual]
-
Returns the return type.
Returns
The return type.
- virtual bool mi::neuraylib::IMdl_function_definition::is_exported() const [pure virtual]
-
Indicates whether the function definition is exported by its module.
- virtual bool mi::neuraylib::IMdl_function_definition::is_parameter_type_uniform( Uint32 index) const [pure virtual]
-
Indicates whether the type of a parameter is uniform.
Parameters
- index
- The index of the parameter.
Returns
true if the parameter is uniform, otherwise false (including invalid index ).
- virtual bool mi::neuraylib::IMdl_function_definition::is_parameter_type_uniform( const char* name) const [pure virtual]
-
Indicates whether the type of a parameter is uniform.
Parameters
- name
- The name of the parameter.
Returns
true if the parameter is uniform, otherwise false (including invalid name ).
- virtual bool mi::neuraylib::IMdl_function_definition::is_return_type_varying() const [pure virtual]
-
Indicates whether the return type is varying.
Returns
true if the return type is varying, otherwise false .