shader_map.h File Reference

#include "mi_shader_if.h"

Go to the source code of this file.

Namespaces

namespace  mi
namespace  mi::shader_v3

Classes

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...

Typedefs

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.


Detailed Description

mental ray C++ shader interface extensions.

This file provides interfaces that allow interaction with map primitives.

shader_map.h is included by mi_shader_if.h, which in turn is included from shader.h if the shader is compiled as C++ code. A shader does not need to include this file directly.


Typedef Documentation

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.

Copyright © 1986-2009 by mental images GmbH