NVIDIA Iray API Home  Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Modules | Classes | Enumerations | Functions
Scene elements
Iray API

All the scene elements that make up the scene graph. More...

Modules

  Scene graph structure
  Inner nodes of the scene graph defining its structure.
 
  Miscellaneous
  Miscellaneous scene graph elements, for example, textures, light profiles, BSDF measurements, or decals.
 
  Materials (MDL)
  Materials comprise a set of interfaces related to the Material Definition Language (MDL).
 
  Leaf nodes
  Leaf nodes of the scene graph, for example, geometry, lights, or cameras.
 

Classes

class   mi::neuraylib::IAttribute_set
  The attribute set comprises all attributes attached to a database element. More...
 
class   mi::neuraylib::IScene_element
  Common base interface for all scene elements. More...
 

Enumerations

enum   mi::neuraylib::Propagation_type {
  mi::neuraylib::PROPAGATION_STANDARD,
  mi::neuraylib::PROPAGATION_OVERRIDE
}
  Propagation types for attribute inheritance. More...
 
enum   mi::neuraylib::Element_type {
  mi::neuraylib::ELEMENT_TYPE_INSTANCE = 0,
  mi::neuraylib::ELEMENT_TYPE_GROUP = 1,
  mi::neuraylib::ELEMENT_TYPE_OPTIONS = 2,
  mi::neuraylib::ELEMENT_TYPE_CAMERA = 3,
  mi::neuraylib::ELEMENT_TYPE_LIGHT = 4,
  mi::neuraylib::ELEMENT_TYPE_LIGHTPROFILE = 5 ,
  mi::neuraylib::ELEMENT_TYPE_TEXTURE = 7,
  mi::neuraylib::ELEMENT_TYPE_IMAGE = 8 ,
  mi::neuraylib::ELEMENT_TYPE_TRIANGLE_MESH = 10,
  mi::neuraylib::ELEMENT_TYPE_ATTRIBUTE_CONTAINER = 16,
  mi::neuraylib::ELEMENT_TYPE_POLYGON_MESH = 18 ,
  mi::neuraylib::ELEMENT_TYPE_SUBDIVISION_SURFACE = 23,
  mi::neuraylib::ELEMENT_TYPE_FREEFORM_SURFACE = 24 ,
  mi::neuraylib::ELEMENT_TYPE_MDL_MODULE = 29,
  mi::neuraylib::ELEMENT_TYPE_MDL_FUNCTION_DEFINITION = 30,
  mi::neuraylib::ELEMENT_TYPE_MDL_FUNCTION_CALL = 31,
  mi::neuraylib::ELEMENT_TYPE_MDL_MATERIAL_DEFINITION = 32,
  mi::neuraylib::ELEMENT_TYPE_MDL_MATERIAL_INSTANCE = 33,
  mi::neuraylib::ELEMENT_TYPE_MDL_COMPILED_MATERIAL = 34,
  mi::neuraylib::ELEMENT_TYPE_BSDF_MEASUREMENT = 35,
  mi::neuraylib::ELEMENT_TYPE_IRRADIANCE_PROBES = 36,
  mi::neuraylib::ELEMENT_TYPE_DECAL = 37,
  mi::neuraylib::ELEMENT_TYPE_ON_DEMAND_MESH = 38
}
  Distinguishes scene elements. More...
 

Functions

template<class T >
mi::Sint32  mi::set_value (mi::neuraylib::IAttribute_set *attribute_set, const char *name, const T &value)
  Simplifies setting the value of an attribute from the corresponding classes from the base and math API. More...
 
template<class T >
mi::Sint32  mi::set_value (mi::neuraylib::IAttribute_set *attribute_set, const char *name, mi::Size index, const T &value)
  Simplifies setting the value of an attribute from the corresponding classes from the base and math API (variant with an index for collections). More...
 
template<class T >
mi::Sint32  mi::set_value (mi::neuraylib::IAttribute_set *attribute_set, const char *name, const char *key, const T &value)
  Simplifies setting the value of an attribute from the corresponding classes from the base and math API (variant with a key for collections). More...
 
template<class T >
mi::Sint32  mi::get_value (const mi::neuraylib::IAttribute_set *attribute_set, const char *name, T &value)
  Simplifies reading the value of an attribute into the corresponding classes from the base and math API. More...
 
