mi::shader_v3 Namespace Reference

Namespace containing mental ray C++ shader interface extensions. More...

Classes

class mi::shader_v3::Interface

Top level C++ mental ray interface extensions. More...

class mi::shader_v3::Options

Access to string options. More...

class mi::shader_v3::Access_interface

Interface wrapper class. More...

class mi::shader_v3::Bsdf

Simplified BSDF interface. More...

class mi::shader_v3::Access_bsdf

class mi::shader_v3::Framebuffer

Framebuffer class. More...

class mi::shader_v3::Access_fb

Smart pointer to access Framebuffer class, no editing. More...

class mi::shader_v3::Edit_fb

Smart pointer to access Framebuffer class for editing. More...

class mi::shader_v3::LightIterator

Iterate over shader or instance light lists. More...

class mi::shader_v3::LightList

Light lists, used internally by LightIterator. More...

class mi::shader_v3::Map_status

Map_status class. The Map_status is an enumerative class which is meant to list all possible error conditions for the Map-related classes and methods. More...

class mi::shader_v3::Map_field_type

Map_field_type class. The Map_field_type is an enumerative class which is meant to list all possible field types for maps. More...

class mi::shader_v3::Map_base

Map_base class. More...

class mi::shader_v3::Access_map_dbhandle

Access_map_dbhandle class, not to be used directly (use Access_map instead). More...

class mi::shader_v3::Access_map

Smart pointer (access-only) to a map in the DB or to a map to be read from file. It defines a dereference operator which provides access to the const methods of the wrapped Map_base object. More...

class mi::shader_v3::Edit_map_dbhandle

Edit_map_dbhandle class, not to be used directly (use Edit_map instead). More...

class mi::shader_v3::Edit_map

Smart pointer (read/write) to a map in the DB, to a map to be read from file, or to a newly created one. It defines a dereference operator which provides access to the methods of the wrapped Map_base object. More...

class mi::shader_v3::Map_declaration_base

Map_declaration_base class. More...

class mi::shader_v3::Map_declaration

Smart pointer to a map declaration, which allows to retrieve a copy of the declaration of an existing map, or to create a new map declaration. It defines a dereference operator which provides access to the methods of the wrapped Map_declaration_base object. More...

class mi::shader_v3::Map_element_base

Map_element_base class. More...

class mi::shader_v3::Map_element

Smart pointer to a map element. It defines a dereference operator which provides access to the methods of the wrapped Map_element_base object. More...

class mi::shader_v3::Map_iterator_base

Map_iterator_base class. More...

class mi::shader_v3::Access_map_iterator

Smart pointer to an access-only map iterator. It defines a dereference operator which provides access to the const methods of the wrapped Map_iterator_base object. More...

class mi::shader_v3::Edit_map_iterator

Smart pointer to a read-write map iterator. It defines a dereference operator which provides access to the methods of the wrapped Map_iterator_base object. More...

class mi::shader_v3::Map_distance_base

Map_distance_base class. The Map_distance_base class is an interface class for all the lookup distance functors. More...

class mi::shader_v3::Map_distance< DIM >

Map_distance<DIM> class. The Map_distance class is an interface template class, which defines all the virtual methods of Map_distance_base class except the distance from an element. The distance from a bounding box is quadratic. More...

class mi::shader_v3::Map_quad_distance< DIM >

Map_quad_distance class. The Map_quad_distance functor is a concrete distance functor that defines the operator that returns the distance from an element (quadratic distance). More...

struct mi::shader_v3::Map_lookup_entry

an entry in a map lookup, the index of an element and its distance from the search point. More...

class mi::shader_v3::Map_lookup_base

Map_lookup_base class. More...

class mi::shader_v3::Map_lookup

Smart pointer to a map lookup. It defines a dereference operator which provides access to the methods of the wrapped Map_lookup_base object. More...

class mi::shader_v3::Metasl_interface

Top level MetaSL mental ray interface extensions. More...

class mi::shader_v3::Access_base< T >

class mi::shader_v3::Access_metasl

Metasl_interface wrapper class More...

class mi::shader_v3::Access_state

State wrapper class More...

class mi::shader_v3::Subdivision34

