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

#include <shader_map.h>

List of all members.

Public Member Functions
	Map_declaration (const miUint dimension=3)
	smart pointer to a new map declaration.
	Map_declaration (const Access_map &map, Map_status *status=0)
	gets a copy of the declaration of the given map.
	Map_declaration (const Edit_map &map, Map_status *status=0)
	gets a copy of the declaration of the given map.
	Map_declaration (const Map_element &map_element, Map_status *status=0)
	gets a copy of the declaration of the given element.
	Map_declaration (const Map_declaration &other, Map_status *status=0)
	copy constructor.
	~Map_declaration ()
	destructor, deletes the declaration.
Map_declaration &	operator= (const Map_declaration &other)
	copy assignment operator.
Map_declaration_base *	operator-> ()
	dereference operator.
const Map_declaration_base *	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. It defines a dereference operator which provides access to the methods of the wrapped Map_declaration_base object.

---

Constructor & Destructor Documentation

mi::shader_v3::Map_declaration::Map_declaration

(

const miUint

dimension = 3

)

[inline]

smart pointer to a new map declaration.

Map_declaration wrapper class.

Parameters:

dimension

is the dimension of the position

mi::shader_v3::Map_declaration::Map_declaration	(	const Access_map &	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_v3::Map_declaration::Map_declaration	(	const Edit_map &	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_v3::Map_declaration::Map_declaration	(	const Map_element &	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_v3::Map_declaration::Map_declaration	(	const Map_declaration &	other,
		Map_status *	status = 0
	)			[inline]

copy constructor.

Parameters:

	other	is the declaration to copy
	status	is a status code

References m_map_declaration.

---

Member Function Documentation

Map_declaration & mi::shader_v3::Map_declaration::operator=

(

const Map_declaration &

other

)

[inline]

copy assignment operator.

Parameters:

other

is the declaration to copy

References m_map_declaration, and mi::shader_v3::Map_declaration_base::release().

Map_declaration_base * mi::shader_v3::Map_declaration::operator->

(

)

[inline]

dereference operator.

Returns:

the map declaration object

const Map_declaration_base * mi::shader_v3::Map_declaration::operator->

(

)

const [inline]

const dereference operator.

Returns:

the map declaration object