ComponentVariable Class
| Header: | #include <UnigineComponentSystem.h> |
A component parameter is created using any of the following macros. Each macro has the format as indicated in the brackets with the mandatory arguments in bold:
- PROP_PARAM(type, name, default_value (for all parameters except curves and properties), items (for switch parameters only), title, tooltip, group)
- PROP_STRUCT(type, name, title, tooltip, group)
- PROP_ARRAY(type, name, title, tooltip, group)
- PROP_ARRAY_STRUCT(struct_type, name, title, tooltip, group)
Using the methods of this class, you can address each parameter.
ComponentVariable Class
Members
const PropertyParameterPtr & getParameter ( ) const#
Returns the pointer to the corresponding property parameter.Return value
Pointer to the property parameter.int size ( ) #
Returns the number of elements in the array.Notice
This method is for the array and array structure component parameters.
Return value
Number of elements in the array.C & operator[] ( int index ) #
Returns the reference to the requested element.Notice
This method is for the array and array structure component parameters.
Arguments
- int index - Position of the element to return.
Return value
Reference to the requested element.Last update:
2023-12-19
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)