Subdivision34 class. More...

struct mi::shader_v3::Subdivision34::Face

face data structure for triangles and quads m_vertices contains either 3 or 4 indices into the vector spaces. use get_vector to access the positions, textures etc using the vertex indices. m_material is the material tag for the given face. More...

class mi::shader_v3::Access_subdivision34

Subdivision34 access class. Provides access to Subdivision34 as defined above. More...

Typedefs

typedef Access_interface Interface_access

Typedef for backwards compatibility.

typedef miUint Map_field_id

Map_field_id.

typedef Access_map_dbhandle Map_dbhandle_access

Typedef for backwards compatibility.

typedef Access_map Map_access

Typedef for backwards compatibility.

typedef Edit_map_dbhandle Map_dbhandle_edit

Typedef for backwards compatibility.

typedef Edit_map Map_edit

Typedef for backwards compatibility.

typedef Access_map_iterator Map_iterator_access

Typedef for backwards compatibility.

typedef Edit_map_iterator Map_iterator_edit

Typedef for backwards compatibility.

typedef Map_quad_distance< 3 > Map_quad_distance3

predefined quadratic distance functor for the 3-dimensional case.

typedef Access_subdivision34 Subdivision34_access

Typedef for backwards compatibility.

Detailed Description

Namespace containing mental ray C++ shader interface extensions.

The mental ray C++ interface is completely contained in the shader namespace.

Note:: This name may change later in order to support multiple versions of the interface.

Typedef Documentation

typedef Access_interface mi::shader_v3::Interface_access

Typedef for backwards compatibility.

Deprecated:
Replaced by Access_interface.

typedef Access_map mi::shader_v3::Map_access

Typedef for backwards compatibility.

Deprecated:
Replaced by Access_map.

typedef Access_map_dbhandle mi::shader_v3::Map_dbhandle_access

Typedef for backwards compatibility.

Deprecated:
Replaced by Access_map_dbhandle.

typedef Edit_map_dbhandle mi::shader_v3::Map_dbhandle_edit

Typedef for backwards compatibility.

Deprecated:
Replaced by Edit_map_dbhandle.

typedef Edit_map mi::shader_v3::Map_edit

Typedef for backwards compatibility.

Deprecated:
Replaced by Edit_map.

typedef Access_map_iterator mi::shader_v3::Map_iterator_access

Typedef for backwards compatibility.

Deprecated:
Replaced by Access_map_iterator.

typedef Edit_map_iterator mi::shader_v3::Map_iterator_edit

Typedef for backwards compatibility.

Deprecated:
Replaced by Edit_map_iterator.

typedef Access_subdivision34 mi::shader_v3::Subdivision34_access

Typedef for backwards compatibility.

Deprecated:
Replaced by Access_subdivision34.


Classes
class	mi::shader_v3::Interface
	Top level C++ mental ray interface extensions. More...
class	mi::shader_v3::Options
	Access to string options. More...
class	mi::shader_v3::Access_interface
	Interface wrapper class. More...
class	mi::shader_v3::Bsdf
	Simplified BSDF interface. More...
class	mi::shader_v3::Access_bsdf
class	mi::shader_v3::Framebuffer
	Framebuffer class. More...
class	mi::shader_v3::Access_fb
	Smart pointer to access Framebuffer class, no editing. More...
class	mi::shader_v3::Edit_fb
	Smart pointer to access Framebuffer class for editing. More...
class	mi::shader_v3::LightIterator
	Iterate over shader or instance light lists. More...
class	mi::shader_v3::LightList
	Light lists, used internally by LightIterator. More...
class	mi::shader_v3::Map_status
	Map_status class. The Map_status is an enumerative class which is meant to list all possible error conditions for the Map-related classes and methods. More...
class	mi::shader_v3::Map_field_type
	Map_field_type class. The Map_field_type is an enumerative class which is meant to list all possible field types for maps. More...
class	mi::shader_v3::Map_base
	Map_base class. More...
class	mi::shader_v3::Access_map_dbhandle
	Access_map_dbhandle class, not to be used directly (use Access_map instead). More...
