mi::shader::Map_edit Class Reference

Smart pointer to a Map, which allows to access an editable copy of a Map in the DB, to read one from file and to create a new one. More...

#include <shader_map.h>

List of all members.

Public Member Functions

Map_edit (const Map_declaration_handle &map_declaration)

Map_edit wrapper class.

Map_edit ()

smart pointer to a new empty Map class

Map_edit (const miTag tag)

smart pointer to a Map class in the DB

Map_edit (const char *filename, Map_status *status=0)

smart pointer to a Map class

~Map_edit ()

release resources, unpin database tag (if any)

Map * operator-> ()

dereference operator

const Map * operator-> () const

const dereference operator

miTag get_tag () const

returns the tag of the map

miTag store ()

stores the map in the DB (if not in the DB already)

Detailed Description

Smart pointer to a Map, which allows to access an editable copy of a Map in the DB, to read one from file and to create a new one.

Constructor & Destructor Documentation

mi::shader::Map_edit::Map_edit ( const Map_declaration_handle & map_declaration ) [inline]

Map_edit wrapper class.

Parameters:

map_declaration declaration of the new map

mi::shader::Map_edit::Map_edit ( const miTag tag ) [inline]

smart pointer to a Map class in the DB

Parameters:

tag map database tag

mi::shader::Map_edit::Map_edit ( const char * filename,

Map_status * status = 0

) [inline]

smart pointer to a Map class

Parameters:

filename file name of the map to read

status a status code

Member Function Documentation

miTag mi::shader::Map_edit::get_tag ( ) const [inline]

returns the tag of the map

Returns:
the tag of the map in the DB

miTag mi::shader::Map_edit::store ( ) [inline]

stores the map in the DB (if not in the DB already)

Returns:
the tag of the map in the DB

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

shader_map.h


Public Member Functions
	Map_edit (const Map_declaration_handle &map_declaration)
	Map_edit wrapper class.
	Map_edit ()
	smart pointer to a new empty Map class
	Map_edit (const miTag tag)
	smart pointer to a Map class in the DB
	Map_edit (const char filename, Map_status status=0)
	smart pointer to a Map class
	~Map_edit ()
	release resources, unpin database tag (if any)
Map *	operator-> ()
	dereference operator
const Map *	operator-> () const
	const dereference operator
miTag	get_tag () const
	returns the tag of the map
miTag	store ()
	stores the map in the DB (if not in the DB already)