Class Name: Sound Instance Control Link

Superclass - Control Link

Definition

The specialized Control Link used to provide the connection between an ordered aggregation of Expressions and the target fields of a Sound Instance.

The active_sound_value_expr_index field is a 1-based index into the ordered aggregation of Expressions, and is used to select the specific Expression that defines Sound Instance's active_sound_value field.

Primary Page in DRM Diagram:

Secondary Pages in DRM Diagram:

Example

  1. A Model of a lighthouse has a Geometry Model with a Union of Geometry Hierarchy, to which is attached a Sound Instance representing the foghorn. The Sound Instance has a Sound Instance Control Link that turns the foghorn on or off, depending on the weather.

FAQs

What does a Sound Instance Control Link control?
A Sound Instance Control Link controls the active_sound_value stored in its Sound Instance, so that the Sound Instance can be turned on and off.

Can I use the Sound Instance Control Link to change the Sound accessed by a Sound Instance?
No. The link to the Sound is an association within the transmittal, and associations cannot be changed dynamically.

Constraints

None.

Composed of (two-way)(inherited)

Component of (two-way)

Inherited Field Elements

SE_STRING description; (notes)

Field Elements

SE_UINT32 active_sound_value_expr_index; (notes)

Notes

Fields Notes

description

 A text description of what the Control_Link is for

active_sound_value_expr_index

 index of the <Expression> whose value controls the active_sound_value
 field of the affected <Sound Instance>. If the <Expression> evaluates
 to SE_TRUE, the <Sound Instance> is on.

Prev: Sound Instance. Next: Sound Library. Up:Index.