Unigine::PropertyParameter Class

Methods:

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

PropertyParameter Class

Members

int getID ( ) const#

Returns the ID of the property parameter.

Return value

ID of the property parameter.

Ptr<Property> getProperty ( ) const#

Returns the property, that owns the parameter.

Return value

Smart pointer to a property owning the parameter.

UGUID getPropertyGUID ( ) const#

Returns the GUID of the property that owns the parameter.

Return value

GUID of the property that owns the parameter.

Ptr<PropertyParameter> getParent ( ) const#

Returns the parent property parameter, if it exists.

Return value

Parent property parameter, if it exists,; otherwise, nullptr.

int getNumChildren ( ) const#

Returns the total number of children of the property parameter.

Return value

Total number of children of the property parameter.

bool isChild ( const Ptr<PropertyParameter> & parameter ) const#

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

Arguments

const Ptr<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 ( const char * name ) const#

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

Arguments

const char * 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.

Ptr<PropertyParameter> getChild ( int num ) const#

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 smart pointer, if it exists; otherwise, nullptr.

Ptr<PropertyParameter> getChild ( const char * name ) const#

Returns a child property parameter by its name.

Arguments

const char * name - Child property parameter name.

Return value

Child property parameter smart pointer, if it exists; otherwise, nullptr.

int getChildIndex ( const Ptr<PropertyParameter> & parameter ) const#

Returns the index of the specified child property parameter.

Arguments

const Ptr<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 isExist ( ) const#

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

Return value

true if the property parameter is an existing one; otherwise, false.

bool isHidden ( ) const#

Returns a value indicating if the property parameter is hidden.

Return value

true if the property parameter is hidden; otherwise, false.

bool isInherited ( ) const#

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

Return value

true if the property parameter is inherited from a parent; otherwise, false.

bool isOverridden ( ) const#

Returns a value indicating if the property parameter is overridden.

Return value

true if the property parameter is overridden; otherwise, false.

int getType ( ) const#

Returns 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: %s\n", prop_param->parameterNameByType(prop_param->getType()));

Return value

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

const char * getName ( ) const#

Returns the name of the property parameter.

Return value

Property parameter name.

const char * getTitle ( ) const#

Returns the title of the property parameter. This title is displayed in the UnigineEditor's UI.

Return value

Property parameter title.

const char * getTooltip ( ) const#

Returns the tooltip for the property parameter. This title is displayed in the UnigineEditor's UI.

Return value

Property parameter tooltip.

const char * getGroup ( ) const#

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

Return value

name of the group to which the property parameter belongs.

const char * getFilter ( ) const#

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

Return value

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

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 ( const char * value ) #

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

Arguments

const char * value - String to be set as the value of the property parameter.

void setValue ( const Math::vec2 & value ) #

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

Arguments

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

void setValue ( const Math::vec3 & value ) #

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

Arguments

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

void setValue ( const Math::vec4 & value ) #

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

Arguments

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

void setValue ( const Math::dvec2 & value ) #

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

Arguments

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

void setValue ( const Math::dvec3 & value ) #

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

Arguments

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

void setValue ( const Math::dvec4 & value ) #

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

Arguments

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

void setValue ( const Math::ivec2 & value ) #

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

Arguments

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

void setValue ( const Math::ivec3 & value ) #

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

Arguments

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

void setValue ( const Math::ivec4 & value ) #

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

Arguments

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

void setValue ( const UGUID & value ) #

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

Arguments

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

void setValue ( const Ptr<Node> & value ) #

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

Arguments

const Ptr<Node> & value - Node to be set as the value of the property parameter.

void setValue ( const Ptr<Material> & value ) #

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

Arguments

const Ptr<Material> & value - Material to be set as the value of the property parameter.

void setValue ( const Ptr<Property> & value ) #

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

Arguments

const Ptr<Property> & value - Property to be set as the value of the property parameter.

bool setValue ( const Variable & value ) #

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

Arguments

const 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 ( const Ptr<Curve2d> & value ) #

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

Arguments

const Ptr<Curve2d> & value - Curve2d value to be set as the value of the property parameter.

void resetValue ( ) #

Resets an overridden value of the property parameter.

Notice

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

int getValueInt ( ) const#

Returns the current value of the property parameter as an integer.

Return value

Value of the property parameter.

float getValueFloat ( ) const#

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

Return value

Value of the property parameter.

double getValueDouble ( ) const#

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

Return value

Value of the property parameter.

const char * getValueString ( ) const#

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

Return value

Value of the property parameter.

Math::vec2 getValueVec2 ( ) const#

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

Return value

Value of the property parameter.

Math::vec3 getValueVec3 ( ) const#

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

Return value

Value of the property parameter.

