2023.1.1175.2 Cue

1 Overview
2 Where to find
3 Feature Layout
4 How to use
- 4.1 Method1: Add Manually

Overview

The goal of a DESCue is used in a DES simulation to trigger an action when a DESActor hits it. For example, pickup a cube that reaches the end of a spline. The DESCue always belongs to a spline. The action is define in the DESInstructor. Instruction steps are shown below including GIFs.

Where to find

The feature can be found under Add Component in the Inspector. The DESCue must be parented under a DESController in the hierarchy.

Add Component

Feature Layout

The image below shows the complete feature layout of the DESCue inspector.

Transform Settings
Use Rigidbody	Disabled: Transform the DESCue without a Rigidbody (Unity physics) Enabled: Transform the DESCue via a Rigidbody (Unity physics)
Rigidbody	Define the Rigidbody to use for transformation
Transform Precision	Transform precision for the DESCue game object: Floating Point: Single precision (Transform)(default) Double: Double precision (DTransform)
Specifications
Cue Name	Create a name for the cue
Participant ID	Unique GUID for the cue
Cue Position Settings
Retain World Position	Disabled: Can only move cue using the cue settings in the inspector. Cannot move cue using the Transform or Gizmo. Enabled: Can move cue using Transform, Gizmo and cue settings.
Cue Spline Settings
Owner Spline	Drag the spline game object into this field
Refresh Spline Ownership	Cue owner changed to the spline defined in the Owner Spline field
Total Spline Length (m)	Spline length
Percentual Position (%)	Cue position on spline (0.0 - 1.0)
Distance from Start (m)	Distance from start of the spline to the cue
Distance from End (m)	Distance from end of the spline to the cue
Cue Trigger & Instructor Settings
Cue Instructor	Drag the DESInstructor game object into this field to define actions
Advanced Trigger Settings:
Trigger on Actor Rotation	Trigger cue event if a DESActor with rotation motion hits the cue (default enabled)
Trigger on Actor Translation	Trigger cue event if a DESActor with translation motion hits the cue (default enabled)
Trigger Actor Continuously	Trigger continuous event every frame when actor is on cue
Trigger Actor When Completely Inside Cue	Trigger cue event to indicated that actor is completely inside the cue
Cue Thickness Settings
Percentual Thickness (%)	Size of the cue trigger boundary in percentage of the spline length
Thickness in Units (m)	Size of the cue trigger boundary in meters
Scene View Settings
Show Gizmos in Scene View	Show cue gizmo and name in the scene
Draw Label in Scene View	Show cue name in the scene

How to use

The DESCue is either manually added to a spline or automatically added using the ActorRouteCreator:

Method1: Add Manually

Create empty game object > Add Component > DES Controller
Create empty game object > Add Component > D Spline
(Alternative: PrespectiveMenu > Utilities > Add DSpline)
Parent the DSpline under the DESController
Create empty game object > Add Component > DES Cue
Parent the new game object (DESCue) under the DSpline (NEW_SPLINE)
Set cue position on the spline (Percentual Position / Distance from Start / Distance from End)
Create a DESInstructor and drag it into the Inspector of the DESCue