Unigine.PropertyParameter Class

Properties:

Name	Description
string StructName	The name of the structure that defines the type of the struct parameter.
int ArrayDim	The dimension of the array parameter.
string ArrayTypeName	The type name of elements of the array parameter.
int ArrayType	The type of elements of the array parameter.
int ArraySize	The size of the array parameter.
string ValueFile	The value of the file parameter.
int MaskType	The type of elements of the mask parameter.
int SwitchNumItems	The number of items of the switch parameter.
int SliderMaxExpand	The value indicating if the maximum value of the slider parameter can be decreased.
int SliderMinExpand	The value indicating if the minimum value of the slider parameter can be decreased.
int SliderLog10	The value indicating if the slider parameter uses a logarithmic scale (with the base ten).
double DoubleMaxValue	The maximum double value of the property parameter.
double DoubleMinValue	The minimum double value of the property parameter.
float FloatMaxValue	The maximum float value of the property parameter.
float FloatMinValue	The minimum float value of the property parameter.
int IntMaxValue	The maximum integer value of the property parameter.
int IntMinValue	The minimum integer value of the property parameter.
UGUID ValueGUID	The value of the UGUID property parameter.
int ValueMask	The value of the mask parameter.
int ValueSwitch	The value of the switch parameter.
bool ValueToggle	The value of the toggle parameter.
int ValueNodeID	The value of the node ID property parameter.
Node ValueNode	The value of the Node property parameter.
Material ValueMaterial	The value of the Material property parameter.
Property ValueProperty	The value of the Property-type property parameter.
vec4 ValueVec4	The .
vec3 ValueVec3	The .
string ValueString	The value of the string property parameter.
vec4 ValueColor	The value of the four-component vec4 color vector (R, G, B, A) property parameter.
double ValueDouble	The value of the double property parameter.
float ValueFloat	The value of the float property parameter.
int ValueInt	The value of the integer property parameter.
Curve2d ValueCurve2dOverride	The Curve2d instance for the data stored in the specified property parameter overriding the default one.
Curve2d ValueCurve2d	The Curve2d value of the property parameter.
bool IsCurve2d	The value indicating if the property parameter is a 2d curve.
bool IsStruct	The value indicating if the property parameter is a structure.
bool IsArray	The value indicating if the property parameter is an array.
bool IsNode	The value indicating if the property parameter is a node.
bool IsMaterial	The value indicating if the property parameter is a material.
bool IsProperty	The value indicating if the property parameter is a property.
bool IsFile	The value indicating if the property parameter is a file.
bool IsMask	The value indicating if the property parameter is a mask.
bool IsIVec4	The value indicating if the property parameter is a vector of 4 integer components.
bool IsIVec3	The value indicating if the property parameter is a vector of 3 integer components.
bool IsIVec2	The value indicating if the property parameter is a vector of 2 integer components.
bool IsDVec4	The value indicating if the property parameter is a vector of 4 double components.
bool IsDVec3	The value indicating if the property parameter is a vector of 3 double components.
bool IsDVec2	The value indicating if the property parameter is a vector of 2 double components.
bool IsVec4	The value indicating if the property parameter is a vector of 4 float components.
bool IsVec3	The value indicating if the property parameter is a vector of 3 float components.
bool IsVec2	The value indicating if the property parameter is a vector of 2 float components.
bool IsColor	The value indicating if the property parameter is a color.
bool IsString	The value indicating if the property parameter is a string.
bool IsSwitch	The value indicating if the property parameter is a switch.
bool IsToggle	The value indicating if the property parameter is a toggle.
bool IsDouble	The value indicating if the property parameter is a double.
bool IsFloat	The value indicating if the property parameter is a float.
bool IsInt	The value indicating if the property parameter is an integer.
string Filter	The filter string associated with the property parameter.
string Group	The name of the group to which the property parameter belongs.
string Tooltip	The tooltip for the property parameter.
string Title	The title of the property parameter.
string Name	The name of the property parameter.
int Type	The type identifier of the property parameter.
bool IsOverridden	The value indicating if the property parameter is overridden.
bool IsInherited	The value indicating if the property parameter is inherited from a parent.
bool IsHidden	The value indicating if the property parameter is hidden.
bool IsExist	The value indicating if the property parameter is an existing one.
int NumChildren	The total number of children of the property parameter.
PropertyParameter Parent	The parent property parameter, if it exists.
UGUID PropertyGUID	The GUID of the property that owns the parameter.
Property Property	The property that owns the parameter.
int ID	The ID of the property parameter.
int SwitchItem	The number of the item of the switch parameter.
ivec4 ValueIVec4	The value of the four-component ivec4 vector property parameter.
ivec3 ValueIVec3	The value of the three-component ivec3 vector property parameter.
ivec2 ValueIVec2	The value of the two-component ivec2 vector property parameter.
dvec4 ValueDVec4	The value of the four-component dvec4 vector property parameter.
dvec3 ValueDVec3	The value of the three-component dvec3 vector property parameter.
dvec2 ValueDVec2	The value of the two-component dvec2 vector property parameter.
vec2 ValueVec2	The value of the two-component vec2 vector property parameter.