Math::vec4 getValueVec4 ( ) const#

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

Return value

Value of the property parameter.

Math::dvec2 getValueDVec2 ( ) const#

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

Return value

Value of the property parameter.

Math::dvec3 getValueDVec3 ( ) const#

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

Return value

Value of the property parameter.

Math::dvec4 getValueDVec4 ( ) const#

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

Return value

Value of the property parameter.

Math::ivec2 getValueIVec2 ( ) const#

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

Return value

Value of the property parameter.

Math::ivec3 getValueIVec3 ( ) const#

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

Return value

Value of the property parameter.

Math::ivec4 getValueIVec4 ( ) const#

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

Return value

Value of the property parameter.

UGUID getValueGUID ( ) const#

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

Return value

Value of the property parameter.

Ptr<Node> getValueNode ( ) const#

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

Return value

Value of the property parameter.

Ptr<Property> getValueProperty ( ) const#

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

Return value

Value of the property parameter.

Ptr<Material> getValueMaterial ( ) const#

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

Return value

Value of the property parameter.

Variable getValue ( ) const#

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

Return value

Value of the property parameter.

void setValueInt ( int val ) #

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

Arguments

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

int getIntMinValue ( ) const#

Returns the minimum integer value of the property parameter.

Return value

Minimum integer value of the property parameter.

int getIntMaxValue ( ) const#

Returns the maximum integer value of the property parameter.

Return value

Maximum integer value of the property parameter.

void setValueFloat ( float val ) #

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

Arguments

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

float getFloatMinValue ( ) const#

Returns the minimum float value of the property parameter.

Return value

Minimum float value of the property parameter.

float getFloatMaxValue ( ) const#

Returns the maximum float value of the property parameter.

Return value

Maximum float value of the property parameter.

void setValueDouble ( double val ) #

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

Arguments

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

double getDoubleMinValue ( ) const#

Returns the minimum double value of the property parameter.

Return value

Minimum double value of the property parameter.

double getDoubleMaxValue ( ) const#

Returns the maximum double value of the property parameter.

Return value

Maximum double value of the property parameter.

bool hasSliderMinValue ( ) const#

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: PARAMETER_INT, PARAMETER_FLOAT, PARAMETER_DOUBLE.

Return value

true if the slider parameter has the minimum value specified; otherwise, false.

bool hasSliderMaxValue ( ) const#

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: PARAMETER_INT, PARAMETER_FLOAT, PARAMETER_DOUBLE.

Return value

true if the slider parameter has the maximum value specified; otherwise, false.

int getSliderLog10 ( ) const#

Returns a 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.

Return value

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

int getSliderMinExpand ( ) const#

Returns a 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.

Return value

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

int getSliderMaxExpand ( ) const#

Returns a 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.

Return value

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

void setValueToggle ( bool toggle ) #

Sets the value of the toggle parameter. If the PARAMETER_TOGGLE variable isn't set for the parameter, or the property is not editable, the value won't be updated.

Arguments

bool toggle - New value of the toggle parameter.

bool getValueToggle ( ) const#

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

Return value

Value of the toggle parameter.

void setValueSwitch ( int val ) #

Sets the value of the switch parameter. If the PARAMETER_SWITCH variable isn't set for the parameter, or the property is not editable, the value won't be updated.

Arguments

int val - New value of the switch parameter.

int getValueSwitch ( ) const#

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

Return value

Value of the switch parameter.

int getSwitchNumItems ( ) const#

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

Return value

Number of items of the switch parameter.

void setSwitchItem ( int item ) #

Sets the item with the specified number as a value 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).

Arguments

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

int getSwitchItem ( ) const#

Returns the number of the currently selected 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).

Return value

Number of the currently selected item of the switch parameter.

const char * getSwitchItemName ( int item ) const#

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 ) const#

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.

void setValueString ( const char * value ) #

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

Arguments

const char * value - String to be set as the value of the property parameter.

void setValueColor ( const Math::vec4 & color ) #

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

Arguments

const Math::vec4 & color - Four-component color vector (R, G, B, A) to be set as the value of the property parameter.

Math::vec4 getValueColor ( ) const#

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

Return value

Value of the property parameter.

void setValueVec2 ( const Math::vec2 & vec2 ) #

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

Arguments

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

void setValueVec3 ( const Math::vec3 & vec3 ) #

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

Arguments

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

void setValueVec4 ( const Math::vec4 & vec4 ) #

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

Arguments

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

void setValueDVec2 ( const Math::dvec2 & dvec2 ) #

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

Arguments

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

void setValueDVec3 ( const Math::dvec3 & dvec3 ) #

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

Arguments

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

void setValueDVec4 ( const Math::dvec4 & dvec4 ) #

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

Arguments

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

