Viewer

Namespaces
namespace	sal3d::Viewer
	Namespace for the Viewer functions.
Functions
void	sal3d::Viewer::initialize ()
	Initializes internal data needed to use the other functions in this module. Be sure to call if first.
void	sal3d::Viewer::cleanup ()
	Releases the resources allocated in initialize(). This function should be called once the viewers are no longer needed.
void	sal3d::Viewer::display (const sal3d::RangeMap &rm)
	Open a viewer with the RangeMap or update the one displayed.
void	sal3d::Viewer::display (const sal3d::COP &cop)
	Open a viewer with the COP or update the one displayed.
void	sal3d::Viewer::display (const sal3d::COP &cop1, const sal3d::COP &cop2)
	Open a viewer with the two COPs or update the one displayed.
void	sal3d::Viewer::display (const sal3d::ZMap &zmap)
	Open a viewer with the ZMap or update the one displayed.
void	sal3d::Viewer::waitAllClosed ()
	Holds the execution of the program until all the windows are closed.

---

Function Documentation

void sal3d::Viewer::cleanup

(

)

[inline]

Releases the resources allocated in initialize(). This function should be called once the viewers are no longer needed.

This function requires linking with viewer.lib (import library for viewer.dll).

This function should be called when the viewers are no longer needed. Failing to do so will cause memory leaks.

Exceptions:

sal3d::Error

On error

void sal3d::Viewer::display

(

const sal3d::RangeMap &

rm

)

[inline]

Open a viewer with the RangeMap or update the one displayed.

This function requires linking with viewer.lib (import library for viewer.dll).

If no RangeMap viewer exists, this function will create one and display the one passed to it. Otherwise, the existing one will be updated to display it.

Parameters:

[in]

rm

The RangeMap to be displayed.

Exceptions:

sal3d::Error

On error

References sal3d::RangeMap::c_range_map().

void sal3d::Viewer::display

(

const sal3d::COP &

cop

)

[inline]

Open a viewer with the COP or update the one displayed.

This function requires linking with viewer.lib (import library for viewer.dll).

If no COP viewer exists, this function will create one and display the one passed to it. Otherwise, the existing one will be updated to display it.

Parameters:

[in]

cop

The COP to be displayed.

Exceptions:

sal3d::Error

On error

References sal3d::COP::c_cop().

void sal3d::Viewer::display	(	const sal3d::COP &	cop1,
		const sal3d::COP &	cop2
	)		[inline]

Open a viewer with the two COPs or update the one displayed.

This function requires linking with viewer.lib (import library for viewer.dll).

If no COP viewer exists, this function will create one and display the ones passed to it. Otherwise, the existing one will be updated to display them.

Parameters:

[in]	cop1	The first COP to be displayed.
[in]	cop2	The second COP to be displayed.

Exceptions:

sal3d::Error

On error

References sal3d::COP::c_cop().

void sal3d::Viewer::display

(

const sal3d::ZMap &

zmap

)

[inline]

Open a viewer with the ZMap or update the one displayed.

This function requires linking with viewer.lib (import library for viewer.dll).

If no ZMap viewer exists, this function will create one and display the one passed to it. Otherwise, the existing one will be updated to display it.

Parameters:

[in]

zmap

The ZMap to be displayed.

Exceptions:

sal3d::Error

On error

References sal3d::ZMap::c_zmap().

void sal3d::Viewer::initialize

(

)

[inline]

Initializes internal data needed to use the other functions in this module. Be sure to call if first.

This function requires linking with viewer.lib (import library for viewer.dll).

This function should be called before any of the others in this module, as it initializes some internal data needed for the viewers to properly work. Once no more viewers are needed, one should call the cleanup() function to release the resources allocated here.

Exceptions:

sal3d::Error

On error

void sal3d::Viewer::waitAllClosed

(

)

[inline]

Holds the execution of the program until all the windows are closed.

This function requires linking with viewer.lib (import library for viewer.dll).

When this function is called, it does nothing but wait for all the viewer windows to be closed. It can be called after displaying the wanted objects, so the program doesn't continue until the user decides.