ga_view_aa_get | (name_of_view, angle_x, angle_y, angle_z) |
Description: | ||
This function gets the absolute x, y, and z angles of rotation around the axes of the global model coordinate system of the specified view. | ||
Input: | ||
STRING | name_of_view[31] | This value specifies the name of the view from which the absolute angles will be obtained. If this value is set to nothing or ““, the current view will be used. |
Output: | ||
REAL | angle_x | This value returns the rotation about the x axis. |
REAL | angle_y | This value returns the rotation about the y axis. |
REAL | angle_z | This value returns the rotation about the z axis. |
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: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. |
ga_view_aa_set | (angle_x, angle_y, angle_z) |
Description: | ||
This function sets the absolute x, y, and z angles of rotation around the axes of the global model coordinate system for the current view. | ||
Input: | ||
REAL | angle_x | This value specifies the angle of rotation for the x axis. |
REAL | angle_y | This value specifies the angle of rotation for the y axis. |
REAL | angle_z | This value specifies the angle of rotation for the z axis. |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. | |
13000014 | Viewport not found |
ga_view_ar_set | (angle_x, angle_y, angle_z) |
Description: | ||
This function sets the x, y, and z angles of rotation around the axes of the global model coordinate system for the current view relative to current rotational position. | ||
Input: | ||
REAL | angle_x | This value specifies the angle of rotation for the x axis. |
REAL | angle_y | This value specifies the angle of rotation for the y axis. |
REAL | angle_z | This value specifies the angle of rotation for the z axis. |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. | |
13000014 | Viewport not found |
ga_view_back_get | (name_of_view, distance) |
Description: | ||
This function gets the distance of the back clipping plane. | ||
Input: | ||
STRING | name_of_view[31] | This value specifies the name of the view from which the back clipping plane will be obtained. If this value is set to nothing or ““, the current view will be used. |
Output: | ||
REAL | distance | This value returns the location of back clipping plane. |
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: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. | |
13000014 | Viewport not found |
ga_view_back_set | (distance) |
Description: | ||
This function sets the distance of the back clipping plane. | ||
Input: | ||
REAL | distance | This value sets the location of back clipping plane. |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred |
ga_view_capping_get | (name_of_view, capping_status) |
Description: | ||
This function will return the on/off status for capping. | ||
Input: | ||
STRING | name_of_view[31] | This value specifies the name of the view from which the capping status will be obtained. If this value is set to nothing or ““, the current view will be used. |
Output: | ||
LOGICAL | capping_status | This value returns the on/off status of capping. It will be set TRUE for on, FALSE for off. |
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: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. |
ga_view_capping_set | (capping_status) |
Description: | ||
This function sets the on/off status of capping for the current view. | ||
Input: | ||
LOGICAL | capping_status | This value sets the status of capping to either TRUE for on, or FALSE for off. |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred |
ga_view_center_get | (name_of_view, coordinate_x, coordinate_y) |
Description: | ||
This function returns the location of the center of the named view in the global model coordinate system. | ||
Input: | ||
STRING | name_of_view[31] | This value specifies the name of the view from which the center location will be obtained. If this value is set to nothing or ““, the current view will be used. |
Output: | ||
REAL | coordinate_x | This value returns the x coordinate for the center of the view. |
REAL | coordinate_y | This value returns the y coordinate for the center of the view. |
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: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. |
ga_view_center_set | (coordinate_x, coordinate_y) |
Description: | ||
This function centers the current view around a specified point in the global model coordinate system. | ||
Input: | ||
REAL | coordinate_x | This value specifies the x coordinate around which the view will be centered. |
REAL | coordinate_y | This value specifies the x coordinate around which the view will be centered. |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred |
ga_view_clipping_get | (name_of_view, clipping_status) |
Description: | ||
This function will return the on/off status for clipping. | ||
Input: | ||
STRING | name_of_view[31] | This value specifies the name of the view from which the clipping status will be obtained. If this value is set to nothing or ““, the current view will be used. |
Output: | ||
LOGICAL | clipping_status | This value returns the on/off status of capping. It will be set TRUE for on, FALSE for off. |
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: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. |
ga_view_clipping_set | (clipping_status) |
Description: | ||
This function sets the on/off status of clipping for the current view. | ||
Input: | ||
LOGICAL | clipping_status | This value sets the status of clipping to either TRUE for on, or FALSE for off. |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred |
ga_view_corners_set | (point_1, point_2, aspect_ratio) |
Description: | ||
This function changes the size and center location of the current view. | ||
Input: | ||
REAL | point_1(3) | This value specifies a point that is the location of the corner point of a box that is on a diagonal to point_2. See the remarks below for more information. |
REAL | point_2(3) | This value specifies a point that is the location of the corner point of a box that is on a diagonal to point_1. See the remarks below for more information. |
REAL | aspect_ratio | This value specifies the relationship between the size of the box and the zoom value applied to the view. See the remarks below for more information. |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred |
ga_view_create | (name_of_view, viewport_name) |
Description: | ||
This function will create a named view and post it to a viewport. | ||
Input: | ||
STRING | name_of_view[31] | This value specifies the name of the view. If this value is set to nothing or ““, an error status value will be returned by the function. |
STRING | viewport_name[31] | This value specifies the name of the viewport to which the view will be posted. If this value is set to nothing or ““, the current viewport will be used. |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000007 | The viewport name is invalid. | |
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000153 | The specified Named View already exists. | |
13000007 | An unspecified database error occurred | |
13000014 | Viewport not found |
ga_view_delete | (name_of_view) |
Description: | ||
This function deletes a named view. | ||
Input: | ||
STRING | name_of_view[31] | This value specifies the name of the view to be deleted. If this value is set to nothing or ““, the current view will be used. |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred |
ga_view_dist_get | (name_of_view, distance) |
Description: | ||
The function will get the distance from the center of the named view to the view plane along the z axis of the global model coordinate system. | ||
Input: | ||
STRING | name_of_view[31] | This value specifies the name of the view from which the distance will be obtained. If this value is set to nothing or ““, the current view will be used. |
Output: | ||
REAL | distance | This value returns the distance from the center of the named view to the view plane. The output value distance will always be less than the observer position distance. |
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: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. |
ga_view_dist_set | (distance) |
Description: | ||
This function will set the distance from the center of the current view to the view plane along the z axis of the global model coordinate system. | ||
Input: | ||
REAL | distance | This value specifies the distance from the view plane to the center of the current view. This input value must be less than the observer position distance. |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred |
ga_view_exist_get | (name_of_view, view_status) |
Description: | ||
This function returns a status value reporting the existence of a named view. | ||
Input: | ||
STRING | name_of_view[31] | This value specifies the name of the view from which the distance will be obtained. If this value is set to nothing or ““, the current view will be used. |
Output: | ||
INTEGER | view_status | This value returns the status of the named view as 1 or TRUE if it exists, and 0 or false if it does not exist. |
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: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. | |
13000007 | An unspecified database error occurred |
ga_view_fov_get | (name_of_view, fov_angle) |
Description: | ||
This function will get the field of view angle for the named view. | ||
Input: | ||
STRING | name_of_view[31] | This value specifies the name of the view from which the field of view angle will be obtained. If this value is set to nothing or ““, the current view will be used. |
Output: | ||
REAL | fov_angle | This value returns the field of view angle for the named view. |
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: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. |
ga_view_fov_set | (fov_angle) |
Description: | ||
This function will set the field of view angle for the current view. | ||
Input: | ||
REAL | fov_angle | This value specifies the field of view angle. |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred |
ga_view_from_get | (name_of_view, position) |
Description: | ||
This function will get the position of the observer. | ||
Input: | ||
STRING | name_of_view[31] | This value specifies the name of the view from which the position of the observer will be obtained. If this value is set to nothing or ““, the current view will be used. |
Output: | ||
REAL | position(3) | This value returns the location of the position of the observer. The offsets of the array (1, 2, 3) correspond to the axes of the global model coordinate system (x, y, z). |
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: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. |
ga_view_from_set | (position) |
Description: | ||
This function will set the position of the observer in the current view. | ||
Input: | ||
REAL | point(3) | This value specifies the position of the observer. The offsets of the array (1, 2, 3) correspond to the axes of the global model coordinate system (x, y, z). |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred |
ga_view_front_get | (name_of_view, distance) |
Description: | ||
The function will get the distance from the center of the named view to the front clipping plane along the z axis of the global model coordinate system. | ||
Input: | ||
STRING | name_of_view[31] | This value specifies the name of the view from which the distance of the front clipping plane will be obtained. If this value is set to nothing or ““, the current view will be used. |
Output: | ||
REAL | distance | This value returns the distance from the center of the named view to the front clipping plane. The output value distance will always be greater than the distance to the back clipping plane. |
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: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. |
ga_view_front_set | (distance) |
Description: | ||
This function will set the distance from the center of the named view to the front clipping plane along the z axis of the global model coordinate system. | ||
Input: | ||
REAL | distance | This value specifies the distance from the center of the named view to the front clipping plane. This value must always be greater than the distance to the back clipping plane. |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred |
ga_view_model_scale_get | (name_of_view, scale_x, scale_y, scale_z) |
Description: | ||
This function gets the model scale factors for each of the axes in the global model coordinate system of the named view. | ||
Input: | ||
STRING | name_of_view[31] | This value specifies the name of the view from which the model scale factors will be obtained. If this value is set to nothing or ““, the current view will be used. |
Output: | ||
REAL | scale_x | This value returns the scale factor for the x axis. |
REAL | scale_y | This value returns the scale factor for the y axis. |
REAL | scale_z | This value returns the scale factor for the z axis. |
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: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. |
ga_view_model_scale_set | (scale_x, scale_y, scale_z) |
Description: | ||
This function sets the model scale factors for each of the axes in the global model coordinate system of the current view. | ||
Input: | ||
REAL | scale_x | This value specifies the scale factor for the x axis. |
REAL | scale_y | This value specifies the scale factor for the y axis. |
REAL | scale_z | This value specifies the scale factor for the z axis. |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred |
ga_view_nviews_get | (number_of_views) |
Description: | ||
This function gets the number of views. | ||
Input: | ||
None. | ||
Output: | ||
INTEGER | number_of_views | This value returns the number of views. |
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: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred | |
13000085 | Cursor not open |
ga_view_perspective_get | (name_of_view, perspective_status) |
Description: | ||
This function gets the on/off status of the perspective for the name view. | ||
Input: | ||
STRING | name_of_view[31] | This value specifies the name of the view from which the perspective status will be obtained. If this value is set to nothing or ““, the current view will be used. |
Output: | ||
LOGICAL | perspective_status | This value returns the status of the perspective. It will either be set to on (TRUE), or off (FALSE). |
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: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. |
ga_view_perspective_set | (perspective_status) |
Description: | ||
This function sets the on/off status of the perspective for the current view. | ||
Input: | ||
LOGICAL | perspective_status | This value specifies the status of the perspective to be either TRUE for on, or FALSE for off. |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred |
ga_view_plane_set | (point_1, point_2, point_3) |
Description: | ||
This function set a plane defined by three input points in the global model coordinate system as the current view plane in the current view. | ||
Input: | ||
REAL | point_1(3) | This value specifies the first point defining a plane. |
REAL | point_2(3) | This value specifies the second point defining a plane. |
REAL | point_3(3) | This value specifies the third point defining a plane. |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred |
ga_view_rename | (original_name, new_name) |
Description: | ||
This function renames a view. | ||
Input: | ||
STRING | original_name[31] | This value specifies the original name of the view. If this value is set to nothing or ““, the current view will be used. |
STRING | new_name[31] | This value specifies a new name to be assigned to the view. |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000153 | The specified Named View already exists. | |
13000007 | An unspecified database error occurred |
ga_view_sa_get | (name_of_view, angle_x, angle_y, angle_z) |
Description: | ||
This function gets the absolute x, y, and z angles of rotation around the axes of the global screen coordinate system of the specified view. | ||
Input: | ||
STRING | name_of_view[31] | This value specifies the name of the view from which the absolute angles will be obtained. If this value is set to nothing or ““, the current view will be used. |
Output: | ||
REAL | angle_x | This value returns the rotation about the x axis. |
REAL | angle_y | This value returns the rotation about the y axis. |
REAL | angle_z | This value returns the rotation about the z axis. |
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: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. |
ga_view_sa_set | (angle_x, angle_y, angle_z) |
Description: | ||
This function sets the absolute x, y, and z angles of rotation around the axes of the global screen coordinate system for the current view. | ||
Input: | ||
REAL | angle_x | This value specifies the angle of rotation for the x axis. |
REAL | angle_y | This value specifies the angle of rotation for the y axis. |
REAL | angle_z | This value specifies the angle of rotation for the z axis. |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. | |
13000014 | Viewport not found |
ga_view_screen_scale_get | (name_of_view, scale_x, scale_y) |
Description: | ||
This function gets the model scale factors for each of the axes in the global screen coordinate system of the named view. | ||
Input: | ||
STRING | name_of_view[31] | This value specifies the name of the view from which the screen scale factors will be obtained. If this value is set to nothing or ““, the current view will be used. |
Output: | ||
REAL | scale_x | This value returns the scale factor for the x axis. |
REAL | scale_y | This value returns the scale factor for the y axis. |
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: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. |
ga_view_screen_scale_set | (scale_x, scale_y) |
Description: | ||
This function sets the screen scale factors for each of the axes in the global screen coordinate system of the current view. | ||
Input: | ||
REAL | scale_x | This value specifies the scale factor for the x axis. |
REAL | scale_y | This value specifies the scale factor for the y axis. |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred |
ga_view_sr_set | (angle_x, angle_y, angle_z) |
Description: | ||
This function sets the relative x, y, and z angles of rotation around the axes of the global screen coordinate system for the current view. | ||
Input: | ||
REAL | angle_x | This value specifies the angle of rotation for the x axis. |
REAL | angle_y | This value specifies the angle of rotation for the y axis. |
REAL | angle_z | This value specifies the angle of rotation for the z axis. |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000096 | A current viewport has not been defined. | |
11000132 | There is no current view. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred |
ga_view_to_get | (name_of_view, center_point) |
Description: | ||
This function returns the center point of the named view. | ||
Input: | ||
STRING | name_of_view[31] | This value specifies the name of the view from which the center point will be obtained. If this value is set to nothing or ““, the current view will be used. |
Output: | ||
REAL | center_point(3) | This value returns the location of the center point of the view. The offsets of the array (1, 2, 3) correspond to the axes of the global model coordinate system (x, y, z). |
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: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000132 | There is no current view. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. |
ga_view_to_set | (point) |
Description: | ||
This function will set the position of the observer in the current view. | ||
Input: | ||
REAL | point(3) | This value sets the position of the observer. The offsets of the array (1, 2, 3) correspond to the axes of the global model coordinate system (x, y, z). |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred |
ga_view_up_get | (name_of_view, direction_vector) |
Description: | ||
This function returns a point that is on a vector normal to the view plane of the named view that defines the up direction of the view. | ||
Input: | ||
STRING | name_of_view[31] | This value specifies the name of the view from which the direction vector will be obtained. If this value is set to nothing or ““, the current view will be used. |
Output: | ||
REAL | direction_vector(3) | This value returns the location of a point on a vector normal to the view plane defining the up direction of the view. The offsets of the array (1, 2, 3) correspond to the axes of the global model coordinate system (x, y, z). |
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: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. |
ga_view_up_set | (direction_vector) |
Description: | ||
This function defines the up direction in a view by setting a point that is on a vector normal to the view plane of the current view. | ||
Input: | ||
REAL | direction_vector(3) | This value specifies the location of a point on a vector normal to the view plane defining the up direction of the view. The offsets of the array (1, 2, 3) correspond to the axes of the global model coordinate system (x, y, z). |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred | |
13000013 | View not found |
ga_view_views_get | (view_list) |
Description: | ||
This function gets a list of all of the named views. | ||
Input: | ||
None. | ||
Output: | ||
STRING | view_list[31]() | This value returns a list of all of the view. The number of offsets allocated for this array should match the number of viewports. See the remarks below for more information. |
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: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
13000085 | Cursor not open |
ga_view_zoom_get | (name_of_view, zoom_factor) |
Description: | ||
This function will get the zoom factor for the named view. | ||
Input: | ||
STRING | name_of_view[31] | This value specifies the name of the view from which the zoom factor will be obtained. If this value is set to nothing or ““, the current view will be used. |
Output: | ||
REAL | zoom_factor | This value returns the zoom factor for the named view. |
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: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000058 | The view name is invalid. | |
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. |
ga_view_zoom_set | (zoom_factor) |
Description: | ||
This function will set the current zoom factor for the current view. | ||
Input: | ||
REAL | zoom_factor | This value specifies the new zoom factor to which the current view will be set. The zoom factor value must be between 1e-32 and 1e+32 or otherwise function will return an error. |
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 Conditions: | ||
This is only a partial list of the error values that can be returned by this function. | ||
11000096 | A current viewport has not been defined. | |
11000098 | A fatal error has occurred in the database. Database is corrupted. | |
11000103 | The specified view was not found in the data base. | |
11000132 | There is no current view. | |
13000004 | Duplicate entry exists in table | |
13000007 | An unspecified database error occurred |