Class PathFollowerBehavior

Moves an object along a 3D curve (e.g., CatmullRomSpline) over time. Optionally orients the object to face the direction of travel.

Hierarchy (View Summary)

Behavior
- PathFollowerBehavior

Index

Constructors

Properties

curve duration isActive lookForward pingPong target uuid inspector?

Methods

onAttach onDetach update

Constructors

constructor

new PathFollowerBehavior(
    curve: Curve3D,
    duration?: number,
    lookForward?: boolean,
    pingPong?: boolean,
): PathFollowerBehavior
Parameters
- curve: Curve3D
  The mathematical path to follow.
- duration: number = 5.0
  Time in seconds to complete the path.
- lookForward: boolean = true
  If true, aligns the object's rotation with the path's tangent (forward direction).
- pingPong: boolean = false
  If true, the object reverses direction at the ends of the path. Otherwise it loops back to 0.
Returns PathFollowerBehavior
Overrides Behavior.constructor
- Defined in core/behaviors/PathFollowerBehavior.ts:28

Properties

curve

curve: Curve3D

duration

duration: number

isActive

isActive: boolean = true

lookForward

lookForward: boolean

pingPong

pingPong: boolean

target

target: CameraInterfaceData | Object3D | undefined = undefined

The object this behavior is attached to. Set automatically.

`Readonly`uuid

uuid: string = ...

`Static` `Optional` `Readonly`inspector

inspector?: Record<string, InspectorField>

Methods

onAttach

onAttach(target: CameraInterfaceData | Object3D): void
Called when the behavior is attached to an object.
Parameters
- target: CameraInterfaceData | Object3D
Returns void
Inherited from Behavior.onAttach
- Defined in core/behaviors/Behavior.ts:35

onDetach

onDetach(): void
Called when the behavior is detached from an object.

Returns void
Inherited from Behavior.onDetach
- Defined in core/behaviors/Behavior.ts:42

update

update(deltaTime: number): void
Called every frame to update the behavior logic.
Parameters
- deltaTime: number
  The time elapsed since the last frame in seconds.
Returns void
Overrides Behavior.update
- Defined in core/behaviors/PathFollowerBehavior.ts:41