Class Name: Color Index

Superclass - Color

Definition

The means of referencing a Primitive Color that is contained in a Color Table.

A Color Index contains an index into the primary Color Table of the Color Table Group to which it is associated. The Color Table Group specifies which of its Color Tables is being used, while the Color Index specifies which Primitive Color within that primary Color Table is being referenced.

Primary Page in DRM Diagram:

Example

  1. Consider a Color Table Group whose primary Color Table consists of Primitive Colors for Out-the-Window (OTW) viewing conditions.

    A Polygon that references the kth Primitive Color in this table will do so by having a Color Index component that is associated to the Color Table Group and whose index value is set to k. If the Color Index is solely responsible for the Polygon's color, then its intensity_level will be 100.0.

FAQs

I am attempting to consume an object, e.g. a Polygon, whose Color is specified by a Color Index. What can I do to get access to the actual Primitive Color being referred to?
A consumer can access the actual Primitive Colors contained within a Color Table, just as though Inline Colors had been used, via the Level 0 API. See SE_InitializeComponentIterator()'s directly_attach_table_components parameter, and SE_GetComponent()'s directly_attach_table_components parameter.

How can I, as a data provider, specify that a Color contributes x percent (e.g. 25%) of the total effect on a colored object, while an Image Mapping Function provides the remaining 100%-x (e.g. 75%)?
See Color Index's intensity_level field and Image Mapping Function's intensity_level field.

Constraints

Associated to (one-way)

Composed of (one-way)(inherited)

Composed of (two-way)

Component of (one-way)(inherited)

Inherited Field Elements

SE_TOKEN_SET color_mapping;
SE_TOKEN_SET presentation_domain;

Field Elements

SE_PINT32 index;
SE_FLOAT64 intensity_level; (notes)

Notes

Fields Notes

intensity_level

 value between 0.0 and 1.0 that indicates the percent contribution of
 this mapping to the total effect on the colored object (normal value
 is 1.0) Multiply the <Color Data> values within the referenced
 <Primitive Color> by this value.

Prev: Color Entry Table. Next: Color Index Control Link. Up:Index.