SET HIGHLIGHTING FILTER(3P) — SUNPHIGS LIBRARY

NAME

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

SYNOPSIS

C Syntax

void
psethilightfilter ( ws, inclusion, exclusion )
Pintws;workstation identifier
Pintlst∗inclusion;inclusion filter
Pintlst∗exclusion;exclusion filter

FORTRAN Syntax

SUBROUTINE pshlft ( WKID, ISN, IS, ESN, ES )
INTEGERWKIDworkstation identifier
INTEGERISNnumber of names in the inclusion set
INTEGERIS(ISN)inclusion set
INTEGERESNnumber of names in the exclusion set
INTEGERES(ESN)exclusion set

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 name set, inclusion set, and exclusion set is a small positive integer.

C Input Parameters

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

inclusion
A pointer to a Pintlst structure containing the set of names for the inclusion set.

exclusion
A pointer to a Pintlst structure containing the set of names for the exclusion set.

The Pintlst structure is defined in phigs.h as:

typedef struct {
Pintnumber;/∗ number of Pints in list ∗/
Pint∗integers;/∗ list of integers ∗/
} Pintlst;

FORTRAN Input Parameters

WKIDThe identifier of the workstation whose ‘highlighting filter’ is to be set.

ISNThe number of names for the inclusion set.

ISAn array containing the set of ISN names for the inclusion set.

ESNThe number of names for the exclusion set.

ESAn array containing the set of ESN names for the exclusion set.

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, no primitives are eligible for highlighting.

If the ‘current name set’ is empty, 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 (i.e., the workstation category is neither OUTPUT, OUTIN, nor MO)

Museum