Unigine::PropertyParameter Class
| Header: | #include <UnigineProperties.h> |
This class is used to represent a property parameter.
PropertyParameter Class
Members
void grab( )
Sets the owner flag to 1 for the PropertyParameter pointer. The PropertyParameter should not be handled by the class after this function is calledint isOwner( )
Returns the owner flag. If the pointer is the owner, on its deletion the PropertyParameter also will be deleted. Use grab() and release() functions to change ownership.Return value
The owner flag.void release( )
Releases the PropertyParameter (sets the owner flag to 0 for the pointer). The PropertyParameter should be handled by the class after this function is called.int getID( )
Returns the ID of the property parameter.Return value
ID of the property parameter.Ptr<Property> getProperty( )
Returns the property, that owns the parameter.Return value
Smart pointer to a property owning the parameter.UGUID getPropertyGUID( )
Returns the GUID of the property that owns the parameter.Return value
GUID of the property that owns the parameter.Ptr<PropertyParameter> getParent( )
Returns the parent property parameter, if it exists.Return value
Parent property parameter, if it exists,; otherwise, nullptr.int getNumChildren( )
Returns the total number of children of the property parameter.Return value
Total number of children of the property parameter.int isChild( const Ptr<PropertyParameter> & parameter )
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
1 if the specified property parameter is a child of this property parameter; otherwise, 0.int findChild( const char * name )
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 )
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 )
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 )
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.int isExist( )
Returns a value indicating if the property parameter is an existing one.Return value
1 if the property parameter is an existing one; otherwise, 0.int isHidden( )
Returns a value indicating if the property parameter is hidden.Return value
1 if the property parameter is hidden; otherwise, 0.int isInherited( )
Returns a value indicating if the property parameter is inherited from a parent.Return value
1 if the property parameter is inherited from a parent; otherwise, 0.int isOverridden( )
Returns a value indicating if the property parameter is overridden.Return value
1 if the property parameter is overridden; otherwise, 0.int getType( )
Returns the type of the property parameter.Return value
One of the PARAMETER_* pre-defined variables; if an error occurs, -1 will be returned.const char * getName( )
Returns the name of the property parameter.Return value
Property parameter name.const char * getTitle( )
Returns the title of the property parameter. This title is displayed in the UnigineEditor's UI.Return value
Property parameter title.const char * getTooltip( )
Returns the tooltip for the property parameter. This title is displayed in the UnigineEditor's UI.Return value
Property parameter tooltip.const char * getGroup( )
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( )
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).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::vec3 & value )
Sets the value of the property parameter using the three-component vec3 vector specified.Arguments
- const Math::vec3 & value - Three-component 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 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.
void resetValue( )
Resets an overridden value of the property parameter.Notice
Resetting a value of the property parameter affects all its children.
int getValueInt( )
Returns the current value of the property parameter as an integer.Return value
Value of the property parameter.float getValueFloat( )
Returns the current value of the property parameter as a float.Return value
Value of the property parameter.double getValueDouble( )
Returns the current value of the property parameter as a double.Return value
Value of the property parameter.String getValueString( )
Returns the current value of the property parameter as a string.Return value
Value of the property parameter.Math::vec3 getValueVec3( )
Returns the current value of the property parameter as a three-component vec3 vector.Return value
Value of the property parameter.Math::vec4 getValueVec4( )
Returns the current value of the property parameter as a four-component vec4 vector.Return value
Value of the property parameter.UGUID getValueGUID( )
Returns the current value of the property parameter as a UGUID.Return value
Value of the property parameter.Ptr<Node> getValueNode( )
Returns the current value of the property parameter as a Node.Return value
Value of the property parameter.Ptr<Property> getValueProperty( )
Returns the current value of the property parameter as a Property.Return value
Value of the property parameter.Ptr<Material> getValueMaterial( )
Returns the current value of the property parameter as a Material.Return value
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.Variable getValue( )
Returns the current value of the property parameter as a Variable.Return value
Value of the property parameter.void setValueInt( 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.
int getIntMinValue( )
Returns the minimum integer value of the property parameter.Return value
Minimum integer value of the property parameter.int getIntMaxValue( )
Returns the maximum integer value of the property parameter.Return value
Maximum integer value of the property parameter.void setValueFloat( 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.
float getFloatMinValue( )
Returns the minimum float value of the property parameter.Return value
Minimum float value of the property parameter.float getFloatMaxValue( )
Returns the maximum float value of the property parameter.Return value
Maximum float value of the property parameter.void setValueDouble( 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.
double getDoubleMinValue( )
Returns the minimum double value of the property parameter.Return value
Minimum double value of the property parameter.double getDoubleMaxValue( )
Returns the maximum double value of the property parameter.Return value
Maximum double 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: PARAMETER_INT, PARAMETER_FLOAT, 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: PARAMETER_INT, PARAMETER_FLOAT, PARAMETER_DOUBLE.Return value
1 if the slider parameter has the maximum value specified; otherwise, 0.int getSliderLog10( )
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( )
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( )
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( int value )
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
- int value - New value of the toggle parameter.
int getValueToggle( )
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 value )
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 value - New value of the switch parameter.
int getValueSwitch( )
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( )
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.const char * getSwitchItem( int item )
Returns the value of the item of the switch parameter. If the PARAMETER_SWITCH variable isn't set for the parameter, the function will return NULL.Arguments
- int item - Number of the item of the switch parameter.
Return value
Value of the item. If an error occurs, NULL will be returned.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 & value )
Sets the value of the property parameter using the four-component vec4 color vector (R, G, B, A) specified.Arguments
- const Math::vec4 & value - Four-component color vector (R, G, B, A) to be set as the value of the property parameter.
Math::vec4 getValueColor( )
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 setValueVec3( 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 vector to be set as the value of the property parameter.
void setValueVec4( const Math::vec4 & value )
Sets the value of the property parameter using the three-component vec4 vector specified.Arguments
- const Math::vec4 & value - Four-component vector to be set as the value of the property parameter.
void setValueMask( int value )
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 value - Mask to be set as the value of the property parameter.
int getValueMask( )
Returns the current value of the property parameter as an integer mask.Return value
Value of the property parameter.void setValueFile( const char * value )
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_pathArguments
- const char * value - Value for the file parameter to be set.
const char * getValueFile( int fast = 0 )
Returns the current value of the file parameter.Arguments
- int fast - 1 to use the specified number as an index in users auxiliary parameters cache; otherwise, 0.
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_pathNotice
To get a GUID of the file, use the getValueGUID() method.
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.void setValueProperty( const Ptr<Property> & value )
Sets the value of the property parameter using the Property specified.Arguments
- const Ptr<Property> & value - Value of the property parameter.
void setValueMaterial( const Ptr<Material> & value )
Sets the value of the property parameter using the Material specified.Arguments
- const Ptr<Material> & value - Value of the property parameter.
void setValueNode( const Ptr<Node> & value )
Sets the value of the property parameter using the Node specified.Arguments
- const Ptr<Node> & value - Value of the property parameter.
void setValueNodeID( int value )
Sets the value of the property parameter using the Node ID specified.Arguments
- int value - Value of the property parameter.
int getValueNodeID( )
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( )
Returns the current size of the array parameter.Return value
Current array size (number of elements).int getArrayType( )
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( )
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( )
Returns the dimension of the array parameter.Notice
Multi-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( )
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( )
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.int saveState( const Ptr<Stream> & stream )
Saves data of the property parameter into a binary stream.Arguments
- const Ptr<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( const Ptr<Stream> & stream, int restore_mode = 0 )
Restores the data of the property parameter from a binary stream in the specified mode.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
1 if the property parameter data is restored successfully; otherwise, 0.Last update:
2020-01-14
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)