Document toolboxDocument toolbox

2023.1.1344.2 Emitter



Overview

The Beam Emitter is a component that projects an optical (laser) beam, used for detecting objects. It is used in conjunction with a Beam Receiver and/or a Beam Reflector.

A Beam Emitter projecting its beam onto a Beam Receiver (left) and a Beam Reflector (right).


Where to find

The Beam Emitter Physical component can be found under Standard Components > Beam Sensor > Emitter > Add Physical Component.

It can be accessed from the GameObject menu as well as from the Hierarchy Context menu.

A new GameObject will be created if you do not have a GameObject selected. Otherwise, the Beam Emitter will be added to the selected GameObject.


Feature layout - Physical Component

Live Data

 

State

Shows whether the Beam Emitter is currently active and thus whether it will emit a beam.

Properties

 

Reach

The maximum distance the beam is allowed to travel.

Origin Offset

Allows the beam to originate from an offset position relative to its GameObject position.

Origin Direction

Allows the beam to be rotated relative to its GameObject rotation.

Gizmo Settings

 

Show Gizmo

When selected, shows a gizmo for the origin position and the origin direction of the beam.

Gizmo Color

The color the gizmo will be drawn in.

Show Beam

When selected, draws the beam during playmode if a Bamematerial has been set.

Beam Material

The material used to render this beam. Has to be set for “Show Beam“ functionality.

Beam Radius

The radius with which this beam will be drawn during playmode.

Control Panel

 

Generate Control Panel

Click this button to generate a ControlPanelInterface for the Beam Emitter.

Feature Layout - Control Panel

Title

The Title of the Control Panel.

Click to ping the target component in the hierarchy.

Double click to edit.

Beam Emitter Properties

 

State

Shows whether the Beam Emitter is currently active and thus whether it will emit a beam.

Enable/Disable

Enables/Disables the Beam.

Target Component

 

Target Gameobject

The gameobject which has a standardcomponent you want the Control Panel for.

Target Component

The Component which for which a Control Panel is generated.


How to use

  1. Assign a Beam Emitter physical component to a GameObject, or create a new one directly from the menu.

  2. Select the desired settings under the Properties tab.

  3. In order to detect objects passing through the beam, a Beam Receiver must also be created.

  4. Direct the beam at the Beam Receiver.

  5. Objects with a Collider will interrupt the beam, changing the signal value of the Beam Receiver.

Prespective Documentation