SET HIGHLIGHTING FILTER(3P) — Kubota Pacfic Computer Inc. (29 February 1991)

NAME

SET HIGHLIGHTING FILTER − set the workstation’s name set filter that determines which primitives are highlighted

SYNOPSIS

C Syntax

void
pset_highl_filter ( ws, filter)
Pintws;workstation identifier
Pfilter∗filter;highlighting filter

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

SET HIGHLIGHTING FILTER sets the workstation’s highlighting filter, which is compared to the traversal-time current name set of each primitive to determine if the primitive is highlighted.

The filter contains an inclusion set and an exclusion set of names. During traversal, a primitive is eligible for highlighting if at least one name in the current name set is in the inclusion set and no name in the current name set is in the exclusion set. Each name in the inclusion name set and exclusion name set is a small positive integer.

C Input Parameters

wsThe identifier of the workstation whose highlighting filter is to be set.

filterA pointer to a Pfilter structure containing the inclusion set and exclusion set of names. Pfilter is defined in phigs.h as follows:

typedef struct {
Pint_listincl_set;/∗ inclusion set ∗/
Pint_listexcl_set;/∗ exclusion set ∗/
} Pfilter;

The Pint_list structure is defined in phigs.h as follows:

typedef struct {
Pintnum_ints;/∗ number of Pints in list ∗/
Pint∗ints;/∗ list of integers ∗/
} Pint_list;

Execution

SET HIGHLIGHTING FILTER sets the workstation’s highlighting filter, which contains an inclusion set and an exclusion set of names, both empty by default. A primitive is eligible for highlighting if at least one name in the current name set is in the inclusion set and no name in the current name set is in the exclusion set. This means the exclusion set has precedence over the inclusion set. If the workstation’s highlighting filter inclusion set is empty, then no primitives are eligible for highlighting.

If the current name set is empty, then subsequent primitives are not eligible. When traversal of a posted structure network starts, the current name set is empty. During traversal, the member names specified by the ADD NAMES TO SET element are added to the current name set by the union operation on the sets. REMOVE NAMES FROM SET elements remove names from the current name set. The actual appearance of highlighting is workstation dependent.

ERRORS

003Ignoring function, function requires state (PHOP, WSOP, ∗, ∗)

054Ignoring function, the specified workstation is not open

059Ignoring function, the specified workstation does not have output capability (in other words, the workstation category is neither OUTPUT, OUTIN, nor MO)

Museum