PURPOSE
Shows attribute-locked geometry in specified rendition.
CALLING SEQUENCE
HIC_Show_Attribute_Locks (nr), returns lock
-------------------------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. lock Enumerated Type of geometry locked. --------------------------------------------------------------------------
DETAILS
See HIC_Set_Attribute_Locks for predefined constants for lock.
PURPOSE
Shows values of camera attributes in specified rendition.
CALLING SEQUENCE
HIC_Show_Camera_Field_Height (nr), returns height
HIC_Show_Camera_Field_Width (nr), returns width
HIC_Show_Camera_Oblique_X (nr), returns x
HIC_Show_Camera_Oblique_Y (nr), returns y
HIC_Show_Camera_Position (nr) returns position
HIC_Show_Camera_Positioning_Matrix (nr), returns matrix
HIC_Show_Camera_Projection (nr), returns projection
HIC_Show_Camera_Projection_Matrix (nr), returns matrix
HIC_Show_Camera_Target (nr) returns target
HIC_Show_Camera_Up_Vector (nr), returns vector
-------------------------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. height float Height of the camera. width float Width of the camera. x float Amount of skew along the x axis. y float Amount of skew along the y axis. position HT_Point X, Y, Z position of the camera. matrix array of floats 4 x 4 camera positioning matrix. projection HT_Point Enumerated. target HT_Point X, Y, Z coordinates of the camera target. vector HT_Vector X, Y, Z coordinates of the camera up vector.. --------------------------------------------------------------------------
DETAILS
There are no corresponding set routines. These show routines merely return the information residing in the HOOPS database. They are basically self explanatory.
PURPOSE
Shows color-locked geometry in specified rendition.
CALLING SEQUENCE
HIC_Show_Color_Locks (nr), returns lock
-------------------------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. lock Enumerated Type of geometry locked. --------------------------------------------------------------------------
DETAILS
See HIC_Set_Color_Locks for predefined constants for lock.
PURPOSE
Show various characteristics of the graphics device or the device driver.
CALLING SEQUENCE
HIC_Show_Device_Colormap_ID (nr), returns colormap_id
HIC_Show_Device_Colors (nr), returns dev_colors
HIC_Show_Device_Driver (nr), returns driver
HIC_Show_Device_Gouraud_Shading (nr), returns gouraud
HIC_Show_Device_Hardware_Lights (nr), returns lights
HIC_Show_Device_Locater (nr), returns locator
HIC_Show_Device_Locater_Button_Count (nr), returns buttons
HIC_Show_Device_Locater_Type (nr), returns loc_type
HIC_Show_Device_Max_Colors (nr), returns max_colors
HIC_Show_Device_Max_Pixels_X (nr), returns max_x_pix
HIC_Show_Device_Max_Pixels_Y (nr), returns max_y_pix
HIC_Show_Device_Max_Size_X (nr), returns max_width
HIC_Show_Device_Max_Size_Y (nr), returns max_height
HIC_Show_Device_Phong_Shading (nr), returns phong
HIC_Show_Device_Pixels_X (nr), returns x_pix
HIC_Show_Device_Pixels_Y (nr), returns y_pix
HIC_Show_Device_Plane_Count (nr), returns planes
HIC_Show_Device_Resolution_X (nr), returns x_res
HIC_Show_Device_Size_Y (nr), returns height
HIC_Show_Device_Type (nr), returns dev_type
HIC_Show_Device_Windowing_System (nr), returns wind_sys
HIC_Show_Device_Pixel_Aspect_Ratio (nr), returns pix_aspect
HIC_Show_Device_Window_Aspect_Ratio (nr), returns wind_aspect
HIC_Show_Device_Window_ID (nr), returns wind_id
HIC_Show_Device_Window_ID2 (nr), returns wind_id2
HIC_Show_Device_Z_Buffer_Depth (nr), returns z_depth
---------------------------------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. dev_colors long Number of color map entries available to HOOPS. driver string Driver identifier, as specified by driver. Passed by reference. gouraud boolean True if device supports color interpolation in hardware. lights int Number of light sources supported by hardware. locator boolean True if device has a locator. buttons int Number of locator buttons. loc_type string Locator type. Passed by reference. See below for details. max_colors long Actual number of entries in physical color map. max_x_pix int Number of pixels per scan line for physical device. max_y_pix int Number of scan lines for physical device. max_width float Width of physical device screen, in centimeters. max_height float Height of physical device screen, in centimeters. phong boolean True if hardware supports Phong lighting. x_pix int Number of pixels per scan line for current outer window. y_pix int Number of scan lines for current outer window. planes int Number of bit planes in the frame buffer. x_res float Pixels per centimeter in horizontal direction. y_res float Pixels per centimeter in vertical direction. width float Width of current outer window in centimeters. height float Height of current outer window, in centimeters. dev_type string Device type. Passed by reference. See below for details. wind_sys boolean True if driver is for a window system. pix_aspect float Pixel height/width. wind_aspect float Current outer window height/width. wind_id HC_POINTER_SIZED_INT Current outer window identifier. See below for details. wind_id2 HC_POINTER_SIZED_INT Secondary identifier of outer window. See below for details. z_depth int Number of bit planes in physical Z-buffer. ----------------------------------------------------------------------------------
DETAILS
The HIC_Show_Device_... functions report information about the graphics device, the outer window, or the device driver. This information is generally independent of the graphics database of objects and attributes. The rendition argument nr is relevant only because renditions contain a pointer to the data structures containing the device information.
Much of the device information is constant, and is determined by the driver when HOOPS is started. An exception is the information about the outer window, which is relevant when running on a window system. The outer window is the window-system window containing the HOOPS picture. It can change dynamically during the running of your application, either by your application setting the subscreen driver option, or by the user manipulating the window.
loc_type may typically have values "mouse", "tablet", "joystick", etc.
dev_type may typically have values "frame buffer", "pen plotter", "laser printer", "hard copy", etc., as reported by the driver.
wind_id is the window identifier returned by the window system when you (or HOOPS) created the outer window.
wind_id2 is relevant for two-level drivers, such as a PEX driver that makes use of an underlying X11 driver.
NOTES
Third-party drivers might introduce some variability in the results returned by the HIC_Show_Device_... functions.
The driver may have no way to determine the physical screen size in centimeters, so width, height, max_width, and max_height might represent the driver's best guess, rather than the actual values.
Note the difference in syntax and arguments between these functions and the corresponding classic function Show_Device_Info, which is a single function for all the device information items, and which takes string arguments for item specification and returned values.
PURPOSE
Returns the current key (possibly renumbered) of the segment for the driver currently being updated
CALLING SEQUENCE
HIC_Show_Driver_Segment_Key (nr), returns key
------------------------------------------------------------------ | ||
nr    | HT_Rendition    | Rendition. Passed by reference |
key    | HC_KEY    | key to a driver segment |
------------------------------------------------------------------ |
PURPOSE
Shows values of edge attributes in specified rendition.
CALLING SEQUENCE
HIC_Show_Edge_Color_Blue(nr), returns col_comp
HIC_Show_Edge_Color_Green (nr), returns col_comp
HIC_Show_Edge_Color_Red (nr), returns col_comp
HIC_Show_Edge_Pattern (nr), returns npattern
HIC_Show_Edge_Weight (nr), returns nweight
--------------------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. col_comp float B, R, or G component of edge color attribute. npattern Enumerated Edge pattern. See below for details. nweight int Edge thickness attribute, in pixels. ---------------------------------------------------------------------
VARIANTS
HIC_Show_Internal_Edge_Color (nr), returns int_color
------------------------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. int_color HT_RGB32 Edge color, in four-byte format (with platform- dependent order) -------------------------------------------------------------------------
DETAILS
Each of the R, G, and B color components is a float between 0 and 1.
The four-byte internal color shows the value of the same edge color attribute as the three float color components.
npattern has one of the symbolic constant values
LP_SOLID, LP_DASHDOT, LP_DASHED, LP_DOTTED, LP_DASH_2DOT, LP_DASH_3DOT, LP_LONG_DASH, LP_CENTER, LP_PHANTOM.
These correspond to the line patterns that you specify by descriptive strings in calls to the classic function Set_Edge_Pattern.
NOTES
Note the following differences between these I.M. functions and the corresponding Show_(Attribute) functions of classic HOOPS:
Note also the difference in color arguments between HIC_Show_Edge_Color_... and HIC_Set_Edge_Color.
PURPOSE
Shows values of face attributes in specified rendition.
CALLING SEQUENCE
HIC_Show_Face_Back_Color_Blue (nr), returns color_comp
HIC_Show_Face_Back_Color_Green (nr), returns color_comp
HIC_Show_Face_Back_Color_Red (nr), returns color_comp
HIC_Show_Face_Color_Blue (nr), returns col_comp
HIC_Show_Face_Color_Green (nr), returns col_comp
HIC_Show_Face_Color_Red (nr), returns col_comp
HIC_Show_Face_Contrast_Color_Blue (nr), returns col_comp
HIC_Show_Face_Contrast_Color_Green (nr), returns col_comp
HIC_Show_Face_Contrast_Color_Red (nr), returns col_comp
HIC_Show_Face_Pattern (nr), returns npattern
---------------------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. col_comp float B, R, or G component of face color or face con trast color attribute. npattern Enumerated Face pattern. See below for details. ----------------------------------------------------------------------
VARIANTS
HIC_Show_Internal_Face_Color (nr), returns int_color
HIC_Show_Internal_Face_Back_Color (nr), returns int_color
------------------------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. int_color HT_RGB32 Face color or face contrast color, in four-byte format (with platform- dependent order) -------------------------------------------------------------------------
DETAILS
Each of the R, G, and B color components is a float between 0 and 1.
The four-byte internal color shows the value of the same face color attribute as the three float color components.
npattern has one of the symbolic constant values
FP_SOLID, FP_CHECKERBOARD, FP_CROSSHATCH, FP_DIAMONDS, FP_HORIZONTAL_BARS, FP_SLANT_LEFT, FP_SLANT_RIGHT, FP_SQUARE_DOTS, FP_VERTICAL_BARS, FP_WINDOW_CHECKERBOARD, FP_WINDOW_CROSSHATCH, FP_WINDOW_DIAMONDS, FP_WINDOW_HORIZONTAL_BARS, FP_WINDOW_SLANT_LEFT, FP_WINDOW_SLANT_RIGHT, FP_WINDOW_SQUARE_DOTS, FP_WINDOW_VERTICAL_BARS, FP_WINDOW_TRANSPARENT, FP_USER_DEFINED.
All but the last of these correspond to the face patterns that you specify by descriptive strings in calls to the classic function Set_Face_Pattern. The last, FP_USEWR_DEFINED, will be the case when you have set the face pattern with HIC_Set_User_Face_Pattern.
NOTES
Note the following differences between these I.M. functions and the corresponding Show_(Attribute) functions of classic HOOPS:
Note also the difference in color arguments between HIC_Show_Face_Color_... and HIC_Set_Face_Color.
PURPOSE
Returns the current face displacement value.
CALLING SEQUENCE
HIC_Show_Face_Displacement (nr), returns displacement
------------------------------------------------------------------ | ||
nr    | HT_Rendition    | Rendition. Passed by reference |
displacement    | integer    | current face displacement value in z-buffer units. |
------------------------------------------------------------------ |
PURPOSE
Shows the geometry element in progress.
CALLING SEQUENCE
HIC_Show_Geometry (nr), returns geom
HIC_Show_Geometry_Key (nr), returns key
HIC_Show_Geometry_Type (nr), returns type
---------------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. geom HT_Geometry Geometry descriptor structure. Passed by ref erence. key HC_KEY Key of geometry in progress. See below for details. type Enumerated Type of geometry in progress. See below for details. ----------------------------------------------------------------
VARIANTS
HIC_Show_Original_Geometry_Key (nr), returns orig_key
------------------------------------------------------------------ nr HT_Rendition Rendition. Passed by reference. orig_key HC_KEY Original key of geometry in progress. See DETAILS. ------------------------------------------------------------------
DETAILS
These functions return information about the geometry element in progress at the callback point
type has one of the symbolic constant values
HK_CIRCLE, HK_CIRCULAR_ARC, HK_CIRCULAR_CHORD, HK_CIRCULAR_WEDGE, HK_EDGE,HK_ELLIPSE, HK_ELLIPTICAL_ARC, HK_FACE, HK_GRID, HK_IMAGE, HK_LINE, HK_MARKER, HK_MESH, HK_POLYLINE, HK_POLYGON, HK_SHELL, HK_STRING_CURSOR,
HK_TEXT, HK_VERTEX, HK_MISSING_GEOMETRY.
orig_key is the system-assigned key returned by KInsert_..., independently of how you may have renumbered it.
key is the system-assigned key, or the renumbered key if you have renumbered it.
When no geometry is in progress at the callback point, then HIC_Show_Geometry returns null, HIC_Show_Geometry_Type returns HK_BAD_TYPE, and HIC_Show_Geometry_Key and HIC_Show_Original_Geometry_Key return (long)(-1).
NOTES
geom is a pointer that you can pass to one of the other geometry-dependent functions, such as HIC_Draw_3D_Geometry or HIC_..._Geometry_Interesting. You can also pass it to one of the functions depending on a specific geometry when the geometry has the appropriate type. For example, you can pass geom to HIC_Draw_3D_Polygon, HIC_Show_Polygon_Count, or HIC_Show_Polygon_Points when type is HK_Polygon.
PURPOSE
Returns the key of the segment which contains the geometry currently being drawn.
CALLING SEQUENCE
HIC_Show_Geometry_Owner (nr), returns key
------------------------------------------------------------------ | ||
nr    | HT_Rendition    | Rendition. Passed by reference |
key    | HC_KEY    | segment key |
------------------------------------------------------------------ |
PURPOSE
Returns the internal representation of the color used to draw shell vertices (a composite of color components or color map index). Normally used with HIC_Set_Internal_XXX_Color to transfer a color setting without any need to interpret its value.
CALLING SEQUENCE
HIC_Show_Internal_Vertex_Color (nr), returns int_color
------------------------------------------------------------------ | ||
nr    | HT_Rendition    | Rendition. Passed by reference |
int_color    | HT_RGB32    | Vertex color in four-byte format (with platform-dependent order) |
------------------------------------------------------------------ |
PURPOSE
Returns the name of the line style or pattern in the specified rendition.
CALLING SEQUENCE
HIC_Show_Line_Style (nr), returns name
------------------------------------------------------------------ | ||
nr    | HT_Rendition    | Rendition. Passed by reference |
name | string | Name of the current line style or pattern. |
------------------------------------------------------------------ |
DETAILS
Returns the line pattern or style name as a string, rather than as enumerated type ( see HIC_Show_Line_Pattern ). This function can be used with user-defined line styles as well as with existing line patterns such as "dashdot".
PURPOSE
Shows values of line attributes in specified rendition.
CALLING SEQUENCE
HIC_Show_Line_Color_Blue (nr), returns col_comp
HIC_Show_Line_Color_Green (nr), returns col_comp
HIC_Show_Line_Color_Red (nr), returns col_comp
HIC_Show_Line_Pattern (nr), returns npattern
HIC_Show_Line_Weight (nr), returns nweight
--------------------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. col_comp float B, R, or G component of line color attribute. npattern Enumerated Line pattern. See below for details. nweight int Line thickness attribute, in pixels. ---------------------------------------------------------------------
VARIANTS
HIC_Show_Internal_Line_Color (nr), returns int_color
------------------------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. int_color HT_RGB32 Line color, in four-byte format (with platform- dependent order) -------------------------------------------------------------------------
DETAILS
Each of the R, G, and B color components is a float between 0 and 1.
The four-byte internal color shows the value of the same line color attribute as the three float color components.
npattern has one of the symbolic constant values
LP_SOLID, LP_DASHDOT, LP_DASHED, LP_DOTTED, LP_DASH_2DOT, LP_DASH_3DOT, LP_LONG_DASH, LP_CENTER, LP_PHANTOM.
These correspond to the line patterns that you specify by descriptive strings in calls to the classic function Set_Line_Pattern.
NOTES
Note the following differences between these I.M. functions and the corresponding Show_(Attribute) functions of classic HOOPS:
Note also the difference in color arguments between HIC_Show_Line_Color_... and HIC_Set_Line_Color.
PURPOSE
Returns the name of the marker glyph or symbol in the specified rendition.
CALLING SEQUENCE
HIC_Show_Marker_Name (nr), returns name
------------------------------------------------------------------ | ||
nr    | HT_Rendition    | Rendition. Passed by reference |
name | string | Name of the current marker glyph or symbol. |
------------------------------------------------------------------ |
DETAILS
Returns the marker glyph name or symbol as a string, rather than as enumerated type ( see HIC_Show_Marker_Symbol ). This function can be used with user-defined glyphs as well as with existing marker symbols, such as "<>".
PURPOSE
Returns the red component of the marker contrast color in the specified rendition.
CALLING SEQUENCE
HIC_Show_Marker_Contrast_Color_Red (nr), returns color_spec
------------------------------------------------------------------ | ||
nr    | HT_Rendition    | Rendition. Passed by reference |
color_spec | float | R component of the marker contrast color attribute |
------------------------------------------------------------------ |
PURPOSE
Returns the green component of the marker contrast color in the specified rendition.
CALLING SEQUENCE
HIC_Show_Marker_Contrast_Color_Green (nr), returns color_spec
------------------------------------------------------------------ | ||
nr    | HT_Rendition    | Rendition. Passed by reference |
color_spec | float | G component of the marker contrast color attribute |
------------------------------------------------------------------ |
PURPOSE
Returns the blue component of the marker contrast color in the specified rendition.
CALLING SEQUENCE
HIC_Show_Marker_Contrast_Color_Blue (nr), returns color_spec
------------------------------------------------------------------ | ||
nr    | HT_Rendition    | Rendition. Passed by reference |
color_spec | float | B component of the marker contrast color attribute |
------------------------------------------------------------------ |
PURPOSE
Returns the internal representation of the marker contrast color (a composite of color components).
CALLING SEQUENCE
HIC_Show_Internal_Marker_Contrast_Color (nr), returns color_spec
------------------------------------------------------------------ | ||
nr    | HT_Rendition    | Rendition. Passed by reference |
color_spec | HT_RGB32 | Current marker contrast color in four-byte format (with platform-dependent order). |
------------------------------------------------------------------ |
PURPOSE
Shows values of marker attributes in specified rendition.
CALLING SEQUENCE
HIC_Show_Marker_Color_Blue (nr), returns col_comp
HIC_Show_Marker_Color_Green (nr), returns col_comp
HIC_Show_Marker_Color_Red (nr), returns col_comp
HIC_Show_Marker_Symbol (nr), returns nsymbol
HIC_Show_Marker_Size (nr), returns nsize
----------------------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. col_comp float B, R, or G component of marker color attribute. nsymbol Enumerated Marker symbol. See DETAILS. nsize int Marker size attribute, in pixels. -----------------------------------------------------------------------
VARIANTS
HIC_Show_Internal_Marker_Color (nr), returns int_color
---------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. int_color HT_RGB32 Marker color, in four-byte format (with platform- dependent order) ----------------------------------------------------------
DETAILS
Each of the R, G, and B color components is a float between 0 and 1.
The four-byte internal color shows the value of the same marker color attribute as the three float color components.
nsymbol has one of the symbolic constant values
MK_CIRCLE, MK_CIRCLE_WITH_DOT, MK_CIRCLE_WITH_CROSS, MK_CIRCLE_WITH_TIMES, MK_CIRCLE_WITH_CIRCLE, MK_SOLID_CIRCLE, MK_DOT, MK_CROSS, MK_SPLAT, MK_TIMES, MK_BOX, MK_BOX_WITH_DOT, MK_BOX_WITH_TIMES, MK_SOLID_BOX, MK_DIAMOND, MK_DIAMOND_WITH_DOT, MK_DIAMOND_WITH_CROSS, MK_SOLID_DIAMOND, MK_TRIANGLE_UP, MK_TRIANGLE_UP_V, MK_TRIANGLE_UP_WITH_DOT, MK_SOLID_TRIANGLE_UP, MK_SOLID_TRIANGLE_UP_V, MK_TRIANGLE_DOWN, MK_TRIANGLE_DOWN_V, MK_TRIANGLE_DOWN_WITH_DOT, MK_SOLID_TRIANGLE_DOWN, MK_SOLID_TRIANGLE_DOWN_V, MK_TRIANGLE_RIGHT, MK_TRIANGLE_RIGHT_V, MK_TRIANGLE_RIGHT_WITH_DOT, MK_SOLID_TRIANGLE_RIGHT, MK_SOLID_TRIANGLE_RIGHT_V, MK_TRIANGLE_LEFT, MK_TRIANGLE_LEFT_V, MK_TRIANGLE_LEFT_WITH_DOT, MK_SOLID_TRIANGLE_LEFT, MK_SOLID_TRIANGLE_LEFT_V, MK_POUND, MK_WIDE_PLUS, MK_OPEN_ARROW, MK_CLOSED_ARROW, MK_VERTICAL_BAR, MK_HALF_ARROW_LEFT, MK_HALF_ARROW_RIGHT, MK_WIDE_ARROW, MK_DOUBLE_ARROW, MK_LETTER_Y, MK_LETTER_Z.
These correspond to the marker symbols that you specify by descriptive strings in calls to the classic function Set_Marker_Symbol.
NOTES
Note the differences between these I.M. functions and the corresponding Show_(Attribute) functions of classic HOOPS:
Note also the difference in color arguments between HIC_Show_Marker_Color_... and HIC_Set_Marker_Color
PURPOSE
Shows defining position of specific marker, given its descriptor structure.
CALLING SEQUENCE
HIC_Show_Marker_Position (marker), returns point
-------------------------------------------------------------------- marker HT_Marker Marker descriptor structure. Passed by reference. point HT_Point Marker position. Passed by reference. --------------------------------------------------------------------
DETAILS
This function lets you determine the position of a given marker. The returned point is given with respect to object coordinates.
PURPOSE
Shows the net modelling matrix for the specified rendition.
CALLING SEQUENCE
HIC_Show_Modelling_Matrix (nr), returns matrix.
---------------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. matrix matrix Net modelling matrix.Passed by reference. ----------------------------------------------------------------
VARIANTS
HIC_Show_Modelling_Matrix_Adjoint (nr), returns matrix.
-------------------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. matrix matrix Adjoint of net modelling matrix. Passed by ref erence. --------------------------------------------------------------------
DETAILS
The net modelling matrix is the matrix of the transformation from object coordinates to world coordinates.
The adjoint is related to the inverse matrix, but has the advantage that it is well defined even if the modelling matrix is singular. Specifically, when the inverse exists it is the adjoint divided by the determinant.
PURPOSE
Returns the adjoint of the object-to-screen matrix.
CALLING SEQUENCE
HIC_Show_Object_To_Screen_Adjoint (nr), returns matrix
------------------------------------------------------------------ | ||
nr    | HT_Rendition    | Rendition. Passed by reference |
matrix    | matrix    | Adjoint of complete transformation matrix. Passed by reference |
------------------------------------------------------------------ |
PURPOSE
Returns the matrix used to transform points from object space to screen (pixel) space
CALLING SEQUENCE
HIC_Show_Object_To_Screen_Matrix (nr), returns matrix
------------------------------------------------------------------ | ||
nr    | HT_Rendition    | Rendition. Passed by reference |
matrix    | matrix    | Complete transformation matrix. Passed by reference |
------------------------------------------------------------------ |
PURPOSE
Returns the original key of the segment for the driver currently being updated
CALLING SEQUENCE
HIC_Show_Original_Driver_Segment_Key (nr), returns key
------------------------------------------------------------------ | ||
nr    | HT_Rendition    | Rendition. Passed by reference |
    |     | |
