Class FlightInstance

baseclass for all Objects

Hierarchy (View Summary)

VcsObject
- FlightInstance

Index

Accessors

className initialized interpolation loop multiplier className

Constructors

Methods

destroy getLogger initialize isValid toJSON getDefaultOptions

Properties

[moduleIdSymbol]? anchors anchorsChanged isDestroyed name properties propertyChanged

Accessors

className

get className(): string
Returns string
Inherited from VcsObject.className
- Defined in src/vcsObject.ts:53

initialized

get initialized(): boolean
Returns boolean
- Defined in src/util/flight/flightInstance.ts:96

interpolation

get interpolation(): FlightInterpolation
Returns FlightInterpolation
- Defined in src/util/flight/flightInstance.ts:129
set interpolation(value: FlightInterpolation): void
Parameters
- value: FlightInterpolation
Returns void
- Defined in src/util/flight/flightInstance.ts:133

loop

get loop(): boolean
Whether this flight represents a circular flight path or not

Returns boolean
- Defined in src/util/flight/flightInstance.ts:116
set loop(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/util/flight/flightInstance.ts:120

multiplier

get multiplier(): number
Returns number
- Defined in src/util/flight/flightInstance.ts:100
set multiplier(value: number): void
Parameters
- value: number
Returns void
- Defined in src/util/flight/flightInstance.ts:104

`Static`className

get className(): string
Returns string
Overrides VcsObject.className
- Defined in src/util/flight/flightInstance.ts:34

Constructors

constructor

new FlightInstance(options: FlightInstanceOptions): FlightInstance
Parameters
- options: FlightInstanceOptions
Returns FlightInstance
Overrides VcsObject.constructor
- Defined in src/util/flight/flightInstance.ts:71

Methods

destroy

destroy(): void
Returns void
Overrides VcsObject.destroy
- Defined in src/util/flight/flightInstance.ts:236

getLogger

getLogger(): Logger
Returns Logger
Inherited from VcsObject.getLogger
- Defined in src/vcsObject.ts:57

initialize

initialize(): Promise<void>
Returns Promise<void>
- Defined in src/util/flight/flightInstance.ts:142

isValid

isValid(): boolean
checks if this flightInstance is valid. To be valid, a flight must have at least 2 anchors.

Returns boolean
- Defined in src/util/flight/flightInstance.ts:200

toJSON

toJSON(defaultOptions?: FlightInstanceOptions): FlightInstanceOptions
returns an options object for this flight. if this flight was configured via an URL, only the url will be configured.
Parameters
- defaultOptions: FlightInstanceOptions = ...
Returns FlightInstanceOptions
Overrides VcsObject.toJSON
- Defined in src/util/flight/flightInstance.ts:208

`Static`getDefaultOptions

getDefaultOptions(): FlightInstanceOptions
Returns FlightInstanceOptions
Overrides VcsObject.getDefaultOptions
- Defined in src/util/flight/flightInstance.ts:62

Properties

`Optional`[moduleIdSymbol]

"[moduleIdSymbol]"?: string

anchors

anchors: IndexedCollection<FlightAnchor>

anchorsChanged

anchorsChanged: VcsEvent<void> = ...

Raised when anchors are added, removed, moved or changed

isDestroyed

isDestroyed: boolean

`Readonly`name

name: string

unique Name

properties

properties: Record<string, unknown>

propertyChanged

propertyChanged: VcsEvent<"multiplier" | "loop" | "interpolation"> = ...

Raised when multiplier, loop or interpolation changes.