Methods:

Name	Description View: Sort by:
IsChild	Returns a value indicating if the specified property parameter is a child of this property parameter.
FindChild	Returns the number of the child property parameter with the specified name.
GetChild	Returns a child property parameter by its number.
GetChildIndex	Returns the index of the specified child property parameter.
SetValue	Sets the value of the property parameter using the integer value specified.
ResetValue	Resets an overridden value of the property parameter.
GetValue	Returns the current value of the property parameter as a Variable.
HasSliderMinValue	Returns a value indicating if the slider parameter has the minimum value specified.
HasSliderMaxValue	Returns a value indicating if the slider parameter has the maximum value specified.
GetSwitchItemName	Returns the name of the item of the switch parameter.
GetSwitchItemValue	Returns the value of the item of the switch parameter with the specified number.
GetValueFile	Returns the current value of the file parameter.
GetFileIsAsset	Returns a value indicating if the file parameter stores a reference to an asset file.
GetFileIsRuntime	Returns a value indicating if the file parameter stores a reference to a runtime file.
GetFileIsAbsPath	Returns a value indicating if the file parameter stores an absolute file path.
IsFileExist	Returns a value indicating if a file corresponding to the property parameter exists.
SaveState	Saves data of the property parameter into a binary stream.
RestoreState	Restores the data of the property parameter from a binary stream in the specified mode.
IsValuePropertyInternal	Checks if the property parameter flag is set to internal (flags="internal").
IsValueFitFilter	Checks if the type of the indicated node fits the current property parameter filter.

PropertyParameter Class

Properties

string StructName#

The name of the structure that defines the type of the struct parameter.

int ArrayDim#

The dimension of the array parameter.

NoticeMulti-dimensional arrays are represented as arrays of arrays, thus, the return value of this method will decrease with each level down the hierarchy.

string ArrayTypeName#

The type name of elements of the array parameter.

int ArrayType#

The type of elements of the array parameter.

int ArraySize#

The size of the array parameter.

string ValueFile#

The

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

The value stored in the file parameter depends on the flags set for the parameter.

int MaskType#

The type of elements of the mask parameter.

int SwitchNumItems#

The

int SliderMaxExpand#

The value indicating if the maximum value of the slider parameter can be decreased. Slider parameter is a parameter of one of the following types: PARAMETER_INT, PARAMETER_FLOAT, PARAMETER_DOUBLE.

int SliderMinExpand#

The value indicating if the minimum value of the slider parameter can be decreased. Slider parameter is a parameter of one of the following types: PARAMETER_INT, PARAMETER_FLOAT, PARAMETER_DOUBLE.

int SliderLog10#

