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

GPADCN - Add Class Name to Set

GPADCN (number, names)

Purpose

Use GPADCN to insert an Add Class Name to Set structure element into the open structure following the element pointer or to replace the element pointed at by the element pointer with an Add Class Name to Set structure element depending on the current edit mode.

During structure traversal, this structure element adds the specified class names to the current class set. The traversal default is a null name set.

Class names let an application control the eligibility of a primitive for pickability (detectability), highlighting, and invisibility by associating the primitive with a class set.

When the graPHIGS API encounters a primitive during structure traversal, the primitive belongs to the classes contained in the current class set. If the workstation does not support a specified name, then the graPHIGS API ignores the name and the name has no affect on the primitive.

Also use class names to create inclusion and exclusion filters for the specified workstation. The graPHIGS API uses these filters in conjunction with the class set traversal state to determine if pickability, highlighting, and visibility apply. The filters act independently of each other. During structure traversal, the graPHIGS API compares the current class set to the current filters.

For a complete discussion of class names and filters, see The graPHIGS Programming Interface: Understanding Concepts

Parameters

number -- specified by user, fullword integer

Number of class names to add to the class set (>=0)

names -- specified by user, array of fullword integers

Array of class names to add to the class set (class names must be >=0)

Error Codes

5
FUNCTION REQUIRES STATE STOP OR NROP (NOT STCL)
320
CLASS NAME VALUE IS INVALID
530
NUMBER OF CLASS NAMES < ZERO

Related Subroutines

GPHLF
Set Highlighting Filter
GPIVF
Set Invisibility Filter
GPPKF
Set Pick Filter
GPQNCN
Inquire Number of Available Class Names
GPRCN
Remove Class Name from Set

RCP code

201334785 (X'0C002001')


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