hic.h
Functions
-
void HIC_Abort_Update(HIC_Rendition *nr)
This function interrupts tree traversal and ends the update.
- Parameters
nr – A pointer to a const HIC_Rendition.
-
void HIC_Abort_Selection(HIC_Rendition *nr)
This function interrupts tree traversal and ends the selection.
- Parameters
nr – A pointer to a const HIC_Rendition.
-
void HIC_Exit_Update(HIC_Rendition *nr)
This function checks for conditions that would cause the update to exit.
- Parameters
nr – A pointer to a const HIC_Rendition.
-
void *HIC_Begin_Occlusion_Query(HIC_Rendition *nr, int disable_write)
This function begins an occlusion query.
- Parameters
nr – A pointer to a const HIC_Rendition.
disable_write – A boolean.
- Returns
A void pointer.
-
void HIC_End_Occlusion_Query(HIC_Rendition *nr, void *id)
This function ends an occlusion query.
- Parameters
nr – A pointer to a const HIC_Rendition.
id – A void pointer.
-
int HIC_Get_Occlusion_Query(HIC_Rendition *nr, void *id)
This function returns the occlusion query.
- Parameters
nr – A pointer to a const HIC_Rendition.
id – A void pointer.
- Returns
An int.
-
void HIC_Delete_Occlusion_Query(HIC_Rendition *nr, void *id)
This function deletes the occlusion query.
- Parameters
nr – A pointer to a const HIC_Rendition.
id – A void pointer.
-
int HIC_Occlusion_Query_Available(HIC_Rendition *nr)
This function returns a boolean which is true if the occlusion query is available and false if the occlusion query is not available.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A boolean.
-
void HIC_Add_Cutting_Plane(HIC_Rendition *nr, HIC_Plane *pln)
This function adds a cutting plane.
- Parameters
nr – A pointer to a const HIC_Rendition.
pln – A pointer to a HIC_Plane.
-
void HIC_Remove_Cutting_Planes(HIC_Rendition *nr)
This function removes all cutting planes.
- Parameters
nr – A pointer to a const HIC_Rendition.
-
void HIC_Clear_Cutting_Planes(HIC_Rendition *nr)
This function clears all cutting planes.
- Parameters
nr – A pointer to a const HIC_Rendition.
-
int HIC_Can_Save_And_Restore_Regions(HIC_Rendition *nr)
This function returns a boolean which is true if you can save and restore regions and false if you cannot save and restore regions.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A boolean.
-
void HIC_Create_Region(HIC_Rendition *nr, HIC_Int_Rectangle *area, void **image_buffer, void **z_buffer)
This function creates a region.
- Parameters
nr – A pointer to a const HIC_Rendition.
area – A pointer to a const HIC_Int_Rectangle.
image_buffer – A pointer to a void pointer.
z_buffer – A pointer to a void pointer.
-
void HIC_Save_Region(HIC_Rendition *nr, HIC_Int_Rectangle *area, void *image_buffer, void *z_buffer)
This function saves a region.
- Parameters
nr – A pointer to a const HIC_Rendition.
area – A pointer to a const HIC_Int_Rectangle.
image_buffer – A void pointer.
z_buffer – A void pointer.
-
void HIC_Restore_Region(HIC_Rendition *nr, HIC_Int_Rectangle *area, void *image_buffer, void *z_buffer)
This function restores a region.
- Parameters
nr – A pointer to a const HIC_Rendition.
area – A pointer to a const HIC_Int_Rectangle.
image_buffer – A void pointer.
z_buffer – A void pointer.
-
void HIC_Destroy_Region(HIC_Rendition *nr, void *image_buffer, void *z_buffer)
This function destroys a region.
- Parameters
nr – A pointer to a const HIC_Rendition.
image_buffer – A void pointer.
z_buffer – A void pointer.
-
int HIC_Snapshot(HIC_Rendition *nr, int width, int height, unsigned char *data)
This function takes a snapshot whose dimensions are the passed in width and height parameters.
- Parameters
nr – A pointer to a const HIC_Rendition.
width – An int.
height – An int.
data – A pointer to an unsigned char.
- Returns
A boolean, true if snapshot was taken, otherwise false.
-
int HIC_Can_Snapshot(HIC_Rendition *nr)
This function returns a boolean which is true if the driver supports snapshotting and false otherwise.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A boolean.
-
long HIC_Driver_Snapshot_Texture(HIC_Rendition *nr, long id)
-
long HIC_Driver_Snapshot_Depth_Texture(HIC_Rendition *nr, long id)
-
void HIC_Set_Geometry_Interesting(HIC_Rendition *nr, HIC_Marker *geo)
This function sets a geometry to interesting.
- Parameters
nr – A pointer to a const HIC_Rendition.
geo – A pointer to a const HIC_Marker.
-
void HIC_UnSet_Geometry_Interesting(HIC_Rendition *nr, HIC_Marker *geo)
This function sets geometry to not interesting.
- Parameters
nr – A pointer to a const HIC_Rendition.
geo – A pointer to a const HIC_Marker.
-
int HIC_Check_Geometry_Interesting(HIC_Rendition *nr, HIC_Marker *geo)
This function returns a boolean, true if geometry is interesting, false if geometry is not interesting.
- Parameters
nr – A pointer to a const HIC_Rendition.
geo – A pointer to a const HIC_Marker.
- Returns
A boolean, true if geometery is interesting, otherwise false.
-
void HIC_Set_Current_Geometry_Interesting(HIC_Rendition *nr)
This function sets current geometry to interesting.
- Parameters
nr – A pointer to a const HIC_Rendition.
-
void HIC_UnSet_Current_Geometry_Interesting(HIC_Rendition *nr)
This function sets current geometry to not interesting.
- Parameters
nr – A pointer to a const HIC_Rendition.
-
int HIC_Check_Current_Geometry_Interesting(HIC_Rendition *nr)
This function returns a boolean, true if current geometry is interesting, false if current geometry is not interesting.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A boolean, true if current geometry is interesting, otherwise false.
-
void HIC_Set_Segment_Interesting(HIC_Rendition *nr, HIC_Segment_Info *si)
This function sets a segment to interesting.
- Parameters
nr – A pointer to a const HIC_Rendition.
si – A pointer to a const HIC_Segment_Info.
-
void HIC_UnSet_Segment_Interesting(HIC_Rendition *nr, HIC_Segment_Info *si)
This function sets a segment to not interesting.
- Parameters
nr – A pointer to a const HIC_Rendition.
si – A pointer to a const HIC_Segment_Info.
-
int HIC_Check_Segment_Interesting(HIC_Rendition *nr, HIC_Segment_Info *si)
This function returns a boolean, true if segment is interesting, false if segment is not interesting.
- Parameters
nr – A pointer to a const HIC_Rendition.
si – A pointer to a const HIC_Segment_Info.
- Returns
A boolean, true if segment is interesting, otherwise false.
-
void HIC_Clear_Z_Buffer(HIC_Rendition *nr)
This function clears the Z-buffer.
- Parameters
nr – A pointer to a const HIC_Rendition.
-
int HIC_Show_Z_Buffering(HIC_Rendition *nr)
This function returns a boolean, true if Z-buffering is in effect, false if Z-buffering is not in effect.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A boolean, true if Z-buffering is in effect, otherwise false.
-
HIC_Point *HIC_Compute_Transformed_Text_Position(HIC_Rendition *nr, HIC_Text_Info *ti, HIC_DC_Point *pt)
This function computes transformed text position.
- Parameters
nr – A pointer to a const HIC_Rendition.
ti – A pointer to a const HIC_Text_Info.
pt – A pointer to a HIC_DC_Point.
- Returns
A pointer to a const HIC_Point.
-
HIC_Segment_Info *HIC_Copy_Segment_Info(HIC_Segment_Info *si)
This function copies segment information.
- Parameters
si – A pointer to a const HIC_Segment_Info.
- Returns
A const pointer to a HIC_Segment_Info.
-
void HIC_Free_Segment_Info(HIC_Segment_Info *si)
This function frees memory associated with segment information.
- Parameters
si – A pointer to a const HIC_Segment_Info.
-
void HIC_Disable_Shadows(HIC_Rendition *nr)
This function disables shadows.
- Parameters
nr – A pointer to a const HIC_Rendition.
-
void HIC_Enable_Shadows(HIC_Rendition *nr)
This function enables shadows.
- Parameters
nr – A pointer to a const HIC_Rendition.
-
void HIC_Draw_3D_Geometry(HIC_Rendition *nr, HIC_Geometry *geo)
This function draws the geometry.
- Parameters
nr – A pointer to a const HIC_Rendition.
geo – A pointer to a const HIC_Geometry.
-
void HIC_Draw_3D_Marker(HIC_Rendition *nr, HIC_Marker *marker)
This function draws the marker.
- Parameters
nr – A pointer to a const HIC_Rendition.
marker – A pointer to a const HIC_Marker.
-
void HIC_Draw_3D_Polyline(HIC_Rendition *nr, HIC_Polyline *polyline)
This function draws the polyline.
- Parameters
nr – A pointer to a const HIC_Rendition.
polyline – A pointer to a const HIC_Polyline.
-
void HIC_Draw_3D_Infinite_Line(HIC_Rendition *nr, HIC_Polyline *polyline)
This function draws the infinite line.
- Parameters
nr – A pointer to a const HIC_Rendition.
polyline – A pointer to a const HIC_Polyline.
-
void HIC_Draw_3D_Polygon(HIC_Rendition *nr, HIC_Polygon *polygon)
This function draws the polygon.
- Parameters
nr – A pointer to a const HIC_Rendition.
polygon – A pointer to a const HIC_Polygon.
-
void HIC_Draw_3D_Text(HIC_Rendition *nr, HIC_Text *text)
This function draws text.
- Parameters
nr – A pointer to a const HIC_Rendition.
text – A pointer to a const HIC_Text.
-
void HIC_Draw_3D_Stenciled_Quad(HIC_Rendition *nr, HIC_Point points[], HIC_Stencil_Bitmap *stencil)
This function draws a stenciled quad.
- Parameters
nr – A pointer to a const HIC_Rendition.
points – A pointer to a const HIC_Point.
stencil – A pointer to a const HIC_Stencil_Bitmap.
-
void HIC_Draw_3D_Tristrip(HIC_Rendition *nr, HIC_Tristrip *tristrip)
This function draws a tristrip.
- Parameters
nr – A pointer to a const HIC_Rendition.
tristrip – A pointer to a const HIC_Tristrip.
-
void HIC_Draw_3D_Polyhedron(HIC_Rendition *nr, HIC_Polyhedron *phon)
This function draws a polyhedron.
- Parameters
nr – A pointer to a const HIC_Rendition.
phon – A pointer to a const HIC_Polyhedron.
-
void HIC_Draw_3D_Shell(HIC_Rendition *nr, HIC_Polyhedron *phon)
This function draws a shell.
- Parameters
nr – A pointer to a const HIC_Rendition.
phon – A pointer to a const HIC_Polyhedron.
-
void HIC_Draw_3D_Mesh(HIC_Rendition *nr, HIC_Polyhedron *phon)
This function draws a mesh.
- Parameters
nr – A pointer to a const HIC_Rendition.
phon – A pointer to a const HIC_Polyhedron.
-
void HIC_Draw_3D_Polyedge(HIC_Rendition *nr, HIC_Polyedge *pe)
This function draws polyedge.
- Parameters
nr – A pointer to a const HIC_Rendition.
pe – A pointer to a const HIC_Polyedge.
-
void HIC_Draw_3D_Polymarker(HIC_Rendition *nr, HIC_Polymarker *pm)
This function draws polymarker.
- Parameters
nr – A pointer to a const HIC_Rendition.
pm – A pointer to a const HIC_Polymarker.
-
void HIC_Draw_3D_Polyedge_From_Tristrip(HIC_Rendition *nr, HIC_Polyedge *pe, HIC_Tristrip *ts)
This function draws a 3D polyedge from a tristrip.
- Parameters
nr – A pointer to a const HIC_Rendition.
pe – A pointer to a const HIC_Polyedge.
ts – A pointer to a const HIC_Tristrip.
-
void HIC_Draw_3D_Ellipse(HIC_Rendition *nr, HIC_Ellipse *ellipse)
This function draws the ellipse.
- Parameters
nr – A pointer to a const HIC_Rendition.
ellipse – A pointer to a const HIC_Ellipse.
-
void HIC_Draw_3D_Elliptical_Arc(HIC_Rendition *nr, HIC_Elliptical_Arc *arc)
This function draws the elliptical arc.
- Parameters
nr – A pointer to a const HIC_Rendition.
arc – A pointer to a const HIC_Elliptical_Arc.
-
void HIC_Draw_3D_NURBS_Curve(HIC_Rendition *nr, HIC_NURBS_Curve *curve)
This function draws the NURBS curve.
- Parameters
nr – A pointer to a const HIC_Rendition.
curve – A pointer to a const HIC_NURBS_Curve.
-
void HIC_Draw_3D_NURBS_Surface(HIC_Rendition *nr, HIC_NURBS_Surface *surface)
This function draws the NURBS surface.
- Parameters
nr – A pointer to a const HIC_Rendition.
surface – A pointer to a const HIC_NURBS_Surface.
-
void HIC_Draw_3D_Cylinder(HIC_Rendition *nr, HIC_Cylinder *cylinder)
This function draws the cylinder.
- Parameters
nr – A pointer to a const HIC_Rendition.
cylinder – A pointer to a const HIC_Cylinder.
-
void HIC_Draw_3D_PolyCylinder(HIC_Rendition *nr, HIC_Polycylinder *polycylinder)
This function draws the polycylinder.
- Parameters
nr – A pointer to a const HIC_Rendition.
polycylinder – A pointer to a const HIC_Polycylinder.
-
void HIC_Draw_3D_Sphere(HIC_Rendition *nr, HIC_Sphere *sphere)
This function draws sphere.
- Parameters
nr – A pointer to a const HIC_Rendition.
sphere – A pointer to a const HIC_Sphere.
-
void HIC_Draw_3D_Grid(HIC_Rendition *nr, HIC_Grid *grid)
This function draws 3D grid.
- Parameters
nr – A pointer to a const HIC_Rendition.
grid – A pointer to a const HIC_Grid.
-
void HIC_Draw_3D_Image(HIC_Rendition *nr, HIC_Image *image)
This function draws the image.
- Parameters
nr – A pointer to a const HIC_Rendition.
image – A pointer to a const HIC_Image.
-
void HIC_Draw_DC_Bit_Rasters(HIC_Rendition *nr, HIC_DC_Point *start, HIC_DC_Point *end, int rowbytes, unsigned char rasters[])
This function draws a single scan line determined by the bits in the data array.
- Parameters
nr – A pointer to a const HIC_Rendition.
start – A pointer to a const HIC_DC_Point.
end – A pointer to a const HIC_DC_Point.
rowbytes – An int.
rasters – A pointer to a const unsigned char.
-
void HIC_Draw_DC_Gray8_Rasters(HIC_Rendition *nr, HIC_DC_Point *start, HIC_DC_Point *end, int rowbytes, unsigned char rasters[])
This function draws an image specified by an array of eight-bit gray scale values.
- Parameters
nr – A pointer to a const HIC_Rendition.
start – A pointer to a const HIC_DC_Point.
end – A pointer to a const HIC_DC_Point.
rowbytes – An int.
rasters – A pointer to a const unsigned char.
-
void HIC_Draw_DC_Mapped8_Rasters(HIC_Rendition *nr, HIC_DC_Point *start, HIC_DC_Point *end, int rowbytes, unsigned char rasters[])
This function draws an image specified by an array of eight-bit color indices into the current color map.
- Parameters
nr – A pointer to a const HIC_Rendition.
start – A pointer to a const HIC_DC_Point.
end – A pointer to a const HIC_DC_Point.
rowbytes – An int.
rasters – A pointer to a const unsigned char.
-
void HIC_Draw_DC_Mapped16_Rasters(HIC_Rendition *nr, HIC_DC_Point *start, HIC_DC_Point *end, int rowbytes, unsigned short rasters[])
This function draws an image specified by an array of 16-bit color indices into the current color map.
- Parameters
nr – A pointer to a const HIC_Rendition.
start – A pointer to a const HIC_DC_Point.
end – A pointer to a const HIC_DC_Point.
rowbytes – An int.
rasters – A pointer to a const unsigned char.
-
void HIC_Draw_DC_RGB32_Rasters(HIC_Rendition *nr, HIC_DC_Point *start, HIC_DC_Point *end, int rowbytes, HIC_RGBAS32 rasters[])
This function draws an image specified by an array of 32-bit words, each giving a pixel color in the platform-dependent four-byte color format.
- Parameters
nr – A pointer to a const HIC_Rendition.
start – A pointer to a const HIC_DC_Point.
end – A pointer to a const HIC_DC_Point.
rowbytes – An int.
rasters – A pointer to a const unsigned char.
-
void HIC_Draw_DC_Line(HIC_Rendition *nr, HIC_DC_Point points[])
This function draws a line.
- Parameters
nr – A pointer to a const HIC_Rendition.
points – A pointer to a const HIC_DC_Point.
-
void HIC_Draw_DC_Colorized_Line(HIC_Rendition *nr, HIC_DC_Point points[], HIC_RGBAS32 color[])
This function draws a line using passed in color values instead of the rendition colors.
- Parameters
nr – A pointer to a const HIC_Rendition.
points – A pointer to a const HIC_DC_Point.
color – A pointer to a const HIC_RGBAS32.
-
void HIC_Draw_DC_Gouraud_Line(HIC_Rendition *nr, HIC_DC_Point points[], HIC_RGBAS32 colors[])
This function draws a line segment with color interpolated from the argument endpoint colors.
- Parameters
nr – A pointer to a const HIC_Rendition.
points – A pointer to a const HIC_DC_Point.
colors – A pointer to a const HIC_RGBAS32.
-
void HIC_Draw_DC_Reshaded_Line(HIC_Rendition *nr, HIC_DC_Point points[], HIC_RGBA colors[], HIC_Plane planes[], HIC_Parameter params[], int param_width, HIC_Integer32 param_flags)
This function draws a line segment with color interpolated at each pixel, using the line pattern and line weight attributes.
- Parameters
nr – A pointer to a const HIC_Rendition.
points – A pointer to a const HIC_DC_Point.
colors – A pointer to a const HIC_RGBA.
planes – A pointer to a const HIC_Plane, defined for each vertex V as the camera-space plane that passes through V with V’s surface normal, after modelling and camera positioning and before camera projection.
params – A pointer to a const HIC_Parameter.
param_width – An int.
param_flags – A HIC_Integer32.
-
void HIC_Draw_DC_Marker(HIC_Rendition *nr, HIC_DC_Point *point)
This function draws a marker, with position specified in device coordinates.
- Parameters
nr – A pointer to a const HIC_Rendition.
point – A pointer to a const HIC_DC_Point.
-
void HIC_Draw_DC_Colorized_Marker(HIC_Rendition *nr, HIC_DC_Point *point, HIC_RGBAS32 *color)
This function draws a marker using passed in color values instead of the rendition colors.
- Parameters
nr – A pointer to a const HIC_Rendition.
point – A pointer to a const HIC_DC_Point.
color – A pointer to a const HIC_RGBAS32.
-
void HIC_Draw_DC_Polymarker(HIC_Rendition *nr, int count, HIC_DC_Point point[], float *rotations, float *size_fixups)
This function draws a polymarker.
- Parameters
nr – A pointer to a const HIC_Rendition.
count – An int.
point – An array of const HIC_DC_Point.
rotations – A pointer to a const float.
size_fixups – A pointer to a const float.
-
void HIC_Draw_DC_Colorized_Polymarker(HIC_Rendition *nr, int count, HIC_DC_Point point[], HIC_RGBAS32 *colors, int single, float *rotations, float *size_fixups)
This function draws a polymarker using passed in color values instead of rendition colors.
- Parameters
nr – A pointer to a const HIC_Rendition.
count – An int representing the number of points in the HIC_DC_Point array.
point – An array of const HIC_DC_Point.
colors – A pointer to a const HIC_RGBAS32.
single – A boolean.
rotations – A pointer to a const float.
size_fixups – A pointer to a const float.
-
void HIC_Draw_DC_Polydot(HIC_Rendition *nr, int count, HIC_DC_Point points[])
This function draws a polydot.
- Parameters
nr – A pointer to a const HIC_Rendition.
count – An int.
points – An array of const HIC_DC_Point.
-
void HIC_Draw_DC_Colorized_Polydot(HIC_Rendition *nr, int count, HIC_DC_Point points[], HIC_RGBAS32 *colors, int single)
This function draws a polydot using passed in color values instead of rendition colors.
- Parameters
nr – A pointer to a const HIC_Rendition.
count – An int.
points – An array of const HIC_DC_Point.
colors – A pointer to a const HIC_RGBAS32.
single – A boolean.
-
void HIC_Draw_DC_Polyline(HIC_Rendition *nr, int count, HIC_DC_Point points[])
This function draws a polyline.
- Parameters
nr – A pointer to a const HIC_Rendition.
count – An int.
points – An array of const HIC_DC_Point.
-
void HIC_Draw_DC_Colorized_Polyline(HIC_Rendition *nr, int count, HIC_DC_Point points[], HIC_RGBAS32 color[], int single)
This function draws a polyline using passed in color values instead of the rendition colors.
See also
HIC_Draw_DC_Polyline, HIC_Draw_DC_Edges
- Parameters
nr – A pointer to a const HIC_Rendition.
count – An int.
points – An array of const HIC_DC_Point.
color – A pointer to a const HIC_RGBAS32.
single – A boolean.
-
void HIC_Draw_DC_Gouraud_Polyline(HIC_Rendition *nr, int count, HIC_DC_Point points[], HIC_RGBAS32 colors[])
This function draws a gouraud polyline.
- Parameters
nr – A pointer to a const HIC_Rendition.
count – An int.
points – An array of const HIC_DC_Point.
colors – A pointer to a const HIC_RGBAS32.
-
void HIC_Draw_DC_Phong_Polyline(HIC_Rendition *nr, int count, HIC_DC_Point points[], HIC_RGBA colors[], HIC_Plane planes[], HIC_DPlane dplanes[], HIC_Point worlds[], HIC_DPoint dworlds[])
This function draws a phong polyline.
- Parameters
nr – A pointer to a const HIC_Rendition.
count – An int.
points – An array of const HIC_DC_Point.
colors – A pointer to a const HIC_RGBA.
planes – A pointer to a const HIC_Plane.
-
void HIC_Draw_DC_Textured_Polyline(HIC_Rendition *nr, int count, HIC_DC_Point points[], HIC_RGBA colors[], HIC_Plane planes[], HIC_DPlane dplanes[], HIC_Point worlds[], HIC_DPoint dworlds[], float params[], int param_width, HIC_Integer32 param_flags)
This function draws a textured polyline.
- Parameters
nr – A pointer to a const HIC_Rendition.
count – An int.
points – An array of const HIC_DC_Point.
colors – A pointer to a const HIC_RGBA.
planes – A pointer to a const HIC_Plane.
params – A pointer to a const float.
param_width – An int.
param_flags – A HIC_Integer32.
-
void HIC_Draw_DC_Triangle(HIC_Rendition *nr, HIC_DC_Point points[])
This function draws a triangle using passed in color values instead of the rendition colors.
- Parameters
nr – A pointer to a const HIC_Rendition.
points – A pointer to a const HIC_DC_Point.
-
void HIC_Draw_DC_Colorized_Triangle(HIC_Rendition *nr, HIC_DC_Point points[], HIC_RGBAS32 color[])
This function draws a triangle using passed in color values instead of the rendition colors.
- Parameters
nr – A pointer to a const HIC_Rendition.
points – A pointer to a const HIC_DC_Point.
color – A pointer to a const HIC_RGBAS32.
-
void HIC_Draw_DC_Gouraud_Triangle(HIC_Rendition *nr, HIC_DC_Point points[], HIC_RGBAS32 colors[])
This function draws a filled triangle using the face pattern and face contrast color attributes with color interpolated from the vertex colors.
- Parameters
nr – A pointer to a const HIC_Rendition.
points – A pointer to a const HIC_DC_Point.
colors – A pointer to a const HIC_RGBAS32.
-
void HIC_Draw_DC_Reshaded_Triangle(HIC_Rendition *nr, HIC_DC_Point points[], HIC_RGBA colors[], HIC_Plane planes[], HIC_Parameter params[], int param_width, HIC_Integer32 param_flags)
This function draws a filled triangle with color interpolated at each pixel using the face pattern and face contrast color attributes.
- Parameters
nr – A pointer to a const HIC_Rendition.
points – A pointer to a const HIC_DC_Point.
colors – A pointer to a const HIC_RGBA.
planes – A pointer to a const HIC_Plane.
params – A pointer to a const HIC_Parameter.
param_width – An int.
param_flags – A HIC_Integer32.
-
void HIC_Draw_DC_Dot(HIC_Rendition *nr, HIC_DC_Point *point)
This function draws one pixel whose color is the line color.
- Parameters
nr – A pointer to a const HIC_Rendition.
point – A pointer to a const HIC_DC_Point.
-
void HIC_Draw_DC_Ellipse(HIC_Rendition *nr, HIC_DC_Point *where, HIC_DC_Point *radius)
This function draws a filled ellipse.
- Parameters
nr – A pointer to a const HIC_Rendition.
where – A pointer to a const HIC_DC_Point.
radius – A pointer to a const HIC_DC_Point.
-
void HIC_Draw_DC_Elliptical_Arc(HIC_Rendition *nr, HIC_DC_Point *where, HIC_DC_Point *radius, float start, float end)
This function draws an elliptical arc.
- Parameters
nr – A pointer to a const HIC_Rendition.
where – A pointer to a const HIC_DC_Point.
radius – A pointer to a const HIC_DC_Point.
start – A float.
end – A float.
-
void HIC_Draw_DC_Face(HIC_Rendition *nr, int count, HIC_DC_Point points[])
This function draws a face.
- Parameters
nr – A pointer to a const HIC_Rendition.
count – An int, the number of points in the array of vertices which define a polygon.
points – A pointer to a const HIC_DC_Point.
-
void HIC_Draw_DC_Colorized_Face(HIC_Rendition *nr, int count, HIC_DC_Point points[], HIC_RGBAS32 color[])
This function draws a face using passed in color values instead of rendition colors.
- Parameters
nr – A pointer to a const HIC_Rendition.
count – An int.
points – A pointer to a const HIC_DC_Point.
color – A pointer to a const HIC_RGBAS32.
-
void HIC_Draw_DC_Image(HIC_Rendition *nr, HIC_DC_Point *start, HIC_DC_Point *end, int hoffset, HIC_Image_Format format, int row_bytes, void **rasters, int pattern, HIC_Driver_Color *contrast_color, HIC_Image *db_image)
This device-independent function draws the entire image stored in the data block and does not provide for Z-buffering tilted images.
- Parameters
nr – A pointer to a const HIC_Rendition.
start – A pointer to a const HIC_DC_Point, may be off-screen.
end – A pointer to a const HIC_DC_Point.
hoffset – An int.
format – A HIC_Image_Format.
row_bytes – An int.
rasters – A const void pointer that depends on the format of the image.
pattern – An int.
contrast_color – A pointer to a const HIC_Driver_Color.
db_image – A pointer to a const HIC_Image.
-
void HIC_Draw_DC_Image_Block(HIC_Rendition *nr, HIC_DC_Point *strt, int wdth, int hite, HIC_Image_Format frmt, int rowbytes, void *image_block)
This device-independent function draws the entire image stored in the data block and does not provide for Z-buffering tilted images. limited to RGB24 RGBA32 RGBAS32 image blocks
- Parameters
nr – A pointer to a const HIC_Rendition.
strt – A HIC_DC_Point pointer which may be off-screen.
wdth – An int.
hite – An int.
frmt – A HIC_Image_Format.
rowbytes – An int.
image_block – A const void pointer.
-
void HIC_Draw_DC_Image_Block_Z(HIC_Rendition *nr, HIC_DC_Point *strt, int wdth, int hite, HIC_Image_Format frmt, int rowbytes, void *image_block, HIC_Image_Format z_format, int z_rowbytes, void *z_image_block)
This device-independent function draws the entire image stored in the data block and z image block. limited to RGB24 RGBA32 RGBAS32 image blocks and DEPTH16 DEPTH32 DEPTH_FLOAT32 z image blocks.
- Parameters
nr – A pointer to a const HIC_Rendition.
strt – A HIC_DC_Point pointer which may be off-screen.
wdth – An int.
hite – An int.
frmt – A HIC_Image_Format.
rowbytes – An int.
image_block – A const void pointer to the image data.
z_format – A HIC_Image_Format.
z_rowbytes – An int.
z_image_block – A const void pointer to the z image data.
-
void HIC_Draw_DC_Polygon(HIC_Rendition *nr, int count, HIC_DC_Point points[])
This function draws a filled polygon with edge.
See also
HIC_Insert_Polygon, HIC_Draw_3D_Polygon
- Parameters
nr – A pointer to a const HIC_Rendition.
count – An int, one greater than the number of polygon vertices.
points – A pointer to a const HIC_DC_Point.
-
void HIC_Draw_DC_Outline_Ellipse(HIC_Rendition *nr, HIC_DC_Point *where, HIC_DC_Point *radius)
This function draws an ellipse outline (closed curve).
- Parameters
nr – A pointer to a const HIC_Rendition.
where – A pointer to a const HIC_DC_Point.
radius – A pointer to a const HIC_DC_Point.
-
void HIC_Draw_DC_Rectangle(HIC_Rendition *nr, int left, int right, int bottom, int top)
This function draws a filled rectangle using face color, pattern, and contrast color attributes. The rectangle is aligned with the device coordinate axes. HOOPS uses this function to fill windows after replacing face with window attributes.
- Parameters
nr – A pointer to a const HIC_Rendition.
left – An int.
right – An int.
bottom – An int.
top – An int.
-
void HIC_Draw_DC_Stenciled_Quad(HIC_Rendition *nr, HIC_DC_Point points[], HIC_Stencil_Bitmap *stencil)
This function draws a stenciled quad.
- Parameters
nr – A pointer to a const HIC_Rendition.
points – A pointer to a const HIC_DC_Point.
stencil – A pointer to a const HIC_Stencil_Bitmap.
-
void HIC_Draw_Text(HIC_Rendition *nr, HIC_Text_Info *ti)
Reconciles the text attributes in the rendition with the capabilities of the requested font and completes the computations to draw the text. Applies the per-character transformations and the atmospheric attenuation when called for in the rendition. Specified font may be replaced by a stroked font if it doesn’t permit called for transformations. If text is drawn in a hardware font, the window system, or the driver, a driver-level method is called otherwise the text is stroked out.
- Parameters
nr – A pointer to a const HIC_Rendition.
ti – A pointer to a const HIC_Text_Info.
-
void HIC_Draw_DC_Text(HIC_Rendition *nr, HIC_DC_Point *where, int count, HIC_Karacter kstring[])
This function draws text.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
where – An array of const HIC_DC_Point.
count – An int.
kstring – A pointer to a const HIC_Karacter.
-
void HIC_Draw_Simple_Text(HIC_Rendition *nr, HIC_DC_Point *where, char *text)
This function draws simple text for purposes such as debugging.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
where – A pointer to a const HIC_DC_Point.
text – A null-terminated string containing the text to be drawn.
-
void HIC_Draw_Segment(HIC_Rendition *nr, HIC_Segment_Info *si)
This function draws geometry defined in the segment and its subsegments.
- Parameters
nr – A pointer to a const HIC_Rendition.
si – A pointer to a const HIC_Segment_Info.
-
void HIC_Draw_Window(HIC_Rendition *nr, HIC_Int_Rectangle *extent)
This function fills the intersection of the rectangle specified by extent and the current clipping rectangle with the pattern determined by window color, pattern and contrast color.
- Parameters
nr – A pointer to a const HIC_Rendition.
extent – A pointer to a const HIC_Int_Rectangle.
-
void HIC_Draw_Window_Frame(HIC_Rendition *nr, HIC_Int_Rectangle *extent, HIC_Int_Rectangle *frame, int calculate_only)
This function draws a frame of concentric rectangles using two solid polylines where the weight of the lines and the space between them is the device’s default line weight.
- Parameters
nr – A pointer to a const HIC_Rendition.
extent – A pointer to a const HIC_Int_Rectangle. Specifies extents of frame around window.
frame – A pointer to a HIC_Int_Rectangle.
calculate_only – A boolean. If true the function draws nothing, otherwise draws specified frame.
-
int HIC_Driver_Get_Window_Width(HIC_Rendition *nr)
The behavior of this function is driver and platform specific. This function returns the window width as an int.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
An int.
-
int HIC_Driver_Get_Window_Height(HIC_Rendition *nr)
The behavior of this function is driver and platform specific. This function returns the window height as an int.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
An int.
-
int HIC_Driver_Is_Double_Buffering(HIC_Rendition *nr)
The behavior of this function is driver and platform specific. This function returns a boolean which is true if double buffering is in effect, false if double buffering is not in effect.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A boolean, true if double buffering is in effect, otherwise false.
-
void *HIC_Driver_Get_HDC(HIC_Rendition *nr)
This function gets the HDC associated with the current driver. The behavior of this function is driver and platform specific.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A void pointer.
-
int HIC_Driver_Tristrip_Has_Valid_DL(HIC_Rendition *nr, HIC_Tristrip *ts)
The behavior of this function is driver and platform specific. This function returns a boolean which is true if driver tristrip has a valid display list, false if driver tristrip has an invalid display list.
- Parameters
nr – A pointer to a const HIC_Rendition.
ts – A pointer to a const HIC_Tristrip.
- Returns
A boolean, true if tristrip has valid display list, otherwise false.
-
void HIC_Driver_glActiveTextureARB(HIC_Rendition *nr, int number)
The behavior of this function is driver and platform specific. This is only valid with opengl driver and corresponds to the gl call ActiveTextureARB.
- Parameters
nr – A pointer to a const HIC_Rendition.
number – An int.
-
void HIC_Driver_ENSURE_ALPHA_TEST_ON(HIC_Rendition *nr, int number)
The behavior of this function is driver and platform specific.
- Parameters
nr – A pointer to a const HIC_Rendition.
number – An int.
-
void HIC_Driver_ENSURE_ALPHA_TEST_OFF(HIC_Rendition *nr, int number)
The behavior of this function is driver and platform specific.
- Parameters
nr – A pointer to a const HIC_Rendition.
number – An int.
-
void HIC_Driver_ENSURE_TEXTURES_ON(HIC_Rendition *nr, int number)
The behavior of this function is driver and platform specific.
- Parameters
nr – A pointer to a const HIC_Rendition.
number – An int.
-
void HIC_Driver_ENSURE_TEXTURES_OFF(HIC_Rendition *nr, int number)
The behavior of this function is driver and platform specific.
- Parameters
nr – A pointer to a const HIC_Rendition.
number – An int.
-
void HIC_Driver_FORCE_TEXTURE_GEN_OFF(HIC_Rendition *nr, int number)
The behavior of this function is driver and platform specific.
- Parameters
nr – A pointer to a const HIC_Rendition.
number – An int.
-
void HIC_Driver_Bind_Image_As_Texture(HIC_Rendition *nr, HIC_Image *image)
The behavior of this function is driver and platform specific.
- Parameters
nr – A pointer to a const HIC_Rendition.
image – A pointer to const HIC_Image.
-
void HIC_Driver_Show_Projection_Matrix(HIC_Rendition *nr, float matrix[])
-
void HIC_Driver_Draw_Clear_Window(HIC_Rendition *nr, HIC_Int_Rectangle *extent)
-
long HIC_Driver_Get_Surface(HIC_Rendition *nr, int index)
This function returns the surface pointer for the driver. Currently only valid with the DX9 driver.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A HC_POINTER_SIZED_INT.
-
void HIC_Init_Picture(HIC_Rendition *nr)
- Parameters
nr – A pointer to a const HIC_Rendition. This function can be used to do whatever driver-specific pre-update maintenance might be required
-
void HIC_Finish_Picture(HIC_Rendition *nr, int swap_buffers)
This function can be used to make direct opengl or gdi calls to capture the results of a render.
- Parameters
nr – A pointer to a const HIC_Rendition.
swap_buffers – A boolean. If true, function called once, otherwise called multiple times per frame if the hidden surface removal algorithm is “fast hlr”.
-
HIC_Convex_Clip_Region *HIC_New_Convex_Clip_Region(HIC_Rendition *nr, long ncnt, HIC_DC_Point npts[])
This function creates a convex clip region.
- Parameters
nr – A pointer to a const HIC_Rendition.
ncnt – An int.
npts – A pointer to a const HIC_DC_Point.
- Returns
A pointer to a const HIC_Convex_Clip_Region.
-
void HIC_Free_Convex_Clip_Region(HIC_Convex_Clip_Region *ccr)
This function frees the memory associated with a convex clip region.
- Parameters
ccr – A pointer to a const Convex_Clip_Region.
-
void HIC_Set_Convex_Clip_Region(HIC_Rendition *nr, HIC_Convex_Clip_Region *ccr)
This function sets the convex clip region.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
ccr – A pointer to a const HIC_Convex_Clip_Region.
-
HIC_Polygonal_Clip_Region *HIC_New_Polygonal_Clip_Region(HIC_Rendition *nr, long ncnt, HIC_DC_Point npts[])
This function creates a polygonal clip region.
- Parameters
nr – A pointer to a const HIC_Rendition.
ncnt – An int.
npts – A pointer to a const HIC_DC_Point.
- Returns
A pointer to a const HIC_Polygonal_Clip_Region.
-
void HIC_Free_Polygonal_Clip_Region(HIC_Polygonal_Clip_Region *pcr)
This function frees the memory associated with a polygonal clip region.
- Parameters
pcr – A pointer to a const Polygonal_Clip_Region.
-
void HIC_Set_Polygonal_Clip_Region(HIC_Rendition *nr, HIC_Polygonal_Clip_Region *pcr)
This function sets the polygonal clip region.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
ccr – A pointer to a const HIC_Polygonal_Clip_Region.
-
HIC_Complex_Clip_Region *HIC_New_Complex_Clip_Region(HIC_Rendition *nr, long nloops, int nlengths[], HIC_DC_Point npts[])
This function creates a complex clip region.
- Parameters
nr – A pointer to a const HIC_Rendition.
ncnt – An int.
npts – A pointer to a const HIC_DC_Point.
- Returns
A pointer to a const HIC_Complex_Clip_Region.
-
void HIC_Free_Complex_Clip_Region(HIC_Complex_Clip_Region *ccr)
This function frees the memory associated with a complex clip region.
- Parameters
ccr – A pointer to a const Complex_Clip_Region.
-
void HIC_Set_Complex_Clip_Region(HIC_Rendition *nr, HIC_Complex_Clip_Region *ccr)
This function sets the complex clip region.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
ccr – A pointer to a const HIC_Complex_Clip_Region.
-
void HIC_Free_Geometry(HIC_Geometry *pointer)
This function frees the memory associated with a geometry data structure.
- Parameters
pointer – A pointer to a HIC_Geometry.
-
HIC_Tristrip *HIC_New_Tristrip(HIC_Tristrip *ts)
This function creates a tristrip data structure.
See also
- Parameters
ts – A pointer to a HIC_Tristrip.
- Returns
A pointer to a const HIC_Tristrip.
-
void HIC_Free_Tristrip(HIC_Tristrip *ts)
This function frees the memory associated with a tristrip data structure.
- Parameters
ts – A pointer to a HIC_Tristrip.
-
HIC_Polyedge *HIC_New_Polyedge(HIC_Polyedge *pe)
This function creates a polyedge data structure.
- Parameters
pe – A pointer to a HIC_Polyedge.
- Returns
A pointer to a const HIC_Polyedge.
-
void HIC_Free_Polyedge(HIC_Polyedge *pe)
This function frees the memory associated with a polyedge data structure.
- Parameters
pe – A pointer to a HIC_Polyedge.
-
HIC_Polymarker *HIC_New_Polymarker(HIC_Polymarker *pm)
This function creates a polymarker data structure.
- Parameters
pm – A pointer to a HIC_Polymarker.
- Returns
A pointer to a const HIC_Polymarker.
-
void HIC_Free_Polymarker(HIC_Polymarker *pm)
This function frees the memory associated with a polymarker data structure.
- Parameters
pm – A pointer to a HIC_Polymarker.
-
HIC_Marker *HIC_New_Marker(HIC_Point *point)
This function allocates a marker descriptor structure.
- Parameters
point – A pointer to a const HIC_Point.
- Returns
A pointer to a const HIC_Marker.
-
HIC_Polyline *HIC_New_Polyline(int count, HIC_Point points[])
This function allocates a polyline descriptor structure.
- Parameters
count – An int.
points – A pointer to a HIC_Point.
- Returns
A pointer to a const HIC_Polyline.
-
HIC_Polygon *HIC_New_Polygon(int count, HIC_Point points[])
This function allocates a polygon descriptor structure.
- Parameters
count – An int.
points – A pointer to a HIC_Point.
- Returns
A pointer to a const HIC_Polygon.
-
HIC_Rendition *HIC_New_Rendition(HIC_Rendition *nr)
This function creates a new rendition.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A pointer to a const HIC_Rendition.
-
void HIC_Free_Rendition(HIC_Rendition *nr)
This function destroys the rendition and frees the memory allocated for it.
- Parameters
nr – A pointer to a const HIC_Rendition.
-
HIC_Segment_Path *HIC_Show_Segment_Path(HIC_Rendition *nr)
This function returns an array of keys which specifies the complete draw path.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A pointer to a const HIC_Segment_Path.
-
void HIC_Free_Segment_Path(HIC_Segment_Path *sp)
This function frees memory associated with a segment path.
- Parameters
sp – A pointer to a const HIC_Segment_Path.
-
HIC_Stencil_Bitmap *HIC_New_Stencil_Bitmap(HIC_Rendition *nr, int nw, int nh, int bpr, int bpp, unsigned char *bm)
This function creates a stencil bitmap.
- Parameters
nr – A pointer to a const HIC_Rendition.
nw – An int.
nh – An int.
bpr – An int.
bpp – An int.
bm – A pointer to an unsigned char.
- Returns
A pointer to a const HIC_Stencil_Bitmap.
-
void HIC_Free_Stencil_Bitmap(HIC_Rendition *nr, HIC_Stencil_Bitmap *stencil)
This function frees memory associated with a stencil bitmap.
- Parameters
nr – A pointer to a const HIC_Rendition.
stencil – A pointer to a const HIC_Stencil_Bitmap.
-
HIC_Text_Info *HIC_New_Text_Info(HIC_Text_Info *text_info)
This function creates new text info.
- Parameters
text_info – A pointer to a const HIC_Text_Info.
- Returns
A pointer to a const HIC_Text_Info.
-
void HIC_Free_Text_Info(HIC_Text_Info *text_info)
This function frees the memory associated with a text info structure.
- Parameters
text_info – A pointer to a const HIC_Text_Info.
-
void HIC_Draw_DC_Polytriangle(HIC_Rendition *nr, int count, HIC_DC_Point points[])
This function draws a polytriangle.
- Parameters
nr – A pointer to a const HIC_Rendition.
count – An int.
points – An array of const HIC_DC_Point.
-
void HIC_Draw_DC_Colorized_Polytriangle(HIC_Rendition *nr, int count, HIC_DC_Point points[], HIC_RGBAS32 color[], int single)
This function draws a polytriangle using passed in color values instead of the rendition colors.
- Parameters
nr – A pointer to a const HIC_Rendition.
count – An int.
points – An array of const HIC_DC_Point.
color – A pointer to a const HIC_RGBAS32.
single – A boolean.
-
void HIC_Draw_DC_Gouraud_Polytriangle(HIC_Rendition *nr, int count, HIC_DC_Point points[], HIC_RGBAS32 colors[])
This function draws a gouraud polytriangle.
- Parameters
nr – A pointer to a const HIC_Rendition.
count – An int.
points – An array of const HIC_DC_Point.
colors – A pointer to a const HIC_RGBAS32.
-
void HIC_Draw_DC_Phong_Polytriangle(HIC_Rendition *nr, int count, HIC_DC_Point points[], HIC_RGBA colors[], HIC_Plane planes[], HIC_DPlane dplanes[], HIC_Point worlds[], HIC_DPoint dworlds[])
This function draws a phong polytriangle.
- Parameters
nr – A pointer to a const HIC_Rendition.
count – An int.
points – An array of const HIC_DC_Point.
colors – A pointer to a const HIC_RGBA.
planes – An pointer to a const HIC_Plane.
-
void HIC_Draw_DC_Textured_Polytriangle(HIC_Rendition *nr, int count, HIC_DC_Point points[], HIC_RGBA colors[], HIC_Plane planes[], HIC_DPlane dplanes[], HIC_Point worlds[], HIC_DPoint dworlds[], float params[], int param_width, HIC_Integer32 param_flags, float params_alt[], int param_alt_width, HIC_Integer32 param_alt_flags)
This function draws a textured polytriangle.
- Parameters
nr – A pointer to a const HIC_Rendition.
count – An int.
points – An array of const HIC_DC_Point.
colors – A pointer to a const HIC_RGBA.
planes – A pointer to a const HIC_Plane.
params – A pointer to a const float.
param_width – An int.
param_flags – A HIC_Integer32.
-
HIC_User_Face_Pattern *HIC_New_User_Face_Pattern(HIC_Rendition *nr, int nrows, int ncols, unsigned char npat[], int nsee)
This function defines a custom face pattern.
- Parameters
nr – A pointer to a const HIC_Rendition.
nrows – An int. If negative, the pattern will be applied with the row order reversed from that of the stored character array.
ncols – An int.
npat – A static unsigned char.
nsee – A const int.
- Returns
A pointer to a const HIC_User_Face_Pattern.
-
void HIC_Free_User_Face_Pattern(HIC_User_Face_Pattern *upat)
This function releases the memory allocated for a user pattern.
- Parameters
upat – A pointer to a const HIC_User_Face_Pattern.
-
void HIC_Set_User_Face_Pattern(HIC_Rendition *nr, HIC_User_Face_Pattern *upat)
This function sets a user face pattern.
- Parameters
nr – A pointer to a const HIC_Rendition.
upat – A pointer to a const HIC_User_Face_Pattern.
-
HIC_Line_Style *HIC_New_User_Line_Pattern(HIC_Rendition *nr, long nlen, void *npat)
This function creates a new user line pattern.
- Parameters
nr – A pointer to a const HIC_Rendition.
nlen – A long.
npat – A void pointer.
- Returns
A pointer to a HIC_Line_Style.
-
HIC_Line_Style *HIC_New_User_Line_Pattern2(HIC_Rendition *nr, long nlen, void *npat, long abs)
This function creates a new user line pattern, using integers to describe the pattern.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
nlen – A long.
npat – A void pointer.
abs – A long.
- Returns
A pointer to a HIC_Line_Style.
-
void HIC_Free_User_Line_Pattern(HIC_Line_Style *upat)
This function frees memory associated with a user line pattern.
See also
- Parameters
upat – A pointer to a const HIC_Line_Style.
-
HIC_Polyhedron *HIC_New_User_Shell(int point_count, HIC_Point points[], HIC_Vector normals[], int face_list_length, int face_list[])
This function allocates memory associated with a polyhedron data structure.
- Parameters
point_count – An int representing the number of points in the points array.
points – A pointer to a const HIC_Point.
normals – A pointer to a const HIC_Vector.
face_list_length – An int.
face_list – A pointer to an int.
- Returns
A pointer to a const HIC_Polyhedron.
-
void HIC_Free_User_Shell(HIC_Polyhedron *user_shell)
This function frees memory associated with a polyhedron data structure.
- Parameters
user_shell – A pointer to a const HIC_Polyhedron.
-
void HIC_Get_Bounding_Cuboid(HIC_Segment_Info *si, HIC_Bounding_Cuboid *bounding)
This function returns the bounding cuboid.
- Parameters
si – A pointer to a const HIC_Segment_Info.
bounding – A pointer to HIC_Bounding_Cuboid.
-
long HIC_Get_Geometry_Key(HIC_Geometry *geo)
This function returns the geometry key.
- Parameters
geo – A pointer to a const HIC_Polyhedron.
- Returns
A HC_KEY.
-
void *HIC_Get_Image_Block(HIC_Image *image)
This function gets the image block data pointer.
- Parameters
image – A pointer to a const HIC_Image.
-
HIC_Geometry *HIC_Key_To_Geometry_Pointer(HIC_Rendition *nr, long key)
This function returns a pointer to geometry referred to by the passed in key parameter.
- Parameters
nr – A pointer to a const HIC_Rendition.
key – A HC_KEY.
- Returns
A pointer to a const HIC_Geometry.
-
int HIC_Partial_Erasing(HIC_Rendition *nr)
If the incremental update heuristic is enabled partial erasing is used to draw out objects deleted from the database. When partial erasing is in progress geometry items are drawn in the window color.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A boolean.
-
int HIC_Polyhedron_Face_Normals_Valid(HIC_Polyhedron *phon)
This function returns a boolean which is true if polyhedron face normals are valid and false if polyhedron face normals are invalid.
- Parameters
phon – A pointer to a const HIC_Polyhedron.
- Returns
A boolean, true if polyhedron face normals are valid and false if polyhedron face normals are invalid.
-
void HIC_Polyhedron_Assemble_Face_Normals(HIC_Polyhedron *phon)
This function assembles polyhedron face normals.
- Parameters
phon – A pointer to a const HIC_Polyhedron.
-
void HIC_Polyhedron_Generate_Face_List(HIC_Polyhedron *phon)
This function generates a polyhedron face list.
- Parameters
phon – A pointer to a const HIC_Polyhedron.
-
void HIC_Record_Selection(HIC_Rendition *nr, float xyoff, float bz, int off1, int off2, int off3)
This function enters an item into the current selection list.
- Parameters
nr – A pointer to a const HIC_Rendition.
xyoff – A float, representing the distance from the item to the locator position.
bz – A float, representing the z coordinate.
off1 – A int, representing the offset of the item from the locator position.
off2 – A int, representing the offset of the item from the locator position.
off3 – A int, representing the offset of the item from the locator position.
-
void HIC_Restrict_Clipping(HIC_Rendition *nr, long nleft, long nright, long nbottom, long ntop)
This function restricts the clipping rectangle using the passed in clipping limits.
- Parameters
nr – A pointer to a const HIC_Rendition.
nleft – An int.
nright – An int.
nbottom – An int.
ntop – An int.
-
void HIC_Select_Segment(HIC_Rendition *nr, HIC_Segment_Info *si)
This function selects a segment.
- Parameters
nr – A pointer to a const HIC_Rendition.
si – A pointer to a const HIC_Segment_Info.
-
void HIC_Select_Window(HIC_Rendition *nr, HIC_Geometry *wi)
This function selects a window.
- Parameters
nr – A pointer to a const HIC_Rendition.
wi – A pointer to a const HIC_Geometry.
-
void HIC_Select_Geometry(HIC_Rendition *nr, HIC_Geometry *geo)
This function checks the referenced database element against the current selection event.
- Parameters
nr – A pointer to a const HIC_Rendition.
geo – A pointer to a const HIC_Geometry.
-
HIC_Point *HIC_Show_Selection_Point(HIC_Rendition *nr)
This function returns the location the user was pointing at when the current selection traversal was triggered.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A pointer to a const HIC_Point.
-
HIC_Volume *HIC_Show_Selection_Volume(HIC_Rendition *nr)
This function returns selection volume.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A pointer to a const HIC_Volume.
-
float HIC_Show_Selection_Proximity_Sq(HIC_Rendition *nr)
This function returns selection proximity square as a float value.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A float.
-
HIC_Integer32 HIC_Show_Selection_Status(HIC_Rendition *nr)
This function returns selection status.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A HIC_Integer32.
-
int HIC_Show_Selection_Action(HIC_Rendition *nr)
This function returns the selection action.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
An int.
-
float HIC_Show_Face_Opacity(HIC_Rendition *inr)
This function returns face opacity as a float.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A float.
-
unsigned char HIC_Show_Face_DirectRGB_Red(HIC_Rendition *nr)
This function returns face direct rgb red as an unsigned char.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
An unsigned char.
-
unsigned char HIC_Show_Face_DirectRGB_Green(HIC_Rendition *nr)
This function returns face direct rgb green as an unsigned char.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
An unsigned char.
-
unsigned char HIC_Show_Face_DirectRGB_Blue(HIC_Rendition *nr)
This function returns face direct rgb blue as an unsigned char.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
An unsigned char.
-
unsigned char HIC_Show_Face_DirectRGB_Alpha(HIC_Rendition *nr)
This function returns face direct rgb alpha as an unsigned char.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
An unsigned char.
-
int HIC_Has_Face_Material(HIC_Rendition *nr)
This function returns true if the face has a material.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A bool.
-
int HIC_Face_Mat_Has_Enviro_Txr(HIC_Rendition *nr)
This function returns true if the face material has an environment texture.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A bool.
-
int HIC_Face_Mat_Has_Diffuse_Txr(HIC_Rendition *nr, int layer)
This function returns true if the face material has an diffuse texture on the specified layer.
- Parameters
nr – A pointer to a const HIC_Rendition and an integer index into the texture list.
- Returns
A bool.
-
void HIC_Face_Mat_Set_Diffuse_Txr_Tint(HIC_Rendition *nr, HIC_RGB *rgb)
This sets the tint on a face material diffuse texture.
- Parameters
nr – A pointer to a const HIC_Rendition
rgb – A pointer to a HIC_RGB, a structure of three floats, each between zero and one.
-
float HIC_Show_Face_Mat_Mirror_Txr_R(HIC_Rendition *nr)
This function returns the face material mirror red component.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A float.
-
float HIC_Show_Face_Mat_Mirror_Txr_G(HIC_Rendition *nr)
This function returns the face material mirror green component.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A float.
-
float HIC_Show_Face_Mat_Mirror_Txr_B(HIC_Rendition *nr)
This function returns the face material mirror green component.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A float.
-
float HIC_Show_Face_Mat_Opacity(HIC_Rendition *nr)
This function returns the face material opacity.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A float.
-
float HIC_Show_Face_Mat_Trans_R(HIC_Rendition *nr)
This function sets the face material transmission red component.
- Parameters
nr – A pointer to a const HIC_Rendition.
r – A float
-
float HIC_Show_Face_Mat_Trans_G(HIC_Rendition *nr)
This function sets the face material transmission green component.
- Parameters
nr – A pointer to a const HIC_Rendition.
r – A float
-
float HIC_Show_Face_Mat_Trans_B(HIC_Rendition *nr)
This function sets the face material transmission blue component.
- Parameters
nr – A pointer to a const HIC_Rendition.
r – A float
-
float HIC_Show_Current_Arc_Start(HIC_Rendition *nr)
This function returns the current arc start.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A float.
-
float HIC_Show_Current_Arc_End(HIC_Rendition *nr)
This function returns the current arc end.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A float.
-
int HIC_Show_Diffuse_Textures_Name_Length(HIC_Rendition *nr, int layer)
This function returns face material diffuse texture name length as an int.
- Parameters
nr – A pointer to a const HIC_Rendition and an integer index into the texture list.
- Returns
An unsigned char.
-
char *HIC_Show_Diffuse_Textures_Name_Text(HIC_Rendition *nr, int layer)
This function returns face material diffuse texture name text as a pointer to a const char.
- Parameters
nr – A pointer to a const HIC_Rendition and an integer index into the texture list.
- Returns
An unsigned char.
-
int HIC_Show_Diffuse_Texture_Source_Name_Length(HIC_Rendition *nr, int layer)
This function returns face material diffuse texture texture component name length as an int.
- Parameters
nr – A pointer to a const HIC_Rendition and an integer index into the texture list.
- Returns
An unsigned char.
-
char *HIC_Show_Diffuse_Texture_Source_Name_Text(HIC_Rendition *nr, int layer)
This function returns face material diffuse texture texture component name text as a pointer to a const char.
- Parameters
nr – A pointer to a const HIC_Rendition and an integer index into the texture list.
- Returns
An unsigned char.
-
int HIC_Show_Mirroring(HIC_Rendition *inr)
This function returns mirroring as a boolean.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A float.
-
HIC_Segment *HIC_Get_Geometry_Owner(HIC_Geometry *geo)
This function returns the geometry owner.
- Parameters
geo – A pointer to a const HIC_Geometry.
- Returns
A pointer to a const HIC_Segment.
-
void HIC_Set_Attribute_Locks(HIC_Rendition *nr, HIC_Attributes attribute_locks)
This function locks the attribute(s).
- Parameters
nr – A pointer to a const HIC_Rendition.
attribute_locks – A HIC_Attributes, one or more of which work together.
-
HIC_Attribute_Locks HIC_Show_Attribute_Locks(HIC_Rendition *nr)
This function returns the attribute locks.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A HIC_Attribute_Locks.
-
void HIC_Set_Clipping(HIC_Rendition *nr, long nleft, long nright, long nbottom, long ntop)
This function sets the hard clip limit attributes.
- Parameters
nr – A pointer to a const HIC_Rendition.
nleft – An int.
nright – An int.
nbottom – An int.
ntop – An int.
-
HIC_Int_Rectangle *HIC_Show_Clipping(HIC_Rendition *nr)
This function returns the clipping rectangle.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A pointer to a HIC_Int_Rectangle.
-
void HIC_UnSet_Clipping_Not_Needed(HIC_Rendition *nr)
This function clears the ‘clipping not needed’ flag.
- Parameters
nr – A pointer to a const HIC_Rendition. This should be a new rendition created by HIC_New_Rendition.
-
void HIC_Set_Color_Front_Locks(HIC_Rendition *nr, HIC_Color_Lock_Objects material_color_locks)
This function locks the color front attribute.
- Parameters
nr – A pointer to a const HIC_Rendition.
material_color_locks – A HIC_Color_Lock_Objects.
-
void HIC_Set_Color_Back_Locks(HIC_Rendition *nr, HIC_Color_Lock_Objects material_color_locks)
This function locks the color back attribute.
- Parameters
nr – A pointer to a const HIC_Rendition.
material_color_locks – A HIC_Color_Lock_Objects.
-
void HIC_Set_Color_Face_Contrast_Locks(HIC_Rendition *nr, HIC_Color_Lock_Objects material_color_locks)
This function locks the color face contrast attribute.
- Parameters
nr – A pointer to a const HIC_Rendition.
material_color_locks – A HIC_Color_Lock_Objects.
-
void HIC_Set_Color_Edge_Locks(HIC_Rendition *nr, HIC_Color_Lock_Objects material_color_locks)
This function locks the color edge attribute.
- Parameters
nr – A pointer to a const HIC_Rendition.
material_color_locks – A HIC_Color_Lock_Objects.
-
void HIC_Set_Color_Edge_Contrast_Locks(HIC_Rendition *nr, HIC_Color_Lock_Objects material_color_locks)
This function locks the color edge contrast attribute.
- Parameters
nr – A pointer to a const HIC_Rendition.
material_color_locks – A HIC_Color_Lock_Objects.
-
void HIC_Set_Color_Line_Locks(HIC_Rendition *nr, HIC_Color_Lock_Objects material_color_locks)
This function locks the color line attribute.
- Parameters
nr – A pointer to a const HIC_Rendition.
material_color_locks – A HIC_Color_Lock_Objects.
-
void HIC_Set_Color_Line_Contrast_Locks(HIC_Rendition *nr, HIC_Color_Lock_Objects material_color_locks)
This function locks the color line contrast attribute.
- Parameters
nr – A pointer to a const HIC_Rendition.
material_color_locks – A HIC_Color_Lock_Objects.
-
void HIC_Set_Color_Marker_Locks(HIC_Rendition *nr, HIC_Color_Lock_Objects material_color_locks)
This function locks the color marker attribute.
- Parameters
nr – A pointer to a const HIC_Rendition.
material_color_locks – A HIC_Color_Lock_Objects.
-
void HIC_Set_Color_Marker_Contrast_Locks(HIC_Rendition *nr, HIC_Color_Lock_Objects material_color_locks)
This function locks the color marker contrast attribute.
- Parameters
nr – A pointer to a const HIC_Rendition.
material_color_locks – A HIC_Color_Lock_Objects.
-
void HIC_Set_Color_Vertex_Locks(HIC_Rendition *nr, HIC_Color_Lock_Objects material_color_locks)
This function locks the color vertex attribute.
- Parameters
nr – A pointer to a const HIC_Rendition.
material_color_locks – A HIC_Color_Lock_Objects.
-
void HIC_Set_Color_Vertex_Contrast_Locks(HIC_Rendition *nr, HIC_Color_Lock_Objects material_color_locks)
This function locks the color vertex contrast attribute.
- Parameters
nr – A pointer to a const HIC_Rendition.
material_color_locks – A HIC_Color_Lock_Objects.
-
void HIC_Set_Color_Text_Locks(HIC_Rendition *nr, HIC_Color_Lock_Objects material_color_locks)
This function locks the color text attribute.
- Parameters
nr – A pointer to a const HIC_Rendition.
material_color_locks – A HIC_Color_Lock_Objects.
-
void HIC_Set_Color_Text_Contrast_Locks(HIC_Rendition *nr, HIC_Color_Lock_Objects material_color_locks)
This function locks the color text contrast attribute.
- Parameters
nr – A pointer to a const HIC_Rendition.
material_color_locks – A HIC_Color_Lock_Objects.
-
void HIC_Set_Color_Window_Locks(HIC_Rendition *nr, HIC_Color_Lock_Objects material_color_locks)
This function locks the color window attribute.
- Parameters
nr – A pointer to a const HIC_Rendition.
material_color_locks – A HIC_Color_Lock_Objects.
-
void HIC_Set_Color_Window_Contrast_Locks(HIC_Rendition *nr, HIC_Color_Lock_Objects material_color_locks)
This function locks the color window contrast attribute.
- Parameters
nr – A pointer to a const HIC_Rendition.
material_color_locks – A HIC_Color_Lock_Objects.
-
void HIC_Set_Color_Cut_Face_Locks(HIC_Rendition *nr, HIC_Color_Lock_Objects material_color_locks)
This function locks the color cut face attribute.
- Parameters
nr – A pointer to a const HIC_Rendition.
material_color_locks – A HIC_Color_Lock_Objects.
-
void HIC_Set_Color_Cut_Edge_Locks(HIC_Rendition *nr, HIC_Color_Lock_Objects material_color_locks)
This function locks the color cut edge attribute.
- Parameters
nr – A pointer to a const HIC_Rendition.
material_color_locks – A HIC_Color_Lock_Objects.
-
void HIC_Set_Color_Locks(HIC_Rendition *nr, HIC_Color_Lock_Objects color_locks)
This function locks the color attribute.
- Parameters
nr – A pointer to a const HIC_Rendition.
color_locks – A HIC_Color_Lock_Objects.
-
HIC_Material_Color_Locks HIC_Show_Color_Front_Locks(HIC_Rendition *nr)
This function returns the color front locks.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A HIC_Material_Color_Locks.
-
HIC_Material_Color_Locks HIC_Show_Color_Back_Locks(HIC_Rendition *nr)
This function returns the color back locks.
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A HIC_Material_Color_Locks.
-
HIC_Material_Color_Locks HIC_Show_Color_Face_Contrast_Locks(HIC_Rendition *nr)
This function returns the color face contrast locks.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A HIC_Material_Color_Locks.
-
HIC_Material_Color_Locks HIC_Show_Color_Edge_Locks(HIC_Rendition *nr)
This function returns the color edge locks.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A HIC_Material_Color_Locks.
-
HIC_Material_Color_Locks HIC_Show_Color_Edge_Contrast_Locks(HIC_Rendition *nr)
This function returns the color edge contrast locks.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A HIC_Material_Color_Locks.
-
HIC_Material_Color_Locks HIC_Show_Color_Line_Locks(HIC_Rendition *nr)
This function returns the color line locks.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A HIC_Material_Color_Locks.
-
HIC_Material_Color_Locks HIC_Show_Color_Line_Contrast_Locks(HIC_Rendition *nr)
This function returns the color line contrast locks.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A HIC_Material_Color_Locks.
-
HIC_Material_Color_Locks HIC_Show_Color_Marker_Locks(HIC_Rendition *nr)
This function returns the color marker locks.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A HIC_Material_Color_Locks.
-
HIC_Material_Color_Locks HIC_Show_Color_Marker_Contrast_Locks(HIC_Rendition *nr)
This function returns the color marker contrast locks.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A HIC_Material_Color_Locks.
-
HIC_Material_Color_Locks HIC_Show_Color_Vertex_Locks(HIC_Rendition *nr)
This function returns the color vertex locks.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A HIC_Material_Color_Locks.
-
HIC_Material_Color_Locks HIC_Show_Color_Vertex_Contrast_Locks(HIC_Rendition *nr)
This function returns the color vertex contrast locks.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A HIC_Material_Color_Locks.
-
HIC_Material_Color_Locks HIC_Show_Color_Text_Locks(HIC_Rendition *nr)
This function returns the color text locks.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A HIC_Material_Color_Locks.
-
HIC_Material_Color_Locks HIC_Show_Color_Text_Contrast_Locks(HIC_Rendition *nr)
This function returns the color text contrast locks.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A HIC_Material_Color_Locks.
-
HIC_Material_Color_Locks HIC_Show_Color_Window_Locks(HIC_Rendition *nr)
This function returns the color window locks.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A HIC_Material_Color_Locks.
-
HIC_Material_Color_Locks HIC_Show_Color_Window_Contrast_Locks(HIC_Rendition *nr)
This function returns the color window contrast locks.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A HIC_Material_Color_Locks.
-
HIC_Material_Color_Locks HIC_Show_Color_Cut_Face_Locks(HIC_Rendition *nr)
This function returns the color cut face locks.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A HIC_Material_Color_Locks.
-
HIC_Material_Color_Locks HIC_Show_Color_Cut_Edge_Locks(HIC_Rendition *nr)
This function returns the color cut edge locks.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A HIC_Material_Color_Locks.
-
HIC_Color_Locks HIC_Show_Color_Locks(HIC_Rendition *nr)
This function returns the color locks.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A HIC_Color_Locks.
-
HIC_Visibility_Locks HIC_Show_Visibility_Locks(HIC_Rendition *nr)
This function returns the visibility locks.
See also
- Parameters
nr – A pointer to a const HIC_Rendition.
- Returns
A HIC_Visibility_Locks.
-
void HIC_Set_Visibility_Locks(HIC_Rendition *nr, HIC_Visibility visibility_locks)
This function locks the visibility.
- Parameters
nr – A pointer to a const HIC_Rendition.
visibility_locks – A HIC_Visibility_e, one or more of which work together.
-
void HIC_Set_Color_Map_Start(HIC_Rendition *nr, long strt)
This function sets the color map starting index.
- Parameters
nr – A pointer to a const HIC_Rendition.
strt – A HIC_Color_Index. XXX -missing type-
-
void HIC_Set_Line_Equal_Edge_Rendition(HIC_Rendition *nr)
This function sets the line rendition equal to the edge rendition.
- Parameters
nr – A pointer to a const HIC_Rendition.
-
void HIC_Set_Edge_Weight(HIC_Rendition *nr, int nweight)
This function changes the edge weight.
- Parameters
nr – A pointer to a const HIC_Rendition.
nweight – An int.
-
void HIC_Set_Variable_Edge_Weight(HIC_Rendition *nr, HIC_Size_Units nunits, float nweight)
This function changes the edge weight.
- Parameters
nr – A pointer to a const HIC_Rendition.
nunit – An HIC_Size_Units.
nweight – An float.
-
void HIC_Set_Edge_Pattern(HIC_Rendition *nr, char npattern)
This function changes the edge pattern.
- Parameters
nr – A pointer to a const HIC_Rendition.
npattern – A char.
-
void HIC_Set_Edge_Style(HIC_Rendition *nr, char *nname)
This function changes the edge style.
- Parameters
nr – A pointer to a const HIC_Rendition.
nname – A const char.
-
void HIC_Set_User_Edge_Pattern(HIC_Rendition *nr, HIC_Line_Style *upat)
This function sets the user edge pattern.
- Parameters
nr – A pointer to a const HIC_Rendition.
upat – A pointer to a const HIC_User_Line_Pattern.
-
void HIC_Set_Edge_Color(HIC_Rendition *nr, HIC_RGB *rgb)
This function changes the value of edge color.
- Parameters
nr – A pointer to a const HIC_Rendition.
rgb – A pointer to a HIC_RGB, a structure of three floats, each between zero and one.
-
void HIC_Set_Edge_Contrast_Color(HIC_Rendition *nr, HIC_RGB *rgb)
This function changes the edge contrast color.
- Parameters
nr – A pointer to a const HIC_Rendition.
rgb – A pointer to a HIC_RGB, a structure of three floats, each between zero and one.
-
void HIC_Set_Cut_Edge_Color(HIC_Rendition *nr, HIC_RGB *rgb)
This function changes the cut edge color.
- Parameters
nr – A pointer to a const HIC_Rendition.
rgb – A pointer to a HIC_RGB, a structure of three floats, each between zero and one.
-
void HIC_Set_Internal_Edge_Color(HIC_Rendition *nr, HIC_RGBAS32 internal)
This function changes the internal edge color.
- Parameters
nr – A pointer to a const HIC_Rendition.
internal – A HIC_RGBAS32.
-
void HIC_Set_Cut_Face_Color(HIC_Rendition *nr, HIC_RGB *rgb)
This function sets the cut face color.
- Parameters
nr – A pointer to a const HIC_Rendition.
rgb – A pointer to a const HIC_RGB, a structure of three floats, each between 0 and 1.
-
void HIC_Set_Face_Pattern(HIC_Rendition *nr, int npattern)
This function changes the face pattern to the passed in int value.
See also
HIC_New_User_Pattern
- Parameters
nr – A pointer to a const HIC_Rendition.
npattern – An int.
-
void HIC_Set_Face_Color(HIC_Rendition *nr, HIC_RGB *rgb)
This function changes the face color.
- Parameters
nr – A pointe