PropertyParameter Class

WarningThe scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.

Methods:

Name	Description View: Sort by:
getStructName	Returns the current name of the structure that defines the type of the struct parameter.
getArrayDim	Returns the current dimension of the array parameter.
getArrayTypeName	Returns the current type name of elements of the array parameter.
getArrayType	Returns the current type of elements of the array parameter.
setArraySize	Setter and Getter for size of the array parameter.
getArraySize	Setter and Getter for size of the array parameter.
setValueFile	Setter and Getter for value of the file parameter.
getValueFile	Setter and Getter for value of the file parameter.
getMaskType	Returns the current type of elements of the mask parameter.
getSwitchNumItems	Returns the current number of items of the switch parameter.
getSliderMaxExpand	Returns the current value indicating if the maximum value of the slider parameter can be decreased.
getSliderMinExpand	Returns the current value indicating if the minimum value of the slider parameter can be decreased.
getSliderLog10	Returns the current value indicating if the slider parameter uses a logarithmic scale (with the base ten).
getDoubleMaxValue	Returns the current maximum double value of the property parameter.
getDoubleMinValue	Returns the current minimum double value of the property parameter.
getFloatMaxValue	Returns the current maximum float value of the property parameter.
getFloatMinValue	Returns the current minimum float value of the property parameter.
getIntMaxValue	Returns the current maximum integer value of the property parameter.
getIntMinValue	Returns the current minimum integer value of the property parameter.
setValueGUID	Setter and Getter for value of the UGUID property parameter.
getValueGUID
setValueMask	Setter and Getter for value of the mask parameter.
getValueMask	Setter and Getter for value of the mask parameter.
setValueSwitch	Setter and Getter for value of the switch parameter.
getValueSwitch	Setter and Getter for value of the switch parameter.
setValueToggle	Setter and Getter for value of the toggle parameter.
getValueToggle	Setter and Getter for value of the toggle parameter.
setValueNodeID	Setter and Getter for value of the node ID property parameter.
getValueNodeID
setValueNode	Setter and Getter for value of the Node property parameter.
getValueNode	Setter and Getter for value of the Node property parameter.
setValueMaterial	Setter and Getter for value of the Material property parameter.
getValueMaterial
setValueProperty	Setter and Getter for value of the Property-type property parameter.
getValueProperty
setValueVec4	Setter and Getter for .
getValueVec4	Setter and Getter for .
setValueVec3	Setter and Getter for .
getValueVec3	Setter and Getter for .
setValueString	Setter and Getter for value of the string property parameter.
getValueString
setValueColor	Setter and Getter for value of the four-component vec4 color vector (R, G, B, A) property parameter.
getValueColor
setValueDouble	Setter and Getter for value of the double property parameter.
getValueDouble
setValueFloat	Setter and Getter for value of the float property parameter.
getValueFloat
setValueInt	Setter and Getter for value of the integer property parameter.
getValueInt
getValueCurve2dOverride	Returns the current Curve2d instance for the data stored in the specified property parameter overriding the default one.
setValueCurve2d	Setter and Getter for Curve2d value of the property parameter.
getValueCurve2d
isCurve2d	Returns the current value indicating if the property parameter is a 2d curve.
isStruct	Returns the current value indicating if the property parameter is a structure.
isArray	Returns the current value indicating if the property parameter is an array.
isNode	Returns the current value indicating if the property parameter is a node.
isMaterial	Returns the current value indicating if the property parameter is a material.
isProperty	Returns the current value indicating if the property parameter is a property.
isFile	Returns the current value indicating if the property parameter is a file.
isMask	Returns the current value indicating if the property parameter is a mask.
isIVec4	Returns the current value indicating if the property parameter is a vector of 4 integer components.
isIVec3	Returns the current value indicating if the property parameter is a vector of 3 integer components.
isIVec2	Returns the current value indicating if the property parameter is a vector of 2 integer components.
isDVec4	Returns the current value indicating if the property parameter is a vector of 4 double components.
isDVec3	Returns the current value indicating if the property parameter is a vector of 3 double components.
isDVec2	Returns the current value indicating if the property parameter is a vector of 2 double components.
isVec4	Returns the current value indicating if the property parameter is a vector of 4 float components.
isVec3	Returns the current value indicating if the property parameter is a vector of 3 float components.
isVec2	Returns the current value indicating if the property parameter is a vector of 2 float components.
isColor	Returns the current value indicating if the property parameter is a color.
isString	Returns the current value indicating if the property parameter is a string.
isSwitch	Returns the current value indicating if the property parameter is a switch.
isToggle	Returns the current value indicating if the property parameter is a toggle.
isDouble	Returns the current value indicating if the property parameter is a double.
isFloat	Returns the current value indicating if the property parameter is a float.
isInt	Returns the current value indicating if the property parameter is an integer.
getFilter	Returns the current filter string associated with the property parameter.
getGroup	Returns the current name of the group to which the property parameter belongs.
getTooltip	Returns the current tooltip for the property parameter.
getTitle	Returns the current title of the property parameter.
getName	Returns the current name of the property parameter.
getType	Returns the current type identifier of the property parameter.
isOverridden	Returns the current value indicating if the property parameter is overridden.
isInherited	Returns the current value indicating if the property parameter is inherited from a parent.
isHidden	Returns the current value indicating if the property parameter is hidden.
isExist	Returns the current value indicating if the property parameter is an existing one.
getNumChildren	Returns the current total number of children of the property parameter.
getParent	Returns the current parent property parameter, if it exists.
getPropertyGUID	Returns the current GUID of the property that owns the parameter.
getProperty	Returns the current property that owns the parameter.
getID	Returns the current ID of the property parameter.
setSwitchItem	Setter and Getter for number of the item of the switch parameter.
getSwitchItem
setValueIVec4	Setter and Getter for value of the four-component ivec4 vector property parameter.
getValueIVec4
setValueIVec3	Setter and Getter for value of the three-component ivec3 vector property parameter.
getValueIVec3
setValueIVec2	Setter and Getter for value of the two-component ivec2 vector property parameter.
getValueIVec2
setValueDVec4	Setter and Getter for value of the four-component dvec4 vector property parameter.
getValueDVec4
setValueDVec3	Setter and Getter for value of the three-component dvec3 vector property parameter.
getValueDVec3
setValueDVec2	Setter and Getter for value of the two-component dvec2 vector property parameter.
getValueDVec2
setValueVec2	Setter and Getter for value of the two-component vec2 vector property parameter.
getValueVec2
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 Variable 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.
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").

