Skip to main content

​
Overview

Highlight Object applies a glow, outline, or pulse to selected objects. Use it to identify an interaction target or give visual feedback after a task. Remove Highlight on Object removes an existing highlight from selected targets. Highlighting changes visual emphasis. Use Set Interactable Objects to control whether the trainee can interact with an object.

​
Highlight Object

​
Parameters

​
Duration and Action Timing

In the browser Trainee App, a positive Duration (ms) schedules automatic removal. With Wait Until Complete unchecked, subsequent actions can run while the highlight is visible. With it checked, they wait for the timed highlight to end. With Duration empty or 0, the highlight has no automatic timeout. Wait Until Complete does not wait for a later Remove Highlight on Object action. For guidance that remains until an interaction, leave Duration empty and remove the highlight in that interaction’s transition or the step’s On Exit actions. A new Highlight Object action for the same target replaces that target’s previous highlight. Objects must already be available; enable Wait Until Complete on a preceding Add Object action when highlighting a newly loaded instance.

​
Remove Highlight on Object

The action removes highlights only from its listed targets. An empty list does not mean “remove all.” If a target has no active highlight, removing it has no effect. The object remains in the scene with its existing interaction settings. If you highlighted a specific child, select that child again when removing the highlight. Selecting only its parent does not clear separately tracked child highlights.

​
Example: Guide an Assembly Sequence

The scene contains component_a and component_b. Create Assemble A and Assemble B steps.
1

Highlight the first component

In Assemble A, add Highlight Object to On Entry:
  • Target Objects: component_a
  • Highlight Color: #FF6600
  • Intensity: 100
  • Effect Type: Glow
  • Duration (ms): empty
  • Wait Until Complete: unchecked
2

Handle the completed placement

Configure a Move event for component_a and its assembly destination. Set the transition’s target to Assemble B.In the transition’s Actions, add Remove Highlight on Object, selecting component_a. The destination is configured on the transition, not added as an action.
3

Highlight the next component

In Assemble B, add Highlight Object to On Entry, selecting component_b with the same color and an empty Duration. Remove its highlight when the next placement completes.

​
Example: Timed Success Feedback

A Move or Rotate transition represents successful completion of a repair and leads to a Repair Complete step. In Repair Complete, add these On Entry actions in order:
  1. Highlight Object: select repaired_component, set Highlight Color to #00FF00, Effect Type to Pulse, Duration (ms) to 1500, and check Wait Until Complete.
  2. Show Text: set Body to “Repair complete. Continue to inspection.” and leave Wait Until Complete unchecked.
In the browser Trainee App, the component pulses for 1.5 seconds, the highlight is removed, and the message then appears. Use the completion event or step to track progress; the visual effect itself does not determine whether the repair was successful.

​
Example: Reduce Guidance Gradually

Apply persistent highlights to component_a, component_b, component_c, and tool_shelf during the guided phase. Each removal action lists the exact targets to clear. If objects were highlighted through individual child selections, use those same selections here.

​
Best Practices

  • Highlight the objects needed for the current task and remove their highlights when that guidance ends.
  • Explain any color meanings in the instructions, such as green for completed components.
  • Preview the chosen effect and intensity against the actual scene background.
  • Keep highlight targets available until any timed feedback has finished.