Property Class

#include <core/unigine.h>
// This file is in UnigineScript language.
// World script, it takes effect only when the world is loaded.

	// declaring UI widgets to be used
    WidgetWindow window;
    WidgetHBox hbox;

    WidgetGroupBox properties_gb;
    WidgetTreeBox properties;
    WidgetGroupBox parameters_gb;
    WidgetTreeBox parameters;
    WidgetGroupBox value_gb;
    WidgetGroupBox menu_gb;

    WidgetVBox vbox2, vbox3;
    WidgetHBox hbox2;
    WidgetButton reload;
    WidgetButton clone;
    WidgetButton inherit;
    WidgetButton save_prop;

    // UI widgets for values
    WidgetLabel label[0];
    WidgetEditLine value;
    WidgetButton change;
    WidgetButton reset;

    WidgetLabel info;
    WidgetLabel prop_info;
	// lists of properties and parameters
    int item_prop[];
    int item_param[];

/// method refreshing properties
void refresh_properties()
{
	properties.setCallbackEnabled(GUI_CHANGED, 0);
	properties.clear();
	item_prop.clear();
	
	// recursive function iterating through all children properties and building property hierarchy
	void attach_children(int parent, Property prop_parent) 
	{
		for (int k = 0; k < prop_parent.getNumChildren(); k++)
		{
			Property prop = prop_parent.getChild(k);
			
			if ((prop.getParent() != NULL) && (prop != prop_parent) && (prop.getParent() == prop_parent))
			{
				int child = properties.addItem(prop.getName());
				properties.addItemChild(parent, child);
				item_prop.append(child, prop);
				attach_children(child, prop);
			}
		}
	}
	// building property hierarchy
	for (int i = 0; i < engine.properties.getNumProperties(); i++)
	{
		Property prop_base = engine.properties.getProperty(i);
		if (prop_base.isBase() == 1)
		{
			int parent = properties.addItem(prop_base.getName());
			item_prop.append(parent, prop_base);
			attach_children(parent, prop_base);
		}
	}
	properties.setCallbackEnabled(GUI_CHANGED, 1);
}

/// method refreshing property parameters
void properties_changed()
{
	parameters.setCallbackEnabled(GUI_CHANGED, 0);
	// clearing the list of property parameters and updating values displayed
	parameters.clear();
	value_gb.setEnabled(0);
	for (int i = 0; i <= 12; i++)
		label[i].setText("");

	item_param.clear();
	
	int item = properties.getCurrentItem();
	if (item == -1)
	{
		parameters.setCallbackEnabled(GUI_CHANGED, 1);
		return;
	}
	// getting a property from the list in accordance with current selection
	Property prop = item_prop[item];
	
	// getting a root parameter of the selected property
	PropertyParameter pp = prop.getParameterPtr();
            
	// recursive function iterating through all parameters of a property
	void add_parameters(int parent, PropertyParameter p)
	{
		for (int i = 0; i < p.getNumChildren(); i++)
		{
			PropertyParameter child = p.getChild(i);
			int child_index = parameters.addItem(child.getName());
			parameters.setItemColor(child_index,
				Vec4(
				(child.isInherited()),
				1,
				(1 - child.isOverridden()),
				(child.isHidden() == 1) ? 0.5f : 1.0f));
		item_param.append(child_index, child);

			if (parent != -1)
				parameters.addItemChild(parent, child_index);

			add_parameters(child_index, child);
		}
	}
	
	// building the hierarchy of parameters for the selected property
	add_parameters(-1, pp);
	
	// preparing property information
	string pi = format("\nName: %s\nPath: %s\nInternal: %d\nStructs: %d\n", prop.getName(), prop.getPath(), prop.isInternal(), prop.getNumStructs());
	// adding all structures defined in the property (if any)
	for (int i = 0; i < prop.getNumStructs(); i++)
		pi += format("%d) %s\n", i, prop.getStructName(i));
	// displaying property information
	prop_info.setText(pi);

	parameters.setCallbackEnabled(GUI_CHANGED, 1);
	parameters.setCurrentItem(-1);
}

