Graphics Manager

Retrieves the viewport id associated with the specified viewport.

Location for returned value.

Returns the success or failure of the routine.

Unrecoverable database error.

An unspecified database error occurred.

This function gets the view vector for the view.

The name of the viewport. ““ for the current viewport.

The three values of the view vector.

This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.

db_get_current_viewport_id	(id)

Description:
Retrieves the viewport id associated with the specified viewport.
Input:
None.
Output:
INTEGER	id	Location for returned value.
INTEGER	<Return Value>	Returns the success or failure of the routine.
Error Conditions:
13000002	Unrecoverable database error.
13000007	An unspecified database error occurred.

ga_view_normal_get	(viewport, vector)

Description:
This function gets the view vector for the view.
Input:
STRING	viewport[ ]	The name of the viewport. ““ for the current viewport.
Output:
REAL ARRAY	vector(3)	The three values of the view vector.
INTEGER	<Return_value>	This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
See the Status Messages (Ch. 11) for information on any error values returned by this function.

See the Status Messages (Ch. 11) for information on any error values returned by this function.

This function will remove the directory from a full path and file name specification.

This value specifies the full path and file name.

This value will return the file name from the path and file name specification.

This return value is unused.

Device dependent routine.

To convert from device space to subject space.

Point in device space.

Point in subject space.

See error conditions.

The viewport must be posted to carry out this operation.

An error occurred during an operation on the graphics manager display list.

Get the current database from the graphics manager.

Current database name.

This function draws an entity in segment or current viewport.

Segment id number. If <0 then use current viewport.

Selected color id of entity.

Type of entity, i.e. curve or surface.

This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.

Make sure limits are up to date and perform a fit view.

If TRUE perform fit view no matter what. If FALSE, only fit view if gm has detected that a fit is necessary.

1 if a fit view was done, 0 if not.

Return whether or not the device is Fullcolor.

Fullcolor status of device.

Shut down the graphics. Database will be closed and all colors freed.

Start the graphics back up. Called after a GmGraphicsOff call. Loads in the last database, allocated colors.

To unhighlight all of the highlighted objects.

To highlight an entity.

Color to hilight. 0 - unhilight, -1 - hilight using preference color.

This return value is unused.

A new pick list could not be created.

This function highlights all of the entities in the picklist string.

Color to hilight. 0 - unhilight, -1 - hilight using preference color.

This return value is unused.

To hilight all of the entities in the select databox.

Select databox widget id.

Color to hilight. 0 - unhilight, -1 - hilight using preference color.

This return value is unused.

A new pick list could not be created.

Write colors to lookup table.

Starting location in colormap to write to.

Number of colors to write.

Array of RGB values.

See error conditions.

The color table is organized in three regions; The first region is for the DAKAR color table, the second for UIMS colors, the third for shading. When calling this routine, the ncolors should not cross over these boundaries.

User Interface colors not allocated. The colormap is being used.

Not enough colors were allocated for shading.

This function pauses the recording of mpeg images file. This is a void function so there are no input/output arguments in this function.

This function resumes the recording of mpeg images file. This is a void function so there are no input/output arguments in this function.

This function starts the recording of an mpeg images file.

Recorded .mpeg filename

File version, i.e. overwrite or increment

Width of the drawable area

Height of the drawable area

Maximum number of frames.

0 for success of the function and integer value 1 to 7 for the failure of the function.

This function stops the recording of an mpeg images file. This is a void function so there are no input/output arguments in this function.

To get whether viewport is drawn in hardware mode.

If TRUE, viewport is drawn in hardware.

This return value is unused.

To set whether viewport is drawn in hardware mode.

If TRUE, viewport is drawn in hardware.

This return value is unused.

Convert from Viewport id to Viewport name.

Determine the limits of the model in View Space.

If TRUE, this skips perspective. If FALSE, the perspective setting in the current viewport will be used.

Min/max x, y and z coordinates of the model in View Space.

See error conditions.

An error occurred during an operation on the graphics manager display list.

The viewport must be posted to carry out this operation.

To get the number of colors used by the GM.

This return value is unused.

Turn off viewport refresh.

This return value is unused.

Turn on viewport refresh.

This return value is unused.

Return the current status of gmRefreshViewports.

gm_convert_name	( orig_name, new_name )

Description:
This function will remove the directory from a full path and file name specification.
Input:
STRING	orig_name[]	This value specifies the full path and file name.
Output:
STRING	new_name[]	This value will return the file name from the path and file name specification.
INTEGER	<Return Value>	This return value is unused.
Comments:
Device dependent routine.