void setValueIVec2 ( const Math::ivec2 & ivec2 ) #

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

Arguments

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

void setValueIVec3 ( const Math::ivec3 & ivec3 ) #

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

Arguments

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

void setValueIVec4 ( const Math::ivec4 & ivec4 ) #

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

Arguments

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

void setValueMask ( int mask ) #

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

Arguments

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

int getValueMask ( ) const#

Returns the current value of the property parameter as an integer mask.

Return value

Value of the property parameter.

void setValueFile ( const char * file ) #

Sets 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 (this value will be returned by the getValueFile() method) depends 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

Arguments

const char * file - Value for the file parameter to be set.

const char * getValueFile ( bool fast = 0 ) const#

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

Notice

To get a GUID of the file, use the getValueGUID() method.

const char * getValueFile ( ) const#

Returns the current value of the file parameter.

Return value

Current file parameter value

bool getFileIsAsset ( ) const#

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

Return value

true if the file parameter stores a reference to an asset file; otherwise, false.

bool getFileIsRuntime ( ) const#

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

Return value

true if the file parameter stores a reference to a runtime file; otherwise, false.

bool getFileIsAbsPath ( ) const#

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

Return value

true if the file parameter stores an absolute file path; otherwise, false.

bool isFileExist ( ) const#

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

Return value

true if a file corresponding to the property parameter exists; otherwise, false.

void setValueProperty ( const Ptr<Property> & property ) #

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

Arguments

const Ptr<Property> & property - Value of the property parameter.

void setValueMaterial ( const Ptr<Material> & material ) #

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

Arguments

const Ptr<Material> & material - Value of the property parameter.

void setValueNode ( const Ptr<Node> & node ) #

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

Arguments

const Ptr<Node> & node - Value of the property parameter.

void setValueNodeID ( int valuenodeid ) #

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

Arguments

int valuenodeid - Value of the property parameter.

int getValueNodeID ( ) const#

Returns the current value of the property parameter as a Node ID.

Return value

Value of the property parameter.

void setArraySize ( int size ) #

Sets a new size of the array parameter.

Arguments

int size - New array size to be set (number of elements).

int getArraySize ( ) const#

Returns the current size of the array parameter.

Return value

Current array size (number of elements).

int getArrayType ( ) const#

Returns the type of elements of the array parameter.

Return value

Type of array elements, one of the PARAMETER_* variables.

Notice

This method does not return PARAMETER_ARRAY for an array parameter, it returns the type of array elements instead (e.g. PARAMETER_FLOAT, PARAMETER_STRUCT, etc.)

const char * getArrayTypeName ( ) const#

Returns the type name of elements of the array parameter.

Return value

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

int getArrayDim ( ) const#

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

Return value

Dimension of the array parameter.

int getMaskType ( ) const#

Returns the type of elements of the mask parameter.

Return value

Type of the mask parameter, one of the PARAMETER_MASK_* variables.

const char * getStructName ( ) const#

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

Return value

Name of the structure, that defines the type of the struct parameter.

bool saveState ( const Ptr<Stream> & stream ) const#

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->setValueInt(7);

// save state
BlobPtr blob_state = Blob::create();
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