PropertyParameter Class

Members

string getStructName() const#

Returns the current name of the structure that defines the type of the struct parameter.

Return value

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

int getArrayDim() const#

Returns the current 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.

Return value

Current dimension of the array parameter.

string getArrayTypeName() const#

Returns the current type name of elements of the array parameter.

Return value

Current type name of elements of the array parameter (Float, Node, Material, etc.).

int getArrayType() const#

Returns the current type of elements of the array parameter.

Return value

Current type of array elements, one of the PROPERTY_PARAMETER_* variables.

Notice

This method does not return PROPERTY_PARAMETER_ARRAY for an array parameter, it returns the type of array elements instead (e.g. PROPERTY_PARAMETER_FLOAT, PROPERTY_PARAMETER_STRUCT, etc.)

void setArraySize ( int size ) #

Sets a new size of the array parameter.

Arguments

int size - The array size (number of elements).

int getArraySize() const#

Returns the current size of the array parameter.

Return value

Current array size (number of elements).

void setValueFile ( string file ) #

Sets a new

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.

Arguments

string file - The value for the file parameter.

string getValueFile() const#

Returns the current

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.

Return value

Current value for the file parameter.

int getMaskType() const#

Returns the current type of elements of the mask parameter.

Return value

Current Type of the mask parameter, one of the PROPERTY_PARAMETER_MASK_* variables.

int getSwitchNumItems() const#

Returns the current number of items of the switch parameter. If the PROPERTY_PARAMETER_SWITCH variable isn't set for the parameter, the function will return 0.

Return value

Current number of items of the switch parameter.

int getSliderMaxExpand() const#

Returns the current value indicating if the maximum value of the slider parameter can be decreased. Slider parameter is a parameter of one of the following types: PROPERTY_PARAMETER_INT, PROPERTY_PARAMETER_FLOAT, PROPERTY_PARAMETER_DOUBLE.

Return value

Current 1 if the maximum value can be changed; otherwise, 0.

int getSliderMinExpand() const#

Returns the current value indicating if the minimum value of the slider parameter can be decreased. Slider parameter is a parameter of one of the following types: PROPERTY_PARAMETER_INT, PROPERTY_PARAMETER_FLOAT, PROPERTY_PARAMETER_DOUBLE.