gm_conv_device_to_subject	( vp_id, dev_pt, sub_pt )

Description:
To convert from device space to subject space.
Input:
INTEGER	vp_id	Viewport id.
INTEGER	dev_pt (2)	Point in device space.
Output:
REAL	sub_pt (3)	Point in subject space.
INTEGER	<Return Value>	See error conditions.
Error Conditions:
15000028	The viewport must be posted to carry out this operation.
15000025	An error occurred during an operation on the graphics manager display list.

gm_database_current	( dbname )

Description:
Get the current database from the graphics manager.
Input:
None.
Output:
STRING	dbname[]	Current database name.
INTEGER	<Return Value>	GM Error status.

gm_draw_entity	(segment_id, color_id, entity_type, entity_id)

Description:
This function draws an entity in segment or current viewport.
Input:
INTEGER	segment_id	Segment id number. If <0 then use current viewport.
INTEGER	color_id	Selected color id of entity.
INTEGER	entity_type	Type of entity, i.e. curve or surface.
INTEGER	entity_id	Entity ID
Output:
INTEGER	<Return Value>	This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Condition:
None

gm_fit_view	( flag )

Description:
Make sure limits are up to date and perform a fit view.
Input:
INTEGER	flag	If TRUE perform fit view no matter what. If FALSE, only fit view if gm has detected that a fit is necessary.
Output:
INTEGER	<Return Value>	1 if a fit view was done, 0 if not.

gm_fullcolor_mode	( )

Description:
Return whether or not the device is Fullcolor.
Input:
None.
Output:
LOGICAL	<Return Value>	Fullcolor status of device.

gm_graphics_off	( )

Description:
Shut down the graphics. Database will be closed and all colors freed.
Input:
None.
Output:
INTEGER	<Return Value>	GM Error status.

gm_graphics_on	( )

Description:
Start the graphics back up. Called after a GmGraphicsOff call. Loads in the last database, allocated colors.
Input:
None.
Output:
INTEGER	<Return Value>	GM Error status.

gm_hilight_clear	( )

Description:
To unhighlight all of the highlighted objects.
Input:
None.
Output:
INTEGER	<Return Value>	GM Error status.

gm_hilight_entity	( type, id, color )

Description:
To highlight an entity.
Input:
INTEGER	type	Entity type.
INTEGER	id	Entity id.
INTEGER	color	Color to hilight. 0 - unhilight, -1 - hilight using preference color.
Output:
INTEGER	<Return Value>	This return value is unused.
Error Conditions:
15000035	A new pick list could not be created.

gm_hilight_string	(string, color)

Description:
This function highlights all of the entities in the picklist string.
Input:
STRING	string[]	Picklist string.
INTEGER	color	Color to hilight. 0 - unhilight, -1 - hilight using preference color.
Output:
INTEGER	<Return Value>	This return value is unused.
Error Condition:
None

gm_hilight_widget	( wid_id, color )

Description:
To hilight all of the entities in the select databox.
Input:
widget	wid_id	Select databox widget id.
INTEGER	color	Color to hilight. 0 - unhilight, -1 - hilight using preference color.
Output:
INTEGER	<Return Value>	This return value is unused.
Error Conditions:
15000035	A new pick list could not be created.

gm_lookup_write	( start, ncolors, colors )

Description:
Write colors to lookup table.
Input:
INTEGER	start	Starting location in colormap to write to.
INTEGER	ncolors	Number of colors to write.
REAL	colors (ncolors,3)	Array of RGB values.
Output:
INTEGER	<Return Value>	See error conditions.
Comments:
The color table is organized in three regions; The first region is for the DAKAR color table, the second for UIMS colors, the third for shading. When calling this routine, the ncolors should not cross over these boundaries.
Error Conditions:
15000041	User Interface colors not allocated. The colormap is being used.
15000042	Not enough colors were allocated for shading.

gm_mpeg_pause_recording	()

Description:
This function pauses the recording of mpeg images file. This is a void function so there are no input/output arguments in this function.
Input:
None
Output:
None

gm_mpeg_resume_recording	()

Description:
This function resumes the recording of mpeg images file. This is a void function so there are no input/output arguments in this function.
Input:
None
Output:
None

gm_mpeg_start_recording	(file_name, file_version, x, y, width, height, quality, maxframes)