const Ptr<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 ( const Ptr<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->setValueInt(7);

// save state
BlobPtr blob_state = Blob::create();
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

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

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

bool isInt ( ) const#

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

Return value

true if the property parameter is an integer; otherwise, false.

bool isFloat ( ) const#

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

Return value

true if the property parameter is a float; otherwise, false.

bool isDouble ( ) const#

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

Return value

true if the property parameter is a double; otherwise, false.

bool isToggle ( ) const#

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

Return value

true if the property parameter is a toggle; otherwise, false.

bool isSwitch ( ) const#

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

Return value

true if the property parameter is a switch; otherwise, false.

bool isString ( ) const#

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

Return value

true if the property parameter is a string; otherwise, false.

bool isColor ( ) const#

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

Return value

true if the property parameter is a color; otherwise, false.

bool isVec2 ( ) const#

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

Return value

true if the property parameter is a vector of 2 float components; otherwise, false.

bool isVec3 ( ) const#

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

Return value

true if the property parameter is a vector of 3 float components; otherwise, false.

bool isVec4 ( ) const#

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

Return value

true if the property parameter is a vector of 4 float components; otherwise, false.

bool isDVec2 ( ) const#

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

Return value

true if the property parameter is a vector of 2 double components; otherwise, false.

bool isDVec3 ( ) const#

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

Return value

true if the property parameter is a vector of 3 double components; otherwise, false.

bool isDVec4 ( ) const#

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

Return value

true if the property parameter is a vector of 4 double components; otherwise, false.

bool isIVec2 ( ) const#

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

Return value

true if the property parameter is a vector of 2 integer components; otherwise, false.

bool isIVec3 ( ) const#

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

Return value

true if the property parameter is a vector of 3 integer components; otherwise, false.

bool isIVec4 ( ) const#

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

Return value

true if the property parameter is a vector of 4 integer components; otherwise, false.

bool isMask ( ) const#

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

Return value

true if the property parameter is a mask; otherwise, false.

bool isFile ( ) const#

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

Return value

true if the property parameter is a file; otherwise, false.

bool isProperty ( ) const#

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

Return value

true if the property parameter is a property; otherwise, false.

bool isMaterial ( ) const#

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

Return value

true if the property parameter is a material; otherwise, false.

bool isNode ( ) const#

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

Return value

true if the property parameter is a node; otherwise, false.

bool isArray ( ) const#

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

Return value

true if the property parameter is an array; otherwise, false.

bool isStruct ( ) const#

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

Return value

true if the property parameter is a structure; otherwise, false.

void setValueGUID ( const UGUID & valueguid ) #

Sets the UGUID variable as a property parameter value.

Arguments

const UGUID & valueguid - UGUID type value

bool isValuePropertyInternal ( ) const#

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.

bool isValueFitFilter ( const Ptr<Node> & value ) const#

Checks if the type of the indicated node fits the current property parameter filter.

Arguments

const Ptr<Node> & value

Return value

true, if the node fits the filter; otherwise, false.

bool isValueFitFilter ( const Ptr<Property> & value ) const#

Checks if the indicated property fits the current property parameter filter.

Arguments

const Ptr<Property> & value

Return value

true, if the property fits the filter; otherwise, false.

bool isValueFitFilter ( const Ptr<Material> & value ) const#

Checks if the indicated material fits the current property parameter filter.

Arguments

const Ptr<Material> & value

Return value

true, if the material fits the filter; otherwise, false.

bool isValueFitFilter ( const UGUID & value ) const#

Checks if the indicated GUID fits the current property parameter filter.

Arguments

const UGUID & value

Return value

true, if the GUID fits the filter; otherwise, false.

bool isCurve2d ( ) const#

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

Return value

true if the property parameter is a 2D curve; otherwise, false.

void setValueCurve2d ( const Ptr<Curve2d> & curve2d ) #

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

Arguments

const Ptr<Curve2d> & curve2d - Curve2d value to be set as the value of the property parameter.

Ptr<Curve2d> getValueCurve2d ( ) const#

Returns the current Curve2d value of the property parameter.

Return value

Current Curve2d value of the property parameter.

Ptr<Curve2d> getValueCurve2dOverride ( ) const#

Returns a new 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.

Last update: 2022-12-14

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:

Methods:

PropertyParameter Class

Members

int getID ( ) const#

Return value

Ptr<Property> getProperty ( ) const#

Return value

UGUID getPropertyGUID ( ) const#

Return value

Ptr<PropertyParameter> getParent ( ) const#

Return value

int getNumChildren ( ) const#

Return value

bool isChild ( const Ptr<PropertyParameter> & parameter ) const#

Arguments

Return value

int findChild ( const char * name ) const#

Arguments

Return value

Ptr<PropertyParameter> getChild ( int num ) const#

Arguments

Return value

Ptr<PropertyParameter> getChild ( const char * name ) const#

Arguments

Return value

int getChildIndex ( const Ptr<PropertyParameter> & parameter ) const#

Arguments

Return value

bool isExist ( ) const#

Return value

bool isHidden ( ) const#

Return value

bool isInherited ( ) const#

Return value

bool isOverridden ( ) const#

Return value

int getType ( ) const#

Return value

const char * getName ( ) const#

Return value

const char * getTitle ( ) const#

Return value

const char * getTooltip ( ) const#

Return value

const char * getGroup ( ) const#

Return value

const char * getFilter ( ) const#

Return value

void setValue ( int value ) #

Arguments

void setValue ( float value ) #

Arguments

void setValue ( double value ) #

Arguments

void setValue ( const char * value ) #

Arguments

void setValue ( const Math::vec2 & value ) #

Arguments

void setValue ( const Math::vec3 & value ) #

Arguments

void setValue ( const Math::vec4 & value ) #

Arguments

void setValue ( const Math::dvec2 & value ) #

Arguments

void setValue ( const Math::dvec3 & value ) #

Arguments

void setValue ( const Math::dvec4 & value ) #

Arguments

void setValue ( const Math::ivec2 & value ) #

Arguments

void setValue ( const Math::ivec3 & value ) #

Arguments

void setValue ( const Math::ivec4 & value ) #

Arguments

void setValue ( const UGUID & value ) #

Arguments

void setValue ( const Ptr<Node> & value ) #

Arguments