Class HermiteProperty<T>

Type Parameters

T extends Tensor

Hierarchy (View Summary)

SequenceProperty<T, Hermite>
- HermiteProperty

Index

Constructors

constructor

new HermiteProperty<T extends Tensor>(
loop: boolean,
keyframes: IHermiteKeyframe<T>[],
): HermiteProperty<T>
Type Parameters
- T extends Tensor
Parameters
- loop: boolean
- keyframes: IHermiteKeyframe<T>[]
Returns HermiteProperty<T>
Overrides SequenceProperty.constructor
- Defined in fxr.ts:34179

Properties

function

function: Hermite

keyframes

keyframes: IHermiteKeyframe<T>[] = []

loop

loop: boolean = false

modifiers

modifiers: IModifier<T>[]

Accessors

componentCount

get componentCount(): 1 | 2 | 3 | 4
Returns 1 | 2 | 3 | 4
Inherited from SequenceProperty.componentCount
- Defined in fxr.ts:33173

duration

get duration(): number
Returns number
Inherited from SequenceProperty.duration
- Defined in fxr.ts:33744
set duration(value: number): void
Parameters
- value: number
Returns void
Inherited from SequenceProperty.duration
- Defined in fxr.ts:33745

fieldCount

get fieldCount(): number
Returns number
Inherited from SequenceProperty.fieldCount
- Defined in fxr.ts:33428

fields

get fields(): NumericalField[]
Returns NumericalField[]
Inherited from SequenceProperty.fields
- Defined in fxr.ts:33439

valueType

get valueType(): ValueTypeOfTensor<T>
Returns ValueTypeOfTensor<T>
Inherited from SequenceProperty.valueType
- Defined in fxr.ts:33416

Methods

add

add(summand: number | T): HermiteProperty<T>
Parameters
- summand: number | T
Returns HermiteProperty<T>
Inherited from SequenceProperty.add
- Defined in fxr.ts:33639

clamp

clamp(min: T, max: T): Property<T, PropertyFunction>
Parameters
- min: T
- max: T
Returns Property<T, PropertyFunction>
Inherited from SequenceProperty.clamp
- Defined in fxr.ts:33236

clone

clone(): SequenceProperty<T, Hermite>
Returns SequenceProperty<T, Hermite>
Inherited from SequenceProperty.clone
- Defined in fxr.ts:33681

for

for(game: Game): Property<T, Hermite>
Returns an equal property that works with the given game.

If the property has multiple modifiers, there is a chance that the output of this method will not be perfectly equal, but it should still be close.
Parameters
- game: Game
  The game to ensure that the property works with.
Returns Property<T, Hermite>
Inherited from SequenceProperty.for
- Defined in fxr.ts:33207

max

max(): T
Returns T
Inherited from SequenceProperty.max
- Defined in fxr.ts:33715

min

min(): T
Returns T
Inherited from SequenceProperty.min
- Defined in fxr.ts:33706

minify

minify(): Property<T, PropertyFunction>
Returns Property<T, PropertyFunction>
Inherited from SequenceProperty.minify
- Defined in fxr.ts:33724

scale

scale(factor: number | T): HermiteProperty<T>
Parameters
- factor: number | T
Returns HermiteProperty<T>
Inherited from SequenceProperty.scale
- Defined in fxr.ts:33624

separateComponents

separateComponents(): SequenceProperty<number, Hermite>[]
Returns SequenceProperty<number, Hermite>[]
Inherited from SequenceProperty.separateComponents
- Defined in fxr.ts:33690

serialize

serialize(
options?: FXRSerializeOptions,
): { function: string; keyframes: any[]; loop: boolean; modifiers?: any[] }
Parameters
- Optionaloptions: FXRSerializeOptions
Returns { function: string; keyframes: any[]; loop: boolean; modifiers?: any[] }
Inherited from SequenceProperty.serialize
- Defined in fxr.ts:33563

sortKeyframes

sortKeyframes(): HermiteProperty<T>
Returns HermiteProperty<T>
Inherited from SequenceProperty.sortKeyframes
- Defined in fxr.ts:33423

toJSON

toJSON(): any
Returns any
Inherited from SequenceProperty.toJSON
- Defined in fxr.ts:33240

valueAt

valueAt(arg: number): T
Parameters
- arg: number
Returns T
Inherited from SequenceProperty.valueAt
- Defined in fxr.ts:33653

withModifiers

withModifiers(...modifiers: IModifier<T>[]): HermiteProperty<T>
Parameters
- ...modifiers: IModifier<T>[]
Returns HermiteProperty<T>
Inherited from SequenceProperty.withModifiers
- Defined in fxr.ts:33175

`Static`ease

ease<T extends Tensor>(
    loop: boolean,
    duration: number,
    startValue: T,
    endValue: T,
): HermiteProperty<T>
Creates a new sequence property that smoothly transitions from one value to another using an easing function that starts slowly, speeds up towards the midpoint, and then slows down towards the end.

This is very similar to the ease keyword in CSS.
Type Parameters
- T extends Tensor
Parameters
- loop: boolean
  Controls whether the animation should loop or not.
- duration: number
  The duration of the animation.
- startValue: T
  The value at the start of the animation.
- endValue: T
  The value at the end of the animation.
Returns HermiteProperty<T>
- Defined in fxr.ts:34195

`Static`easeIn

easeIn<T extends Tensor>(
    loop: boolean,
    duration: number,
    startValue: T,
    endValue: T,
): HermiteProperty<T>
Creates a new sequence property that smoothly transitions from one value to another using an easing function that starts slowly and speeds up towards the end.