/// method refreshing information about the currently selected property parameter
void parameters_changed()
{
    // checking if any property parameter is selected
	int item = parameters.getCurrentItem();
	if (item == -1)		
		return;
	
	value_gb.setEnabled(1);
	// getting the parameter from the list in accordance with current selection
	PropertyParameter p = item_param[item];
	int i = 0;
	label[i++].setText(format("<font color=ffff00>ID:</font> %d", p.getID()));
	label[i++].setText(format("<font color=ffff00>Name:</font> %s", p.getName()));
	label[i++].setText(format("<font color=ffff00>Title:</font> %s", p.getTitle()));
	label[i++].setText(format("<font color=ffff00>Tooltip:</font> %s", p.getTooltip()));
	label[i++].setText(format("<font color=ffff00>Group:</font> %s", p.getGroup()));
	label[i++].setText(format("<font color=ffff00>Filter:</font> %s", p.getFilter()));
	
	string s;
	// displaying parameter's type
	if (p.getType() == PROPERTY_PARAMETER_ARRAY)
		s = format("<font color=ffff00>Type:</font> array [<font color=ffff00>Size:</font> %d, <font color=ffff00>Type:</font> %s]", p.getArraySize(), p.getArrayTypeName());
	else if (p.getType() == PROPERTY_PARAMETER_STRUCT)
		s = format("<font color=ffff00>Type:</font> struct [<font color=ffff00>Struct Name:</font> %s]", p.getStructName());
	else
		s = format("<font color=ffff00>Type:</font> %s", p.getProperty().parameterNameByType(p.getType()));
	label[i++].setText(s);
	label[i++].setText(format("<font color=ffff00>Hidden:</font> %d", p.isHidden()));
	label[i++].setText(format("<font color=ffff00>Inherited:</font> %d", p.isInherited()));
	label[i++].setText(format("<font color=ffff00>Overridden:</font> %d", p.isOverridden()));
	label[i++].setText(format("<font color=ffff00>Has Min:</font> %d", p.hasSliderMinValue()));
	label[i++].setText(format("<font color=ffff00>Has Max:</font> %d", p.hasSliderMaxValue()));
	s = "";
	if (p.getType() == PROPERTY_PARAMETER_INT)
		s = format("<font color=ffff00>Min:</font> %d <font color=ffff00>Max:</font> %d", p.getIntMinValue(), p.getIntMaxValue());
	else if (p.getType() == PROPERTY_PARAMETER_FLOAT)
		s = format("<font color=ffff00>Min:</font> %d <font color=ffff00>Max:</font> %d", p.getFloatMinValue(), p.getFloatMaxValue());
	else if (p.getType() == PROPERTY_PARAMETER_DOUBLE)
		s = format("<font color=ffff00>Min:</font> %d <font color=ffff00>Max:</font> %d", p.getDoubleMinValue(), p.getDoubleMaxValue());
	else if (p.getType() == PROPERTY_PARAMETER_SWITCH)
		s = format("<font color=ffff00>Switch Num Items:</font> %d", p.getSwitchNumItems());
	label[i++].setText(s);
	value.setText(p.getValueString());
	reset.setEnabled(p.isOverridden());
}

/// change button on_click event handler
void change_clicked()
{
    // checking if any property parameter is currently selected
    int item = parameters.getCurrentItem();
    if (item == -1)
        return;
    // setting the value of the currently selected property parameter and refreshing information
    PropertyParameter pp = item_param[item];
    pp.setValue(value.getText());

    refresh_info();
}

/// reset button on_click event handler
void reset_clicked()
{
    // checking if any property parameter is currently selected
    int item = parameters.getCurrentItem();
    if (item == -1)
        return;
	
    // resetting the value of the currently selected property parameter and refreshing information
    PropertyParameter pp = item_param[item];
    pp.resetValue();

    refresh_info();
}

/// reload button on_click event handler
void reload_clicked()
{
    // reload all properties and refreshing information
    engine.properties.reloadProperties();
    refresh_info();
}

/// method refreshing property and parameter information
void refresh_info()
{
	// getting current indices of property and parameter selection
	int item_pr = properties.getCurrentItem();
	int item_pa = parameters.getCurrentItem();
	refresh_properties();
	
	// setting current items and updating information displayed
	properties.setCurrentItem(clamp(item_pr, -1, properties.getNumItems() - 1));
	properties_changed();
	parameters.setCurrentItem(clamp(item_pa, -1, parameters.getNumItems() - 1));
	parameters_changed();
}

/// clone button on_click event handler
void clone_clicked()
{
    // checking if any property is selected in the hierarchy
    int item = properties.getCurrentItem();
    if (item == -1)
        return;
    // cloning the selected property
    Property p = item_prop[item];
    Property p_clone = p.clone();
    p_clone.setName(format("%s_cloned", p.getName()));
	
    // refreshing information displayed
    refresh_info();
}

/// inherit button on_click event handler
void inherit_clicked()
{
    // checking if any property is selected in the hierarchy
    int item = properties.getCurrentItem();
    if (item == -1)
        return;
    // inheriting a new property from the selected one
    Property p = item_prop[item];
    p.inherit().setName(format("%s_inherited", p.getName()));
	
	// refreshing information displayed
    refresh_info();
}

/// method saving the currently selected property to the "my_test_prop.prop" file
void save_prop_clicked()
{	
    // checking if any property is selected in the hierarchy
    int item = properties.getCurrentItem();
    if (item == -1)
        return;
    // saving a property to the specified file
    Property p = item_prop[item];
    p.save("my_test_prop.prop");
}

