If your application was coded to the Version 1 graPHIGS API, it may be dependent on the format of structure elements from that version. The Inquire Element Content (GPQE) subroutine returns the contents of the Version 1 structure elements in a format that is compatible with the Version 1 format. The contents and organization of the structure element records built by the graPHIGS API are provided in this chapter.
When your application uses the Inquire Element Content (GPQE) subroutine, the size in bytes and the contents of the structure element record are returned by the API in the formats presented here. The subroutine call in parenthesis following each element shows the corresponding subroutine call used to create the element.
The GPQE subroutine is provided only for compatibility with Version 1. If you use any of the new subroutine calls provided in Version 2, you must convert your application to use the Inquire Element Content (GPQED) subroutine. of structure elements returned by GPQEDscreen
The notes preceding each structure element record format tell how the element is defined, and for some, processing considerations of which you should be aware.
Structure elements are organized in this chapter as follows:
This structure element defines an annotation text string in modeling space. It is drawn at the location specified in a plane parallel to the view plane.
---------------------------
| x position | Short floating-point number
---------------------------
| y position | Short floating-point number
---------------------------
| length of text string | Fullword integer
---------------------------
| character set identifier| Fullword integer
---------------------------
/ characters of text / Variable-length character string
/ string /
---------------------------
This structure element defines an annotation text string and its position in modeling space. It is drawn at the location specified in a plane parallel to the view plane.
---------------------------
| x position | Short floating-point number
---------------------------
| y position | Short floating-point number
---------------------------
| z position | Short floating-point number
---------------------------
| length of text string | Fullword integer
---------------------------
| character set identifier| Fullword integer
---------------------------
/ characters of text / Variable-length character string
/ string /
---------------------------
This structure element defines a two-dimensional circle primitive.
---------------------------
| x position | Short floating-point number
---------------------------
| y position | Short floating-point number
---------------------------
| radius | Short floating-point number
---------------------------
This structure element defines a two-dimensional circular arc primitive.
---------------------------
| x position | Short floating-point number
---------------------------
| y position | Short floating-point number
---------------------------
| radius | Short floating-point number
---------------------------
| start angle | Short floating-point number
---------------------------
| end angle | Short floating-point number
---------------------------
This structure element defines a series of two-dimensional points that may or may not be connected by straight lines. When processing this element during traversal, the z coordinate defaults to 0.0. The WIDTH parameter is discarded when creating the structure element.
---------------------------
| number of points | Fullword integer
---------------------------
| |
| array of point |
/ values stored / Array of short floating-point
/ X,Y,X,Y,X,Y,X.... / numbers
| |
---------------------------
| |
/ move/draw indicators / Array of fullword integers
/ /
| |
---------------------------
This structure element defines a series of three-dimensional points that may or may not be connected by straight lines. The WIDTH parameter is discarded when creating the structure element.
---------------------------
| number of points | Fullword integer
---------------------------
| array of point |
/ values stored / Array of short
/ X,Y,Z,X,Y,Z,X.... / floating-point numbers
| |
--------------------------
| |
/ move/draw indicators / Array of fullword integers
/ /
| |
--------------------------
This structure element defines a two-dimensional ellipse primitive.
---------------------------
| x position | Short floating-point number
---------------------------
| y position | Short floating-point number
---------------------------
| major axis component 1 | Short floating-point number
---------------------------
| major axis component 2 | Short floating-point number
---------------------------
| minor axis component 1 | Short floating-point number
---------------------------
| minor axis component 2 | Short floating-point number
---------------------------
This structure element defines a three-dimensional ellipse primitive.
---------------------------
| x position | Short floating-point number
---------------------------
| y position | Short floating-point number
---------------------------
| z position | Short floating-point number
---------------------------
| major axis component 1 | Short floating-point number
---------------------------
| major axis component 2 | Short floating-point number
---------------------------
| major axis component 3 | Short floating-point number
---------------------------
| minor axis component 1 | Short floating-point number
---------------------------
| minor axis component 2 | Short floating-point number
--------------------------
| minor axis component 3 | Short floating-point number
--------------------------
This structure element defines a two-dimensional elliptical arc primitive.
---------------------------
| x position | Short floating-point number
---------------------------
| y position | Short floating-point number
---------------------------
| major axis component 1 | Short floating-point number
---------------------------
| major axis component 2 | Short floating-point number
---------------------------
| minor axis component 1 | Short floating-point number
---------------------------
| minor axis component 2 | Short floating-point number
---------------------------
| start angle | Short floating-point number
---------------------------
| end angle | Short floating-point number
---------------------------
This structure element defines a three-dimensional elliptical arc primitive.
---------------------------
| x position | Short floating-point number
---------------------------
| y position | Short floating-point number
---------------------------
| z position | Short floating-point number
---------------------------
| major axis component 1 | Short floating-point number
---------------------------
| major axis component 2 | Short floating-point number
---------------------------
| major axis component 3 | Short floating-point number
---------------------------
| minor axis component 1 | Short floating-point number
---------------------------
| minor axis component 2 | Short floating-point number
---------------------------
| minor axis component 3 | Short floating-point number
---------------------------
| start angle | Short floating-point number
---------------------------
| end angle | Short floating-point number
---------------------------
This structure element defines a pixel 2 primitive in modeling space.
---------------------------
| x position | Short floating-point number
---------------------------
| y position | Short floating-point number
---------------------------
| packing factor | Fullword integer
---------------------------
| number of rows in array | Fullword integer
---------------------------
| number of cols in array | Fullword integer
---------------------------
/ array of / Array of fullword integers
/ color indexes /
---------------------------
This structure element defines a pixel 3 primitive in modeling space.
---------------------------
| x position | Short floating-point number
---------------------------
| y position | Short floating-point number
---------------------------
| z position | Short floating-point number
---------------------------
| packing factor | Fullword integer
---------------------------
| number of rows in array | Fullword integer
---------------------------
| number of cols in array | Fullword integer
---------------------------
/ array of / Array of fullword integers
/ color indexes /
---------------------------
This structure element defines a polygon in two-dimensional modeling space. All points specified are placed in the x, y plane. The WIDTH parameter is discarded when creating the structure element.
--------------------------
| number of subareas (n) | Fullword integer
--------------------------
|# of points in subarea 1| Fullword integer
--------------------------
/ /
/ /
--------------------------
|# of points in subarea n| Fullword integer
--------------------------
| |
/ array of point values / Array of short
/ stored X,Y,X,Y,X.... / floating-point numbers
| |
--------------------------
This structure element defines a polygon in three-dimensional modeling space. All points specified must lie in the same plane but no check is made to verify this. The WIDTH parameter is discarded when creating the structure element.
--------------------------
| number of subareas (n) | Fullword integer
--------------------------
|# of points in subarea 1| Fullword integer
--------------------------
/ /
/ /
--------------------------
|# of points in subarea n| Fullword integer
--------------------------
| |
/ array of point values / Array of short
/ stored X,Y,Z,X,Y,Z,X... / floating-point numbers
| |
--------------------------
This structure element defines a series of two-dimensional points that are to be connected by straight lines. The WIDTH parameter is discarded when creating the structure element.
---------------------------
| number of points | Fullword integer
---------------------------
| |
/ array of point values / Array of short
/ stored X,Y,X,Y,X.... / floating-point numbers
| |
---------------------------
This structure element defines a series of three-dimensional points that are to be connected by straight lines. The WIDTH parameter is discarded when creating the structure element.
---------------------------
| number of points | Fullword integer
---------------------------
| |
/ array of point values / Array of short
/ stored X,Y,Z,X,Y,Z,X... / floating-point numbers
| |
---------------------------
This structure element defines a series of two-dimensional points which are to be identified with markers. The WIDTH parameter is discarded when creating the structure element.
---------------------------
| number of points | Fullword integer
---------------------------
| |
/ array of point values / Array of short
/ stored X,Y,X,Y,X,Y,X... / floating-point numbers
| |
---------------------------
This structure element defines a series of three-dimensional points, which are to be identified with markers. The WIDTH parameter is discarded when creating the structure element.
---------------------------
| number of points | Fullword integer
---------------------------
| |
/ array of point values / Array of short
/ stored X,Y,Z,X,Y,Z, / floating-point numbers
| X,Y,Z... |
---------------------------
This structure element defines a text string in modeling space. It is drawn at the location specified in the XY plane.
---------------------------
| x position | Short floating-point number
---------------------------
| y position | Short floating-point number
---------------------------
| length of text string | Fullword integer
---------------------------
| character set identifier| Fullword integer
---------------------------
/ characters of text / Variable-length character string
/ string /
---------------------------
This structure element defines a text string and its orientation in modeling space. It is drawn at the location specified and in the plane defined by the position and two reference points.
---------------------------
| x position | Short floating-point number
---------------------------
| y position | Short floating-point number
---------------------------
| z position | Short floating-point number
---------------------------
| x reference point 1 | Short floating-point number
---------------------------
| y reference point 1 | Short floating-point number
---------------------------
| z reference point 1 | Short floating-point number
---------------------------
| x reference point 2 | Short floating-point number
---------------------------
| y reference point 2 | Short floating-point number
---------------------------
| z reference point 2 | Short floating-point number
---------------------------
| length of text string | Fullword integer
---------------------------
| character set identifier| Fullword integer
---------------------------
| | Variable-length character string
/ characters of text /
/ string /
| |
---------------------------
This structure element sets the current polyline bundle index to the specified value. All subsequent polyline primitives use the contents of the specified bundle table entry for all polyline attributes whose attribute source flag is set to BUNDLED screen
---------------------------
| polyline bundle index | Fullword integer
---------------------------
This structure element sets the current polymarker bundle index to the specified value. All subsequent polymarker primitives use the contents of the specified bundle table entry for all polymarker attributes whose attribute source flags are set to BUNDLED screen
---------------------------
| polymarker bundle index | Fullword integer
---------------------------
This structure element sets the current text bundle index to the specified value. All subsequent text primitives use the contents of the specified bundle table entry for all text attributes whose attribute source flags are set to BUNDLED screen
---------------------------
| text bundle index | Fullword integer
---------------------------
This structure element sets the interior bundle index to the specified value. All subsequent polygon primitives use the contents of the specified bundle table entry for all interior attributes whose attribute source flags are set to BUNDLED screen
---------------------------
| interior bundle index | Fullword integer
---------------------------
This structure element sets the edge bundle index to the specified value. All subsequent polygon primitives use the contents of the specified bundle table entry for all edge attributes whose attribute source flags are set to BUNDLED screen
---------------------------
| edge bundle index | Fullword integer
---------------------------
This structure element sets the current line type to the specified value. All subsequent polyline primitives use this line type for drawing the primitive if the line type attribute source flag is set to INDIVIDUAL screen
---------------------------
| linetype | Fullword integer
---------------------------
This structure element sets the current line width scale factor. All subsequent polyline primitives use this value to determine the line width of lines to be drawn if the attribute source flag is set to INDIVIDUAL screen
---------------------------
| linewidth scale factor | Short floating-point number
---------------------------
This structure element sets the current polyline color index to the specified value. All subsequent polyline primitives use this color index for drawing the primitive if the polyline color index attribute source flag is set to INDIVIDUAL screen
---------------------------
| polyline color index | Fullword integer
---------------------------
This structure element sets the polyline end type to the specified value.
---------------------------
| endtype | Fullword integer
---------------------------
This structure element sets the current marker type. All subsequent polymarker primitives use this marker type for identifying each point if the marker type attribute source flag is set to INDIVIDUAL screen
---------------------------
| marker type | Fullword integer
---------------------------
This structure element sets the current marker size scale factor. All subsequent polymarker primitives use this value to determine the size to draw the markers if the attribute source flag is set to INDIVIDUAL screen
---------------------------
| marker size scale factor| Short floating-point number
---------------------------
This structure element sets the current polymarker color index to the specified value. All subsequent polymarker primitives use this color index for drawing the primitive if the polymarker color index attribute source flag is set to INDIVIDUAL screen
---------------------------
| polymarker color index | Fullword integer
---------------------------
This structure element sets the current text font to the one specified. All subsequent text primitives are drawn in this font if the text font attribute source flag is set to INDIVIDUAL screen
---------------------------
| text font # | Fullword integer
---------------------------
This structure element sets the current text precision to that specified. All subsequent text primitives are drawn at this precision if the text precision attribute source flag is set to INDIVIDUAL screen
---------------------------
| text precision | Fullword integer
---------------------------
This structure element sets the current character expansion factor. All subsequent text primitives are drawn with this value for the character expansion factor if its attribute source flag is set to INDIVIDUAL screen The value is a fraction of the width/height ratio that the font designer specified. A value of 1.0 reproduces the font designer's aspect ratio.
----------------------------
|character expansion factor| Short floating-point number
----------------------------
This structure element sets the current character spacing. All subsequent text primitives are drawn with this value for the character spacing if its attribute source flag is set to INDIVIDUAL screen
---------------------------
| character spacing | Short floating-point number
---------------------------
This structure element sets the current annotation height scale factor. All subsequent annotation text primitives are drawn with this value for the height scale factor.
---------------------------
| annotation h.s.f. | Short floating-point number
---------------------------
This structure element sets the text color index to the specified value. All subsequent text primitives use this color index for drawing the primitive if the text color index attribute source flag is set to INDIVIDUAL screen
---------------------------
| text color index | Fullword integer
---------------------------
This structure element sets the current character height. All subsequent non-annotation text primitives will be drawn with this value for the character height.
---------------------------
| character height | Short floating-point number
---------------------------
This structure element sets the current character up vector. All subsequent text primitives are drawn with this value for the character up vector.
--------------------------
| X direction | Short floating-point number
--------------------------
| Y direction | Short floating-point number
--------------------------
This structure element sets the current geometric text path. All subsequent text primitives are drawn with this value for the text path.
---------------------------
| text path | Fullword integer
---------------------------
This structure element sets the current geometric text alignment. All subsequent geometric text primitives are drawn with this value for text alignment.
---------------------------
| horizontal | Fullword integer
---------------------------
| vertical | Fullword integer
---------------------------
This structure element sets the current interior style. All subsequent primitives use this attribute when drawing the interior if the corresponding attribute source flag is set to INDIVIDUAL screen
---------------------------
| interior style | Fullword integer
---------------------------
This structure element sets the current interior style index. All subsequent primitives use this attribute when drawing the interior if the corresponding attribute source flag is set to INDIVIDUAL and the current interior style is HATCH or PATTERN screen
---------------------------
| interior style index | Fullword integer
---------------------------
The current interior color index is set by this structure element. All subsequent primitives use this attribute when drawing the interior if the corresponding attribute source flag is set to INDIVIDUAL and the current interior style is SOLID or HATCH screen
---------------------------
| interior color index | Fullword integer
---------------------------
The visibility of edges is set by this structure element. All subsequent primitives use this attribute to determine whether the edges should be drawn if the attribute source flag is set to INDIVIDUAL screen
---------------------------
| edge flag | Fullword integer
---------------------------
This structure element sets the current edge line type to the specified value. All subsequent primitives use this edge line type for drawing the primitive if the edge line type attribute source flag is set to INDIVIDUAL and the edge flag is set to ON screen
---------------------------
| edge linetype | Fullword integer
---------------------------
This structure element sets the current edge color index to the specified value. All subsequent primitives use this color index for drawing the edges if the edge color index attribute source flag is set to INDIVIDUAL and the edge flag is set to ON screen
---------------------------
| edge color index | Fullword integer
---------------------------
This structure element sets the current edge scale factor to the specified value. All subsequent primitives use this value to determine the width of the edges to be drawn if the attribute source flag is set to INDIVIDUAL and the edge flag is set to ON screen
---------------------------
| edge scale factor | Short floating-point number
---------------------------
This structure element defines whether the attribute used for rendering each bundled attribute should be the bundled or current individual attribute setting.
---------------------------
| count | Fullword integer
---------------------------
| |
/ array of / Array of fullword integers
/ attribute identifiers /
| |
---------------------------
| |
/ array of corresponding / Array of fullword integers
/ attribute ASF values /
| |
---------------------------
This structure element specifies a modification for local modeling transformation.
----------------------------
| composition type | Fullword integer
----------------------------
|row 1 col 1 matrix element| Short floating-point number
----------------------------
|row 1 col 2 matrix element| Short floating-point number
----------------------------
|row 1 col 3 matrix element| Short floating-point number
----------------------------
|row 1 col 4 matrix element| Short floating-point number
----------------------------
|row 2 col 1 matrix element| Short floating-point number
----------------------------
|row 2 col 2 matrix element| Short floating-point number
----------------------------
|row 2 col 3 matrix element| Short floating-point number
----------------------------
|row 2 col 4 matrix element| Short floating-point number
----------------------------
|row 3 col 1 matrix element| Short floating-point number
----------------------------
|row 3 col 2 matrix element| Short floating-point number
----------------------------
|row 3 col 3 matrix element| Short floating-point number
----------------------------
|row 3 col 4 matrix element| Short floating-point number
----------------------------
|row 4 col 1 matrix element| Short floating-point number
----------------------------
|row 4 col 2 matrix element| Short floating-point number
----------------------------
|row 4 col 3 matrix element| Short floating-point number
----------------------------
|row 4 col 4 matrix element| Short floating-point number
----------------------------
This structure element specifies a modification for local modeling transformation. The matrix returned by GPQE is the expanded, 4[default]4 matrix.
----------------------------
| composition type | Fullword integer
----------------------------
|row 1 col 1 matrix element| Short floating-point number
----------------------------
|row 1 col 2 matrix element| Short floating-point number
----------------------------
|row 1 col 3 matrix element| Short floating-point number
----------------------------
|row 1 col 4 matrix element| Short floating-point number
----------------------------
|row 2 col 1 matrix element| Short floating-point number
----------------------------
|row 2 col 2 matrix element| Short floating-point number
----------------------------
|row 2 col 3 matrix element| Short floating-point number
----------------------------
|row 2 col 4 matrix element| Short floating-point number
----------------------------
|row 3 col 1 matrix element| Short floating-point number
----------------------------
|row 3 col 2 matrix element| Short floating-point number
----------------------------
|row 3 col 3 matrix element| Short floating-point number
----------------------------
|row 3 col 4 matrix element| Short floating-point number
----------------------------
|row 4 col 1 matrix element| Short floating-point number
----------------------------
|row 4 col 2 matrix element| Short floating-point number
----------------------------
|row 4 col 3 matrix element| Short floating-point number
----------------------------
|row 4 col 4 matrix element| Short floating-point number
----------------------------
This structure element specifies a global modeling transformation.
----------------------------
|row 1 col 1 matrix element| Short floating-point number
----------------------------
|row 1 col 2 matrix element| Short floating-point number
----------------------------
|row 1 col 3 matrix element| Short floating-point number
----------------------------
|row 1 col 4 matrix element| Short floating-point number
----------------------------
|row 2 col 1 matrix element| Short floating-point number
----------------------------
|row 2 col 2 matrix element| Short floating-point number
----------------------------
|row 2 col 3 matrix element| Short floating-point number
----------------------------
|row 2 col 4 matrix element| Short floating-point number
----------------------------
|row 3 col 1 matrix element| Short floating-point number
----------------------------
|row 3 col 2 matrix element| Short floating-point number
----------------------------
|row 3 col 3 matrix element| Short floating-point number
----------------------------
|row 3 col 4 matrix element| Short floating-point number
----------------------------
|row 4 col 1 matrix element| Short floating-point number
----------------------------
|row 4 col 2 matrix element| Short floating-point number
----------------------------
|row 4 col 3 matrix element| Short floating-point number
----------------------------
|row 4 col 4 matrix element| Short floating-point number
----------------------------
This structure element specifies a global modeling transformation. The matrix returned by GPQE is the expanded, 4[default]4 matrix.
----------------------------
|row 1 col 1 matrix element| Short floating-point number
----------------------------
|row 1 col 2 matrix element| Short floating-point number
----------------------------
|row 1 col 3 matrix element| Short floating-point number
----------------------------
|row 1 col 4 matrix element| Short floating-point number
----------------------------
|row 2 col 1 matrix element| Short floating-point number
----------------------------
|row 2 col 2 matrix element| Short floating-point number
----------------------------
|row 2 col 3 matrix element| Short floating-point number
----------------------------
|row 2 col 4 matrix element| Short floating-point number
----------------------------
|row 3 col 1 matrix element| Short floating-point number
----------------------------
|row 3 col 2 matrix element| Short floating-point number
----------------------------
|row 3 col 3 matrix element| Short floating-point number
----------------------------
|row 3 col 4 matrix element| Short floating-point number
----------------------------
|row 4 col 1 matrix element| Short floating-point number
----------------------------
|row 4 col 2 matrix element| Short floating-point number
----------------------------
|row 4 col 3 matrix element| Short floating-point number
----------------------------
|row 4 col 4 matrix element| Short floating-point number
----------------------------
This structure element adds class names to the current class set.
---------------------------
| # of class names (n) | Fullword integer
---------------------------
| class name 1 | Fullword integer
---------------------------
/ /
/ /
---------------------------
| class name n | Fullword integer
---------------------------
This structure element defines a call or invocation of another structure.
---------------------------
| structure id | Fullword integer
---------------------------
This structure element sets the index into the workstation-dependent color table, which is used for highlighted primitives.
---------------------------
| highlighting color index| Fullword integer
---------------------------
This structure element contains application specified data.
---------------------------
| application defined |
/ /
| data |
---------------------------
This structure element defines a label that the application uses to reference and modify structure elements.
---------------------------
| label | Fullword integer
---------------------------
This structure element sets the current pick identifier to the specified value.
---------------------------
| pick identifier | Fullword integer
---------------------------
This structure element removes class names from the current class set.
---------------------------
| # of class names (n) | Fullword integer
---------------------------
| class name 1 | Fullword integer
---------------------------
/ /
/ /
---------------------------
| class name n | Fullword integer
---------------------------