This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
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
Content Creation
Content Optimization
Materials
Art Samples
Tutorials

Unigine::Plugins::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 <plugins/UnigineIG.h>

This class represents the IG Component interface.

Notice
IG plugin must be loaded.

Component Class

Enums

TYPE#

NameDescription
COMPONENT_ENTITY = 0Entity component class.
COMPONENT_VIEW = 1View component class.
COMPONENT_GROUP = 2View Group component class.
COMPONENT_SENSOR = 3Sensor component class.
COMPONENT_REG_WATER = 4Regional Water component class.
COMPONENT_REG_TERRAIN = 5Regional Terrain component class.
COMPONENT_REG_WEATHER = 6Regional Weather component class.
COMPONENT_GLOBAL_WATER = 7Global Water component class.
COMPONENT_GLOBAL_TERRAIN = 8Global Terrain component class.
COMPONENT_GLOBAL_WEATHER = 9Global Weather component class.
COMPONENT_ATMOSPHERE = 10Atmosphere component class.
COMPONENT_CELESTIAL = 11Celestial component class.
COMPONENT_EVENT = 12Event component class.
COMPONENT_SYSTEM = 13System component class.
COMPONENT_SYMBOL_SURFACE = 14Symbol Surface component class.
COMPONENT_SYMBOL = 15Symbol component class.

Members


int getID ( ) #

Returns the component ID.

Return value

Component ID.

int getClass ( ) #

Returns the component class.

Return value

CIGI component class.

int64_t getInstanceID ( ) #

Returns the instance ID.

Return value

Instance ID.

Ptr<Node> getNode ( ) #

Returns the node assigned to the component.

Return value

Node assigned to the component.

Ptr<Property> getProperty ( ) #

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: 2021-02-17
Build: ()