Class ComponentSequenceProperty<T>

constructor

• new ComponentSequenceProperty<T extends ValueType>(
      loop?: boolean,
      components: GenComponents<IHermiteKeyframe<Scalar>[], T>,
      modifiers?: IModifier<T>[],
  ): ComponentSequenceProperty<T>

  Type Parameters

  • T extends ValueType

  Parameters

  • loop: boolean = false
  • components: GenComponents<IHermiteKeyframe<Scalar>[], T>
  • modifiers: IModifier<T>[] = []

  Returns ComponentSequenceProperty<T>

components

function

loop

duration

• get duration(): number

  Returns number

• set duration(value: number): void

  Parameters

  • value: number

  Returns void

fieldCount

• get fieldCount(): number

  Returns number

fields

• get fields(): NumericalField[]

  Returns NumericalField[]

add

• add(summand: number | TypeMap.PropertyValue[T]): ComponentSequenceProperty<T>

  Parameters

  • summand: number | TypeMap.PropertyValue[T]

  Returns ComponentSequenceProperty<T>

canBeSimplified

• canBeSimplified(): boolean

  If all components have the same number of keyframes and keyframe positions, the property can be converted to a HermiteProperty without losing any information or functionality.

  This method performs these checks and returns a boolean indicating if the property can be simplified this way or not.

  Returns boolean

clone

• clone(): ComponentSequenceProperty<T>

  Returns ComponentSequenceProperty<T>

combineComponents

• combineComponents(): HermiteProperty<T> | LinearProperty<T>

  Combines the components to form a new SequenceProperty with roughly the same values and the same modifiers.

  Note that linear interpolation is used to approximate both sampling of the components as well as the function of the output property, meaning that non-linear curves used are lost in this conversion.

  Returns HermiteProperty<T> | LinearProperty<T>

max

• max(): TypeMap.PropertyValue[T]

  Returns TypeMap.PropertyValue[T]

min

• min(): TypeMap.PropertyValue[T]

  Returns TypeMap.PropertyValue[T]

minify

• minify(): Property<T, PropertyFunction>

  Returns Property<T, PropertyFunction>

scale

• scale(factor: number | TypeMap.PropertyValue[T]): ComponentSequenceProperty<T>

  Parameters

  • factor: number | TypeMap.PropertyValue[T]

  Returns ComponentSequenceProperty<T>

separateComponents

• separateComponents(): ComponentSequenceProperty<Scalar>[]

  Returns ComponentSequenceProperty<Scalar>[]

serialize

• serialize(
      options?: FXRSerializeOptions,
  ): {
      components: IHermiteKeyframe<Scalar>[][];
      function: "ComponentHermite";
      loop: boolean;
      modifiers?: any[];
  }

  Parameters

  • Optionaloptions: FXRSerializeOptions

  Returns {
      components: IHermiteKeyframe<Scalar>[][];
      function: "ComponentHermite";
      loop: boolean;
      modifiers?: any[];
  }

sortComponentKeyframes

• sortComponentKeyframes(): ComponentSequenceProperty<T>

  Returns ComponentSequenceProperty<T>

valueAt

• valueAt(arg: number): TypeMap.PropertyValue[T]

  Parameters

  • arg: number

  Returns TypeMap.PropertyValue[T]

StaticfromFields

• fromFields<T extends ValueType>(
      valueType: T,
      loop: boolean,
      modifiers: IModifier<T>[],
      fieldValues: number[],
  ): ComponentSequenceProperty<T>

  Type Parameters

  • T extends ValueType

  Parameters

  • valueType: T
  • loop: boolean
  • modifiers: IModifier<T>[]
  • fieldValues: number[]

  Returns ComponentSequenceProperty<T>

StaticfromJSON

• fromJSON<T extends ValueType>(
      __namedParameters: {
          components: GenComponents<IHermiteKeyframe<Scalar>[], T>;
          loop: boolean;
          modifiers?: any[];
      },
  ): ComponentSequenceProperty<T>

  Type Parameters

  • T extends ValueType

  Parameters

  • __namedParameters: {
        components: GenComponents<IHermiteKeyframe<Scalar>[], T>;
        loop: boolean;
        modifiers?: any[];
    }

  Returns ComponentSequenceProperty<T>