Unigine::Cigi::IComponent Class

This class represents the CIGI Component interface.

IComponent Class

Members

---

int getID()

Returns the component ID.

Return value

Component ID.

int getClass()

Returns the component class.

Return value

CIGI component class. One of the CIGI_COMPONENT_* values.

int getInstanceID()

Returns the instance ID.

Return value

Instance ID.

void setState(int state)

Sets the state of the CIGI component.

Arguments

• int state - Component state. One of the CIGI_STATE_* values.

int getState()

Returns the state of the CIGI component.

Return value

Component state. One of the CIGI_STATE_* values.

void setData(unsigned int value1, unsigned int value2)

Sets the component data fields using the specified values.

Arguments

• unsigned int value1 - Data1 value to be set.
• unsigned int value2 - Data2 value to be set.

void setData(unsigned int value1, unsigned int value2, unsigned int value3, unsigned int value4, unsigned int value5, unsigned int value6)

Sets the component data fields using the specified values.

Arguments

• unsigned int value1 - Data1 value to be set.
• unsigned int value2 - Data2 value to be set.
• unsigned int value3 - Data3 value to be set.
• unsigned int value4 - Data4 value to be set.
• unsigned int value5 - Data5 value to be set.
• unsigned int value6 - Data6 value to be set.

void setData1(unsigned int value)

Sets the specified value for the component data1 field.

Arguments

• unsigned int value - Data1 value to be set.

unsigned int getData1()

Returns the value of the component data1 field.

Return value

Component data1 field value.

void setData2(unsigned int value)

Sets the specified value for the component data2 field.

Arguments

• unsigned int value - Data2 value to be set.

unsigned int getData2()

Returns the value of the component data2 field.

Return value

Component data2 field value.

void setData3(unsigned int value)

Sets the specified value for the component data3 field.

Arguments

• unsigned int value - Data3 value to be set.

unsigned int getData3()

Returns the value of the component data3 field.

Return value

Component data3 field value.

void setData4(unsigned int value)

Sets the specified value for the component data4 field.

Arguments

• unsigned int value - Data4 value to be set.

unsigned int getData4()

Returns the value of the component data4 field.

Return value

Component data4 field value.

void setData5(unsigned int value)

Sets the specified value for the component data5 field.

Arguments

• unsigned int value - Data5 value to be set.

unsigned int getData5()

Returns the value of the component data5 field.

Return value

Component data5 field value.

void setData6(unsigned int value)

Sets the specified value for the component data6 field.

Arguments

• unsigned int value - Data6 value to be set.

unsigned int getData6()

Returns the value of the component data6 field.

Return value

Component data6 field value.

void setData1(float value)

Sets the specified float value for the component data1 field.

Arguments

• float value - Data1 value to be set.

float getData1()

Returns the float value of the component data1 field.

Return value

Component data1 field value.

void setData2(float value)

Sets the specified float value for the component data2 field.

Arguments

• float value - Data2 value to be set.

float getData2()

Returns the float value of the component data2 field.

Return value

Component data2 field value.

void setData3(float value)

Sets the specified float value for the component data3 field.

Arguments

• float value - Data3 value to be set.

float getData3()

Returns the float value of the component data3 field.

Return value

Component data3 field value.

void setData4(float value)

Sets the specified float value for the component data4 field.

Arguments

• float value - Data4 value to be set.

float getData4()

Returns the float value of the component data4 field.

Return value

Component data4 field value.

void setData5(float value)

Sets the specified float value for the component data5 field.

Arguments

• float value - Data5 value to be set.

float getData5()

Returns the float value of the component data5 field.

Return value

Component data5 field value.

void setData6(float value)

Sets the specified float value for the component data6 field.

Arguments

• float value - Data6 value to be set.

float getData6()

Returns the float value of the component data6 field.

Return value

Component data6 field value.

void setData1(int value)

Sets the specified integer value for the component data1 field.

Arguments

• int value - Data1 value to be set.

int getData1()

Returns the integer value of the component data1 field.

Return value

Component data1 field value.

void setData2(int value)

Sets the specified integer value for the component data2 field.

Arguments

• int value - Data2 value to be set.

int getData2()

Returns the integer value of the component data2 field.

Return value

Component data2 field value.

void setData3(int value)

Sets the specified integer value for the component data3 field.

Arguments

• int value - Data3 value to be set.

int getData3()

Returns the integer value of the component data3 field.

Return value

Component data3 field value.

void setData4(int value)

Sets the specified integer value for the component data4 field.

Arguments

• int value - Data4 value to be set.

int getData4()

Returns the integer value of the component data4 field.

Return value

Component data4 field value.

void setData5(int value)

Sets the specified integer value for the component data5 field.

Arguments

• int value - Data5 value to be set.

int getData5()

Returns the integer value of the component data5 field.

Return value

Component data5 field value.

void setData6(int value)

Sets the specified integer value for the component data6 field.

Arguments

• int value - Data6 value to be set.

int getData6()

Returns the integer value of the component data6 field.

Return value

Component data6 field value.

void setChangeCallback(Unigine::CallbackBase * func)

Sets a callback function to be fired when the component data has changed.

Arguments

• Unigine::CallbackBase * func - Callback pointer.

Unigine::CallbackBase * getChangeCallback()

Returns a callback to be fired when the component data has changed.

Return value

Callback pointer.

virtual ~IComponent()

Virtual destructor.

---

int CIGI_COMPONENT_ENTITY

Description

Entity component class.

int CIGI_COMPONENT_VIEW

Description

View component class.

int CIGI_COMPONENT_GROUP

Description

View Group component class.

int CIGI_COMPONENT_SENSOR

Description

Sensor component class.

int CIGI_COMPONENT_REG_WATER

Description

Regional Water component class.

int CIGI_COMPONENT_REG_TERRAIN

Description

Regional Terrain component class.

int CIGI_COMPONENT_REG_WEATHER

Description

Regional Weather component class.

int CIGI_COMPONENT_GLOBAL_WATER

Description

Global Water component class.

int CIGI_COMPONENT_GLOBAL_TERRAIN

Description

Global Terrain component class.

int CIGI_COMPONENT_GLOBAL_WEATHER

Description

Global Weather component class.

int CIGI_COMPONENT_ATMOSPHERE

Description

Atmosphere component class.

int CIGI_COMPONENT_CELESTIAL

Description

Celestial component class.

int CIGI_COMPONENT_EVENT

Description

Event component class.

int CIGI_COMPONENT_SYSTEM

Description

System component class.

int CIGI_COMPONENT_SYMBOL_SURFACE

Description

Symbol Surface component class.

int CIGI_COMPONENT_SYMBOL

Description

Symbol component class.