Scripting API
ReactiveModule
Box2DSignal

Box2DSignal

The Box2DSignal class monitors a 2D bounding box value.

Properties

PropertyDescription

center

(get) center: Vec2Signal
(set) (Not Available)


Represents the center of the bounding box, in normalized screen space units.

height

(get) height: ScalarSignal
(set) (Not Available)


Represents the height of the bounding box, in normalized screen space units.

width

(get) width: ScalarSignal
(set) (Not Available)


Represents the width of the bounding box, in normalized screen space units.

x

(get) x: ScalarSignal
(set) (Not Available)


Represents the X-position of top left corner of the bounding box, in normalized screen space units.

y

(get) y: ScalarSignal
(set) (Not Available)


Represents the Y-position of top left corner of the bounding box, in normalized screen space units.

Methods

MethodDescription

history

history(framesCount: number): SignalHistory<Box2D>


Returns an object used to access signal values from past frames.
Historical signal values are going to be initialized with signal value at call time.


  • framesCount - the number of frames to track.