Unigine.Properties Class
The functions below are used to control property loading and management within the project: you can get, clone, inherit, or remove any property within the project. Reparenting is supported for all non-manual and editable properties.
Notice
- This class is a singleton.
- To modify a single property, use functions of the Property class.
Properties Class
Members
Properties get()
Returns the existing property manager. The property manager must be obtained to access functions of the Properties class:Source code (C#)
Properties properties = Properties.get();
// access functions of the Properties class
...Return value
The existing property manager.int getNumProperties()
Returns the total number of properties loaded for the current project.Return value
Total number of properties loaded.Property getProperty(int num)
Returns a property by its number. The returned property can be modified by using methods of the Property class.Source code (C#)
Property[] my_properties = new Property[properties.getNumProperties()];
for (int i = 0; i < properties.getNumProperties(); i++)
{
my_properties[i] = properties.getProperty(i);
}Arguments
- int num - Number of the property in range from 0 to the total number of properties.
Return value
Property instance if it exists or NULL.int isProperty(string name)
Checks if a property with the given name exists.Arguments
- string name - Name of the property.
Return value
1 if a property with the given name exists; otherwise, 0.int isProperty(UGUID guid)
Checks if a property with the given GUID exists.Arguments
- UGUID guid - GUID of the property.
Return value
1 if a property with the given GUID exists; otherwise, 0.int isManualProperty(string name)
Checks if a property with the given name exists.Arguments
- string name - Name of the manual property.
Return value
1 if a manual property with the given name exists; otherwise, 0.string getPropertyName(int num)
Returns the name of the property by its number.Arguments
- int num - Number of the property in range from 0 to the total number of properties.
Return value
Name of the property.Notice
If the property with the specified number is internal and has a parent, the parent's name will be returned.
Property cloneProperty(UGUID guid, string name = 0, string path = 0)
Clones the property and assigns the specified name and path to the clone.Notice
Without a name the cloned property won't be displayed in the properties hierarchy, without a path it won't be saved when saveProperties() is called.
Arguments
- UGUID guid - GUID of the property to clone.
- string name - Cloned property name.
- string path - Path to save the cloned property.
Return value
Property instance if the property with the specified GUID exists or nullptr.Property findProperty(string name)
Searches for a property with the given name. The returned property can be managed using the methods of the Property class.Arguments
- string name - Property name.
Return value
Property, if it is found (an instance of the Property class); otherwise, nullptr.Property findManualProperty(string name)
Searches for a manual property with the given name. The returned property can be managed using the methods of the Property class.Arguments
- string name - Manual property name.
Return value
Manual property, if it is found (an instance of the Property class); otherwise, nullptr.Property findPropertyByGUID(UGUID guid)
Searches for a property with the given GUID. The returned property can be managed using the methods of the Property class.Arguments
- UGUID guid - Property GUID.
Return value
Property, if it is found (an instance of the Property class); otherwise, nullptr.Property findPropertyByPath(string path)
Searches for a property with the given path. The returned property can be managed using the methods of the Property class.Arguments
- string path - Property path.
Return value
Property, if it is found (an instance of the Property class); otherwise, nullptr.Property findPropertyByFileGUID(UGUID guid)
Searches for a property with the given *.prop file GUID. The returned property can be managed using the methods of the Property class.Arguments
- UGUID guid - Property file GUID.
Return value
Property, if it is found (an instance of the Property class); otherwise, nullptr.Property loadProperty(string path)
Loads a property from the specified *.prop file. The returned property can be managed using the methods of the Property class.Arguments
- string path - Path to the *.prop file to load a property from.
Return value
Property, if it is loaded successfully (an instance of the Property class); otherwise, nullptr.Property inheritProperty(UGUID guid, string name = 0, string path = 0)
Inherits a property from the given property and assigns the specified name and path to the new property.Notice
Without a name the inherited property won't be displayed in the properties hierarchy, without a path it won't be saved when saveProperties() is called.
Arguments
- UGUID guid - GUID of the property to inherit from.
- string name - Inherited property name.
- string path - Path to save the inherited property.
Return value
Property instance if the property with the specified GUID exists or nullptr.int removeProperty(UGUID guid, int remove_file = 0, int remove_children = 1)
Removes the property with the specified GUID.Notice
A root property (the property that has no parent) or a non-editable property cannot be removed using this function.
Arguments
- UGUID guid - GUID of the property to remove.
- int remove_file - Flag indicating if the corresponding *.prop file will be deleted. Set 1 to delete the file, or 0 to keep it.
- int remove_children - Flag indicating if all children of the property will be deleted. Set 1 to delete all children of the property, or 0 to link all children to the parent.
Return value
1 if the property is removed successfully; otherwise, 0.int renameProperty(UGUID guid, string new_name)
Changes the name of the property with the specified GUID.Notice
- The name of the *.prop file is not affected.
- This method is not available for the manual and non-editable properties.
Arguments
- UGUID guid - GUID of the property to be renamed.
- string new_name - New name for the property to be set.
Return value
1 if the property is renamed successfully; otherwise, 0.int replaceProperty(Property property, Property new_property)
Replaces the specified property with a new one for all nodes and surfaces. The new property that replaces the specified one must exist. For example, if you have 3 nodes with the same property, calling this method will change this property to the specified one for all these nodes.Arguments
- Property property - Property to be replaced.
- Property new_property - New property.
Return value
1 if the property is replaced successfully; otherwise, 0.int reparentProperty(UGUID guid, UGUID new_parent, int save_all_values = 0)
Sets a new parent for the specified property. Both properties with given GUIDs must exist.Notice
The method isn't available for the manual and non-editable properties.
Arguments
- UGUID guid - GUID of the property whose parent is to be changed.
- UGUID new_parent - GUID of the property to be set as a new parent.
- int save_all_values - Flag indicating if parameter values of the specified property will be saved after reparenting.
Return value
1 if the parent for the property is changed successfully; otherwise, 0.void reloadProperties()
Reloads all *.prop files from all data folders.Notice
If new *.prop files are found, they will be loaded automatically. The hierachy will be rebuilt if necessary, while keeping all overridden parameter values.
int saveProperties()
Saves all properties that can be saved to corresponding *.prop files.Notice
Return value
1 if all properties are saved successfully; otherwise, 0.void removeCallback(int callback, int num)
Removes a callback with the given number from the list of callbacks of the specified type. Callback functions can be used to determine actions to be performed when any changes to any property are made.Arguments
- int callback
- int num - Callback number.
void clearCallbacks(int callback)
Clears all added callbacks of the specified type. Callback functions can be used to determine actions to be performed when any changes to any property are made.Arguments
- int callback
int
Description
Property created callback. This callback is fired when a new property is created.int
Description
Property moved callback. This callback is fired when the path of a property is changed.int
Description
Property removed callback. This callback is fired when a property is removed.int
Description
Property renamed callback. This callback is fired when the name of a property is changed.int
Description
Property reparented callback. This callback is fired when the parent of a property is changed.Last update: 2018-06-04
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)