UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
FAQ
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes

Unigine::UGUID Class

Header: #include <UnigineGUID.h>

This class represents a globally unique identifier (a 40-byte hash value). The SHA1 algorithm is used for hash generation.

UGUID Class

Members


UGUID ( ) #

Default constructor. Creates an empty 0-filled UGUID.

UGUID ( const char * str ) #

Constructor. Creates a UGUID from the given source string. UGUID is generated using the SHA1 algorithm.

Arguments

  • const char * str - Source string.

UGUID ( const UGUID & guid ) #

Copy constructor. Creates a UGUID by copying a source UGUID.

Arguments

  • const UGUID & guid - Source UGUID.

void generate ( ) #

Generates a new random UGUID value.

void generate ( const char * str ) #

Generates a UGUID value from the given source string using the SHA1 algorithm.

Arguments

  • const char * str - Source string.

unsigned int hash ( ) #

Returns a hash for the UGUID value.

Return value

Hash generated for the UGUID value.

void clear ( ) #

Clears the UGUID value. All 40 bytes are set to 0.

int isEmpty ( ) #

Returns a value indicating if the UGUID is empty (all 40 bytes are equal to 0).

Return value

1 if the UGUID is empty; otherwise, 0.

int isValid ( ) #

Returns a value indicating if the UGUID has a valid value.

Return value

1 if the value is valid; otherwise, 0.

const char * getFileSystemString ( ) #

Returns the string containing the UGUID value with the filesystem prefix "guid://".

Return value

UGUID value with the filesystem prefix "guid://".

void setString ( const char * str ) #

Sets the UGUID value equal to a given 40-character hexadecimal string.

Arguments

  • const char * str - 40-character hexadecimal string representing the UGUID value.

const char * getString ( ) #

Returns the UGUID value as a 40-character hexadecimal string.

Return value

40-character hexadecimal string representing the UGUID value.

UGUID & operator= ( const char * str ) #

Performs UGUID assignment. The value of the destination UGUID is set equal to the source hexadecimal string.

Arguments

  • const char * str - Source string. A 40-character hexadecimal string representing the UGUID value.

Return value

Result.

UGUID & operator= ( const UGUID & g ) #

Performs UGUID assignment. Destination UGUID = Source UGUID.

Arguments

  • const UGUID & g - Source UGUID.

Return value

Result.

int operator> ( const UGUID & g ) #

Indicates whether the UGUID value is greater than the source UGUID value.

Arguments

  • const UGUID & g - Source UGUID.

Return value

1 if the UGUID value is greater than the source UGUID value; otherwise, 0.

int operator>= ( const UGUID & g ) #

Indicates whether the UGUID value is greater than or equal to the source UGUID value.

Arguments

  • const UGUID & g - Source UGUID.

Return value

1 if the UGUID value is greater than or equal to the source UGUID value; otherwise, 0.

int operator< ( const UGUID & g ) #

Indicates whether the UGUID value is less than the source UGUID value.

Arguments

  • const UGUID & g - Source UGUID.

Return value

1 if the UGUID value is less than or equal to the source UGUID value; otherwise, 0.

int operator<= ( const UGUID & g ) #

Indicates whether the UGUID value is less than or equal to the source UGUID value.

Arguments

  • const UGUID & g - Source UGUID.

Return value

1 if the UGUID value is less than or equal to the source UGUID value; otherwise, 0.

int operator== ( const UGUID & g ) #

Equality. Indicates whether the UGUID value is equal to the source UGUID value.

Arguments

  • const UGUID & g - Source UGUID.

Return value

1 if the UGUID value is equal to the source UGUID value; otherwise, 0.

int operator!= ( const UGUID & g ) #

Inequality. Indicates whether the UGUID value is not equal to the source UGUID value.

Arguments

  • const UGUID & g - Source UGUID.

Return value

1 if the UGUID value is not equal to the source UGUID value; otherwise, 0.

const char * get ( ) #

Returns the UGUID value as a string.

Return value

String.

char & get ( int index ) #

Returns a UGUID character by index.

Arguments

  • int index - Index of the character

Return value

Character of UGUID

char get ( int index ) #

Constant array access.

Arguments

  • int index - Array item index

Return value

Array item

char & operator[] ( int index ) #

Array access.

Arguments

  • int index - Array item index

Return value

Array item

char operator[] ( int index ) #

Item access by index.

Arguments

  • int index

const char * operator const char * ( ) #

Returns the pointer to the current string.

Return value

Pointer to the current string

const void * operator const void * ( ) #

Returns the pointer to the current string.
Last update: 2019-07-18