Class VectorFieldOptions

Descriptor structure used for initialization of a VectorField.

Index

Constructors

Properties

_bounds _countX _countY _countZ

Accessors

bounds countX countY countZ

Methods

assign clone isEqual isEqual

Constructors

constructor

new VectorFieldOptions(
    countX?: number,
    countY?: number,
    countZ?: number,
    bounds?: Immutable<AABox>,
): VectorFieldOptions
Parameters
- OptionalcountX: number
- OptionalcountY: number
- OptionalcountZ: number
- Optionalbounds: Immutable<AABox>
Returns VectorFieldOptions

Properties

`Protected`_bounds

_bounds: AABox

`Protected`_countX

_countX: number

`Protected`_countY

_countY: number

`Protected`_countZ

_countZ: number

Accessors

bounds

get bounds(): AABox

Spatial bounds of the vector field.

Returns AABox
set bounds(value: Immutable<AABox>): void
Parameters
- value: Immutable<AABox>
Returns void

countX

get countX(): number

Number of entries in the vector field along the X axis.

Returns number
set countX(value: number): void
Parameters
- value: number
Returns void

countY

get countY(): number

Number of entries in the vector field along the Y axis.

Returns number
set countY(value: number): void
Parameters
- value: number
Returns void

countZ

get countZ(): number

Number of entries in the vector field along the Z axis.

Returns number
set countZ(value: number): void
Parameters
- value: number
Returns void

Methods

assign

assign(other: Immutable<VectorFieldOptions>): VectorFieldOptions
Copies all properties defined by the prototype of VectorFieldOptions from other to this instance.
Parameters
- other: Immutable<VectorFieldOptions>
Returns VectorFieldOptions

clone

clone(): VectorFieldOptions

Clones this instance and returns a new VectorFieldOptions with identical values.

Returns VectorFieldOptions

isEqual

isEqual(
this: Immutable<VectorFieldOptions>,
other: Immutable<VectorFieldOptions>,
): boolean
Determines if this VectorFieldOptions instance is equal to the other instance.
Parameters
- this: Immutable<VectorFieldOptions>
- other: Immutable<VectorFieldOptions>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<VectorFieldOptions>,
rhs: Immutable<VectorFieldOptions>,
): boolean
Determines if both VectorFieldOptions instances are equal.
Parameters
- lhs: Immutable<VectorFieldOptions>
- rhs: Immutable<VectorFieldOptions>
Returns boolean