Return value

Current 1 if the minimum value can be changed; otherwise, 0.

int getSliderLog10() const#

Returns the current 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: PROPERTY_PARAMETER_INT, PROPERTY_PARAMETER_FLOAT, PROPERTY_PARAMETER_DOUBLE.

Return value

Current 1 if the property parameter uses a logarithmic scale; otherwise, 0.

double getDoubleMaxValue() const#

Returns the current maximum double value of the property parameter.

Return value

Current maximum double value of the property parameter.

double getDoubleMinValue() const#

Returns the current minimum double value of the property parameter.

Return value

Current minimum double value of the property parameter.

float getFloatMaxValue() const#

Returns the current maximum float value of the property parameter.

Return value

Current maximum float value of the property parameter.

float getFloatMinValue() const#

Returns the current minimum float value of the property parameter.

Return value

Current minimum float value of the property parameter.

int getIntMaxValue() const#

Returns the current maximum integer value of the property parameter.

Return value

Current maximum integer value of the property parameter.

int getIntMinValue() const#

Returns the current minimum integer value of the property parameter.

Return value

Current minimum integer value of the property parameter.

void setValueGUID ( UGUID guid ) #

Sets a new value of the UGUID property parameter.

Arguments

UGUID guid - The value of the UGUID property parameter.

UGUID getValueGUID() const#

Returns the current value of the UGUID property parameter.

Return value

Current value of the UGUID property parameter.

void setValueMask ( int mask ) #

Sets a new value of the mask parameter. If the PROPERTY_PARAMETER_MASK variable isn't set for the parameter, or the property is not editable, the value won't be updated.

Arguments

int mask - The value of the integer mask property parameter.

int getValueMask() const#

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

Return value

Current value of the integer mask property parameter.

void setValueSwitch ( int switch ) #

Sets a new value of the switch parameter. If the PROPERTY_PARAMETER_SWITCH variable isn't set for the parameter, the function will return 0.

Arguments

int switch - The value of the switch parameter.

int getValueSwitch() const#

Returns the current value of the switch parameter. If the PROPERTY_PARAMETER_SWITCH variable isn't set for the parameter, the function will return 0.

Return value

Current value of the switch parameter.

void setValueToggle ( bool toggle ) #

Sets a new value of the toggle parameter. If the PROPERTY_PARAMETER_TOGGLE variable isn't set for the parameter, the function will return 0.

Arguments

bool toggle - true for the toggle parameter value set as enabled, and false for the disabled value.

bool getValueToggle() const#

Returns the current value of the toggle parameter. If the PROPERTY_PARAMETER_TOGGLE variable isn't set for the parameter, the function will return 0.

Return value

true for the toggle parameter value set as enabled, and false for the disabled value.

void setValueNodeID ( int id ) #

Sets a new value of the node ID property parameter.

Arguments

int id - The value of the node ID property parameter.

int getValueNodeID() const#

Returns the current value of the node ID property parameter.

Return value

Current value of the node ID property parameter.

void setValueNode ( Node node ) #

Sets a new value of the Node property parameter.

Arguments

Node node - The value of the Node property parameter.

Node getValueNode() const#

Returns the current value of the Node property parameter.

Return value

Current value of the Node property parameter.

void setValueMaterial ( Material material ) #

Sets a new value of the Material property parameter.

Arguments

Material material - The value of the Material property parameter.

Material getValueMaterial() const#

Returns the current value of the Material property parameter.

Return value

Current value of the Material property parameter.

void setValueProperty ( Property property ) #

Sets a new value of the Property-type property parameter.

Arguments

Property property - The value of the Property-type property parameter.

Property getValueProperty() const#

Returns the current value of the Property-type property parameter.

Return value

Current value of the Property-type property parameter.

void setValueVec4 ( vec4 vec4 ) #

Sets a new value of the four-component vec4 vector property parameter

Arguments

vec4 vec4 - The value of the four-component vec4 vector property parameter

vec4 getValueVec4() const#

Returns the current value of the four-component vec4 vector property parameter

Return value

Current value of the four-component vec4 vector property parameter

void setValueVec3 ( vec3 vec3 ) #

Sets a new value of the three-component vec3 vector property parameter

Arguments

vec3 vec3 - The value of the three-component vec3 vector property parameter

