Unigine.PropertyParameter Class

PropertyParameter Class

Properties

string StructName#

int ArrayDim#

string ArrayTypeName#

int ArrayType#

int ArraySize#

string ValueFile#

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

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

// flags = "abspath"
setValueFile(file_path);				// getValueFile() -> file_path

int MaskType#

int SwitchNumItems#

int SliderMaxExpand#

int SliderMinExpand#

int SliderLog10#

double DoubleMaxValue#

double DoubleMinValue#

float FloatMaxValue#

float FloatMinValue#

int IntMaxValue#

int IntMinValue#

UGUID ValueGUID#

int ValueMask#

int ValueSwitch#

bool ValueToggle#

int ValueNodeID#

Node ValueNode#

Material ValueMaterial#

Property ValueProperty#

vec4 ValueVec4#

vec3 ValueVec3#

string ValueString#

vec4 ValueColor#

double ValueDouble#

float ValueFloat#

int ValueInt#

bool IsStruct#

bool IsArray#

bool IsNode#

bool IsMaterial#

bool IsProperty#

bool IsFile#

bool IsMask#

bool IsVec4#

bool IsVec3#

bool IsColor#

bool IsString#

bool IsSwitch#

bool IsToggle#

bool IsDouble#

bool IsFloat#

bool IsInt#

string Filter#

string Group#

string Tooltip#

string Title#

string Name#

int Type#

bool IsOverridden#

bool IsInherited#

bool IsHidden#

bool IsExist#

int NumChildren#

PropertyParameter Parent#

UGUID PropertyGUID#

Property Property#

int ID#

Members

bool IsChild ( PropertyParameter parameter ) #

Arguments

• PropertyParameter parameter - Property parameter to be checked.

Return value

int FindChild ( string name ) #

Arguments

• string name - Name of the child property parameter to be found.

Return value

PropertyParameter GetChild ( int num ) #

Arguments

• int num - Number of the child property parameter in the range from 0 to the total number of children of this property parameter.

Return value

PropertyParameter GetChild ( string name ) #

Arguments

• string name - Child property parameter name.

Return value

int GetChildIndex ( PropertyParameter parameter ) #

Arguments

• PropertyParameter parameter - Child property parameter for which an index is to be found.

Return value

void SetValue ( int value ) #

Arguments

• int value - Integer value to be set as the value of the property parameter.

void SetValue ( float value ) #

Arguments

• float value - Float value to be set as the value of the property parameter.

void SetValue ( double value ) #

Arguments

• double value - Double value to be set as the value of the property parameter.

void SetValue ( string value ) #

Arguments

• string value - String to be set as the value of the property parameter.

void SetValue ( vec2 value ) #

Arguments

• vec2 value - Two-component float vector to be set as the value of the property parameter.

void SetValue ( vec3 value ) #

Arguments

• vec3 value - Three-component float vector to be set as the value of the property parameter.

void SetValue ( vec4 value ) #

Arguments

• vec4 value - Four-component float vector to be set as the value of the property parameter.

void SetValue ( dvec2 value ) #

Arguments

• dvec2 value - Two-component double vector to be set as the value of the property parameter.

void SetValue ( dvec3 value ) #

Arguments

• dvec3 value - Three-component double vector to be set as the value of the property parameter.

void SetValue ( dvec4 value ) #

Arguments

• dvec4 value - Four-component double vector to be set as the value of the property parameter.

void SetValue ( ivec2 value ) #

Arguments

• ivec2 value - Two-component integer vector to be set as the value of the property parameter.

void SetValue ( ivec3 value ) #

Arguments

• ivec3 value - Three-component integer vector to be set as the value of the property parameter.

void SetValue ( ivec4 value ) #

Arguments

• ivec4 value - Four-component integer vector to be set as the value of the property parameter.

void SetValue ( UGUID value ) #

Arguments

• UGUID value - UGUID value to be set as the value of the property parameter.

void SetValue ( Node value ) #

Arguments

• Node value - Node to be set as the value of the property parameter.

void SetValue ( Material value ) #

Arguments

• Material value - Material to be set as the value of the property parameter.

void SetValue ( Property value ) #

Arguments

• Property value - Property to be set as the value of the property parameter.

void ResetValue ( ) #

bool SetValue ( Variable value ) #

Arguments

• Variable value - Variable to be set as the value of the property parameter.

Return value

Variable GetValue ( ) #

