Entity Control (CIGI Packets)
CIGI Version 3.3
| CIGI Class | CigiEntityCtrlV3_3 | ||
|---|---|---|---|
| CIGI Bass Class | CigiBaseEntityCtrl | ||
| Packet ID | 2 | ||
| Packet Size (bytes) | 48 | ||
| SpyClient Lookup | host2pcnova → h2ig.dat.mova_hv (air targets) host2pcnova → h2ig.dat.movs_hv (sea targets)) host2pcnova → h2ig.dat.movt_hv (ground targets) host2pcnova → h2ig.dat.movw_hv (weapon targets) | ||
| Parameter | Type | Description | Range |
| Entity ID | unsigned int16 | This parameter specifies the entity to which this packet is applied. A value of zero (0) corresponds to the Ownship. | 0 - MAXUINT16 |
| Entity State | 2-bit field | This parameter specifies whether the entity should be active or destroyed. This parameter may be set to one of the following values: 0 : Inactive/Standby - The entity is loaded, but its tree is not enabled in the scene graph. The entity is invisible, and no transformations are applied. Additionally, the entity is excluded from line of sight and collision testing. 1 : Active - The entity's tree is enabled in the scene graph. Transformations are applied to the entity, and it is included in the line of sight and collision testing. 2 : Destroyed - The entity's tree is removed from the scene graph. Any children are also destroyed. All other parameters in this packet are ignored. | 0 - 2 |
| Attach State | 1-bit field | This parameter specifies whether the entity should be attached as a child to a parent. If this parameter is set to Detach (0), the entity becomes or remains a top-level (non-child) entity. The Parent ID parameter is ignored. The Yaw, Pitch, Roll, Latitude, Longitude, and Altitude parameters all specify the entity's position relative to the geodetic coordinate system. If this parameter is set to Attach (1), the entity becomes or remains attached to the entity specified by the Parent ID parameter. The parent must already exist, having been created in a prior frame or earlier in the current frame. The Yaw, Pitch, Roll, X Offset, Y Offset, and Z Offset parameters all specify the entity's position relative to the parent's coordinate system. This parameter may be changed for a given entity at any time. The attachment or detachment takes place immediately and remains in effect until changed with another Entity Control packet. 0 = Detach 1 = Attach | 0 - 1 |
| Ground/Ocean Clamp | 2-bit field | This parameter specifies whether the entity should be clamped to the ground or water surface. If Attach State is set Attach (1), this parameter is ignored. 0 : No Clamp - The entity is not clamped. The Altitude parameter specifies the entity's height above Mean Sea Level. The Pitch and Roll parameters specify the entity's pitch and roll relative to the geodetic reference plane. 1 : Non-Conformal - The entity is clamped. The Altitude parameter specifies an offset above the terrain or sea level. The Pitch and Roll parameters specify the entity's pitch and roll relative to the geodetic reference plane. 2 : Conformal - The entity is clamped and its altitude conforms to the terrain. The Altitude parameter specifies an offset above the terrain or sea level. The Pitch and Roll parameter specify the entity's pitch and roll relative to the slope of the terrain or water. | 0 - 2 |
| Linear Extrapolation/Interpolation Enable | 1-bit field | This parameter specifies whether the entity's motion may be smoothed by extrapolation or interpolation algorithms on the IG. Such smoothing may be useful for compensating for lost CIGI messages, irregular frame rates, asynchronous operation. etc. If extrapolation or interpolation is disabled globally through the Extrapolation/Interpolation Enable flag of the IG Control packet, then smoothing will not be applied to the entity. 0 = Disable 1 = Enable | 0 - 1 |
| Alpha | char | This parameter specifies the missile trial transparency for weapon targets. A value of zero (0) corresponds to fully opaque; a value of 127 corresponds to fully transparent. 0 = Fully Opaque 127 = Fully Transparent | 0 - 127 |
| Entity Type | unsigned int16 | Specifies the type of entity. See Entity Types | 0 - MAXUINT16 |
| Parent ID | unsigned int16 | Specifies the parent of the entity. If attach state is set to detached (0), this parameter is ignored. | 0 - MAXUINT16 |
| Roll | float | This parameter specifies the roll angle of the entity (in degrees) | -180.0 - 180.0 |
| Pitch | float | This parameter specifies the pitch angle of the entity (in degrees) | -90.0 - 90.0 |
| Yaw | float | For top-level (non-child) entities, this parameter specifies the instantaneous heading of the entity (in degrees). For child entities, this parameter specifies a rotation about child entity's Z axis when the child's X axis is parallel to the parent's X axis (in degrees). | 0.0 - 360.0 |
Latitude (top-level entities) X Offset (child entities) | double | Specifies the entity's latitude in degrees (in absolute mode). Specifies the entity's latitude in meters (in relative mode). | 0.0 - MAXDOUBLE (Valid LAT in absolute mode) |
Longitude (top-level entities) Y Offset (child entities) | double | Specifies the entity's longitude in degrees (in absolute mode). Specifies the entity's longitude in meters (in relative mode). | 0.0 - MAXDOUBLE (Valid LON in absolute mode) |
Altitude (top-level entities) Z Offset (child entities) | double | Specifies the entity's altitude in degrees (in absolute mode). Specifies the entity's altitude in meters (in relative mode). | 0.0 - MAXDOUBLE |