UlonNode Class

WarningThe 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 is used to represent a ULON node.

Each ULON node has a type, a name, and a value. It can also have child ULON nodes and a parent node, thus forming a hierarchy.

A node is declared as follows:

Source code

NodeType node_name = node_value

ULON nodes can be of the following types:

Boolean
Node node = true
Integer number
Node node = 1234
Floating-point number
Node node = 3.1459
String
- Quoted string with standard escape characters:
  Node node = "word word"
- Bare word, beginning with a lower case letter, containing only letters, digits, and underscores "_":
  Node node = word1_word2
- Heredoc string enclosed in #{ ... #} (used for code fragments):
  Node node = #{C++ C# USC HLSL GLSL USSL#}
Array containing a finite number of integer, float, and string elements
Node node = [100, 0.2, str str "str str str", #{vec4 asd = vec4_zero;#}] This array has the following 6 elements:
- 100
- 0.2
- str
- str
- str str str
- vec4 asd = vec4_zero;

Conditions#

For each node a condition can be specified, if the condition fails the ULON node with all its children is ignored. Thus you can dynamically build the hierarchy of ULON nodes with a great degree of flexibility.

Notice

Conditions are not parsed and executed automatically, processing of conditions is the responsibility of the user of the ULON format (e.g. in case of materials UnigineScript and UUSL are used).

Conditions are specified after the node's name, starting with the if keyword, the condition itself is enclosed in brackets [ ... ].

Condition of the parent node is added to the condition of the child: (parent_conditon) && (child_conditon)

Example:

Source code

Node parent if[var == 10 || var == 5]
{
    Node child_0  if[var == 3]
    Node child_1  if[var == 4]
    {
        Node child_2 if[var != 11]
        Node child_3 if[var != 25]
	}
}

The resulting conditions for each node are as follows:

parent condition: (var1 == 10 || var1 == 5)
child_0 condition: (var1 == 10 || var1 == 5) && (var2 == 3)
child_1 condition: (var1 == 10 || var1 == 5) && (var2 == 4)
child_2 condition: (var1 == 10 || var1 == 5) && (var2 == 4) && (var3 != 11)
child_3 condition: (var1 == 10 || var1 == 5) && (var2 == 4) && (var3 != 25)

Methods:

Name	Description View: Sort by:
UlonNode	Constructor.
getType	Returns the type of the ULON node.
getName	Returns the name of the ULON node.
getCondition	Returns a condition set for the ULON node.
getValue	Returns the value of the ULON node.
load	Loads ULON-data from the specified file and sets the current ULON node to be the root of the parsed hierarchy.
parse	Parses a given string into the ULON node.
getChildren	Returns the list of all children of the ULON node.
getArgs	Returns the list of all arguments of the ULON node.
isArg	Checks whether an argument with a given name exists.
getArgFloat	Returns the value of the ULON node argument with the specified name as a float.
getArgInt	Returns the value of the ULON node argument with the specified name as an integer.
getArgLong	Returns the value of the ULON node argument with the specified name as a 64-bit long.
getArgBool	Returns the value of the ULON node argument with the specified name as a boolean.
getArgChar	Returns the value of the ULON node argument with the specified name as a char.
getArgStr	Returns the value of the ULON node argument with the specified name as a string.
getArgArray	Returns the value of the ULON node argument with the specified name as an array of strings.
printUnusedData	Prints warnings of unused data (node values and arguments) for the file with the specified name to the Console for debugging.
clearUnusedData	Clears all unused node data (node values and arguments).

UlonNode Class

Members

static UlonNode ( ) #

Constructor. Creates a ULON node.

int load ( string path ) #

Loads ULON-data from the specified file and sets the current ULON node to be the root of the parsed hierarchy.

Arguments

string path - Path to the file containing ULON description.

Return value

1 if ULON-data from the specified file is read successfully; otherwise, 0.

int parse ( string str ) #

Parses a given string into the ULON node.

Arguments

string str - String to parse.

Return value

true if the string was parsed successfully; otherwise, false.

Vector<UlonNode> getChildren ( ) #

Returns the list of all children of the ULON node.

Return value

List of all ULON node's children.

string getType ( ) #

Returns the type of the ULON node.

Return value

ULON node type.

string getName ( ) #

Returns the name of the ULON node.

Return value

ULON node name.

string getCondition ( ) #

Returns a condition set for the ULON node.

Notice

Conditions are not parsed and executed automatically, processing of conditions is the responsibility of the user of the ULON format (e.g. in case of materials UnigineScript and UUSL are used).

Return value

condition set for the ULON node.

UlonValue getValue ( ) #

Returns the value of the ULON node.

Return value

ULON node value.

Vector<UlonArg> getArgs ( ) #

Returns the list of all arguments of the ULON node.

Return value

List of all arguments of the ULON node.

int isArg ( string name ) #

Checks whether an argument with a given name exists.

Arguments

string name - Name of the argument to be checked.

Return value

1 if an argument with the specified name exists; otherwise, 0.

float getArgFloat ( string name, float ret = 0 ) #

Returns the value of the ULON node argument with the specified name as a float.

Notice

To check, if an argument exists, use the isArg() method.

Arguments

string name - Argument name.
float ret - Default value to be returned if a ULON node argument with the specified name is not found.

Return value

Float value of the ULON node argument, if it exists; otherwise a default value set via the ret parameter.

int getArgInt ( string name, int ret = 0 ) #

Returns the value of the ULON node argument with the specified name as an integer.

Notice

To check, if an argument exists, use the isArg() method.

Arguments

string name - Argument name.
int ret - Default value to be returned if a ULON node argument with the specified name is not found.

Return value

Integer value of the ULON node argument, if it exists; otherwise a default value set via the ret parameter.

long getArgLong ( string name, long ret = 0 ) #

Returns the value of the ULON node argument with the specified name as a 64-bit long.

Notice

To check, if an argument exists, use the isArg() method.

Arguments

string name - Argument name.
long ret - Default value to be returned if a ULON node argument with the specified name is not found.

Return value

64-bit long value of the ULON node argument, if it exists; otherwise a default value set via the ret parameter.

int getArgBool ( string name, int ret = false ) #

Returns the value of the ULON node argument with the specified name as a boolean.

Notice

To check, if an argument exists, use the isArg() method.

Arguments

string name - Argument name.
int ret - Default value to be returned if a ULON node argument with the specified name is not found.

Return value

Boolean value of the ULON node argument, if it exists; otherwise a default value set via the ret parameter.

char getArgChar ( string name, char ret = 0 ) #

Returns the value of the ULON node argument with the specified name as a char.

Notice

To check, if an argument exists, use the isArg() method.

Arguments

string name - Argument name.
char ret - Default value to be returned if a ULON node argument with the specified name is not found.

Return value

Char value of the ULON node argument, if it exists; otherwise a default value set via the ret parameter.

string getArgStr ( string name, string ret = "" ) #

Returns the value of the ULON node argument with the specified name as a string.

Notice

To check, if an argument exists, use the isArg() method.

Arguments

string name - Argument name.
string ret - Default value to be returned if a ULON node argument with the specified name is not found.

Return value

String value of the ULON node argument, if it exists; otherwise a default value set via the ret parameter.

Vector<String> getArgArray ( string name ) #

Returns the value of the ULON node argument with the specified name as an array of strings.

Notice

To check, if an argument exists, use the isArg() method.

Arguments

string name - Argument name.

Return value

Array of strings representing elements of the array value, if it exists; otherwise an empty string array.

void printUnusedData ( string name ) #

Prints warnings of unused data (node values and arguments) for the file with the specified name to the Console for debugging.

Arguments

string name - File name.

void clearUnusedData ( ) #

Clears all unused node data (node values and arguments).

Last update: 2022-02-04

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)