int init() {
	// Write here code to be called on world initialization: initialize resources for your world scene during the world start.
	
	Player player = new PlayerSpectator();
	player.setPosition(Vec3(0.0f,3.401f,1.5f));
	player.setDirection(Vec3(0.0f,-1.0f,-0.4f));
	engine.game.setPlayer(player);
	Property property = engine.properties.findManualProperty("my_property");

	engine.app.setUpdate(1);

	// creating user interface
	Gui gui = engine.getGui();

	window = new WidgetWindow(gui, "Properties Viewer");
	window.setSizeable(1);
	window.setWidth(engine.app.getWidth());
	window.setHeight(engine.app.getHeight());
	gui.addChild(window, GUI_ALIGN_OVERLAP);

	vbox2 = new WidgetVBox(gui);
	window.addChild(vbox2, GUI_ALIGN_EXPAND);

	hbox = new WidgetHBox(gui);
	vbox2.addChild(hbox, GUI_ALIGN_EXPAND);

	properties_gb = new WidgetGroupBox(gui, "Properties");
	parameters_gb = new WidgetGroupBox(gui, "Parameters");
	hbox.addChild(properties_gb, GUI_ALIGN_EXPAND);
	hbox.addChild(parameters_gb, GUI_ALIGN_EXPAND);

	properties = new WidgetTreeBox(gui);
	parameters = new WidgetTreeBox(gui);
	properties_gb.addChild(properties, GUI_ALIGN_EXPAND);
	parameters_gb.addChild(parameters, GUI_ALIGN_EXPAND);

	vbox3 = new WidgetVBox(gui);
	hbox.addChild(vbox3, GUI_ALIGN_EXPAND);
	value_gb = new WidgetGroupBox(gui, "Value");
	value_gb.setWidth(300);
	value_gb.setHeight(300);
	value_gb.arrange();
	menu_gb = new WidgetGroupBox(gui, "Menu");
	vbox3.addChild(value_gb, GUI_ALIGN_LEFT);
	vbox3.addChild(menu_gb, GUI_ALIGN_EXPAND);

	label.append(new WidgetLabel(gui, ""));
	label[label.size()-1].setFontRich(1);
	value_gb.addChild(label[label.size()-1], GUI_ALIGN_LEFT);
	value = new WidgetEditLine(gui);
	value_gb.addChild(value, GUI_ALIGN_EXPAND);
	for (int i = 0; i <= 12; i++)
	{
		label.append(new WidgetLabel(gui, ""));
		label[label.size()-1].setFontRich(1);
		value_gb.addChild(label[label.size()-1], GUI_ALIGN_LEFT);
	}
	change = new WidgetButton(gui, "Change Value");
	value_gb.addChild(change, GUI_ALIGN_LEFT);
	reset = new WidgetButton(gui, "Reset Value");
	value_gb.addChild(reset, GUI_ALIGN_LEFT);

	reload = new WidgetButton(gui, "Reload Property Files");
	clone = new WidgetButton(gui, "Clone Property");
	inherit = new WidgetButton(gui, "Inherit Property");
	save_prop = new WidgetButton(gui, "Save Property");

	menu_gb.addChild(reload, GUI_ALIGN_EXPAND);
	menu_gb.addChild(clone, GUI_ALIGN_EXPAND);
	menu_gb.addChild(inherit, GUI_ALIGN_EXPAND);
	menu_gb.addChild(save_prop, GUI_ALIGN_EXPAND);

	info = new WidgetLabel(gui);
	info.setFontRich(1);
	info.setText("<font color=00ffff>Unique value</font><br><font color=ffffff>Inherited value</font><br><font color=ffff00>Overridden value</font><br>");
	menu_gb.addChild(info, GUI_ALIGN_LEFT);
	prop_info = new WidgetLabel(gui);
	menu_gb.addChild(prop_info, GUI_ALIGN_LEFT);
	
	// setting callbacks for UI elements
	properties.setCallback(GUI_CHANGED, "properties_changed");
	parameters.setCallback(GUI_CHANGED, "parameters_changed");

	change.setCallback(GUI_CLICKED, "change_clicked");
	reset.setCallback(GUI_CLICKED, "reset_clicked");
	reload.setCallback(GUI_CLICKED, "reload_clicked");        
			
	clone.setCallback(GUI_CLICKED, "clone_clicked");
	inherit.setCallback(GUI_CLICKED, "inherit_clicked");
	save_prop.setCallback(GUI_CLICKED, "save_prop_clicked");

	refresh_properties();

	return 1;
}

// start of the main loop
int update() {
	// Write here code to be called before updating each render frame: specify all graphics-related functions you want to be called every frame while your application executes.
	
	return 1;
}

int postUpdate() {
	// The engine calls this function before rendering each render frame: correct behavior after the state of the node has been updated.
	
	return 1;
}

int updatePhysics() {
	// Write here code to be called before updating each physics frame: control physics in your application and put non-rendering calculations.
	// The engine calls updatePhysics() with the fixed rate (60 times per second by default) regardless of the FPS value.
	// WARNING: do not create, delete or change transformations of nodes here, because rendering is already in progress.
	
	return 1;
}
// end of the main loop