The value indicating if the slider parameter uses a logarithmic scale (with the base ten). The slider parameter is a parameter of one of the following types: PARAMETER_INT, PARAMETER_FLOAT, PARAMETER_DOUBLE.

double DoubleMaxValue#

The maximum double value of the property parameter.

double DoubleMinValue#

The minimum double value of the property parameter.

float FloatMaxValue#

The maximum float value of the property parameter.

float FloatMinValue#

The minimum float value of the property parameter.

int IntMaxValue#

The maximum integer value of the property parameter.

int IntMinValue#

The minimum integer value of the property parameter.

UGUID ValueGUID#

The value of the UGUID property parameter.

int ValueMask#

The value of the mask parameter. If the PARAMETER_MASK variable isn't set for the parameter, or the property is not editable, the value won't be updated.

int ValueSwitch#

The value of the switch parameter. If the PARAMETER_SWITCH variable isn't set for the parameter, the function will return 0.

bool ValueToggle#

The value of the toggle parameter. If the PARAMETER_TOGGLE variable isn't set for the parameter, the function will return 0.

int ValueNodeID#

The value of the node ID property parameter.

Node ValueNode#

The value of the Node property parameter.

Material ValueMaterial#

The value of the Material property parameter.

Property ValueProperty#

The value of the Property-type property parameter.

vec4 ValueVec4#

The value of the four-component vec4 vector property parameter

vec3 ValueVec3#

The value of the three-component vec3 vector property parameter

string ValueString#

The value of the string property parameter.

vec4 ValueColor#

The value of the four-component vec4 color vector (R, G, B, A) property parameter.

double ValueDouble#

The value of the double property parameter.

float ValueFloat#

The value of the float property parameter.

int ValueInt#

The value of the integer property parameter.

Curve2d ValueCurve2dOverride#

The Curve2d instance for the data stored in the specified property parameter overriding the default one. This method enables you to set individual curves, adjusting the value of the resulting property.

NoticeModifications made to the curve shall not propagate to the parent and sibling properties.

Curve2d ValueCurve2d#

The Curve2d value of the property parameter.

bool IsCurve2d#

The value indicating if the property parameter is a 2d curve.

bool IsStruct#

The value indicating if the property parameter is a structure.

bool IsArray#

The value indicating if the property parameter is an array.

bool IsNode#

The value indicating if the property parameter is a node.

bool IsMaterial#

The value indicating if the property parameter is a material.

bool IsProperty#

The value indicating if the property parameter is a property.

bool IsFile#

The value indicating if the property parameter is a file.

bool IsMask#

The value indicating if the property parameter is a mask.

bool IsIVec4#

The value indicating if the property parameter is a vector of 4 integer components.

bool IsIVec3#

The value indicating if the property parameter is a vector of 3 integer components.

bool IsIVec2#

The value indicating if the property parameter is a vector of 2 integer components.

bool IsDVec4#

The value indicating if the property parameter is a vector of 4 double components.

bool IsDVec3#

The value indicating if the property parameter is a vector of 3 double components.

bool IsDVec2#

The value indicating if the property parameter is a vector of 2 double components.

bool IsVec4#

The value indicating if the property parameter is a vector of 4 float components.

bool IsVec3#

The value indicating if the property parameter is a vector of 3 float components.

bool IsVec2#

The value indicating if the property parameter is a vector of 2 float components.

bool IsColor#

The value indicating if the property parameter is a color.

bool IsString#

The value indicating if the property parameter is a string.

bool IsSwitch#

The value indicating if the property parameter is a switch.

bool IsToggle#

The value indicating if the property parameter is a toggle.

bool IsDouble#

The value indicating if the property parameter is a double.

bool IsFloat#

The value indicating if the property parameter is a float.

bool IsInt#

The value indicating if the property parameter is an integer.

string Filter#

The filter string associated with the property parameter. This string specifies a filter for file, material or property parameter values thet will be used in the unigineeditor. for example, you can specify ".xml|.node|.txt" to filter certain types of assets, or specify a base material to filter out materials, that cannot be used in a particular case (e.g. to avoid an attempt of assigning a post material to a mesh).

