This class is used to represent a collection of values (boolean, integer, float, or string) that can represent a set of import parameters for an asset. More...

Inherits APIInterface.

Public Types
enum	TYPE { TYPE_NONE = 0, TYPE_BOOL, TYPE_INT, TYPE_FLOAT, TYPE_STRING }
	Value type. More...

Public Member Functions
void	clear ()
	Clears the collection by removing all elements. More...

bool	isEmpty () const
	Checks if the collection is empty or has any elements. More...

bool	hasValue (const char *value_name) const
	Checks if the collection contains a value element with the specified name. More...

Unigine::Vector< Unigine::String >	getNames () const
	Returns the list of names of all elements in the collection as a vector of strings. More...

void	getNames (Unigine::Vector< Unigine::String > &names) const
	Saves to the vector of strings specified as the argument the list of names of all elements in the collection. More...

bool	remove (const char *value_name)
	Removes a value element with the specified name from the collection. More...

void	setBool (const char *value_name, bool value)
	Sets a new boolean value for the collection element with the specified name. More...

bool	getBool (const char *value_name, bool default_value=false) const
	Returns the current boolean value of the collection element with the specified name. More...

void	setInt (const char *value_name, int value)
	Sets a new integer value for the collection element with the specified name. More...

int	getInt (const char *value_name, int default_value=0) const
	Returns the current integer value of the collection element with the specified name. More...

void	setFloat (const char *value_name, float value)
	Sets a new float value for the collection element with the specified name. More...

float	getFloat (const char *value_name, float default_value=0) const
	Returns the current float value of the collection element with the specified name. More...

void	setString (const char value_name, const char value)
	Sets a new string value for the collection element with the specified name. More...

Unigine::String	getString (const char value_name, const char default_value=nullptr) const
	Returns the current string value of the collection element with the specified name. More...

Static Public Member Functions
static Unigine::Ptr< Collection >	create ()
	Creates a new empty collection. More...

Detailed Description

This class is used to represent a collection of values (boolean, integer, float, or string) that can represent a set of import parameters for an asset.

Member Enumeration Documentation

◆ TYPE

enum UnigineEditor::Collection::TYPE

Value type.

Enumerator
TYPE_NONE	No type.
TYPE_BOOL	Boolean value type.
TYPE_INT	Integer value type.
TYPE_FLOAT	Float value type.
TYPE_STRING	String value type.

Member Function Documentation

◆ clear()

void UnigineEditor::Collection::clear ( )

Clears the collection by removing all elements.

◆ create()

static Unigine::Ptr<Collection> UnigineEditor::Collection::create ( )

static

Creates a new empty collection.

◆ getBool()

bool UnigineEditor::Collection::getBool	(	const char *	value_name,
		bool	default_value = `false`
	)		const

Returns the current boolean value of the collection element with the specified name.

Parameters

value_name	Name of the collection element.
default_value	Default boolean value to be returned in case the requested value does not exist or cannot be converted to the specified type.

Returns: The current boolean value of the collection element with the specified name.

◆ getFloat()

float UnigineEditor::Collection::getFloat	(	const char *	value_name,
		float	default_value = `0`
	)		const

Returns the current float value of the collection element with the specified name.

Parameters

value_name	Name of the collection element.
default_value	Default float value to be returned in case the requested value does not exist or cannot be converted to the specified type.

Returns: The current float value of the collection element with the specified name.

◆ getInt()

int UnigineEditor::Collection::getInt	(	const char *	value_name,
		int	default_value = `0`
	)		const

Returns the current integer value of the collection element with the specified name.

Parameters

value_name	Name of the collection element.
default_value	Default integer value to be returned in case the requested value does not exist or cannot be converted to the specified type.

Returns: The current integer value of the collection element with the specified name.

◆ getNames() [1/2]

Unigine::Vector<Unigine::String> UnigineEditor::Collection::getNames ( ) const

Returns the list of names of all elements in the collection as a vector of strings.

Returns: The list of names of all elements in the collection.

◆ getNames() [2/2]

void UnigineEditor::Collection::getNames ( Unigine::Vector< Unigine::String > & names ) const

Saves to the vector of strings specified as the argument the list of names of all elements in the collection.

Parameters

names The vector to store the names of all elements in the collection.

◆ getString()

Unigine::String UnigineEditor::Collection::getString	(	const char *	value_name,
		const char *	default_value = `nullptr`
	)		const

Returns the current string value of the collection element with the specified name.

Parameters

value_name	Name of the collection element.
default_value	Default value to be returned in case the requested value does not exist or cannot be converted to the specified type.

Returns: The current string value of the collection element with the specified name.

◆ hasValue()

bool UnigineEditor::Collection::hasValue ( const char * value_name ) const

Checks if the collection contains a value element with the specified name.

Parameters

value_name Name of the collection element to be checked.

Returns: true if the collection contains an element with the specified name; otherwise, false.

◆ isEmpty()

bool UnigineEditor::Collection::isEmpty ( ) const

Checks if the collection is empty or has any elements.

Returns: true if the collection is empty; otherwise, false.

◆ remove()

bool UnigineEditor::Collection::remove ( const char * value_name )

Removes a value element with the specified name from the collection.

Parameters

value_name Name of the collection element to be removed.

Returns: true if the element with the specified name is removed successfully; otherwise, false.

summary> Returns the type of a value element with the specified name (see TYPE).

Parameters

value_name Name of the collection element.

Returns: The type of the value element with the specified name.

◆ setBool()

void UnigineEditor::Collection::setBool	(	const char *	value_name,
		bool	value
	)

Sets a new boolean value for the collection element with the specified name.

Parameters

value_name	Name of the collection element to be updated.
value	New boolean value to be set.

◆ setFloat()

void UnigineEditor::Collection::setFloat	(	const char *	value_name,
		float	value
	)

Sets a new float value for the collection element with the specified name.

Parameters

value_name	Name of the collection element to be updated.
value	New float value to be set.

◆ setInt()

void UnigineEditor::Collection::setInt	(	const char *	value_name,
		int	value
	)

Sets a new integer value for the collection element with the specified name.

Parameters

value_name	Name of the collection element to be updated.
value	New integer value to be set.

◆ setString()

void UnigineEditor::Collection::setString	(	const char *	value_name,
		const char *	value
	)

Sets a new string value for the collection element with the specified name.

Parameters

value_name	Name of the collection element to be updated.
value	New string value to be set.

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ TYPE

Member Function Documentation

◆ clear()

◆ create()

◆ getBool()

◆ getFloat()

◆ getInt()

◆ getNames() [1/2]

◆ getNames() [2/2]

◆ getString()

◆ hasValue()

◆ isEmpty()

◆ remove()

◆ setBool()

◆ setFloat()

◆ setInt()

◆ setString()