vec3 getValueVec3() const#

Returns the current value of the three-component vec3 vector property parameter

Return value

Current value of the three-component vec3 vector property parameter

void setValueString ( string string ) #

Sets a new value of the string property parameter.

Arguments

string string - The value of the string property parameter.

string getValueString() const#

Returns the current value of the string property parameter.

Return value

Current value of the string property parameter.

void setValueColor ( vec4 color ) #

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

Arguments

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

vec4 getValueColor() const#

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

Return value

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

void setValueDouble ( double double ) #

Sets a new value of the double property parameter.

Arguments

double double - The value of the double property parameter.

double getValueDouble() const#

Returns the current value of the double property parameter.

Return value

Current value of the double property parameter.

void setValueFloat ( float float ) #

Sets a new value of the float property parameter.

Arguments

float float - The value of the float property parameter.

float getValueFloat() const#

Returns the current value of the float property parameter.

Return value

Current value of the float property parameter.

void setValueInt ( int int ) #

Sets a new value of the integer property parameter.

Arguments

int int - The value of the integer property parameter.

int getValueInt() const#

Returns the current value of the integer property parameter.

Return value

Current value of the integer property parameter.

Curve2d getValueCurve2dOverride() const#

Returns the current 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.

Return value

Current

void setValueCurve2d ( Curve2d curve2d ) #

Sets a new Curve2d value of the property parameter.

Arguments

Curve2d curve2d - The Curve2d value of the property parameter.

Curve2d getValueCurve2d() const#

Returns the current Curve2d value of the property parameter.

Return value

Current Curve2d value of the property parameter.

int isCurve2d() const#

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

Return value

Current the property parameter is a 2d curve

int isStruct() const#

Returns the current value indicating if the property parameter is a structure.

Return value

Current the property parameter is a structure

int isArray() const#

Returns the current value indicating if the property parameter is an array.

Return value

Current the property parameter is an array

int isNode() const#

Returns the current value indicating if the property parameter is a node.

Return value

Current the property parameter is a node

int isMaterial() const#

Returns the current value indicating if the property parameter is a material.

Return value

Current the property parameter is a material

int isProperty() const#

Returns the current value indicating if the property parameter is a property.

Return value

Current the property parameter is a property

int isFile() const#

Returns the current value indicating if the property parameter is a file.

Return value

Current the property parameter is a file

int isMask() const#

Returns the current value indicating if the property parameter is a mask.

Return value

Current the property parameter is a mask

int isIVec4() const#

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

Return value

Current the property parameter is a vector of 4 integer components

int isIVec3() const#

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

Return value

Current the property parameter is a vector of 3 integer components

int isIVec2() const#

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

Return value

Current the property parameter is a vector of 2 integer components

int isDVec4() const#

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

Return value

Current the property parameter is a vector of 4 double components

int isDVec3() const#

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

Return value

Current the property parameter is a vector of 3 double components

int isDVec2() const#

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

Return value

Current the property parameter is a vector of 2 double components

int isVec4() const#

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

Return value

Current the property parameter is a vector of 4 float components

int isVec3() const#

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

Return value

Current the property parameter is a vector of 3 float components

int isVec2() const#

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

Return value

Current the property parameter is a vector of 2 float components

int isColor() const#

Returns the current value indicating if the property parameter is a color.

Return value

Current the property parameter is a color

int isString() const#

Returns the current value indicating if the property parameter is a string.

Return value

Current the property parameter is a string

int isSwitch() const#

Returns the current value indicating if the property parameter is a switch.

Return value

Current the property parameter is a switch

int isToggle() const#

Returns the current value indicating if the property parameter is a toggle.

Return value

Current the property parameter is a toggle

int isDouble() const#

Returns the current value indicating if the property parameter is a double.

Return value

Current the property parameter is a double

int isFloat() const#

Returns the current value indicating if the property parameter is a float.

Return value

Current the property parameter is a float

int isInt() const#

Returns the current value indicating if the property parameter is an integer.

Return value

Current the property parameter is an integer

string getFilter() const#

Returns the current 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.

Return value

Current string specifying a filter for file, material or property parameter values.

string getGroup() const#

Returns the current name of the group to which the property parameter belongs.

Return value

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

string getTooltip() const#

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

Return value

Current tooltip for the property parameter.

string getTitle() const#

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

Return value