This is very similar to the ease-in keyword in CSS.
Type Parameters
- T extends Tensor
Parameters
- loop: boolean
  Controls whether the animation should loop or not.
- duration: number
  The duration of the animation.
- startValue: T
  The value at the start of the animation.
- endValue: T
  The value at the end of the animation.
Returns HermiteProperty<T>
- Defined in fxr.ts:34219

`Static`easeInOut

easeInOut<T extends Tensor>(
    loop: boolean,
    duration: number,
    startValue: T,
    endValue: T,
): HermiteProperty<T>
Creates a new sequence property that smoothly transitions from one value to another using an easing function that starts slowly, speeds up towards the midpoint, and then slows down towards the end.

This is very similar to the ease-in-out keyword in CSS.
Type Parameters
- T extends Tensor
Parameters
- loop: boolean
  Controls whether the animation should loop or not.
- duration: number
  The duration of the animation.
- startValue: T
  The value at the start of the animation.
- endValue: T
  The value at the end of the animation.
Returns HermiteProperty<T>
- Defined in fxr.ts:34267

`Static`easeOut

easeOut<T extends Tensor>(
    loop: boolean,
    duration: number,
    startValue: T,
    endValue: T,
): HermiteProperty<T>
Creates a new sequence property that smoothly transitions from one value to another using an easing function that starts fast and slows down towards the end.

This is very similar to the ease-out keyword in CSS.
Type Parameters
- T extends Tensor
Parameters
- loop: boolean
  Controls whether the animation should loop or not.
- duration: number
  The duration of the animation.
- startValue: T
  The value at the start of the animation.
- endValue: T
  The value at the end of the animation.
Returns HermiteProperty<T>
- Defined in fxr.ts:34243

`Static`explosive

explosive<T extends Tensor>(
    loop: boolean,
    duration: number,
    startValue: T,
    endValue: T,
): HermiteProperty<T>
Creates a new sequence property that transitions from one value to another using an easing function that starts very fast, but very quickly slows down.
Type Parameters
- T extends Tensor
Parameters
- loop: boolean
  Controls whether the animation should loop or not.
- duration: number
  The duration of the animation.
- startValue: T
  The value at the start of the animation.
- endValue: T
  The value at the end of the animation.
Returns HermiteProperty<T>
- Defined in fxr.ts:34309

`Static`fromFields

fromFields<T extends Tensor, F extends SequencePropertyFunction>(
    valueType: ValueTypeOfTensor<T>,
    func: F,
    loop: boolean,
    modifiers: IModifier<T>[],
    fieldValues: number[],
): SequenceProperty<T, F>
Type Parameters
- T extends Tensor
- F extends SequencePropertyFunction
Parameters
- valueType: ValueTypeOfTensor<T>
- func: F
- loop: boolean
- modifiers: IModifier<T>[]
- fieldValues: number[]
Returns SequenceProperty<T, F>
Inherited from SequenceProperty.fromFields
- Defined in fxr.ts:33504

`Static`fromJSON

fromJSON<T extends Tensor>(
    obj: {
        function: string;
        keyframes?: AnyKeyframe<T>[];
        loop?: boolean;
        modifiers?: any[];
    },
): SequenceProperty<T, any>
Type Parameters
- T extends Tensor
Parameters
- obj: {
      function: string;
      keyframes?: AnyKeyframe<T>[];
      loop?: boolean;
      modifiers?: any[];
  }
Returns SequenceProperty<T, any>
Inherited from SequenceProperty.fromJSON
- Defined in fxr.ts:33549

`Static`launch

launch<T extends Tensor>(
    loop: boolean,
    duration: number,
    startValue: T,
    endValue: T,
): HermiteProperty<T>
Creates a new sequence property that transitions from one value to another using an easing function that starts very slow, but speeds up very quickly near the end.
Type Parameters
- T extends Tensor
Parameters
- loop: boolean
  Controls whether the animation should loop or not.
- duration: number
  The duration of the animation.
- startValue: T
  The value at the start of the animation.
- endValue: T
  The value at the end of the animation.
Returns HermiteProperty<T>
- Defined in fxr.ts:34288

Class HermiteProperty<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns HermiteProperty<T>

Properties

function

keyframes

loop

modifiers

Accessors

componentCount

Returns 1 | 2 | 3 | 4

duration

Returns number

Parameters

Returns void

fieldCount

Returns number

fields

Returns NumericalField[]

valueType

Returns ValueTypeOfTensor<T>

Methods

add

Parameters

Returns HermiteProperty<T>

clamp

Parameters

Returns Property<T, PropertyFunction>

clone

Returns SequenceProperty<T, Hermite>

for

Parameters

Returns Property<T, Hermite>

max

Returns T

min

Returns T

minify

Returns Property<T, PropertyFunction>

scale

Parameters

Returns HermiteProperty<T>

separateComponents

Returns SequenceProperty<number, Hermite>[]

serialize

Parameters

Returns { function: string; keyframes: any[]; loop: boolean; modifiers?: any[] }

sortKeyframes

Returns HermiteProperty<T>

toJSON

Returns any

valueAt

Parameters

Returns T

withModifiers

Parameters

Returns HermiteProperty<T>

Staticease

Type Parameters

Parameters

Returns HermiteProperty<T>

StaticeaseIn

Type Parameters

Parameters

Returns HermiteProperty<T>

StaticeaseInOut

Type Parameters

Parameters

Returns HermiteProperty<T>

StaticeaseOut

`Static`ease

`Static`easeIn

`Static`easeInOut

`Static`easeOut

`Static`explosive

`Static`fromFields

`Static`fromJSON

`Static`launch