class	mi::shader_v3::Access_map
	Smart pointer (access-only) to a map in the DB or to a map to be read from file. It defines a dereference operator which provides access to the const methods of the wrapped Map_base object. More...
class	mi::shader_v3::Edit_map_dbhandle
	Edit_map_dbhandle class, not to be used directly (use Edit_map instead). More...
class	mi::shader_v3::Edit_map
	Smart pointer (read/write) to a map in the DB, to a map to be read from file, or to a newly created one. It defines a dereference operator which provides access to the methods of the wrapped Map_base object. More...
class	mi::shader_v3::Map_declaration_base
	Map_declaration_base class. More...
class	mi::shader_v3::Map_declaration
	Smart pointer to a map declaration, which allows to retrieve a copy of the declaration of an existing map, or to create a new map declaration. It defines a dereference operator which provides access to the methods of the wrapped Map_declaration_base object. More...
class	mi::shader_v3::Map_element_base
	Map_element_base class. More...
class	mi::shader_v3::Map_element
	Smart pointer to a map element. It defines a dereference operator which provides access to the methods of the wrapped Map_element_base object. More...
class	mi::shader_v3::Map_iterator_base
	Map_iterator_base class. More...
class	mi::shader_v3::Access_map_iterator
	Smart pointer to an access-only map iterator. It defines a dereference operator which provides access to the const methods of the wrapped Map_iterator_base object. More...
class	mi::shader_v3::Edit_map_iterator
	Smart pointer to a read-write map iterator. It defines a dereference operator which provides access to the methods of the wrapped Map_iterator_base object. More...
class	mi::shader_v3::Map_distance_base
	Map_distance_base class. The Map_distance_base class is an interface class for all the lookup distance functors. More...
class	mi::shader_v3::Map_distance< DIM >
	Map_distance<DIM> class. The Map_distance class is an interface template class, which defines all the virtual methods of Map_distance_base class except the distance from an element. The distance from a bounding box is quadratic. More...
class	mi::shader_v3::Map_quad_distance< DIM >
	Map_quad_distance class. The Map_quad_distance functor is a concrete distance functor that defines the operator that returns the distance from an element (quadratic distance). More...
struct	mi::shader_v3::Map_lookup_entry
	an entry in a map lookup, the index of an element and its distance from the search point. More...
class	mi::shader_v3::Map_lookup_base
	Map_lookup_base class. More...
class	mi::shader_v3::Map_lookup
	Smart pointer to a map lookup. It defines a dereference operator which provides access to the methods of the wrapped Map_lookup_base object. More...
class	mi::shader_v3::Metasl_interface
	Top level MetaSL mental ray interface extensions. More...
class	mi::shader_v3::Access_base< T >
class	mi::shader_v3::Access_metasl
	`Metasl_interface` wrapper class More...
class	mi::shader_v3::Access_state
	`State` wrapper class More...
class	mi::shader_v3::Subdivision34
	Subdivision34 class. More...
struct	mi::shader_v3::Subdivision34::Face
	face data structure for triangles and quads m_vertices contains either 3 or 4 indices into the vector spaces. use get_vector to access the positions, textures etc using the vertex indices. m_material is the material tag for the given face. More...
class	mi::shader_v3::Access_subdivision34
	Subdivision34 access class. Provides access to Subdivision34 as defined above. More...
Typedefs
typedef Access_interface	Interface_access
	Typedef for backwards compatibility.
typedef miUint	Map_field_id
	Map_field_id.
typedef Access_map_dbhandle	Map_dbhandle_access
	Typedef for backwards compatibility.
typedef Access_map	Map_access
	Typedef for backwards compatibility.
typedef Edit_map_dbhandle	Map_dbhandle_edit
	Typedef for backwards compatibility.
typedef Edit_map	Map_edit
	Typedef for backwards compatibility.
typedef Access_map_iterator	Map_iterator_access
	Typedef for backwards compatibility.
typedef Edit_map_iterator	Map_iterator_edit
	Typedef for backwards compatibility.
typedef Map_quad_distance< 3 >	Map_quad_distance3
	predefined quadratic distance functor for the 3-dimensional case.
typedef Access_subdivision34	Subdivision34_access
	Typedef for backwards compatibility.