Unigine::Property Class

Property Class

Members

static PropertyPtr create ( )

Ptr<Property> getChild( int num )

Arguments

• int num - The number of the target child property.

Return value

int getID( )

Return value

UGUID getGUID( )

Return value

int isBase( )

Return value

void setEditable( int editable )

Arguments

• int editable - 1 to make the property editable; 0 to make it read-only.

int isEditable( )

Return value

int isHidden( )

Return value

int isEngine( )

Return value

int isInternal( )

Return value

int isManual( )

Return value

int isHierarchyValid( )

Return value

int isParameterInherited( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

int isParameterHidden( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

int isParameterOverridden( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

void setName( const char * name )

Arguments

• const char * name - Name of the property.

const char * getName( )

Return value

int getNumChildren( )

Return value

int getNumParameters( )

Return value

int hasOverrides( )

Return value

int findParameter( const char * name )

Arguments

• const char * name - Name of the parameter.

Return value

int fetchParameter( const char * name, int fast_id )

Arguments

• const char * name - Parameter name.
• int fast_id - Parameter number in users auxiliary parameters cache. The value must be in the range [0; 128].

Return value

bool setParameter( int num, const Variable & value )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.
• const Variable & value - New value of the parameter.

Variable getParameter( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

const char * getParameterGroup( int num )

Arguments

• int num - Parameter number.

Return value

const char * getParameterFilter( int num )

Arguments

• int num - Parameter number.

Return value

const char * getParameterTitle( int num )

Arguments

• int num - Parameter number.

Return value

const char * getParameterTooltip( int num )

Arguments

• int num - Parameter number.

Return value

void setParameterFile( int num, const char * value )

Updates the value of the given file parameter. If the property is not editable, the value won't be updated.

The value stored in the file parameter (this value will be returned by the getParameterFile() method) depends on the flags set for the parameter:

// flags = "asset"
setParameterFile("guid://asset_guid"); 		// getParameterFile() -> asset_path
setParameterFile("guid://runtime_guid");	// getParameterFile() -> asset_path
setParameterFile("asset_path");				// getParameterFile() -> asset_path
setParameterFile("runtime_path");			// getParameterFile() -> asset_path

// flags = "runtime" - default
setParameterFile("guid://asset_guid"); 		// getParameterFile() -> runtime_path
setParameterFile("guid://runtime_guid");	// getParameterFile() -> runtime_path
setParameterFile("asset_path");				// getParameterFile() -> runtime_path
setParameterFile("runtime_path");			// getParameterFile() -> runtime_path

// flags = "abspath"
setParameterFile(file_path);				// getParameterFile() -> file_path

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.
• const char * value - New value for the file parameter.

const char * getParameterFile( int num, int fast )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list. An index in users auxiliary parameters cache can laso be specified, in this case the fast flag should be set to 1.
• int fast - 1 to use the specified number as an index in users auxiliary parameters cache; otherwise, 0.

Return value

// flags = "asset"
setParameterFile("guid://asset_guid"); 		// getParameterFile() -> asset_path
setParameterFile("guid://runtime_guid");	// getParameterFile() -> asset_path
setParameterFile("asset_path");				// getParameterFile() -> asset_path
setParameterFile("runtime_path");			// getParameterFile() -> asset_path

// flags = "runtime" - default
setParameterFile("guid://asset_guid"); 		// getParameterFile() -> runtime_path
setParameterFile("guid://runtime_guid");	// getParameterFile() -> runtime_path
setParameterFile("asset_path");				// getParameterFile() -> runtime_path
setParameterFile("runtime_path");			// getParameterFile() -> runtime_path

// flags = "abspath"
setParameterFile(file_path);				// getParameterFile() -> file_path

int getParameterFileIsAsset( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

int getParameterFileIsRuntime( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

int getParameterFileIsAbsPath( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

int isParameterFileExist( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

void setParameterMaterial( int num, const Ptr<Material> & value )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.
• const Ptr<Material> & value - Material smart pointer to be set as a value of the specified parameter.

Ptr<Material> getParameterMaterial( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

void setParameterProperty( int num, const Ptr<Property> & value )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.
• const Ptr<Property> & value - Property smart pointer to be set as a value of the specified parameter.

Ptr<Property> getParameterProperty( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

void setParameterColor( int num, const Math::vec4 & value )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.
• const Math::vec4 & value - New value for the color parameter.

Math::vec4 getParameterColor( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

void setParameterDouble( int num, double value )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.
• double value - New value for the double parameter.

double getParameterDouble( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

double getParameterDoubleMaxValue( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

double getParameterDoubleMinValue( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

void setParameterFloat( int num, float value )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.
• float value - New value of the float parameter.

float getParameterFloat( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

float getParameterFloatMaxValue( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

float getParameterFloatMinValue( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

void setParameterGUID( int num, const UGUID & value )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.
• const UGUID & value - New GUID value for the specified parameter.

UGUID getParameterGUID( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

void setParameterNode( int num, const Ptr<Node> & value )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.
• const Ptr<Node> & value - Node smart pointer to be set as a value of the specified parameter.

Ptr<Node> getParameterNode( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

void setParameterNodeID( int num, int value )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.
• int value - ID of a node to be set as a value of the specified parameter.

int getParameterNodeID( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

void setParameterInt( int num, int value )

Updates the value of the given integer parameter. If the PARAMETER_INT variable isn't set for the parameter, or the property is not editable, the value won't be updated.

For example, the values of some integer parameter named param_1 of some property can be set as follows:

property->setParameterInt(property->findParameter("param_1"), 1);

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.
• int value - New value for the integer parameter.

int getParameterInt( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

int getParameterIntMaxValue( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

int getParameterIntMinValue( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

void setParameterMask( int num, int value )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.
• int value - New value for the mask parameter.

int getParameterMask( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

const char * getParameterName( int num )

Arguments

• int num - The number of the target parameter in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account).

Return value

int getParameterSliderLog10( int num )

Arguments

• int num - The number of the slider parameter in range from 0 to the total number of the property's parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account).

Return value

int getParameterSliderMaxExpand( int num )

Arguments

• int num - The number of the slider parameter in range from 0 to the total number of the property's parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account).

Return value

int getParameterSliderMinExpand( int num )

Arguments

• int num - The number of the slider parameter in range from 0 to the total number of the property's parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account).

Return value

int hasParameterSliderMaxValue( int num )

Arguments

• int num - The number of the slider parameter in range from 0 to the total number of the property's parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account).

Return value

int hasParameterSliderMinValue( int num )

Arguments

• int num - The number of the slider parameter in range from 0 to the total number of the property's parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account).

Return value

void setParameterString( int num, const char * value )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.
• const char * value - New value for the string parameter.

const char * getParameterString( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

void setParameterSwitch( int num, int value )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.
• int value - New value for the switch parameter.

int getParameterSwitch( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

const char * getParameterSwitchItem( int num, int item )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.
• int item - Number of the item of the switch parameter.

Return value

int getParameterSwitchNumItems( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

void setParameterToggle( int num, int value )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.
• int value - New value of the toggle parameter.

int getParameterToggle( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

int getParameterType( int num )

Arguments

• int num - The number of the target parameter in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account).

Return value

void setParameterVec3( int num, const Math::vec3 & value )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.
• const Math::vec3 & value - New value for the vector (vec3) parameter.

Math::vec3 getParameterVec3( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

void setParameterVec4( int num, const Math::vec4 & value )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.
• const Math::vec4 & value - New value for the vector (vec4) parameter.

Math::vec4 getParameterVec4( int num )

Arguments

• int num - Parameter number in range from 0 to the total number of the property parameters (including parameters of its parent; if a parameter of the current property overrides the parent property's parameter, the parent property's parameter isn't taken into account). New parameters are added to the end of the parameters list.

Return value

void resetParameter( int num )

Arguments

• int num - Parameter number.

Ptr<Property> getParent( )

Return value

int isParent( const char * name )

Suppose we have the following two manual properties in our project:

• Source code (XML)

  <?xml version="1.0" encoding="utf-8"?>
  <property version="2.7.3" name="my_prop" parent_name="surface_base" manual="1">
  	<parameter name="my_parameter">100</parameter>
  </property>

• Source code (XML)

  <?xml version="1.0" encoding="utf-8"?>
  <property version="2.7.3" name="my_prop_0" parent_name="my_prop" manual="1">
  	<parameter name="my_parameter1">101</parameter>
  	<parameter name="my_parameter2">101</parameter>
  </property>

// get a property named my_prop_0
PropertyPtr property = Properties::get()->findManualProperty("my_prop_0");
// perform parent check
Log::message("%d\n",property->isParent("my_prop"));

Arguments

• const char * name - Parent property name.

Return value

int isParent( const UGUID & guid )

Arguments

• const UGUID & guid - Parent property GUID.

Return value

int setParent( const Ptr<Property> & property, int save_all_values = 0 )

Arguments

• const Ptr<Property> & property - Property to be set as the parent for this property.
• int save_all_values - Flag indicating if parameter values of the property will be saved after reparenting.

Return value

void setPath( const char * path )

Arguments

• const char * path - New path to the property file.

void setFileGUID( const UGUID & fileguid )

Arguments

• const UGUID & fileguid - New GUID for the property file.

UGUID getFileGUID( )

Return value

const char * getPath( )

Return value

Ptr<Property> clone( )

Return value

Ptr<Property> clone( const char * name, const char * path )

Arguments

• const char * name - Cloned property name.
• const char * path - Path to save the cloned property.

Return value

Ptr<Property> clone( const char * name, const char * path, const UGUID & guid )

Arguments

• const char * name - Cloned property name.
• const char * path - Path to save the cloned property.
• const UGUID & guid - Cloned property GUID.

Return value

Ptr<Property> clone( const char * name )

// get a property to be cloned
Properties *properties = Properties::get();
PropertyPtr property = properties->findProperty("surface_base_0");
// clone the property
PropertyPtr cloned = property->clone("cloned_surface_base_0");
// perform something on the cloned pointer
// ...
// delete the pointer
cloned.grab();
cloned.destroy();

Arguments

• const char * name - Cloned property name.

Return value

void grab( )

int isOwner( )

Return value

void release( )

Ptr<Property> inherit( )

Return value

Ptr<Property> inherit( const char * name )

Arguments

• const char * name - Inherited property name.

Return value

Ptr<Property> inherit( const char * name, const char * path )

Arguments

• const char * name - Inherited property name.
• const char * path - Path to save the inherited property.

Return value

Ptr<Property> inherit( const char * name, const char * path, const UGUID & guid )

Arguments

• const char * name - Inherited property name.
• const char * path - Path to save the inherited property.
• const UGUID & guid - Inherited property GUID.

Return value

int load( )

Return value

int load( const char * path )

Arguments

• const char * path - Path to the *.prop file to load the property data from.

Return value

int loadXml( const Ptr<Xml> & xml )

Arguments

• const Ptr<Xml> & xml - Xml class instance in which the property data is stored.

Return value

int loadWorld( const Ptr<Xml> & xml )

Arguments

• const Ptr<Xml> & xml - Xml class instance in which the property data is stored.

Return value

int reload( )

Return value

int restoreState( const Ptr<Stream> & stream, int restore_mode = 0 )

Arguments

• const Ptr<Stream> & stream - Stream in which the saved property parameter data is stored.
• int restore_mode - Restore mode. One of the Property::RESTORE_MODE_* values. The default value is Property::RESTORE_MODE_REPLACE.

Return value

int canSaveInFile( )

Return value

int saveState( const Ptr<Stream> & stream )

Arguments

• const Ptr<Stream> & stream - Stream into which the property data will be saved.

Return value

int save( )

Return value

int save( const char * path )

Arguments

• const char * path - Path to the *.prop file to save the property data to.

Return value

int saveXml( const Ptr<Xml> & xml )

Arguments

• const Ptr<Xml> & xml - Xml class instance into which the property data will be saved.

Return value

int saveWorld( const Ptr<Xml> & xml, int force = 0 )

Arguments

• const Ptr<Xml> & xml - Xml class instance into which the property data will be saved.
• int force - A value indicating if forced saving of property data is used: 1 to enable forced saving, 0 to disable it.

Return value

void * addCallback( int callback, Unigine::CallbackBase1< Ptr<Property> > * func )

// for all types except for the CALLBACK_PARAMETER_CHANGED
void callback_function_name(PropertyPtr property);

void name_changed(PropertyPtr property)
{
	Log::message("A property has changed its name to \"%s\".\n", property->getName());
    // ...
}

// somewhere in the code

// inheriting a new property named "my_prop" from the base property "surface_base" via the Property Manager
PropertyPtr property = Properties::get()->findManualProperty("surface_base")->inherit("my_prop");

// setting our callback function on renaming a property
property->addCallback(Property::CALLBACK_RENAMED, MakeCallback(name_changed));

// renaming the property
property->setName("new name");

Arguments

• int callback - Callback type. One of the CALLBACK_* variables.
• Unigine::CallbackBase1< Ptr<Property> > * func - Callback pointer.

Return value

void * addCallback( int callback, Unigine::CallbackBase2< Ptr<Property>, int > * func )

// for the CALLBACK_PARAMETER_CHANGED type
void callback_function_name(PropertyPtr property, int parameter_num);

Arguments

• int callback - Callback type. One of the CALLBACK_* variables.
• Unigine::CallbackBase2< Ptr<Property>, int > * func - Callback pointer.

Return value

bool removeCallback( int callback, void * id )

Arguments

• int callback - Callback type. One of the CALLBACK_* variables.
• void * id - Callback ID obtained when adding it.

Return value

void clearCallbacks( int callback )

Arguments

• int callback - Callback type. One of the CALLBACK_* variables.

int parameterTypeByName( const char * param_type )

Arguments

• const char * param_type - Parameter type name.

Return value

const char * parameterNameByType( int param_type )

Arguments

• int param_type - Parameter type identifier, one of the PARAMETER_* variables.

Return value

Ptr<PropertyParameter> getParameterPtr( )

You can't iterate through all parameters of the property in a single loop, a recursive function should be used instead:

#include <functional>
std::function<void(const PropertyParameterPtr &)> recursive_func = [&, this](const PropertyParameterPtr &p)
{
	for (int i = 0; i < p->getNumChildren(); i++)
	{
		PropertyParameterPtr child = p->getChild(i);
		
		// do something... e.g. print parameter names and values
		Log::message("- %s: %s \n", child->getName(), child->getValueString().get());
		
		recursive_func(child);
	}
};

/* ... */
int AppWorldLogic::init() {
	/* ... */
	
	// getting the root parameter of the property
	PropertyParameterPtr root_parameter = property->getParameterPtr();

	// iterating through all parameters of the property
	recursive_func(root_parameter);
	
	return 1;
}

Return value

Ptr<PropertyParameter> getParameterPtr( const char * name )

Arguments

• const char * name - Property parameter name.

Return value

// getting some property named "my_property"
PropertyPtr pProperty = Properties::get()->findManualProperty("my_property");

// trying to get a property parameter named "some_parameter"
PropertyParameterPtr param = pProperty->getParameterPtr("some_parameter");

// checking if such parameter exists and displaying a message
if (param->isExist())
	Log::message("Specified property parameter exists!\n");
else
	Log::message("No such parameter!\n");

Ptr<PropertyParameter> getParameterPtr( int id )

Arguments

• int id - Property parameter ID.

Return value

// getting some property named "my_property"
PropertyPtr pProperty = Properties::get()->findManualProperty("my_property");

// trying to get a property parameter having the ID=30
PropertyParameterPtr param = pProperty->getParameterPtr(30);

// checking if such parameter exists and displaying a message
if (param->isExist())
	Log::message("Property parameter with the specified ID exists!\n");
else
	Log::message("No such parameter!\n");

int getNumStructs( )

Return value

int findStruct( const char * name )

Arguments

• const char * name - Name of the structure to be found.

Return value

const char * getStructName( int num )

Arguments

• int num - Structure number.

Return value