mi::shader_v3::Map_edit Class Reference

Smart pointer (read/write) to a map in the DB, to a map to be read from file, or to a newly created one. More...

#include <shader_map.h>

List of all members.

Public Member Functions

Map_edit (const Map_declaration &map_declaration)

Map_edit wrapper class.

Map_edit ()

smart pointer to a new empty map (with no declaration).

Map_edit (const miTag tag)

smart pointer to a map in the DB.

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

smart pointer to a map to be read from file.

~Map_edit ()

release resources, unpin DB tag (if in the DB).

Map_base * operator-> ()

dereference operator.

const Map_base * operator-> () const

const dereference operator.

miTag get_tag () const

returns the tag of the map in the DB.

miTag store ()

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

Detailed Description

Smart pointer (read/write) to a map in the DB, to a map to be read from file, or to a newly created one.

Constructor & Destructor Documentation

mi::shader_v3::Map_edit::Map_edit ( const Map_declaration & map_declaration ) [inline]

Map_edit wrapper class.

Parameters:

map_declaration is the declaration of the new map

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

smart pointer to a map in the DB.

Parameters:

tag is the map database tag

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

Map_status * status = 0

) [inline]

smart pointer to a map to be read from file.

Parameters:

filename file name of the map to read

status a status code

Member Function Documentation

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

returns the tag of the map in the DB.

Returns:
the tag of the map in the DB, or 0 if not in the DB

const Map_base * mi::shader_v3::Map_edit::operator-> ( ) const [inline]

const dereference operator.

Returns:
the map object

Map_base * mi::shader_v3::Map_edit::operator-> ( ) [inline]

dereference operator.

Returns:
the map object

miTag mi::shader_v3::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 &map_declaration)
	Map_edit wrapper class.
	Map_edit ()
	smart pointer to a new empty map (with no declaration).
	Map_edit (const miTag tag)
	smart pointer to a map in the DB.
	Map_edit (const char filename, Map_status status=0)
	smart pointer to a map to be read from file.
	~Map_edit ()
	release resources, unpin DB tag (if in the DB).
Map_base *	operator-> ()
	dereference operator.
const Map_base *	operator-> () const
	const dereference operator.
miTag	get_tag () const
	returns the tag of the map in the DB.
miTag	store ()
	stores the map in the DB (if not in the DB already).