This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
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
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
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

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 ( unsigned char value_ ) #

Arguments

  • unsigned char value_ - Source character.

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.

void generate ( int& seed_ ) #

Generates a random UGUID value using the seed value.

Arguments

  • int& seed_ - Seed value.

void generate ( const void* data, int size ) #

Generates a UGUID value from the given source byte array of the specified size using the SHA1 algorithm.

Arguments

  • const void* data - Source byte array.
  • int size - Number of bytes to be taken from the byte array for UGUID generation.

unsigned int hash ( ) #

Returns a hash for the UGUID value.

Return value

Hash generated for the UGUID value.

unsigned long long hashLong ( ) const#

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.

bool isEmpty ( ) const#

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

Return value

true if the UGUID is empty; otherwise, false.

bool isValid ( ) const#

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

Return value

true if the value is valid; otherwise, false.

void setFileSystemString ( const char * str ) #

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

Arguments

  • const char * str - UGUID value with the filesystem prefix "guid://" to be set.

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

const unsigned char * getValue ( ) const#

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: 2023-06-23
Build: ()