This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Basics
Rendering
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API Reference
Animations-Related Classes
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
VR-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

GroupData 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 stores the settings for the group of viewport arranged according to a predefined pattern.

The color correction data are stored in the configuration file.

This object is accessible via the corresponding method of the DisplaysConfig class.

GroupData Class

Members

int getID() const#

Returns the current ID of the viewport group.

Return value

Current ID of the viewport group.

int getType() const#

Returns the current type of the viewport group.

Return value

Current type of the viewport group.

void setName ( String name ) #

Sets a new name of the viewport group.

Arguments

  • String name - The name of the viewport group.

String getName() const#

Returns the current name of the viewport group.

Return value

Current name of the viewport group.

void saveXml ( Xml xml ) #

Saves the viewport group data to the given instance of the Xml class.

Arguments

  • Xml xml - Xml class instance into which the data will be saved.

int restoreXml ( Xml xml ) #

Loads the viewport group data from the specified instance of the Xml class.

Arguments

  • Xml xml - Xml class instance the data from which is to be loaded.

Return value

1 if the data has been loaded successfully, otherwise 0.

void save ( Stream stream ) #

Saves the viewport group data to the specified stream.

Arguments

  • Stream stream - Stream to which the data is to be written.

void restore ( Stream stream ) #

Loads the viewport group data from the specified stream.

Arguments

  • Stream stream - Stream the data from which is to be loaded.

The information on this page is valid for UNIGINE 2.20 SDK.

Last update: 2024-07-12
Build: ()