------------------------------------------------------------------ |
PURPOSE
Shows various items that comprise a polyedge structure.
CALLING SEQUENCE
HIC_Show_Polyedge_Edge_Colors (polyedge), returns colors
HIC_Show_Polyedge_Edge_Count (polyedge), returns count
HIC_Show_Polyedge_Edge_Normals (polyedge), returns normals
HIC_Show_Polyedge_Findex_Color_Interpolation (polyedge), returns flag
HIC_Show_Polyedge_List (polyedge), returns list
HIC_Show_Polyedge_Point_Count (polyedge), returns count
HIC_Show_Polyedge_Points (polyedge), returns points
HIC_Show_Polyedge_Vertex_Colors (polyedge), returns colors
HIC_Show_Polyedge_Vertex_Findices (polyedge), returns findices
HIC_Show_Polyedge_Vertex_Normals (polyedge), returns normals
HIC_Show_Polyedge_Vertex_Parameters (polyedge), returns parameters
-------------------------------------------------------------------------- polyedge HT_Polyedge Polyedge structure descriptor. Passed by reference colors HT_RGB32 If not null, points to the first of an array of colors associated with the edges or ver tices. Passed by reference. Returned to caller. count int The number of elements appearing in the specified array. Returned to caller. normals HT_Vertex If not null, points to the first of an array of normal vectors associated with the edges or vertices. Passed by reference. Returned to caller. flag boolean Indicates if an attribute (in this case, col orization by fractional indices) is set. Returned to caller. list int Pointer to an array of integer indices that define the edge data. Passed by reference. Returned to caller. points HT_Point Pointer to an array of 3D points that describe the vertices of the edges. Passed by reference. Returned to caller. findices pointer If not null, points to the first of an array of fractional colormap indices associated with the vertices. Passed by reference. Returned to caller. parameters HT_Parameter In not null, points to texture mapping coordinates associated with the vertices of the edges. Passed by reference. Returned to caller. --------------------------------------------------------------------------
DETAILS
These functions are for use in a "draw 3d polyedge" callback function to extract individual information a HOOPS polyedge data structure, which may be passed in from the core HOOPS or created by HIC_New_Polyedge.
list[0], and list[1] give the indices in points (and the two other vertex data arrays when supplied) of the first two vertices of the first polyline. list[2] gives the index of the first edge in the edge data arrays, and subsequent pairs (list[2*n-1], list[2*n]) give the vertex array index of the next vertex and the edge array index of the edge that comes with it, respectively. The end of the first polyline is flagged by a negative value of the vertex index; specifically, the value in the list array is the one's complement of the actual index of the last vertex in the polyline. If the next value in list after the last index of polyline is non-negative, then there is another polyline to be drawn and the pattern repeats.
For example, a list of 0, 1, 0, -3, 1, 4, -6, -2 means vertices 0, and 1 form edge 0; vertices 1, and -(-3) edge 1. We are done with the first subedge. Starting anew, vertices 4, -(-6) form edge -(-2) and this is the end of the second subpolyedge and the end of the polyedge.
PURPOSE
Shows defining parameters of specific polygon, given its descriptor structure.
CALLING SEQUENCE
HIC_Show_Polygon_Count (polygon), returns count
HIC_Show_Polygon_Points (polygon), returns points
----------------------------------------------------------------------- polygon HT_Polygon Polygon descriptor structure. Passed by reference. count int Number of vertices. points HT_Point Array of count vertices. Passed by reference. -----------------------------------------------------------------------
DETAILS
This function lets you determine the defining parameters of a given polygon. The returned vertices are given with respect to object coordinates.
PURPOSE
Show the value of the polygon visibility attribute in the specified rendition.
CALLING SEQUENCE
HIC_Show_Polygon_Visibility(nr), returns include
--------------------------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. include Enumerated Polygon visibility attribute. See below for details. ---------------------------------------------------------------------------
DETAILS
This shows the value of the polygon visibility attribute, which controls whether faces, edges, or both are to be drawn. It has one of the symbolic constant values FACES_ONLY, EDGES_ONLY, FACES_AND_EDGES.
NOTES
There is no I.M. function to allow you to change the polygon visibility attribute during traversal.
Note the difference from the classic Set_Visibility and Show_Visibility functions in which the visibility is specified by a string rather than a symbolic constant.
PURPOSE
Shows defining parameters of specific polyline, given its descriptor structure.
CALLING SEQUENCE
HIC_Show_Polyline_Count (polyline), returns count
HIC_Show_Polyline_Points (polyline), returns points
-------------------------------------------------------------------------- polyline HT_Polyline Polyline descriptor structure. Passed by reference. count int Number of vertices. points HT_Point Array of count vertices. Passed by reference. --------------------------------------------------------------------------
DETAILS
This function lets you determine the defining parameters of a given polyline. The returned vertices are given with respect to object coordinates.
PURPOSE
Shows various items that comprise a polymarker structure.
CALLING SEQUENCE
HIC_Show_Polymarker_Findex_Color_Interpolation (polymarker), returns flag
HIC_Show_Polymarker_List (polymarker), returns list
HIC_Show_Polymarker_Point_Count (polymarker), returns count
HIC_Show_Polymarker_Points (polymarker), returns points
HIC_Show_Polymarker_Vertex_Colors (polymarker), returns colors
HIC_Show_Polymarker_Vertex_Findices (polymarker), returns findices
HIC_Show_Polymarker_Vertex_Normals (polymarker), returns normals
HIC_Show_Polymarker_Vertex_Parameters (polymarker), returns parameters
--------------------------------------------------------------------------- polymarker HT_Polymarker Polymarker structure descriptor. Passed by reference colors HT_RGB32 If not null, points to the first of an array of colors associated with the markers. Passed by reference. Returned to caller. count int The number of elements appearing in the specified array. Returned to caller. normals HT_Vertex If not null, points to the first of an array of normal vectors associated with the markers. Passed by reference. Returned to caller. flag boolean Indicates if an attribute (in this case, col orization by fractional indices) is set. Returned to caller. list int Pointer to an array of integer indices that define the marker data. Passed by ref erence. Returned to caller. points HT_Point Pointer to an array of 3D points that describe the markers. Passed by ref erence. Returned to caller. findices pointer If not null, points to the first of an array of fractional colormap indices associated with the markers. Passed by reference. Returned to caller. parameters HT_Parameter In not null, points to texture mapping coordinates associated with the markers. Passed by reference. Returned to caller. ---------------------------------------------------------------------------
DETAILS
points points to the first of an array of 3D points that contains the vertices of all the polymarkers in the list. The sequences of vertices defining the polymarkers in the list are specified by list, as described below.
Each polymarker starts with a positive vertex and end with an negative vertex. You would need to negate the negative vertex to get the correct vertex index. For example, 0, 1, 2, -3, 4, 5, -7 means 0, 1, 2, -(-3) form polymarker 0 and 4, 5, -(-7) polymarker 1.
PURPOSE
Shows the key of the segment in progress.
CALLING SEQUENCE
HIC_Show_Segment_Key (si), returns key
--------------------------------------------------------------------- si struct ht_segment_info A "segment info" structure, which is one of the parameters passed to "draw segment" or "draw segment tree" callbacks. Passed by reference. key HC_KEY Key of segment in progress. See below for details. ---------------------------------------------------------------------
VARIANTS
HIC_Show_Original_Segment_Key (nr), returns orig_key
----------------------------------------------------------------------- nr struct ht_segment_info as above. Passed by reference. orig_key HC_KEY Original key (i.e. without regard to any renumbering) of segment in progress. See below for details. -----------------------------------------------------------------------
DETAILS
These functions return information about the segment in progress at the callback point
orig_key is the system-assigned key returned by KOpen_Segment, KCreate_Segment, etc._..., independently of how you may have renumbered it.
key is the system-assigned key, or the renumbered key if you have renumbered it.
PURPOSE
Shows the draw path for a specific rendition.
CALLING SEQUENCE
HIC_Show_Segment_Path (nr), returnspath
HIC_Free_Segment_Path (path)
--------------------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. path HT_Segment_Path Array of keys that specify the complete draw path. ---------------------------------------------------------------------
DETAILS
Returns an array of keys which specifies the complete draw path for geometry being drawn with this rendition. HOOPS allocates memory and so users must call HIC_Free_Segment_Path to free up the memory when finished.
PURPOSE
Shows the screen location of the current selection event.
CALLING SEQUENCE
HIC_Show_Selection_Point (nr), returns point
---------------------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. point HT_DC_Point Screen coordinates of selection event. Passed by reference. ----------------------------------------------------------------------
DETAILS
point gives the location, in device coordinates, that the user was pointing at when the current selection traversal was triggered.
NOTES
You would normally call this function only from a "select ..." callback function
PURPOSE
Shows parameters controlling selection.
CALLING SEQUENCE
HIC_Show_Selection_Action (nr), returns action
HIC_Show_Selection_Point (nr), returns point
HIC_Show_Selection_Proximity_Sq (nr), returns prox_sq
HIC_Show_Selection_Status (nr), returns status
HIC_Show_Selection_Volume (nr), returns volume
----------------------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. action Enumerated. See please.h for details. point HT_Point Center of the selection area. prox_sq float Square of selection proximity. status integer Bit-encoded value representing the state of the keyboard and mouse buttons. volume HT_Volume Selection volume. -----------------------------------------------------------------------
DETAILS
In order that a piece of geometry be selected, its distance from the selection point must be no greater than the proximity value that you set as a driver option. prox_sq is the square of that proximity value.
volume is determined by the left, right, bottom, top, hither, yon arguments of the Compute_Selection_By_Volume or Compute_Selection_By_Area call that initiated the current selection traversal. In particular, it is the volume or area defined by these arguments, intersected with the window that is current at the callback point.
NOTES
You would normally call these functions only from "select ..." callback functions.
If the selection traversal was not initiated by a Compute_Selection_By_Volume or Compute_Selection_By_Area call, then volume is determined by the current window volume. If the selection traversal was initiated by a call to Compute_Selection_By_Area then the z extent of volume is determined by the z extent of the window.
PURPOSE
Show the values of text attributes in the specified rendition.
CALLING SEQUENCE
HIC_Show_Text_Alignment (nr), returns align
HIC_Show_Text_Color_Blue (nr), returns color_comp
HIC_Show_Text_Color_Green (nr), returns color_comp
HIC_Show_Text_Color_Red (nr), returns color_comp
HIC_Show_Text_Final_Font_Size (nr), returns fsize
HIC_Show_Text_Font_Extra_Space (nr), returns xspace
HIC_Show_Text_Font_Extra_Space_Units (nr), returns units
HIC_Show_Text_Font_ID (nr), returns font_id
HIC_Show_Text_Font_Name (nr), returns font_name
HIC_Show_Text_Font_Rotation (nr), returns rotn
HIC_Show_Text_Font_Size (nr), returns size
HIC_Show_Text_Font_Size_Tolerance (nr), returns tolerance
HIC_Show_Text_Font_Size_Tol_Units (nr), returns units
HIC_Show_Text_Font_Size_Units (nr), returns units
HIC_Show_Text_Font_Slant (nr), returns slant
HIC_Show_Text_Font_Transform (nr), returns xform
HIC_Show_Text_Line_Count(ti), returns line_count
HIC_Show_Text_Line_Index(ti), returns index
HIC_Show_Text_Longest_Baseline(ti), returns length
HIC_Show_Text_Path (nr), returns path
HIC_Show_Text_Spacing (nr), returns space
HIC_Show_Text_Z_Max(ti), returns depth
--------------------------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. ti HT_Text_Info Text info object. align Enumerated Text alignment attribute. See below for details. color_comp float B,G, or R component of text color. depth integer Depth of the Z-buffer in Z-buffer units. fsize Integer32 Font size actually used by driver. See below for details. xspace float Text font extra space. See below for details. units Enumerated Units for text size, size tolerance, extra space. See below for details. font_id long Unique identifier of current text font. font_name string Text font name. Passed by reference. index integer The current line of the current text object. length HT_Vector Length vector of the longest line in the current text object. line_count integer Number of lines in a given text object. rotn float Text rotation angle, in degrees. size float Text size attribute. tol float Text size tolerance attribute. slant float Text slant angle, in degrees. xform Enumerated Text transformability attribute. See below for details. path HT_Vector Text path attribute. Passed by reference. ---------------------------------------------------------------------------
VARIANTS
HIC_Show_Internal_Text_Color (nr), returns int_color
----------------------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. int_color HT_RGB32 Text color in four-byte format. With platform- dependent order. -----------------------------------------------------------------------
DETAILS
align has one of the symbolic constant values
TA_CENTERCENTER, TA_CENTERLEFT, TA_CENTERRIGHT, TA_LOWERCENTER, TA_LOWERLEFT, TA_LOWERRIGHT, TA_UPPERCENTER, TA_UPPERLEFT, TA_UPPERRIGHT, TA_INSERTION_POINT,
which have a straightforward correspondence with the descriptive strings that you use with the classic HOOPS function Set_Text_Alignment.
The four-byte internal color shows the value of the same text color attribute as the three float color components.
xspace is a float form of the parameter you specify with a string with "extra space" in Set_Text_Font.
fsize is the size of the font (height of letter "A"), in pixels, actually used by the driver. It may differ from the text size attribute set by the application because of possible size constraints of fonts supplied by the driver or the device (e.g. bitmap fonts).
units has one of the symbolic constant values
FS_NOT_VALID, FS_ORU, FS_SRU, FS_WRU, FS_POINTS, FS_PIXELS, FS_PERCENT,
which have a straightforward correspondence with the descriptive strings that you use with "size = ..." in Set_Text_Font. The size shown reflects the size as inserted into the HOOPS database, not the size that may result after the application of various transforms.
path is a vector whose three components have the same meaning as the three arguments to HIC_Set_Text_Path or Set_Text_Path.
rot, size, tol, and slant are float forms of the corresponding parameters that you specify with strings in Set_Text_Font.
space has the same type and meaning as the argument to Set_Text_Spacing.
xform has one of the symbolic constant values
FT_NOT_VALID, FT_FULL, FT_NONE, FT_POSITION_ONLY
which have a straightforward correspondence with the descriptive strings that you use with the "transforms" specification in Set_Text_Font.
PURPOSE
Shows defining parameters of a specific text line, given its intermediate text structure.
CALLING SEQUENCE
HIC_Show_Text_Baseline (text_info), returns baseline
HIC_Show_Text_Char_Horizontal (text_info), returns horiz
HIC_Show_Text_Char_Position (nr, text_info, index), returns cposition
HIC_Show_Text_Char_Vertical (text_info), returns vert
HIC_Show_Text_Char_Width (nr, text_info, index), returns width
HIC_Show_Text_Length (text_info), returns length
HIC_Show_Text_Position (text_info), returns tposition
----------------------------------------------------------------------------- text_info HT_Text_Info Intermediate text information structure. See below for details. Passed by reference. baseline HT_Vector Text baseline vector. See below for details. Passed by reference. horiz HT_Vector Character horizontal vector. See below for details. Passed by reference. nr HT_Rendition Rendition. Passed by reference. index int Position of character in string, zero-based. cposition HT_DC_Point Location of index-th character, in device coordi nates. Passed by reference. vert HT_Vector Character vertical vector. See below for details. Passed by reference. width float Width of index-th character, in device coordinate units. length int Number of characters in text string. tposition HT_DC_Point Position of first character, device coordinates. -----------------------------------------------------------------------------
DETAILS
These functions are for use in a "draw text" callback function. The "draw text" callback point is at an intermediate stage of rendering, below "draw 3d text" but above "draw dc text".
text_info is passed to your callback as an argument.
baseline is a vector referred to device coordinates, whose direction gives the path of the text string and whose magnitude gives the length of the text string in device coordinate units.
horiz is a unit vector whose direction gives the direction of the (common) baselines of the characters in the string. This might differ from the direction of baseline by the text rotation angle.
index serves to identify one of the characters in the text string. The first character has index zero.
vert is a unit vector, always perpendicular to horiz, in the character-up direction.
cposition is the position of the lower-left corner of the index-th character. tposition is the lower left corner of the first character.
NOTES
Note that only one of these functions takes a rendition argument.
PURPOSE
Shows transformation matrix in specified rendition
CALLING SEQUENCE
HIC_Show_Transform_Matrix (nr), returns matrix
-------------------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. matrix matrix Complete transformation matrix. See below for details. Passed by reference. --------------------------------------------------------------------
DETAILS
This is the matrix of the full transformation from object coordinates to device coordinates.
NOTES
HOOPS transformation matrices are understood to define transformations as right multipliers of row vectors.
PURPOSE
Shows various items that comprise a tristrip structure.
CALLING SEQUENCE
HIC_Show_Tristrip_Face_Colors (tristrip), returns colors
HIC_Show_Tristrip_Face_Count (tristrip), returns count
HIC_Show_Tristrip_Face_Normals (tristrip), returns normals
HIC_Show_Tristrip_Findex_Color_Interpolation (tristrip), returns flag
HIC_Show_Tristrip_List (tristrip), returns list
HIC_Show_Tristrip_Point_Count (tristrip), returns count
HIC_Show_Tristrip_Points (tristrip), returns points
HIC_Show_Tristrip_Vertex_Colors (tristrip), returns colors
HIC_Show_Tristrip_Vertex_Findices (tristrip), returns findices
HIC_Show_Tristrip_Vertex_Normals (tristrip), returns normals
HIC_Show_Tristrip_Vertex_Parameters (tristrip), returns parameters
-------------------------------------------------------------------------- tristrip HT_Tristrip Tristrip structure descriptor. Passed by reference colors HT_RGB32 If not null, points to the first of an array of colors associated with the faces or ver tices. Passed by reference. Returned to caller. count int The number of elements appearing in the specified array. Returned to caller. normals HT_Vertex If not null, points to the first of an array of normal vectors associated with the faces or vertices. Passed by reference. Returned to caller. flag boolean Indicates if an attribute (in this case, col orization by fractional indices) is set. Returned to caller. list int Pointer to an array of integer indices that define the face data. Passed by reference. Returned to caller. points HT_Point Pointer to an array of 3D points that describe the vertices of the faces. Passed by reference. Returned to caller. findices pointer If not null, points to the first of an array of fractional colormap indices associated with the geometry. Passed by reference. Returned to caller. parameters HT_Parameter In not null, points to texture mapping coordinates associated with the faces. Passed by reference. Returned to caller. --------------------------------------------------------------------------
DETAILS
These functions are for use in a "draw 3d tristrip" callback function to extract and set individual information a HOOPS tristrip data structure, which may be passed in from the core HOOPS or created by HIC_New_Tristrip.
points points to the first of an array of 3D points that contains the vertices of all the triangle strips in the list. The sequences of vertices defining the tristrips in the list are specified by list, as described below. For each tristrip, the first three vertices form the first triangle, and thereafter the n-th vertex forms a new triangle with the (n- 1)st and (n-2)nd vertices. Thus, there is a natural one-to-one correspondence between faces and vertices after the second vertex. This correspondence is used to arrange the vertex- specific indices and face-specific indices in the list array, as described below.
For example, a list of 0,1,2,0,-3,1,4,5,-6,-2 means vertices 0, 1, and 2 form face 0; vertices 1, 2, and -(-3) face 1 and we are done with the first substrip. Starting anew, vertices 4, 5, -(-6) form face -(-2) and this is the end of the second substrip and the end of the tristrip.
PURPOSE
Shows user option corresponding to given index in specified rendition.
CALLING SEQUENCE
HIC_Show_User_Index (nr, index), returns pointer
------------------------------------------------------------------ nr HT_Rendition Rendition. Passed by reference. index int User option index pointer pointer Value of user option corresponding to index ------------------------------------------------------------------
DETAILS
This returns the option value that you have defined for the given index using Set_User_Index or HIC_Set_User_Index. It should be a pointer to something meaningful to you.
If you have not set a user option for the given index, the function returns null.
PURPOSE
Obtains visibility settings.
CALLING SEQUENCE
HIC_Show_Visibility (nr), returns visibility
----------------------------------------------------------------------------- nr HT_Rendition Rendition created by HIC_New_Rendition. Passed by reference. visibility int Bitmask that specifies existing visibility values. Returned to caller. -----------------------------------------------------------------------------
DETAILS
This function is most useful in a segment callback. It can be used as teh first step to providing view dependent geometry visibilities. The general method of using this routine is to call this routine to obtain the existing bit values, modify the bit settings, obtain a new rendition, and then set the modified visibility in the new rendition. The specific bit value settings are available in consultation with Tech Soft 3D Technical Support.
PURPOSE
Returns the blue component of the current color used to draw shell vertices.
CALLING SEQUENCE
HIC_Show_Vertex_Color_Blue (nr), returns color_comp
------------------------------------------------------------------ | ||
nr    | HT_Rendition    | Rendition. Passed by reference |
color_comp    | float    | B component of vertex color attribute |
------------------------------------------------------------------ |
PURPOSE
Returns the green component of the current color used to draw shell vertices.
CALLING SEQUENCE
HIC_Show_Vertex_Color_Green (nr), returns color_comp
------------------------------------------------------------------ | ||
nr    | HT_Rendition    | Rendition. Passed by reference |
color_comp    | float    | G component of vertex color attribute |
------------------------------------------------------------------ |
PURPOSE
Returns the red component of the current color used to draw shell vertices.
CALLING SEQUENCE
HIC_Show_Vertex_Color_Red (nr), returns color_comp
------------------------------------------------------------------ | ||
nr    | HT_Rendition    | Rendition. Passed by reference |
color_comp    | float    | R component of vertex color attribute |
------------------------------------------------------------------ |
PURPOSE
Shows visibility-locked geometry in specified rendition.
CALLING SEQUENCE
HIC_Show_Visibility_Locks (nr), returns lock
-------------------------------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. lock Enumerated Type of geometry locked. --------------------------------------------------------------------------
DETAILS
See HIC_Set_Visibility_Locks for predefined constants for lock.
PURPOSE
Shows window attribute values in the specified rendition.
CALLING SEQUENCE
HIC_Show_Window_Color_Blue (nr), returns color_comp
HIC_Show_Window_Color_Green (nr), returns color_comp
HIC_Show_Window_Color_Red (nr), returns color_comp
HIC_Show_Window_Contrast_Color_Blue (nr), returns color_comp
HIC_Show_Window_Contrast_Color_Green (nr), returns color_comp
HIC_Show_Window_Contrast_Color_Red (nr), returns color_comp
HIC_Show_Window_Extent (nr), returns extent
HIC_Show_Window_Pattern (nr), returns pattern
--------------------------------------------------------------------------------- nr HT_Rendition Rendition. color_comp float R, G, or B component of window color or window contrast color attribute extent HT_Int_Rectangle Window net extent attribute in rendition. Passed by reference.Returned to caller. pattern int Window pattern attribute in rendition. Returned to caller. ---------------------------------------------------------------------------------
VARIANTS
HIC_Show_Internal_Window_Color (nr), returns int_color
------------------------------------------------------------------------ nr HT_Rendition Rendition. Passed by reference. int_color HT_RGB32 Window color or window contrast color, in four- byte format (with platform- dependent order) ------------------------------------------------------------------------
DETAILS
Each of the R, G, and B color components is a float between 0 and 1.
The four-byte internal color shows the value of the same color attribute as the corresponding triplet of float color components.
NOTES
Note the following differences between these I.M. functions and the corresponding Show_(Attribute) functions of classic HOOPS:
Note also the difference in color arguments between HIC_Show_Window_Color_... and HIC_Set_Window_Color.
PURPOSE
Shows if Z-buffering is in effect.
CALLING SEQUENCE
HIC_Show_Z_Buffering (nr), returns flag
----------------------------------------------------- nr HT_Rendition Rendition. Passed by reference. flag boolean True if Z-Buffering is in effect. -----------------------------------------------------
DETAILS
flag is true if Z-buffering is in effect at the callback point.
PURPOSE
Returns the adjoint of the world-to-screen matrix.
CALLING SEQUENCE
HIC_Show_World_To_Screen_Adjoint (nr), returns matrix
------------------------------------------------------------------ | ||
nr    | HT_Rendition    | Rendition. Passed by reference |
matrix    | matrix    | Adjoint of complete transformation matrix. Passed by reference |
------------------------------------------------------------------ |
PURPOSE
Returns the matrix used to transform points from world space to screen (pixel) space
CALLING SEQUENCE
HIC_Show_World_To_Screen_Matrix (nr), returns matrix
------------------------------------------------------------------ | ||
nr    | HT_Rendition    | Rendition. Passed by reference |
matrix    | matrix    | Complete transformation matrix. Passed by reference |
------------------------------------------------------------------ |