Notice

This attribute is available only for file, material and property parameter types.

string Group#

The name of the group to which the property parameter belongs.

string Tooltip#

The tooltip for the property parameter. This title is displayed in the UNIGINE Editor's UI.

string Title#

The title of the property parameter. This title is displayed in the UNIGINE Editor's UI.

string Name#

The name of the property parameter.

int Type#

The type identifier of the property parameter. You can get the name of the parameter type using the Property.ParameterNameByType() method:

Source code (C#)

Log.Message("Parameter type: {0}\n", my_property.ParameterNameByType(my_prop_param.Type));

bool IsOverridden#

The value indicating if the property parameter is overridden.

bool IsInherited#

The value indicating if the property parameter is inherited from a parent.

bool IsHidden#

The value indicating if the property parameter is hidden.

bool IsExist#

The value indicating if the property parameter is an existing one.

int NumChildren#

The total number of children of the property parameter.

PropertyParameter Parent#

The parent property parameter, if it exists.

UGUID PropertyGUID#

The GUID of the property that owns the parameter.

Property Property#

The property that owns the parameter.

int ID#

The ID of the property parameter.

int SwitchItem#

The number of the item of the switch parameter.

Suppose we have a property switch parameter declared as follows:

Source code (XML)

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

NoticeSpaces in the items attribute declaration are taken into account. Thus, items="red=-1, green" shall produce 2 items: "red" and " green"

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

Source code (C#)

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).

ivec4 ValueIVec4#

The value of the four-component ivec4 vector property parameter.

ivec3 ValueIVec3#

The value of the three-component ivec3 vector property parameter.

ivec2 ValueIVec2#

The value of the two-component ivec2 vector property parameter.

dvec4 ValueDVec4#

The value of the four-component dvec4 vector property parameter.

dvec3 ValueDVec3#

The value of the three-component dvec3 vector property parameter.

dvec2 ValueDVec2#

The value of the two-component dvec2 vector property parameter.

vec2 ValueVec2#

The value of the two-component vec2 vector property parameter.

Members

bool IsChild ( PropertyParameter parameter ) #

Returns a value indicating if the specified property parameter is a child of this property parameter.

Arguments

PropertyParameter parameter - Property parameter to be checked.

Return value

true if the specified property parameter is a child of this property parameter; otherwise, false.

int FindChild ( string name ) #

Returns the number of the child property parameter with the specified name.

Arguments

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

Return value

Number of the child property parameter with the specified name, if it exists; otherwise, -1.

PropertyParameter GetChild ( int num ) #

Returns a child property parameter by its number.

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

Child property parameter instance, if it exists; otherwise, nullptr.

PropertyParameter GetChild ( string name ) #

Returns a child property parameter by its name.

Arguments

string name - Child property parameter name.

Return value

Child property parameter instance, if it exists; otherwise, nullptr.

int GetChildIndex ( PropertyParameter parameter ) #

Returns the index of the specified child property parameter.

Arguments

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

Return value

Index of the child property parameter in the range from 0 to the total number of children of this property parameter, if such a child exists; otherwise, -1.

void SetValue ( int value ) #

Sets the value of the property parameter using the integer value specified.

Arguments

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

void SetValue ( float value ) #

Sets the value of the property parameter using the float value specified.

Arguments

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

void SetValue ( double value ) #

Sets the value of the property parameter using the double value specified.

Arguments

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

void SetValue ( string value ) #

Sets the value of the property parameter using the string specified.

Arguments

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

void SetValue ( vec2 value ) #

Sets the value of the property parameter using the two-component vec2 vector specified.

Arguments

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

void SetValue ( vec3 value ) #

Sets the value of the property parameter using the three-component vec3 vector specified.

Arguments

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

void SetValue ( vec4 value ) #

Sets the value of the property parameter using the four-component vec4 vector specified.

Arguments

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

void SetValue ( dvec2 value ) #

Sets the value of the property parameter using the two-component dvec2 vector specified.

Arguments

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

void SetValue ( dvec3 value ) #

Sets the value of the property parameter using the three-component dvec3 vector specified.

Arguments

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

void SetValue ( dvec4 value ) #

Sets the value of the property parameter using the four-component dvec4 vector specified.

Arguments

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

void SetValue ( ivec2 value ) #

Sets the value of the property parameter using the two-component ivec2 vector specified.

Arguments

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

void SetValue ( ivec3 value ) #

Sets the value of the property parameter using the three-component ivec3 vector specified.

Arguments

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

void SetValue ( ivec4 value ) #

Sets the value of the property parameter using the four-component ivec4 vector specified.

Arguments

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

void SetValue ( UGUID value ) #

Sets the value of the property parameter using the UGUID value specified.

Arguments

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

void SetValue ( Node value ) #

Sets the value of the property parameter using the Node specified.

Arguments

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

void SetValue ( Material value ) #

Sets the value of the property parameter using the Material specified.

Arguments

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

void SetValue ( Property value ) #

Sets the value of the property parameter using the Property specified.

Arguments

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

bool SetValue ( Variable value ) #

Sets the value of the property parameter using the Variable specified.

Arguments

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

Return value

true if the property value is set successfully; otherwise, false.

void SetValue ( Curve2d value ) #

Sets the value of the property parameter using the Curve2d value specified.

Arguments

Curve2d value - Curve2d value to be set as the value of the property parameter.

Arguments

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

Return value

Name of the item of the switch parameter with the specified number.

int GetSwitchItemValue ( int item ) #

Returns the value of the item of the switch parameter with the specified number.

Arguments

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

Return value

Value of the item of the switch parameter with the specified number.

string GetValueFile ( bool fast = 0 ) #

Returns the current value of the file parameter.

Arguments

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

Return value

Current file parameter value depending on the flags set for the parameter:

Source code (C++)

// 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

bool SaveState ( Stream stream ) #

Saves data of the property parameter into a binary stream.

Example using saveState() and restoreState() methods:

Source code (C#)

// create a property parameter and set its state
propertyparam1.ValueInt = 7;

// save state
Blob blob_state = new Blob();
propertyparam1.SaveState(blob_state);

// change state
propertyparam1.ValueInt = 4;

// restore state
blob_state.SeekSet(0);	// returning the carriage to the start of the blob
propertyparam1.RestoreState(blob_state, 0);

Arguments

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

Return value

true if the property parameter data is saved successfully; otherwise, false.

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

Restores the data of the property parameter from a binary stream in the specified mode.

Example using saveState() and restoreState() methods:

Source code (C#)

// create a property parameter and set its state
propertyparam1.ValueInt = 7;

// save state
Blob blob_state = new Blob();
propertyparam1.SaveState(blob_state);

// change state
propertyparam1.ValueInt = 4;

// restore state
blob_state.SeekSet(0);	// returning the carriage to the start of the blob
propertyparam1.RestoreState(blob_state, 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.

Last update: 2024-11-01

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

Unigine.PropertyParameter Class

In This Article:

Properties:

Methods:

PropertyParameter Class

Properties

string StructName#

int ArrayDim#

string ArrayTypeName#

int ArrayType#

int ArraySize#

string ValueFile#

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#

Curve2d ValueCurve2dOverride#

Curve2d ValueCurve2d#

bool IsCurve2d#

bool IsStruct#

bool IsArray#

bool IsNode#

bool IsMaterial#

bool IsProperty#

bool IsFile#

bool IsMask#

bool IsIVec4#

bool IsIVec3#

bool IsIVec2#

bool IsDVec4#

bool IsDVec3#

bool IsDVec2#

bool IsVec4#

bool IsVec3#

bool IsVec2#

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#

int SwitchItem#