This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

IG::Component Class

Warning
The functionality described in this article is not available in the Community SDK edition.
You should upgrade to Sim SDK edition to use it.
Header: #include <UnigineIG.h>

This class represents the IG Component interface.

Notice
IG plugin must be loaded.

Component Class

Members


int getID ( ) #

Returns the component ID.

Return value

Component ID.

int getClass ( ) #

Returns the component class.

Return value

CIGI component class.

int getInstanceID ( ) #

Returns the instance ID.

Return value

Instance ID.

const Ptr<Node> & getNode ( ) #

Returns the node assigned to the component.

Return value

Node assigned to the component.

const Ptr<Property> & getProperty ( ) #

Returns the node assigned to the component.

Return value

Property assigned to the component.

void setParameterData ( char * name, const void * value ) #

Sets the data for the component parameter with the specified name.

Arguments

  • char * name - Parameter name.
  • const void * value - Pointer to a buffer with parameter data to be set.

void setParameterInt ( char * name, int value ) #

Sets the value of the component parameter with the specified name using the specified integer value.

Arguments

  • char * name - Parameter name.
  • int value - Value to be set.

int getParameterInt ( char * name ) #

Returns the current value of the parameter with the specified name.

Arguments

  • char * name - Parameter name.

Return value

Current value of the parameter with the specified name.

void setParameterFloat ( char * name, float value ) #

Sets the value of the component parameter with the specified name using the specified float value.

Arguments

  • char * name - Parameter name.
  • float value - Value to be set.

float getParameterFloat ( char * name ) #

Returns the current value of the parameter with the specified name.

Arguments

  • char * name - Parameter name.

Return value

Current value of the parameter with the specified name.
Last update: 2020-07-31
Build: ()