CommonRendererUI Namespace Reference

This namespace aggregates various UI functionality to be shared by renderers. More...

Functions
CommonRendererUIExport bool	DoMissingMapsDialog (const NameTab &names, HWND hwnd)
	Shows the missing maps dialog.
CommonRendererUIExport bool	DoMissingUVWChannelsDialog (const NameTab &missingUVWEntries, HWND hwnd)
	Shows the missing UVW channels dialog.

Detailed Description

This namespace aggregates various UI functionality to be shared by renderers.

Function Documentation

DoMissingMapsDialog()

CommonRendererUIExport bool DoMissingMapsDialog	(	const NameTab &	names,
		HWND	hwnd
	)

Shows the missing maps dialog.

The missing maps dialog displays a list of provided file paths for missing maps. It is up to the caller to accumulate that list. The dialog provides the user with the option to browse for the missing maps, adding to the list of search paths. Thus, if the user should press Continue, the renderer should attempt to re-resolve the missing map files before moving on to rendering.

Remarks

This method internally handles logging, error reporting, network rendering, etc.

Parameters

names	The list of file paths to missing maps.
hwnd	Handle to the parent window of the pop-up to be displayed.

Returns

True if rendering should continue normally - either because the user pressed Continue, or because UI pop-ups are disabled (e.g. for network rendering) and the system is set to continue on errors. False if rendering should be cancelled, either because the user pressed Cancel or because UI pop-ups are disabled (e.g. for network rendering) and the system is set to abort on errors.

DoMissingUVWChannelsDialog()

CommonRendererUIExport bool DoMissingUVWChannelsDialog	(	const NameTab &	missingUVWEntries,
		HWND	hwnd
	)

Shows the missing UVW channels dialog.

The missing UVW channels dialog informs the user of a list of objects and UVW channels that are required by their materials, but missing from the geometry. This dialog is purely informative and allows the user to continue or cancel.

Remarks

This method internally handles logging, error reporting, network rendering, etc.

Parameters

missingUVWEntries	The list of strings to display in the missing UVW channels dialog. The standard format is as follows: "(UVW <channel_id>): <object_name>" or "(Vertex Colors): <object_name>".
hwnd	Handle to the parent window of the pop-up to be displayed.

Returns

True if rendering should continue normally - either because the user pressed Continue, or because UI pop-ups are disabled (e.g. for network rendering) and the system is set to continue on errors. False if rendering should be cancelled, either because the user pressed Cancel or because UI pop-ups are disabled (e.g. for network rendering) and the system is set to abort on errors.