Current title of the property parameter.

string getName() const#

Returns the current name of the property parameter.

Return value

Current name of the property parameter.

int getType() const#

Returns the current type identifier of the property parameter.

Return value

Current One of the PROPERTY_PARAMETER_* pre-defined variables; if an error occurs, -1 will be returned.

int isOverridden() const#

Returns the current value indicating if the property parameter is overridden.

Return value

Current the property parameter is overridden

int isInherited() const#

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

Return value

Current the property parameter is inherited from a parent

int isHidden() const#

Returns the current value indicating if the property parameter is hidden.

Return value

Current the property parameter is hidden

int isExist() const#

Returns the current value indicating if the property parameter is an existing one.

Return value

Current the property parameter is an existing one

int getNumChildren() const#

Returns the current total number of children of the property parameter.

Return value

Current total number of children of the property parameter.

PropertyParameter getParent() const#

Returns the current parent property parameter, if it exists.

Return value

Current Parent property parameter, if it exists; otherwise, NULL.

UGUID getPropertyGUID() const#

Returns the current GUID of the property that owns the parameter.

Return value

Current GUID of the property that owns the parameter.

Property getProperty() const#

Returns the current property that owns the parameter.

Return value

Current property that owns the parameter.

int getID() const#

Returns the current ID of the property parameter.

Return value

Current ID of the property parameter.

void setSwitchItem ( int item ) #

Sets a new 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 (UnigineScript)

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 - The number of the item of the switch parameter.

int getSwitchItem() const#

Returns the current 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 (UnigineScript)

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

Current number of the item of the switch parameter.

void setValueIVec4 ( ivec4 ivec4 ) #

Sets a new value of the four-component ivec4 vector property parameter.

Arguments

ivec4 ivec4 - The value of the property parameter.

ivec4 getValueIVec4() const#

Returns the current value of the four-component ivec4 vector property parameter.

Return value

Current value of the property parameter.

void setValueIVec3 ( ivec3 ivec3 ) #

Sets a new value of the three-component ivec3 vector property parameter.

Arguments

ivec3 ivec3 - The value of the property parameter.

ivec3 getValueIVec3() const#

Returns the current value of the three-component ivec3 vector property parameter.

Return value

Current value of the property parameter.

void setValueIVec2 ( ivec2 ivec2 ) #

Sets a new value of the two-component ivec2 vector property parameter.

Arguments

ivec2 ivec2 - The value of the property parameter.

ivec2 getValueIVec2() const#

Returns the current value of the two-component ivec2 vector property parameter.

Return value

Current value of the property parameter.

void setValueDVec4 ( dvec4 dvec4 ) #

Sets a new value of the four-component dvec4 vector property parameter.

Arguments

dvec4 dvec4 - The value of the property parameter.

dvec4 getValueDVec4() const#

Returns the current value of the four-component dvec4 vector property parameter.

Return value

Current value of the property parameter.

void setValueDVec3 ( dvec3 dvec3 ) #

Sets a new value of the three-component dvec3 vector property parameter.

Arguments

dvec3 dvec3 - The value of the property parameter.

dvec3 getValueDVec3() const#

Returns the current value of the three-component dvec3 vector property parameter.

Return value

Current value of the property parameter.

void setValueDVec2 ( dvec2 dvec2 ) #

Sets a new value of the two-component dvec2 vector property parameter.

Arguments

dvec2 dvec2 - The value of the property parameter.

dvec2 getValueDVec2() const#

Returns the current value of the two-component dvec2 vector property parameter.

Return value

Current value of the property parameter.

void setValueVec2 ( vec2 vec2 ) #

Sets a new value of the two-component vec2 vector property parameter.

Arguments

vec2 vec2 - The value of the property parameter.

vec2 getValueVec2() const#

Returns the current value of the two-component vec2 vector property parameter.

Return value

Current value of the property parameter.

int 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

1 if the specified property parameter is a child of this property parameter; otherwise, 0.

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.

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, NULL.

getChild ( ) #

Returns a child property parameter by its name.

Arguments

Return value

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

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.

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 resetValue ( ) #

Resets an overridden value of the property parameter.

Notice

Resetting a value of the property parameter affects all its children.

Variable getValue ( ) #

Returns the current value of the property parameter as a Variable.

Return value

Value of the property parameter.

int hasSliderMinValue ( ) #

