mi::shader::Map_declaration_handle Class Reference

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

#include <shader_map.h>

List of all members.

Public Member Functions

 Map_declaration_handle (const miUint dimension=3)
 Map_declaration_handle wrapper class.
 Map_declaration_handle (const Map_access &map, Map_status *status=0)
 gets a copy of the declaration of the given map
 Map_declaration_handle (const Map_edit &map, Map_status *status=0)
 gets a copy of the declaration of the given map
 Map_declaration_handle (const Map_element_handle &map_element, Map_status *status=0)
 gets a copy of the declaration of the given element
 Map_declaration_handle (const Map_declaration_handle &other, Map_status *status=0)
 copy constructor
 ~Map_declaration_handle ()
 destructor, deletes the declaration
Map_declaration_handle & operator= (const Map_declaration_handle &other)
 copy assignment operator
Map_declaration * operator-> ()
 dereference operator
const Map_declaration * operator-> () const
 const dereference operator

Detailed Description

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.

Constructor & Destructor Documentation

mi::shader::Map_declaration_handle::Map_declaration_handle (  const miUint  dimension = 3  )  [inline]
 

Map_declaration_handle wrapper class.

Parameters:
dimension is the dimension of the position

mi::shader::Map_declaration_handle::Map_declaration_handle (  const Map_access &  map,
Map_status *  status = 0
)  [inline]
 

gets a copy of the declaration of the given map

Parameters:
map is the map to get a copy of the declaration from
status is a status code

mi::shader::Map_declaration_handle::Map_declaration_handle (  const Map_edit &  map,
Map_status *  status = 0
)  [inline]
 

gets a copy of the declaration of the given map

Parameters:
map is the map to get a copy of the declaration from
status is a status code

mi::shader::Map_declaration_handle::Map_declaration_handle (  const Map_element_handle &  map_element,
Map_status *  status = 0
)  [inline]
 

gets a copy of the declaration of the given element

Parameters:
map_element element to get a copy of the declaration from
status is a status code

mi::shader::Map_declaration_handle::Map_declaration_handle (  const Map_declaration_handle &  other,
Map_status *  status = 0
)  [inline]
 

copy constructor

Parameters:
other is the handle of the declaration to copy
status is a status code

Member Function Documentation

Map_declaration_handle & mi::shader::Map_declaration_handle::operator= (  const Map_declaration_handle &  other  )  [inline]
 

copy assignment operator

Parameters:
other is the handle of the declaration to copy

The documentation for this class was generated from the following file:

Copyright © 1986-2008 by mental images GmbH