template<class T >
mi::Sint32  mi::get_value (const mi::neuraylib::IAttribute_set *attribute_set, const char *name, mi::Size index, T &value)
  Simplifies reading the value of an attribute into the corresponding classes from the base and math API (variant with an index for collections). More...
 
template<class T >
mi::Sint32  mi::get_value (const mi::neuraylib::IAttribute_set *attribute_set, const char *name, const char *key, T &value)
  Simplifies reading the value of an attribute into the corresponding classes from the base and math API (variant with a key for collections). More...
 

Detailed Description

All the scene elements that make up the scene graph.

Enumeration Type Documentation

enum mi::neuraylib::Element_type

Distinguishes scene elements.

See Also
mi::neuraylib::IScene_element::get_element_type()
Enumerator
ELEMENT_TYPE_INSTANCE 

mi::neuraylib::IInstance

ELEMENT_TYPE_GROUP 

mi::neuraylib::IGroup

ELEMENT_TYPE_OPTIONS 

mi::neuraylib::IOptions

ELEMENT_TYPE_CAMERA 

mi::neuraylib::ICamera

ELEMENT_TYPE_LIGHT 

mi::neuraylib::ILight

ELEMENT_TYPE_LIGHTPROFILE 

mi::neuraylib::ILightprofile

ELEMENT_TYPE_TEXTURE 

mi::neuraylib::ITexture

ELEMENT_TYPE_IMAGE 

mi::neuraylib::IImage

ELEMENT_TYPE_TRIANGLE_MESH 

mi::neuraylib::ITriangle_mesh

ELEMENT_TYPE_ATTRIBUTE_CONTAINER 

mi::neuraylib::IAttribute_container

ELEMENT_TYPE_POLYGON_MESH 

mi::neuraylib::IPolygon_mesh

ELEMENT_TYPE_SUBDIVISION_SURFACE 

mi::neuraylib::ISubdivision_surface

ELEMENT_TYPE_FREEFORM_SURFACE 

mi::neuraylib::IFreeform_surface

ELEMENT_TYPE_MDL_MODULE 

mi::neuraylib::IMdl_module

ELEMENT_TYPE_MDL_FUNCTION_DEFINITION 

mi::neuraylib::IMdl_function_definition

ELEMENT_TYPE_MDL_FUNCTION_CALL 

mi::neuraylib::IMdl_function_call

ELEMENT_TYPE_MDL_MATERIAL_DEFINITION 

mi::neuraylib::IMdl_material_definition

ELEMENT_TYPE_MDL_MATERIAL_INSTANCE 

mi::neuraylib::IMdl_material_instance

ELEMENT_TYPE_MDL_COMPILED_MATERIAL 

mi::neuraylib::IMdl_compiled_material

ELEMENT_TYPE_BSDF_MEASUREMENT 

mi::neuraylib::IBsdf_measurement

ELEMENT_TYPE_IRRADIANCE_PROBES 

mi::neuraylib::IIrradiance_probes

ELEMENT_TYPE_DECAL 

mi::neuraylib::IDecal

ELEMENT_TYPE_ON_DEMAND_MESH 

mi::neuraylib::IOn_demand_mesh

enum mi::neuraylib::Propagation_type

Propagation types for attribute inheritance.

Inheritance of attributes allows you to easily make changes to an entire subtree of the scene graph. For example, by setting the visible attribute of an mi::neuraylib::IGroup element to false, the entire subtree will become invisible (unless one of its elements has a visible attribute, too, and its value is true). Similarly, materials can be inherited down the scene graph to elements that do not have their own material.

Assume the scene graph contains an inner node P (the parent) like mi::neuraylib::IGroup or mi::neuraylib::IInstance with a (possibly inherited) attribute A and a child node C. If the child node C does not have the attribute A, the child will inherit P's value of A (without actually storing an explicit copy). If the child node C has the attribute A, it will use its own value of the attribute without taking P's value into consideration. This is the standard propagation rule which is represented by the propagation type mi::neuraylib::PROPAGATION_STANDARD.

The outcome of the last case can be reverted by setting the override flag of the attribute A on the parent node (or at the node from where it was inherited to P): in this case P's value of A is inherited to the child node C, no matter whether the child has the attribute or not. This propagation mode is represented by mi::neuraylib::PROPAGATION_OVERRIDE.

