Unigine.Plugins.Wall Class
The functionality described in this article is not available in the Community SDK edition.
You should upgrade to- Sim
SDK edition to use it.
You should upgrade to
This set of functions is available when the Wall plugin is loaded. This plugin allows rendering Unigine viewport into the configurable number of windows.
Wall plugin cannot be used in a Qt-based application
If the plugin is loaded together with the engine, the HAS_WALL definition is set. This definition can be used, for example, to avoid errors if the plugin is not loaded: the code in which the plugin functions are executed can be wrapped around as follows:
#ifdef HAS_WALL
// engine.wall functions
#endif
See also#
A UnigineScript API sample <UnigineSDK>/data/samples/plugins/app_wall_00
Wall Class
Properties
int PrimaryY#
The number of the monitor in a vertical column, which is the primary and can render GUI, wireframe and other additional information.
int PrimaryX#
The number of the monitor in a horizontal row, which is the primary and can render GUI, wireframe and other additional information.
int WallHeight#
The number of Wall monitors in a vertical column (how many rows of monitors there are).
int WallWidth#
The number of Wall monitors in a horizontal row.
Members
Gui GetGui ( int x, int y ) #
Returns a GUI instance to draw interface on the specified monitor.Arguments
- int x - Monitor number in a horizontal row.
- int y - Monitor number in a vertical column.
Return value
GUI instance.int IsEnabled ( int x, int y ) #
Returns a value indicating if the specified Wall monitor is enabled for viewport rendering.Arguments
- int x - Monitor number in a horizontal row.
- int y - Monitor number in a vertical column.
Return value
Returns 1 if the monitor is enabled for rendering; otherwise, 0.void SetEnabled ( int x, int y, int enable ) #
Enables the specified Wall monitor for viewport rendering.Arguments
- int x - Monitor number in a horizontal row.
- int y - Monitor number in a vertical column.
- int enable - 1 to enable the monitor for rendering; 0 to disable it.
void SetPrimary ( int x, int y ) #
Sets the monitor to be the primary display that can render GUI, wireframe and other additional information.Arguments
- int x - Monitor number in a horizontal row.
- int y - Monitor number in a vertical column.
Camera GetCamera ( int x, int y ) #
Returns the camera from the specified monitor.Arguments
- int x - Column of the monitor.
- int y - Row of the monitor.
Return value
Camera.void SetCamera ( int x, int y, Camera camera ) #
Copies the camera from the specified monitor to the provided camera.Arguments
- int x - Column of the monitor.
- int y - Row of the monitor.
- Camera camera - Camera.
Last update:
2023-12-19
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)