Return value

bool HasSliderMinValue ( ) #

Return value

bool HasSliderMaxValue ( ) #

Return value

void SetSwitchItem ( int item ) #

Suppose we have a property switch parameter declared as follows:

<parameter items="red=-1,green,blue=5,yellow"/>

After loading we'll have switch items with the following values: red = -1, green = 0, blue = 5, yellow = 6.

PropertyParameter.SetValue(5); // "blue" shall be selected in the corresponding combobox in the UnigineEditor
PropertyParameter.SetSwitchItem(3); // "yellow" shall be selected in the corresponding combobox in the UnigineEditor (as it is the 3-rd item, starting from 0).

// If "green" item is selected in the UnigineEditor:
PropertyParameter.GetValueInt(); // returns 0, as "green" corresponds to the value of 0.
PropertyParameter.GetSwitchItem() // returns 1, as "green" is the 1-st element in the combobox (starting from 0).

Arguments

• int item - Number of the item of the switch parameter.

int GetSwitchItem ( ) #

Suppose we have a property switch parameter declared as follows:

<parameter items="red=-1,green,blue=5,yellow"/>

After loading we'll have switch items with the following values: red = -1, green = 0, blue = 5, yellow = 6.

PropertyParameter.SetValue(5); // "blue" shall be selected in the corresponding combobox in the UnigineEditor
PropertyParameter.SetSwitchItem(3); // "yellow" shall be selected in the corresponding combobox in the UnigineEditor (as it is the 3-rd item, starting from 0).

// If "green" item is selected in the UnigineEditor:
PropertyParameter.GetValueInt(); // returns 0, as "green" corresponds to the value of 0.
PropertyParameter.GetSwitchItem() // returns 1, as "green" is the 1-st element in the combobox (starting from 0).

Return value

string GetSwitchItemName ( int item ) #

Arguments

• int item - Number of the item of the switch parameter.

Return value

int GetSwitchItemValue ( int item ) #

Arguments

• int item - Number of the item of the switch parameter.

Return value

void setValueString ( string value ) #

Arguments

• string value - String to be set as the value of the property parameter.

string GetValueFile ( bool fast = 0 ) #

Arguments

• bool fast - 1 to use the specified number as an index in users auxiliary parameters cache; otherwise, 0.

Return value

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

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

// flags = "abspath"
setValueFile(file_path);				// getValueFile() -> file_path

string GetValueFile ( ) #

Return value

bool GetFileIsAsset ( ) #

Return value

bool GetFileIsRuntime ( ) #

Return value

bool GetFileIsAbsPath ( ) #

Return value

bool IsFileExist ( ) #

Return value

bool SaveState ( Stream stream ) #

Arguments

• Stream stream - Stream into which the property parameter data will be saved.

Return value

bool RestoreState ( Stream stream, int restore_mode = 0 ) #

Arguments

• 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

bool IsInt ( ) #

Return value

bool IsFloat ( ) #

Return value

bool IsDouble ( ) #

Return value

bool IsToggle ( ) #

Return value

bool IsSwitch ( ) #

Return value

bool IsString ( ) #

Return value

bool IsColor ( ) #

Return value

bool IsVec2 ( ) #

Return value

bool IsVec3 ( ) #

Return value

bool IsVec4 ( ) #

Return value

bool IsDVec2 ( ) #

Return value

bool IsDVec3 ( ) #

Return value

bool IsDVec4 ( ) #

Return value

bool IsIVec2 ( ) #

Return value

bool IsIVec3 ( ) #

Return value

bool IsIVec4 ( ) #

Return value

bool IsMask ( ) #

Return value

bool IsFile ( ) #

Return value

bool IsProperty ( ) #

Return value

bool IsMaterial ( ) #

Return value

bool IsNode ( ) #

Return value

bool IsArray ( ) #

Return value

bool IsStruct ( ) #

Return value

void SetValueGUID ( UGUID valueguid ) #

Arguments

• UGUID valueguid - UGUID type value

bool IsValuePropertyInternal ( ) #

Return value

bool IsValueFitFilter ( Node value ) #

Arguments

• Node value

Return value

bool IsValueFitFilter ( Property value ) #

Arguments

• Property value

Return value

bool IsValueFitFilter ( Material value ) #

Arguments

• Material value

Return value

bool IsValueFitFilter ( UGUID value ) #

Arguments

• UGUID value

Return value