mi::shader_v3::Map_access Class Reference

Smart pointer (access-only) to a map in the DB or to a map to be read from file. More...

#include <shader_map.h>

List of all members.

Public Member Functions

Map_access (const miTag tag)

Map_access wrapper class.

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

smart pointer to a map to be read from file.

~Map_access ()

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

const 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 (access-only) to a map in the DB or to a map to be read from file.

Constructor & Destructor Documentation

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

Map_access wrapper class.

Parameters:

tag is the map database tag

mi::shader_v3::Map_access::Map_access ( 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_access::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_access::operator-> ( ) const [inline]

const dereference operator.

Returns:
the map object

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

dereference operator.

Returns:
the map object

miTag mi::shader_v3::Map_access::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_access (const miTag tag)
	Map_access wrapper class.
	Map_access (const char filename, Map_status status=0)
	smart pointer to a map to be read from file.
	~Map_access ()
	release resources, unpin DB tag (if in the DB).
const 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).