Unigine::Json Class
Header: | #include <UnigineJson.h> |
This class is used to parse and create JSON formatted strings.
Each Json node has type, name, and value. Also, it can have child Json nodes and a parent node.
Json node can have one of the following types:
- null
- bool
- number
- string
- array
- object
The Json node has a hierarchy structure. The following code creates a Json node and adds child nodes with different types of values:
#include <UnigineJson.h>
/* ... */
JsonPtr json = Json::create();
json->addChild("child_0",0); // int
json->addChild("child_1",1.1); // float
json->addChild("child_2","two"); // string
The result is:
{
"child_0": 0,
"child_1": 1.1,
"child_2": "two"
}
Child nodes have names "child_0", "child_1", "child_2" and values: integer 0, double 1.1 and string "two". The name has always string type.
Json Class
Members
static JsonPtr create ( ) #
Default constructor that creates an empty instance.static JsonPtr create ( const char * name ) #
Constructor that creates a JSON node with a given name.Arguments
- const char * name - Name of the Json node.
void setArray ( ) #
Sets array type to the current Json node.int isArray ( ) const#
Returns a value indicating if the Json node has an array type.Return value
1 if the Json has an array type; otherwise, 0.void setBool ( int arg1 ) #
Sets a boolean value and type to the current Json node.Arguments
- int arg1 - Integer value.
int getBool ( ) const#
Reads a boolean value of the current Json node.Return value
1 if the Json node has a bool type; otherwise, 0.int isBool ( ) const#
Returns a value indicating if the Json node has a bool type.Return value
1 if the Json has a bool type; otherwise, 0.Ptr<Json> getChild ( int num ) const#
Returns the child node of the current Json node.Arguments
- int num - Argument of one of the following types:
- string name - Name of the Json node.
- int number - Number of the child of the Json node.
Return value
Child Json node.Ptr<Json> getChild ( const char * name ) const#
Returns the child node of the current Json node.Arguments
- const char * name - Argument of one of the following types:
- string name - Name of the Json node.
- int number - Number of the child of the Json node.
Return value
Child Json node.int isChild ( const char * name ) const#
Checks if a child node with a given name exists.Arguments
- const char * name - Name of the child node.
Return value
1 if a child with the provided name exists; otherwise, 0.Ptr<Json> addChild ( const char * name, double value, double value ) #
Adds a new name-value pair as a child node to the current Json node.Arguments
- const char * name - Node name.
- double value - Argument of one of the following types:
- int value - integer value.
- float value - float value.
- string value - string value.
- double value - Argument of one of the following types:
- int value - integer value.
- float value - float value.
- string value - string value.
Return value
Child Json node.Ptr<Json> addChild ( const char * name ) #
Adds a new name-value pair as a child node to the current Json node.Arguments
- const char * name - Node name.
Return value
Child Json node.Ptr<Json> addChild ( const char * name, const char * value ) #
Adds a new name-value pair as a child node to the current Json node.Arguments
- const char * name - Node name.
- const char * value - Argument of one of the following types:
- int value - integer value.
- float value - float value.
- string value - string value.
Return value
Child Json node.Ptr<Json> addChild ( const Ptr<Json> & json ) #
Adds a new name-value pair as a child node to the current Json node.Arguments
- const Ptr<Json> & json - Node name.
Return value
Child Json node.Ptr<Json> addChild ( const char * name, int value ) #
Adds a new name-value pair as a child node to the current Json node.Arguments
- const char * name - Node name.
- int value - Argument of one of the following types:
- int value - integer value.
- float value - float value.
- string value - string value.
Return value
Child Json node.Ptr<Json> addChild ( ) #
Adds a child node to the current Json node.Return value
Child Json node.String getSubTree ( const char * name = 0 ) #
Returns a subtree of a Json node as the non-formatted string.Arguments
- const char * name - The name of a child node. If there is a name, the function returns formatted subtree for this child Json node.
Return value
Non-formatted subtree.String getFormattedSubTree ( const char * name = 0 ) #
Returns a subtree of a Json node as the formatted string.Arguments
- const char * name - The name of a child node. If there is a name, the function returns formatted subtree for this child Json node.
Return value
Formatted subtree.void setName ( const char * name ) #
Sets the given name to the Json node.Arguments
- const char * name - Name of the Json node.
const char * getName ( ) const#
Returns the name of the current Json node.Return value
The name of the Json node.void setNull ( ) #
Sets null type to the current Json node.int isNull ( ) const#
Returns a value indicating if the Json node has a null type.Return value
1 if the Json has a null type; otherwise, 0.void setNumber ( double arg1 ) #
Sets a number value and type to the current Json node.Arguments
- double arg1 - Double value.
double getNumber ( ) const#
Returns the number value of the current Json node.Return value
Number value of the current Json node.int isNumber ( ) const#
Returns a value indicating if the Json node has a number type.Return value
1 if the Json has a number type; otherwise, 0.int getNumChildren ( ) const#
Returns the number of child nodes of the current Json node.Return value
Number of child nodes.void setObject ( ) #
Sets object type to the current Json node.int isObject ( ) const#
Returns a value indicating if the Json node has an object type.Return value
1 if the Json has an object type; otherwise, 0.Ptr<Json> getParent ( ) #
Returns the parent node of the current Json node.Return value
Parent Json node.void setString ( const char * arg1 ) #
Sets a string value and type to the current Json node. The function automatically casts number values to string type.Arguments
- const char * arg1 - String value.
String getString ( ) #
Returns the value of the current Json node as string.Return value
Value of the current Json nodeint isString ( ) const#
Returns a value indicating if the Json node has a string type.Return value
1 if the Json has a string type; otherwise, 0.void clear ( ) #
Clears all data of the current Json node including type, value, name and all children. If the current Json node has a parent, it also removed from the parent Json node.Ptr<Json> removeChild ( const Ptr<Json> & json ) #
Removes the child Json node.Arguments
- const Ptr<Json> & json - Argument of one of the following types:
- Json json - Json node.
- string name - Name of the Json node.
Return value
Removed child Json node.Ptr<Json> removeChild ( const char * name ) #
Removes the child Json node.Arguments
- const char * name - Argument of one of the following types:
- Json json - Json node.
- string name - Name of the Json node.
Return value
Removed child Json node.void clearChildren ( ) #
Clears all children of the current Json node.void copy ( const Ptr<Json> & source ) #
Copies type, name and value from the source Json node to the current Json node and adds the source Json child nodes as child nodes to the current Json node.Arguments
- const Ptr<Json> & source - Source Json node.
Ptr<Json> find ( const char * name ) #
Finds Json node by its name in current Json node tree.Arguments
- const char * name - Name of the Json node.
Return value
Founded Json node.int load ( const char * path ) #
Loads the data to the current Json node from the file with a given path.Arguments
- const char * path - Path of the file.
Return value
1 if the Json node was loaded successfully; otherwise, 0.int parse ( const char * source ) #
Parses a given string into the Json node.Usage Example
#include <UnigineJson.h>
/* ... */
JsonPtr json = Json::create();
json->addChild("child_0", 1);
JsonPtr json_2 = Json::create();
json_2->parse(json->getSubTree().get());
Now the json_2 node contains:
{
"child_0": 1
}
Arguments
- const char * source - String to parse.
Return value
1 if the string was parsed successfully; otherwise, 0.int save ( const char * path ) const#
Saves the Json node into a file with a given path. Creates the given file path if it doesn’t exist yet (including subdirectories).Arguments
- const char * path - Path to the file.
Return value
1 if the file was saved successfully; otherwise, 0.void read ( const char * name, bool & value ) const#
Reads a boolean value of a Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- bool & value - Target boolean variable to which the value of the Json node with the specified name is saved.
void read ( const char * name, int & value ) const#
Reads an integer value of a Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- int & value - Target integer variable to which the value of the Json node with the specified name is saved.
void read ( const char * name, unsigned int & value ) const#
Reads an unsigned integer value of a Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- unsigned int & value - Target unsigned integer variable to which the value of the Json node with the specified name is saved.
void read ( const char * name, char & value ) const#
Reads a character value of a Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- char & value - Target character variable to which the value of the Json node with the specified name is saved.
void read ( const char * name, double & value ) const#
Reads a double value of a Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- double & value - Target double variable to which the value of the Json node with the specified name is saved.
void read ( const char * name, float & value ) const#
Reads a float value of a Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- float & value - Target float variable to which the value of the Json node with the specified name is saved.
void read ( const char * name, UGUID & value ) const#
Reads a value of a Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- UGUID & value - UGUID of the variable to which the value of the Json node with the specified name is saved.
void read ( const char * name, Math::vec2 & value ) const#
Reads a two-component value of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Math::vec2 & value - Target vector variable to which the value of the Json node with the specified name is saved.
void read ( const char * name, Math::vec3 & value ) const#
Reads a three-component value of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Math::vec3 & value - Target vector variable to which the value of the Json node with the specified name is saved.
void read ( const char * name, Math::vec4 & value ) const#
Reads a four-component value of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Math::vec4 & value - Target vector variable to which the value of the Json node with the specified name is saved.
void read ( const char * name, Math::dvec2 & value ) const#
Reads a two-component value of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Math::dvec2 & value - Target vector variable to which the value of the Json node with the specified name is saved.
void read ( const char * name, Math::dvec3 & value ) const#
Reads a three-component value of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Math::dvec3 & value - Target vector variable to which the value of the Json node with the specified name is saved.
void read ( const char * name, Math::dvec4 & value ) const#
Reads a four-component value of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Math::dvec4 & value - Target vector variable to which the value of the Json node with the specified name is saved.
void read ( const char * name, Math::ivec2 & value ) const#
Reads a two-component value of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Math::ivec2 & value - Target vector variable to which the value of the Json node with the specified name is saved.
void read ( const char * name, Math::ivec3 & value ) const#
Reads a three-component value of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Math::ivec3 & value - Target vector variable to which the value of the Json node with the specified name is saved.
void read ( const char * name, Math::ivec4 & value ) const#
Reads a four-component value of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Math::ivec4 & value - Target vector variable to which the value of the Json node with the specified name is saved.
void read ( const char * name, Vector< int > & value ) const#
Reads values of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Vector< int > & value - Vector to which components of the array-type Json node are saved.
void read ( const char * name, Vector< char > & value ) const#
Reads values of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Vector< char > & value - Vector to which components of the array-type Json node are saved.
void read ( const char * name, Vector< double > & value ) const#
Reads values of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Vector< double > & value - Vector to which components of the array-type Json node are saved.
void read ( const char * name, Vector< float > & value ) const#
Reads values of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Vector< float > & value - Vector to which components of the array-type Json node are saved.
void read ( const char * name, Vector< String > & value ) const#
Reads values of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Vector< String > & value - Vector to which components of the array-type Json node are saved.
void read ( const char * name, Vector< Math::vec2 > & value ) const#
Reads values of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Vector< Math::vec2 > & value - Vector to which components of the array-type Json node are saved.
void read ( const char * name, Vector< Math::vec3 > & value ) const#
Reads values of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Vector< Math::vec3 > & value - Vector to which components of the array-type Json node are saved.
void read ( const char * name, Vector< Math::vec4 > & value ) const#
Reads values of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Vector< Math::vec4 > & value - Vector to which components of the array-type Json node are saved.
void read ( const char * name, Vector< Math::dvec2 > & value ) const#
Reads values of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Vector< Math::dvec2 > & value - Vector to which components of the array-type Json node are saved.
void read ( const char * name, Vector< Math::dvec3 > & value ) const#
Reads values of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Vector< Math::dvec3 > & value - Vector to which components of the array-type Json node are saved.
void read ( const char * name, Vector< Math::dvec4 > & value ) const#
Reads values of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Vector< Math::dvec4 > & value - Vector to which components of the array-type Json node are saved.
void read ( const char * name, Vector< Math::ivec2 > & value ) const#
Reads values of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Vector< Math::ivec2 > & value - Vector to which components of the array-type Json node are saved.
void read ( const char * name, Vector< Math::ivec3 > & value ) const#
Reads values of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Vector< Math::ivec3 > & value - Vector to which components of the array-type Json node are saved.
void read ( const char * name, Vector< Math::ivec4 > & value ) const#
Reads values of the array-type Json node with the specified name to the specified target variable.Arguments
- const char * name - Name of the Json node.
- Vector< Math::ivec4 > & value - Vector to which components of the array-type Json node are saved.
void read ( bool & value ) const#
Reads a boolean value of the Json node to the specified target variable.Arguments
- bool & value - Target boolean variable to which the value of the Json node is saved.
void read ( int & value ) const#
Reads an integer value of the Json node to the specified target variable.Arguments
- int & value - Target integer variable to which the value of the Json node is saved.
void read ( char & value ) const#
Reads a character value of the Json node to the specified target variable.Arguments
- char & value - Target character variable to which the value of the Json node is saved.
void read ( double & value ) const#
Reads a double value of the Json node to the specified target variable.Arguments
- double & value - Target double variable to which the value of the Json node is saved.
void read ( float & value ) const#
Reads a float value of the Json node to the specified target variable.Arguments
- float & value - Target float variable to which the value of the Json node is saved.
void read ( Math::vec2 & value ) const#
Reads a two-component value of the array-type Json node to the specified target variable.Arguments
- Math::vec2 & value - Target vector variable to which two components of the array-type Json node are saved.
void read ( Math::vec3 & value ) const#
Reads a three-component value of the array-type Json node to the specified target variable.Arguments
- Math::vec3 & value - Target vector variable to which three components of the array-type Json node are saved.
void read ( Math::vec4 & value ) const#
Reads a four-component value of the array-type Json node to the specified target variable.Arguments
- Math::vec4 & value - Target vector variable to which four components of the array-type Json node are saved.
void read ( Math::dvec2 & value ) const#
Reads a two-component value of the array-type Json node to the specified target variable.Arguments
- Math::dvec2 & value - Target vector variable to which two components of the array-type Json node are saved.
void read ( Math::dvec3 & value ) const#
Reads a three-component value of the array-type Json node to the specified target variable.Arguments
- Math::dvec3 & value - Target vector variable to which three components of the array-type Json node are saved.
void read ( Math::dvec4 & value ) const#
Reads a four-component value of the array-type Json node to the specified target variable.Arguments
- Math::dvec4 & value - Target vector variable to which four components of the array-type Json node are saved.
void read ( Math::ivec2 & value ) const#
Reads a two-component value of the array-type Json node to the specified target variable.Arguments
- Math::ivec2 & value - Target vector variable to which two components of the array-type Json node are saved.
void read ( Math::ivec3 & value ) const#
Reads a three-component value of the array-type Json node to the specified target variable.Arguments
- Math::ivec3 & value - Target vector variable to which three components of the array-type Json node are saved.
void read ( Math::ivec4 & value ) const#
Reads a four-component value of the array-type Json node to the specified target variable.Arguments
- Math::ivec4 & value - Target vector variable to which four components of the array-type Json node are saved.
void read ( Vector< bool > & value ) const#
Reads values of the array-type Json node to the specified target variable.Arguments
- Vector< bool > & value - Vector to which components of the array-type Json node are saved.
void read ( Vector< int > & value ) const#
Reads values of the array-type Json node to the specified target variable.Arguments
- Vector< int > & value - Vector to which components of the array-type Json node are saved.
void read ( Vector< char > & value ) const#
Reads values of the array-type Json node to the specified target variable.Arguments
- Vector< char > & value - Vector to which components of the array-type Json node are saved.
void read ( Vector< double > & value ) const#
Reads values of the array-type Json node to the specified target variable.Arguments
- Vector< double > & value - Vector to which components of the array-type Json node are saved.
void read ( Vector< float > & value ) const#
Reads values of the array-type Json node to the specified target variable.Arguments
- Vector< float > & value - Vector to which components of the array-type Json node are saved.
void read ( Vector< String > & value ) const#
Reads values of the array-type Json node to the specified target variable.Arguments
void read ( Vector< Math::vec2 > & value ) const#
Reads values of the array-type Json node to the specified target variable.Arguments
void read ( Vector< Math::vec3 > & value ) const#
Reads values of the array-type Json node to the specified target variable.Arguments
void read ( Vector< Math::vec4 > & value ) const#
Reads values of the array-type Json node to the specified target variable.Arguments
void read ( Vector< Math::dvec2 > & value ) const#
Reads values of the array-type Json node to the specified target variable.Arguments
void read ( Vector< Math::dvec3 > & value ) const#
Reads values of the array-type Json node to the specified target variable.Arguments
void read ( Vector< Math::dvec4 > & value ) const#
Reads values of the array-type Json node to the specified target variable.Arguments
void read ( Vector< Math::ivec2 > & value ) const#
Reads values of the array-type Json node to the specified target variable.Arguments
void read ( Vector< Math::ivec3 > & value ) const#
Reads values of the array-type Json node to the specified target variable.Arguments
void read ( Vector< Math::ivec4 > & value ) const#
Reads values of the array-type Json node to the specified target variable.Arguments
String read ( const char * name ) const#
Returns a value of a Json node with the specified name as a string.Arguments
- const char * name - Name of the Json node.
Return value
Node valuevoid write ( const char * name, bool value ) #
Writes the specified boolean value to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- bool value - Boolean value to be written to the Json node with the specified name.
void write ( const char * name, int value ) #
Writes the specified integer value to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- int value - Integer value to be written to the Json node with the specified name.
void write ( const char * name, unsigned int value ) #
Writes the specified unsigned integer value to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- unsigned int value - Unsigned integer value to be written to the Json node with the specified name.
void write ( const char * name, char value ) #
Writes the specified character value to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- char value - Character value to be written to the Json node with the specified name.
void write ( const char * name, const char * value ) #
Writes the specified value to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const char * value - Value to be written to the Json node with the specified name.
void write ( const char * name, double value ) #
Writes the specified double value to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- double value - Double value to be written to the Json node with the specified name.
void write ( const char * name, float value ) #
Writes the specified float value to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- float value - Float value to be written to the Json node with the specified name.
void write ( const char * name, const Math::vec2 & value ) #
Writes the specified two-component value to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Math::vec2 & value - Two-component value to be written to the Json node with the specified name.
void write ( const char * name, const Math::vec3 & value ) #
Writes the specified three-component value to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Math::vec3 & value - Three-component value to be written to the Json node with the specified name.
void write ( const char * name, const Math::vec4 & value ) #
Writes the specified four-component value to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Math::vec4 & value - Four-component value to be written to the Json node with the specified name.
void write ( const char * name, const Math::dvec2 & value ) #
Writes the specified two-component value to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Math::dvec2 & value - Two-component value to be written to the Json node with the specified name.
void write ( const char * name, const Math::dvec3 & value ) #
Writes the specified three-component value to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Math::dvec3 & value - Three-component value to be written to the Json node with the specified name.
void write ( const char * name, const Math::dvec4 & value ) #
Writes the specified four-component value to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Math::dvec4 & value - Four-component value to be written to the Json node with the specified name.
void write ( const char * name, const Math::ivec2 & value ) #
Writes the specified two-component value to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Math::ivec2 & value - Two-component value to be written to the Json node with the specified name.
void write ( const char * name, const Math::ivec3 & value ) #
Writes the specified three-component value to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Math::ivec3 & value - Three-component value to be written to the Json node with the specified name.
void write ( const char * name, const Math::ivec4 & value ) #
Writes the specified four-component value to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Math::ivec4 & value - Four-component value to be written to the Json node with the specified name.
void write ( const char * name, const Vector< int > & value ) #
Writes the specified values to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Vector< int > & value - Vector of values to be written to the Json node with the specified name.
void write ( const char * name, const Vector< char > & value ) #
Writes the specified values to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Vector< char > & value - Vector of values to be written to the Json node with the specified name.
void write ( const char * name, const Vector< double > & value ) #
Writes the specified values to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Vector< double > & value - Vector of values to be written to the Json node with the specified name.
void write ( const char * name, const Vector< float > & value ) #
Writes the specified values to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Vector< float > & value - Vector of values to be written to the Json node with the specified name.
void write ( const char * name, const Vector< String > & value ) #
Writes the specified values to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Vector< String > & value - Vector of values to be written to the Json node with the specified name.
void write ( const char * name, const Vector< Math::vec2 > & value ) #
Writes the specified values to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Vector< Math::vec2 > & value - Vector of values to be written to the Json node with the specified name.
void write ( const char * name, const Vector< Math::vec3 > & value ) #
Writes the specified values to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Vector< Math::vec3 > & value - Vector of values to be written to the Json node with the specified name.
void write ( const char * name, const Vector< Math::vec4 > & value ) #
Writes the specified values to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Vector< Math::vec4 > & value - Vector of values to be written to the Json node with the specified name.
void write ( const char * name, const Vector< Math::dvec2 > & value ) #
Writes the specified values to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Vector< Math::dvec2 > & value - Vector of values to be written to the Json node with the specified name.
void write ( const char * name, const Vector< Math::dvec3 > & value ) #
Writes the specified values to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Vector< Math::dvec3 > & value - Vector of values to be written to the Json node with the specified name.
void write ( const char * name, const Vector< Math::dvec4 > & value ) #
Writes the specified values to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Vector< Math::dvec4 > & value - Vector of values to be written to the Json node with the specified name.
void write ( const char * name, const Vector< Math::ivec2 > & value ) #
Writes the specified values to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Vector< Math::ivec2 > & value - Vector of values to be written to the Json node with the specified name.
void write ( const char * name, const Vector< Math::ivec3 > & value ) #
Writes the specified values to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Vector< Math::ivec3 > & value - Vector of values to be written to the Json node with the specified name.
void write ( const char * name, const Vector< Math::ivec4 > & value ) #
Writes the specified values to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const Vector< Math::ivec4 > & value - Vector of values to be written to the Json node with the specified name.
void write ( const char * name, const UGUID& value ) #
Writes the specified value to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- const UGUID& value - UGUID of the value to be written to the Json node with the specified name.
void write ( const UGUID& value ) #
Writes the specified value to the current Json node.Arguments
- const UGUID& value - UGUID of the value to be written to the Json node.
void write ( bool value ) #
Writes the specified boolean value to the current Json node.Arguments
- bool value - Boolean value to be written to the current Json node.
void write ( int value ) #
Writes the specified integer value to the current Json node.Arguments
- int value - Integer value to be written to the current Json node.
void write ( char value ) #
Writes the specified character value to the current Json node.Arguments
- char value - Character value to be written to the current Json node.
void write ( const char * value ) #
Writes the specified value to the current Json node.Arguments
- const char * value - Value to be written to the current Json node.
void write ( double value ) #
Writes the specified double value to the current Json node.Arguments
- double value - Double value to be written to the current Json node.
void write ( float value ) #
Writes the specified float value to the current Json node.Arguments
- float value - Float value to be written to the current Json node.
void write ( const Math::vec2 & value ) #
Writes the specified two-component value to the current Json node.Arguments
- const Math::vec2 & value - Two-component value to be written to the current Json node.
void write ( const Math::vec3 & value ) #
Writes the specified three-component value to the current Json node.Arguments
- const Math::vec3 & value - Three-component value to be written to the current Json node.
void write ( const Math::vec4 & value ) #
Writes the specified four-component value to the current Json node.Arguments
- const Math::vec4 & value - Four-component value to be written to the current Json node.
void write ( const Math::dvec2 & value ) #
Writes the specified two-component value to the current Json node.Arguments
- const Math::dvec2 & value - Two-component value to be written to the current Json node.
void write ( const Math::dvec3 & value ) #
Writes the specified three-component value to the current Json node.Arguments
- const Math::dvec3 & value - Three-component value to be written to the current Json node.
void write ( const Math::dvec4 & value ) #
Writes the specified four-component value to the current Json node.Arguments
- const Math::dvec4 & value - Four-component value to be written to the current Json node.
void write ( const Math::ivec2 & value ) #
Writes the specified two-component value to the current Json node.Arguments
- const Math::ivec2 & value - Two-component value to be written to the current Json node.
void write ( const Math::ivec3 & value ) #
Writes the specified three-component value to the current Json node.Arguments
- const Math::ivec3 & value - Three-component value to be written to the current Json node.
void write ( const Math::ivec4 & value ) #
Writes the specified four-component value to the current Json node.Arguments
- const Math::ivec4 & value - Four-component value to be written to the current Json node.
void write ( const Vector< bool > & value ) #
Writes the specified values to the current Json node.Arguments
- const Vector< bool > & value - Vector of values to be written to the current Json node.
void write ( const Vector< int > & value ) #
Writes the specified values to the current Json node.Arguments
- const Vector< int > & value - Vector of values to be written to the current Json node.
void write ( const Vector< char > & value ) #
Writes the specified values to the current Json node.Arguments
- const Vector< char > & value - Vector of values to be written to the current Json node.
void write ( const Vector< double > & value ) #
Writes the specified values to the current Json node.Arguments
- const Vector< double > & value - Vector of values to be written to the current Json node.
void write ( const Vector< float > & value ) #
Writes the specified values to the current Json node.Arguments
- const Vector< float > & value - Vector of values to be written to the current Json node.
void write ( const Vector< String > & value ) #
Writes the specified values to the current Json node.Arguments
void write ( const Vector< Math::vec2 > & value ) #
Writes the specified values to the current Json node.Arguments
void write ( const Vector< Math::vec3 > & value ) #
Writes the specified values to the current Json node.Arguments
void write ( const Vector< Math::vec4 > & value ) #
Writes the specified values to the current Json node.Arguments
void write ( const Vector< Math::dvec2 > & value ) #
Writes the specified values to the current Json node.Arguments
void write ( const Vector< Math::dvec3 > & value ) #
Writes the specified values to the current Json node.Arguments
void write ( const Vector< Math::dvec4 > & value ) #
Writes the specified values to the current Json node.Arguments
void write ( const Vector< Math::ivec2 > & value ) #
Writes the specified values to the current Json node.Arguments
void write ( const Vector< Math::ivec3 > & value ) #
Writes the specified values to the current Json node.Arguments
void write ( const Vector< Math::ivec4 > & value ) #
Writes the specified values to the current Json node.Arguments
const char * getTypeName ( ) const#
Returns the name of the type of the Json node.Return value
Name of the Json node type.void setInt ( int value ) #
Sets the specified integer value to the current Json node.Arguments
- int value - Value to be set to the current Json node.
void setInt ( const char * name, int value ) #
Sets the specified integer value to the target Json node with the specified name. In case such node is not found, a new one is added with the name specified.Arguments
- const char * name - Name of the target Json node.
- int value - Value to be set to the target Json node.
int getInt ( ) const#
Returns the value of the current Json node as an integer value, if possible.Return value
Node value.int getInt ( const char * name ) const#
Returns the value of the target Json node with the specified name as an integer value, if possible.Arguments
- const char * name - Name of the target Json node.
void setVec2 ( const Math::vec2 & value ) #
Sets the first two elements of the array-type Json node.Arguments
- const Math::vec2 & value - Vector setting the first two elements of the array-type Json node
Math::vec2 getVec2 ( ) const#
Returns a two-component vector composed of the first two elements of the array-type Json node. If the node is not an array, a zero-vector (0.0f, 0.0f) shall be returned.Return value
Vector composed of the first two elements of the array-type Json nodevoid setVec3 ( const Math::vec3 & value ) #
Sets the first three elements of the array-type Json node.Arguments
- const Math::vec3 & value - Vector setting the first three elements of the array-type Json node
Math::vec3 getVec3 ( ) const#
Returns a three-component vector composed of the first three elements of the array-type Json node. If the node is not an array, a zero-vector (0.0f, 0.0f, 0.0f) shall be returned.Return value
Vector composed of the first three elements of the array-type Json nodevoid setVec4 ( const Math::vec4 & value ) #
Sets the first four elements of the array-type Json node.Arguments
- const Math::vec4 & value - Vector setting the first four elements of the array-type Json node
Math::vec4 getVec4 ( ) const#
Returns a four-component vector composed of the first four elements of the array-type Json node. If the node is not an array, a zero-vector (0.0f, 0.0f, 0.0f, 0.0f) shall be returned.Return value
Vector composed of the first four elements of the array-type Json nodevoid setDVec2 ( const Math::dvec2 & value ) #
Sets the first two elements of the array-type Json node.Arguments
- const Math::dvec2 & value - Vector setting the first two elements of the array-type Json node
Math::dvec2 getDVec2 ( ) const#
Returns a two-component vector composed of the first two elements of the array-type Json node. If the node is not an array, a zero-vector (0.0, 0.0) shall be returned.Return value
Vector composed of the first two elements of the array-type Json nodevoid setDVec3 ( const Math::dvec3 & value ) #
Sets the first three elements of the array-type Json node.Arguments
- const Math::dvec3 & value - Vector setting the first three elements of the array-type Json node
Math::dvec3 getDVec3 ( ) const#
Returns a three-component vector composed of the first three elements of the array-type Json node. If the node is not an array a zero-vector (0.0, 0.0, 0.0) shall be returned.Return value
Vector composed of the first three elements of the array-type Json nodevoid setDVec4 ( const Math::dvec4 & value ) #
Sets the first four elements of the array-type Json node.Arguments
- const Math::dvec4 & value - Vector setting the first four elements of the array-type Json node
Math::dvec4 getDVec4 ( ) const#
Returns a four-component vector composed of the first four elements of the array-type Json node. If the node is not an array a zero-vector (0.0, 0.0, 0.0, 0.0) shall be returned.Return value
Vector composed of the first four elements of the array-type Json nodevoid setIVec2 ( const Math::ivec2 & value ) #
Sets the first two elements of the array-type Json node.Arguments
- const Math::ivec2 & value - Vector setting the first two elements of the array-type Json node
Math::ivec2 getIVec2 ( ) const#
Returns a two-component vector composed of the first two elements of the array-type Json node. If the node is not an array a zero-vector (0, 0) shall be returned.Return value
Vector composed of the first two elements of the array-type Json nodevoid setIVec3 ( const Math::ivec3 & value ) #
Sets the first three elements of the array-type Json node.Arguments
- const Math::ivec3 & value - Vector setting the first three elements of the array-type Json node
Math::ivec3 getIVec3 ( ) const#
Returns a three-component vector composed of the first three elements of the array-type Json node. If the node is not an array a zero-vector (0, 0, 0) shall be returned.Return value
Vector composed of the first three elements of the array-type Json nodevoid setIVec4 ( const Math::ivec4 & value ) #
Sets the first four elements of the array-type Json node.Arguments
- const Math::ivec4 & value - Vector setting the first four elements of the array-type Json node
Math::ivec4 getIVec4 ( ) const#
Returns a four-component vector composed of the first four elements of the array-type Json node. If the node is not an array a zero-vector (0, 0, 0, 0) shall be returned.Return value
Vector composed of the first four elements of the array-type Json nodeLast update:
2022-10-10
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)