[ Previous | Next | Contents | Glossary | Home | Search ]
The graPHIGS Programming Interface: ISO PHIGS Subroutine Reference

INITIALIZE LOCATOR 3 (PHOP,WSOP,*,*)

Purpose

Use Initialize Locator 3 to initialize the specified locator device.

The Initialize Locator 3 subroutine stores the initial locator position, initial view index, prompt/echo type, echo volume, and locator data record in the workstation state list for the specified device.

Two positions are required for some locator prompt/echo types: the initial locator position, which remains fixed during input operation, and the current locator position, which varies dynamically as you use the locator.

This function supports the following prompt/echo types:

  • Type One designates the current position of the locator using a workstation-dependent technique.

  • Type Two, the cross hair, designates the current position of the locator by spanning the display surface or device echo area with both a vertical and a horizontal line. The lines intersect at the current locator position. Whether the cross hair spans the entire display surface or only the echo area depends on the capabilities of the workstation.

  • Type Three designates the current position of the locator using a tracking cross.

  • Type Four designates the current position of the locator using a rubber band line connecting the initial locator position given by this subroutine and the current locator position.

    Note:

    The locator device must be in Request mode.

    Language Bindings

    • C

    pinit_loc3 (ws_id, loc_num, init_view_ind, init_loc_pos, pet, echo_vol, loc_data)

    Input Parameters

    Pint ws_id
    Workstation identifier.

    Pint loc_num
    Locator device number (>=1).

    Pint init_view_ind
    Initial view index (>=0).

    const Ppoint3 *init_loc_pos
    Initial locator position in WC.

    Pint pet
    Prompt and echo type.

    const Plimit3 *echo_vol
    Echo volume in DC.

    const Ploc_data3 *loc_data
    Data record.

    FORTRAN

    PINLC3 (wkid, lcdnr, iviewi, ipx, ipy, ipz, pet, evol, ldr, datrec)

    Input Parameters

    integer wkid
    Workstation identifier.

    integer lcdnr
    Locator device number (>=1).

    integer iviewi
    Initial view index (>=0).

    real ipx
    x coordinate of the initial locator position in WC.

    real ipy
    y coordinate of the initial locator position in WC.

    real ipz
    z coordinate of the initial locator position in WC.

    integer pet
    Prompt and echo type.

    real evol(6)
    Echo volume (XMIN, XMAX, YMIN, YMAX, ZMIN, ZMAX).

    integer ldr
    Dimension of the data record array.

    character*80 datrec(ldr)
    Data record.

    The PPREC parameters to build a locator input data record for PET=4 are as follows: (IL=7, IA=unused, linetype ASF, line width scale factor ASF, polyline color index ASF, polyline index, line type, polyline color index, RL=1, RA=line width scale factor, SL=0, LSTR=(), STR=()).

    Errors

    3
    Function Requires State (PHOP,WSOP,*,*)
    54
    Specified Workstation Is Not Open
    61
    Specified Workstation Is Not Of Category Input Or Outin
    250
    Specified Device Not Available On Workstation
    251
    Function Requires Input Device To Be In Request Mode
    254
    Invalid Echo Area/Volume: XMIN>=XMAX, YMIN>=YMAX OR ZMIN>ZMAX
    255
    Echo Area/Volume Boundary Point(s) Outside Device Range
    253
    Prompt/Echo Type Not Available On Specified Workstation
    260
    Input Device Data Record Field Is In Error
    261
    Initial Value Is Invalid
    114
    View Index Value < ZERO

    Related Subroutines

  • Inquire Locator Device State 3

  • Inquire Default Locator Device Data 3

  • Inquire Display Space Size

  • Inquire Number Of Available Logical Input Devices

  • Pack Data Record

  • Set Locator Mode

    • [ Previous | Next | Contents | Glossary | Home | Search ]