Returns a value indicating if the slider parameter has the minimum value specified. The slider parameter is a parameter of one of the following types: PROPERTY_PARAMETER_INT, PROPERTY_PARAMETER_FLOAT, PROPERTY_PARAMETER_DOUBLE.

Return value

1 if the slider parameter has the minimum value specified; otherwise, 0.

int hasSliderMaxValue ( ) #

Returns a value indicating if the slider parameter has the maximum value specified. The slider parameter is a parameter of one of the following types: PROPERTY_PARAMETER_INT, PROPERTY_PARAMETER_FLOAT, PROPERTY_PARAMETER_DOUBLE.

Return value

1 if the slider parameter has the maximum value specified; otherwise, 0.

string getSwitchItemName ( int item ) #

Returns the name of the item of the switch 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 ( ) #

Returns the current value of the file parameter.

Return value

Current file parameter value

int getFileIsAsset ( ) #

Returns a value indicating if the file parameter stores a reference to an asset file.

Return value

1 if the file parameter stores a reference to an asset file; otherwise, 0.

int getFileIsRuntime ( ) #

Returns a value indicating if the file parameter stores a reference to a runtime file.

Return value

1 if the file parameter stores a reference to a runtime file; otherwise, 0.

int getFileIsAbsPath ( ) #

Returns a value indicating if the file parameter stores an absolute file path.

Return value

1 if the file parameter stores an absolute file path; otherwise, 0.

int isFileExist ( ) #

Returns a value indicating if a file corresponding to the property parameter exists.

Return value

1 if a file corresponding to the property parameter exists; otherwise, 0.

int saveState ( Stream stream ) #

Saves data of the property parameter into a binary stream.

Example using saveState() and restoreState() methods:

Source code (UnigineScript)

// create a property parameter and set its state
propertyparam1.setValueInt(7);

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

// change state
propertyparam1.setValueInt(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

1 if the property parameter data is saved successfully; otherwise, 0.

int 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 (UnigineScript)

// create a property parameter and set its state
propertyparam1.setValueInt(7);

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

// change state
propertyparam1.setValueInt(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.

Return value

1 if the property parameter data is restored successfully; otherwise, 0.

int isValuePropertyInternal ( ) #

Checks if the property parameter flag is set to internal (flags="internal"). If it is internal, only a property assigned to some node can be assigned to it. If the property parameter is not internal, a property from the Asset Browser can be assigned to it.

Return value

true if a property parameter's flag is set to "Internal"; otherwise, false.

Last update: 2024-03-27

Help improve this article

Was this article helpful?

Report a problem related to this article

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

PropertyParameter Class

In This Article:

Methods:

PropertyParameter Class

Members

string getStructName() const#

Return value

int getArrayDim() const#

Return value

string getArrayTypeName() const#

Return value

int getArrayType() const#

Return value

void setArraySize ( int size ) #

Arguments

int getArraySize() const#

Return value

void setValueFile ( string file ) #

Arguments

string getValueFile() const#

Return value

int getMaskType() const#

Return value

int getSwitchNumItems() const#

Return value

int getSliderMaxExpand() const#

Return value

int getSliderMinExpand() const#

Return value

int getSliderLog10() const#

Return value

double getDoubleMaxValue() const#

Return value

double getDoubleMinValue() const#

Return value

float getFloatMaxValue() const#

Return value

float getFloatMinValue() const#

Return value

int getIntMaxValue() const#

Return value

int getIntMinValue() const#

Return value

void setValueGUID ( UGUID guid ) #

Arguments

UGUID getValueGUID() const#

Return value

void setValueMask ( int mask ) #

Arguments

int getValueMask() const#

Return value

void setValueSwitch ( int switch ) #

Arguments

int getValueSwitch() const#

Return value

void setValueToggle ( bool toggle ) #

Arguments

bool getValueToggle() const#

Return value

void setValueNodeID ( int id ) #

Arguments

int getValueNodeID() const#

Return value

void setValueNode ( Node node ) #

Arguments

Node getValueNode() const#

Return value

void setValueMaterial ( Material material ) #

Arguments

Material getValueMaterial() const#

Return value

void setValueProperty ( Property property ) #

Arguments

Property getValueProperty() const#

Return value

void setValueVec4 ( vec4 vec4 ) #

Arguments

vec4 getValueVec4() const#

Return value

void setValueVec3 ( vec3 vec3 ) #