Symbol Surface Definition (CIGI Packets)
| CIGI Class | CigiSymbolSurfaceDefV3_3 | ||
|---|---|---|---|
| CIGI Bass Class | CigiBaseSymbolSurfaceDef | ||
| Packet ID | 29 | ||
| Packet Size (bytes) | 56 | ||
| SpyClient Lookup | N/A | ||
| Parameter | Type | Description | Range |
| Surface ID | unsigned int16 | Identifies the surface to create or update. | 0 - MAXUINT16 |
| Surface State | 1-bit field | Specifies whether the symbol surface should be active or destroyed. 0 = Active : The surface is active and symbols may be drawn on it. The surface can be positioned, oriented, and sized; and it can be attached to an entity or a view. 1 = Destroyed : The surface is removed from the system. Any symbols drawn to it are also destroyed. All other parameters in this packet are ignored. | 0 - 1 |
| Attach Type | 1-bit field | Specifies whether the surface should be attached to an entity or a view. 0 = Entity 1 = View Only view attached is supported. | 1 |
| View ID | unsigned int16 | Specifies the view (channel) that the surface is attached to. Channels for sensors start at 0. Channels for the video blenders start at 1000. | 0 - MAXUINT16 |
| Left | float | Specifies the distance from the left edge of the surface to the left edge of the viewport as a fraction of the viewport's width. | 0.0 - 1.0 |
| Right | float | Specifies the distance from the left edge of the surface to the right edge of the viewport as a fraction of the viewport's width. | 0.0 - 1.0 |
| Top | float | Specifies the distance from the bottom edge of the surface to the top edge of the viewport as a fraction of the viewport's height. | 0.0 - 1.0 |
| Bottom | float | Specifies the distance from the bottom edge of the surface to the bottom edge of the viewport as a fraction of the viewport's height. | 0.0 - 1.0 |
| Min U | float | Specifies the surface's minimum U-coordinate in symbol surface horizontal units. | MINFLOAT - MAXFLOAT |
| Max U | float | Specifies the surface's maximum U-coordinate in symbol surface horizontal units. | MINFLOAT - MAXFLOAT |
| Min V | float | Specifies the surface's minimum V-coordinate in symbol surface vertical units. | MINFLOAT - MAXFLOAT |
| Max V | float | Specifies the surface's maximum V-coordinate in symbol surface vertical units. | MINFLOAT - MAXFLOAT |