mi::shader_v3::Edit_map 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. It defines a dereference operator which provides access to the methods of the wrapped Map_base object. More...

#include <shader_map.h>

List of all members.

Public Member Functions
	Edit_map (const Map_declaration &map_declaration)
	smart pointer to a new empty map.
	Edit_map ()
	smart pointer to a new empty map (with no declaration).
	Edit_map (const miTag tag)
	smart pointer to a map in the DB.
	Edit_map (const char *filename, Map_status *status=0)
	smart pointer to a map to be read from file.
	~Edit_map ()
	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. It defines a dereference operator which provides access to the methods of the wrapped Map_base object.

---

Constructor & Destructor Documentation

mi::shader_v3::Edit_map::Edit_map

(

const Map_declaration &

map_declaration

)

[inline]

smart pointer to a new empty map.

Edit_map wrapper class.

Parameters:

map_declaration

is the declaration of the new map

mi::shader_v3::Edit_map::Edit_map

(

const miTag

tag

)

[inline]

smart pointer to a map in the DB.

Parameters:

tag

is the map database tag

mi::shader_v3::Edit_map::Edit_map	(	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

Map_base * mi::shader_v3::Edit_map::operator->

(

)

[inline]

dereference operator.

Returns:

the map object

const Map_base * mi::shader_v3::Edit_map::operator->

(

)

const [inline]

const dereference operator.

Returns:

the map object

miTag mi::shader_v3::Edit_map::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

References mi::shader_v3::Edit_map_dbhandle::get_tag().

miTag mi::shader_v3::Edit_map::store

(

)

[inline]

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

Returns:

the tag of the map in the DB

References mi::shader_v3::Edit_map_dbhandle::store().