Description:
This function starts the recording of an mpeg images file.
Input:
STRING	file_name[]	Recorded .mpeg filename
STRING	file_version[]	File version, i.e. overwrite or increment
REAL	x	X point coordinate
REAL	y	Y point coordinate
REAL	width	Width of the drawable area
REAL	height	Height of the drawable area
INTEGER	quality	Quality (0-100)
INTEGER	maxframes	Maximum number of frames.
Output:
INTEGER	<Return Value>	0 for success of the function and integer value 1 to 7 for the failure of the function.
Error Condition:
None

gm_mpeg_stop_recording	()

Description:
This function stops the recording of an mpeg images file. This is a void function so there are no input/output arguments in this function.
Input:
None
Output:
None

gm_viewport_hardware_mode_get	( hard_flag )

Description:
To get whether viewport is drawn in hardware mode.
Input:
None.
Output:
INTEGER	hard_flag	If TRUE, viewport is drawn in hardware.
INTEGER	<Return Value>	This return value is unused.

gm_viewport_hardware_mode_set	( hard_flag )

Description:
To set whether viewport is drawn in hardware mode.
Input:
INTEGER	hard_flag	If TRUE, viewport is drawn in hardware.
Output:
INTEGER	<Return Value>	This return value is unused.

gm_viewport_id_to_name	( id, name )

Description:
Convert from Viewport id to Viewport name.
Input:
INTEGER	id	Viewport ID.
Output:
STRING	name[]	Viewport name.
INTEGER	<Return Value>	GM error status.

gm_viewport_limits_get	( persp, limits )

Description:
Determine the limits of the model in View Space.
Input:
LOGICAL	persp	If TRUE, this skips perspective. If FALSE, the perspective setting in the current viewport will be used.
Output:
REAL	limits (6)	Min/max x, y and z coordinates of the model in View Space.
INTEGER	<Return Value>	See error conditions.
Error Conditions:
15000025	An error occurred during an operation on the graphics manager display list.
15000028	The viewport must be posted to carry out this operation.

gm_viewport_ncolors_get	( ncolors )

Description:
To get the number of colors used by the GM.
Input:
None.
Output:
INTEGER	ncolors	Number of colors.
INTEGER	<Return Value>	This return value is unused.

gm_viewport_refresh_off	( )

Description:
Turn off viewport refresh.
Input:
None.
Output:
INTEGER	<Return Value>	This return value is unused.

gm_viewport_view_corners

( id, corn1, corn2, cent_x, cent_y, zoom )

Calculate the center and zoom for a viewport given two corners of a rectangle.

This value specifies the X and Y coordinates of the upper left corner of the rectangle defining the new center point and zoom value for the viewport.

This value specifies the X and Y coordinates of the lower right corner of the rectangle defining the new center point and zoom value for the viewport.

To set the visibility status of all objects.

TRUE - plot.
FALSE - erase.

To set the visibility status of all the entities in the selectdatabox.

List of entities to plot or erase.

Visibility status: TRUE - visible, FALSE - hidden.

See error conditions.

A new pick list could not be created.

The function ends the process of copying the animation from the screen into a VRML file. This function has to follow the start_vrml_animation() function after specifying the animation attributes. The function has no return conditions.

The function prepares an image file of the specified type of the current viewport. It returns an integer status of 0 on success and 1 on failure.

The typeof the image file – BMP, JPEG, PNG, TIFF, VRML.

The name of the file to write the image with the file extensions - bmp, jpg, png, tif, wrl.

String to specify the version logic for writing the image file – “Overwrite”, “Increment”. Any other string defaults to “Increment”.

The starting percentage of the viewport for the image file in the horizontal direction.

The starting percentage of the viewport for the image file in the vertical direction.

The ending percentage of the viewport for the image file in the horizontal direction.

The ending percentage of the viewport for the image file in the vertical direction.

An integer specifying the quality of image.

The image captured will be of the current XY PLOT window as opposed to the model graphics viewport.

0 for success and 1 for failure.

The function prepares an image file of the entire viewport with the extension .wrl. It returns an integer status of 1 on success and 0 on failure.

The name of the file to write the image with the file extension - .wrl.

String to specify the version logic for writing the image file. – “Overwrite”, “Increment”. Any other string defaults to “Increment”.

1 for success and 0 for failure.

The function starts the process of copying the animation from the screen into a VRML file. This function has to be followed by the end_vrml_animation() function after specifying the animation attributes. During the course of execution of this function, the animation is sent to the .wrl file and is not viewed in the current viewport. The function has no return conditions.

The name of the file to write the animation file with the file extension - .wrl

String to specify the version logic for writing the image file – “Overwrite”, “Increment”. Any other string defaults to “Increment”.