Unigine::Plugins::IG::Component Class
The functionality described in this article is not available in the Community SDK edition.
You should upgrade to- Sim
SDK edition to use it.
You should upgrade to
Header: | #include <plugins/Unigine/IG/UnigineIG.h> |
Component Class
Enums
COMPONENT_TYPE#
Members
int getID ( ) const#
Returns the component ID.Return value
Component ID.Component::COMPONENT_TYPE getComponentType ( ) #
Returns the component class.Return value
CIGI component class.int64_t getInstanceID ( ) #
Returns the instance ID.Return value
Instance ID.Ptr<Node> getNode ( ) const#
Returns the node assigned to the component.Return value
Node assigned to the component.Ptr<Property> getProperty ( ) const#
Returns the node assigned to the component.Return value
Property assigned to the component.void setParameterData ( const char * name, const void * value ) #
Sets the data for the component parameter with the specified name.Arguments
- const char * name - Parameter name.
- const void * value - Pointer to a buffer with parameter data to be set.
void setParameterInt ( const char * name, int value ) #
Sets the value of the component parameter with the specified name using the specified integer value.Arguments
- const char * name - Parameter name.
- int value - Value to be set.
int getParameterInt ( const char * name ) #
Returns the current value of the parameter with the specified name.Arguments
- const char * name - Parameter name.
Return value
Current value of the parameter with the specified name.void setParameterFloat ( const char * name, float value ) #
Sets the value of the float component parameter with the specified name using the specified float value.Arguments
- const char * name - Parameter name.
- float value - Value to be set.
float getParameterFloat ( const char * name ) #
Returns the current value of the float parameter with the specified name.Arguments
- const char * name - Parameter name.
Return value
Current value of the float parameter with the specified name.void setParameterDouble ( const char * name, double value ) #
Sets the value of the component parameter with the specified name using the specified double value.Arguments
- const char * name - Parameter name.
- double value - Value to be set.
double getParameterDouble ( const char * name ) #
Returns the current value of the double parameter with the specified name.Arguments
- const char * name - Parameter name.
Return value
Current value of the double parameter with the specified name.Last update:
2024-08-16
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)