Note
There is one exception to these rules: If the child node C is a geometry object, then P's value of A at is used, no matter whether the propagation mode was set to mi::neuraylib::PROPAGATION_OVERRIDE or mi::neuraylib::PROPAGATION_STANDARD. The rationale is that for geometry objects the attribute on the object itself should be a default that is only used if no value for that attribute is inherited.
Inherited attributes are made available to the render modes, but are not available via the Iray API.
See Also
mi::neuraylib::IAttribute_set::set_attribute_propagation()
mi::neuraylib::IAttribute_set::get_attribute_propagation()
Enumerator
PROPAGATION_STANDARD 

Standard inheritance of attributes without any special flags.

PROPAGATION_OVERRIDE 

The override flag for attribute inheritance.

Function Documentation

template<class T >
mi::Sint32 mi::get_value ( const mi::neuraylib::IAttribute_set *  attribute_set,
const char *  name,
T &  value 
)

Simplifies reading the value of an attribute into the corresponding classes from the base and math API.

Parameters
attribute_set The affected attribute set.
name The name of the attribute to read.
value The new value will be stored here.
Returns
  • 0: Success.
  • -1: The dynamic type of the attribute does not match the static type of value.
  • -4: The attribute name does not exist.
template<class T >
mi::Sint32 mi::get_value ( const mi::neuraylib::IAttribute_set *  attribute_set,
const char *  name,
mi::Size  index,
T &  value 
)

Simplifies reading the value of an attribute into the corresponding classes from the base and math API (variant with an index for collections).

Parameters
attribute_set The affected attribute set.
name The name of the attribute to read.
index The index of the affected collection element.
value The new value will be stored here.
Returns
  • 0: Success.
  • -1: The dynamic type of the attribute does not match the static type of value.
  • -3: The index is not valid.
  • -4: The attribute name does not exist.
template<class T >
mi::Sint32 mi::get_value ( const mi::neuraylib::IAttribute_set *  attribute_set,
const char *  name,
const char *  key,
T &  value 
)

Simplifies reading the value of an attribute into the corresponding classes from the base and math API (variant with a key for collections).

Parameters
attribute_set The affected attribute set.
name The name of the attribute to read.
key The key of the affected collection element.
value The new value will be stored here.
Returns
  • 0: Success.
  • -1: The dynamic type of the attribute does not match the static type of value.
  • -3: The key is not valid.
  • -4: The attribute name does not exist.
template<class T >
mi::Sint32 mi::set_value ( mi::neuraylib::IAttribute_set *  attribute_set,
const char *  name,
const T &  value 
)

Simplifies setting the value of an attribute from the corresponding classes from the base and math API.

Parameters
attribute_set The affected attribute set.
name The name of the attribute to modify.
value The new value to be set.
Returns
  • 0: Success.
  • -1: The dynamic type of the attribute does not match the static type of value.
  • -2: The value of value is not valid.
  • -4: The attribute name does not exist.
template<class T >
mi::Sint32 mi::set_value ( mi::neuraylib::IAttribute_set *  attribute_set,
const char *  name,
mi::Size  index,
const T &  value 
)

Simplifies setting the value of an attribute from the corresponding classes from the base and math API (variant with an index for collections).

Parameters
attribute_set The affected attribute set.
name The name of the attribute to modify.
index The index of the affected collection element.
value The new value to be set.
Returns
  • 0: Success.
  • -1: The dynamic type of the attribute does not match the static type of value.
  • -2: The value of value is not valid.
  • -3: The index is not valid.
  • -4: The attribute name does not exist.
template<class T >
mi::Sint32 mi::set_value ( mi::neuraylib::IAttribute_set *  attribute_set,
const char *  name,
const char *  key,
const T &  value 
)

Simplifies setting the value of an attribute from the corresponding classes from the base and math API (variant with a key for collections).

Parameters
attribute_set The affected attribute set.
name The name of the attribute to modify.
key The key of the affected collection element.
value The new value to be set.
Returns
  • 0: Success.
  • -1: The dynamic type of the attribute does not match the static type of value.
  • -2: The value of value is not valid.
  • -3: The key is not valid.
  • -4: The attribute name does not exist.