PM_GET_VIEW_PARAMETERS
Syntax
int_val = PM_GET_VIEW_PARAMETERS ( view_handle[, keyword1, keyword1_argument1, ...] );
- Input arguments
-
handle view_handle Handle of the view. string keyword1 Keyword that identifies a given view parameter.
- Output arguments
-
(type according to parameter) keyword1_argument1, … Arguments of the parameter.
Get the required view parameters by using any of the combinations of {"KEYWORD", arguments} listed in PM_SET_VIEW_PARAMETERS or the following:
| Keyword | Arguments | Description |
|---|---|---|
| "BBOX" | umin, umax, vmin, vmax, wmin, wmax | Limits (float) of the bounding box that encloses all objects visualized so far. All coordinates are in view coordinates. The w-direction measures the depth coordinate. |
| "DW" | dw_handle | Handle of the 2D layer object associated with the view. If none is currently active, then the returned value is (int) -1. Otherwise passes a handle that in turn can be sent to DW_ACTIVATEVIEW(dw_handle). This way you can write scripts that, for example, add some special annotations into a view. |
Return Values
- Success:
-
int 0 Getting the parameters succeeded.
- Failure:
-
int -1 Failed to get the parameters.
Description
This function can be used to query the parameters assigned to an opened view. The parameter values are passed back to the script via arguments associated with the parameter keyword. These arguments must be variables because only variables can pass values back to the caller.
Function Set
Related Functions