Manager Class
Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
This class provides auxiliary functions for configuring the plugin, as well as access to an object of DisplaysConfig class.
Manager Class
Members
DisplaysConfig getConfig() const#
Returns the current DisplaysConfig class instance that stores the complete configuration data.
Return value
Current DisplaysConfig class instance that stores the complete configuration data.void setComputerName ( String name ) #
Sets a new name of the computer on which the viewport is to be displayed. If this parameter is not set, the viewport can be displayed on any PC. If set, the viewport is only displayed on the PC that has a matching name.
Arguments
- String name - The name of the computer on which the viewport is to be displayed.
String getComputerName() const#
Returns the current name of the computer on which the viewport is to be displayed. If this parameter is not set, the viewport can be displayed on any PC. If set, the viewport is only displayed on the PC that has a matching name.
Return value
Current name of the computer on which the viewport is to be displayed.void setEnabled ( bool enabled ) #
Sets a new value indicating if the SpiderVision plugin is enabled.
Arguments
- bool enabled - Set true to enable the SpiderVision plugin; false - to disable it.
bool isEnabled() const#
Returns the current value indicating if the SpiderVision plugin is enabled.
Return value
true if the SpiderVision plugin is enabled; otherwise false.int isConfiguratorEnabled() const#
Returns the current value indicating if the configurator window is open.
Return value
Current the configurator interfacestatic getEventComputerNameChanged() const#
The event handler signature is as follows: myhandler()Usage Example
Source code
Return value
Event reference.int findViewportID ( ) #
Returns the of the viewport window with the specified name.Arguments
Return value
ID of the viewport window with the specified name if it exists, otherwise -1.int findGroupID ( ) #
Returns the of the viewport group with the specified name.Arguments
Return value
ID of the viewport group with the specified name if it exists, otherwise -1.void setProjectionEnabled ( int viewport_id, bool enabled ) #
Sets a value indicating if the projection for the specified viewport (correction of the image according to projection) is enabled. If disabled, the image is rendered as seen from the point of view without any distortions (i.e. regardless of the viewport plane position in the configuration space). If enabled, the image takes into account the projection angle (i.e. the viewport plane position relative to the point of view in the configuration space) and distorts the rendered image accordingly.Arguments
- int viewport_id - ID of the viewport window.
- bool enabled - true to enable projection for the specified viewport; false - to disable.
void setViewportCustomPlayer ( int viewport_id, Player player ) #
Assigns a player to the specified viewport.Arguments
- int viewport_id - ID of the viewport window.
- Player player - The player camera.
void setViewportViewOffset ( int viewport_id, Vec3 offset ) #
Sets a camera view offset (eye position) for the viewport with the specified ID.Arguments
- int viewport_id - ID of the viewport window.
- Vec3 offset - Camera view offset coordinates along the corresponding axes.
void setGroupCustomPlayer ( int group_id, Player player ) #
Assigns a player to the specified group of viewports.Arguments
- int group_id - ID of the viewport group.
- Player player - The player camera.
void setGroupViewOffset ( int group_id, Vec3 offset ) #
Sets a camera view offset (eye position) for the viewport group with the specified ID.Arguments
- int group_id - ID of the viewport group.
- Vec3 offset - Camera view offset coordinates along the corresponding axes.
EngineWindowViewport getEngineWindow ( int viewport_id ) #
Returns the engine window viewport for the specified viewport.Arguments
- int viewport_id - ID of the viewport window.
Return value
The engine window viewport.The information on this page is valid for UNIGINE 2.20 SDK.
Last update:
2024-11-25
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)