Unigine::PropertyParameter Class

PropertyParameter Class

Members

int getID ( ) #

Return value

Ptr<Property> getProperty ( ) #

Return value

UGUID getPropertyGUID ( ) #

Return value

Ptr<PropertyParameter> getParent ( ) #

Return value

int getNumChildren ( ) #

Return value

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

Arguments

• const Ptr<PropertyParameter> & parameter - Property parameter to be checked.

Return value

int findChild ( const char * name ) #

Arguments

• const char * name - Name of the child property parameter to be found.

Return value

Ptr<PropertyParameter> getChild ( int num ) #

Arguments

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

Return value

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

Arguments

• const char * name - Child property parameter name.

Return value

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

Arguments

• const Ptr<PropertyParameter> & parameter - Child property parameter for which an index is to be found.

Return value

int isExist ( ) #

Return value

int isHidden ( ) #

Return value

int isInherited ( ) #

Return value

int isOverridden ( ) #

Return value

int getType ( ) #

Return value

const char * getName ( ) #

Return value

const char * getTitle ( ) #

Return value

const char * getTooltip ( ) #

Return value

const char * getGroup ( ) #

Return value

const char * getFilter ( ) #

Return value

void setValue ( int value ) #

Arguments

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

void setValue ( float value ) #

Arguments

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

void setValue ( double value ) #

Arguments

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

void setValue ( const char * value ) #

Arguments

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

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

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

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

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

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

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

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

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

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

Arguments

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

void setValue ( const UGUID & value ) #

Arguments

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

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

Arguments

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

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

Arguments

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

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

Arguments

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

void resetValue ( ) #

int getValueInt ( ) #

Return value

float getValueFloat ( ) #

Return value

double getValueDouble ( ) #

Return value

String getValueString ( ) #

Return value

Math::vec2 getValueVec2 ( ) #

Return value

Math::vec3 getValueVec3 ( ) #

Return value

Math::vec4 getValueVec4 ( ) #

Return value

Math::dvec2 getValueDVec2 ( ) #

Return value

Math::dvec3 getValueDVec3 ( ) #

Return value

Math::dvec4 getValueDVec4 ( ) #

Return value

Math::ivec2 getValueIVec2 ( ) #

Return value

Math::ivec3 getValueIVec3 ( ) #

Return value

Math::ivec4 getValueIVec4 ( ) #

Return value

UGUID getValueGUID ( ) #

Return value

Ptr<Node> getValueNode ( ) #

Return value

Ptr<Property> getValueProperty ( ) #

Return value

Ptr<Material> getValueMaterial ( ) #

Return value

bool setValue ( const Variable & value ) #

Arguments

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

Return value

Variable getValue ( ) #

Return value

void setValueInt ( int val ) #

Arguments

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

int getIntMinValue ( ) #

Return value

int getIntMaxValue ( ) #

Return value

void setValueFloat ( float val ) #

Arguments

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

float getFloatMinValue ( ) #

Return value

float getFloatMaxValue ( ) #

Return value

void setValueDouble ( double val ) #

Arguments

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

double getDoubleMinValue ( ) #

Return value

double getDoubleMaxValue ( ) #

Return value

int hasSliderMinValue ( ) #

Return value

int hasSliderMaxValue ( ) #

Return value

int getSliderLog10 ( ) #

Return value

int getSliderMinExpand ( ) #

Return value

int getSliderMaxExpand ( ) #

Return value

void setValueToggle ( int toggle ) #

Arguments

• int toggle - New value of the toggle parameter.

int getValueToggle ( ) #

Return value

void setValueSwitch ( int val ) #

Arguments

• int val - New value of the switch parameter.

int getValueSwitch ( ) #

Return value

int getSwitchNumItems ( ) #

Return value

void setSwitchItem ( int item ) #

Suppose we have a property switch parameter declared as follows:

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

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

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

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

Arguments

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

int getSwitchItem ( ) #

Suppose we have a property switch parameter declared as follows:

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

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

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

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

Return value

const char * getSwitchItemName ( int item ) #

Arguments

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

Return value

int getSwitchItemValue ( int item ) #

Arguments

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

Return value

void setValueString ( const String & value ) #

Arguments

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

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

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

Return value

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

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

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

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

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

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

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

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

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

Arguments

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

void setValueMask ( int mask ) #

Arguments

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

int getValueMask ( ) #

Return value

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:

// 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 ( int fast = 0 ) #

Arguments

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

Return value

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

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

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

const char * getValueFile ( ) #

Return value

int getFileIsAsset ( ) #

Return value

int getFileIsRuntime ( ) #

Return value

int getFileIsAbsPath ( ) #

Return value

int isFileExist ( ) #

Return value

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

Arguments

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

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

Arguments

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

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

Arguments

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

void setValueNodeID ( int valuenodeid ) #

Arguments

• int valuenodeid - Value of the property parameter.

int getValueNodeID ( ) #

Return value

void setArraySize ( int size ) #

Arguments

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

int getArraySize ( ) #

Return value

int getArrayType ( ) #

Return value

const char * getArrayTypeName ( ) #

Return value

int getArrayDim ( ) #

Return value

int getMaskType ( ) #

Return value

const char * getStructName ( ) #

Return value

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

Arguments

• const Ptr<Stream> & stream - Stream into which the property parameter data will be saved.

Return value

int restoreState ( const Ptr<Stream> & stream, int restore_mode = 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

int isInt ( ) #

Return value

int isFloat ( ) #

Return value

int isDouble ( ) #

Return value

int isToggle ( ) #

Return value

int isSwitch ( ) #

Return value

int isString ( ) #

Return value

int isColor ( ) #

Return value

bool isVec2 ( ) #

Return value

int isVec3 ( ) #

Return value

int isVec4 ( ) #

Return value

bool isDVec2 ( ) #

Return value

bool isDVec3 ( ) #

Return value

bool isDVec4 ( ) #

Return value

bool isIVec2 ( ) #

Return value

bool isIVec3 ( ) #

Return value

bool isIVec4 ( ) #

Return value

int isMask ( ) #

Return value

int isFile ( ) #

Return value

int isProperty ( ) #

Return value

int isMaterial ( ) #

Return value

int isNode ( ) #

Return value

int isArray ( ) #

Return value

int isStruct ( ) #

Return value

void setValueGUID ( const UGUID & valueguid ) #

Arguments

• const UGUID & valueguid - UGUID type value

int isValuePropertyInternal ( ) #

Return value

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

Arguments

• const Ptr<Node> & value

Return value

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

Arguments

• const Ptr<Property> & value

Return value

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

Arguments

• const Ptr<Material> & value

Return value

int isValueFitFilter ( const UGUID & value ) #

Arguments

• const UGUID & value

Return value