Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LUT <TProps >

Index

Modules

Constructors

Methods

Constructors

constructor

Methods

getColors

  • getColors(values: number): Color
  • getColors(values: number[]): Color[]
  • getColors(values: number[][]): Color[][]

  • Parameters

    • values: number

    Returns Color

    Associated color if the LUT is valid, otherwise fallback color.

  • Parameters

    • values: number[]

    Returns Color[]

    Collection of associated colors if the LUT is valid, otherwise fallback colors.

  • Parameters

    • values: number[][]

    Returns Color[][]

    Collection of associated colors if the LUT is valid, otherwise fallback colors.

getFallbackColor

  • getFallbackColor(): Color

  • Returns Color

    Color object.

getInterpolation

  • getInterpolation(): boolean

  • Returns boolean

    Intepolation behaviour state. True - gradient, False - uniform.

getSteps

  • Returns LUTStep[]

    Collection of steps.

getTitle

  • getTitle(): string

  • Returns string

    Title of the LUT as string.

getUnits

  • getUnits(): string

  • Returns string

    Units of the LUT as string.

setFallbackColor

  • setFallbackColor(color: Color): this

  • Parameters

    Returns this

setInterpolation

  • setInterpolation(interpolate: boolean): this

  • Parameters

    • interpolate: boolean

    Returns this

setSteps

  • Parameters

    Returns this

setTitle

  • setTitle(title: string): this

  • Parameters

    • title: string

    Returns this

setUnits

  • setUnits(units: string): this

  • Parameters

    • units: string

    Returns this

Static Factory

  • Factory(values: Partial<TProps> | Iterable<[string, any]>): Record<TProps> & Readonly<TProps>

  • Type parameters

    • TProps: Object

    Parameters

    • Optional values: Partial<TProps> | Iterable<[string, any]>

    Returns Record<TProps> & Readonly<TProps>

Static Record

  • Record(defaultValues: TProps, name: undefined | string): Factory<TProps>

  • Type parameters

    • TProps

    Parameters

    • defaultValues: TProps
    • Optional name: undefined | string

    Returns Factory<TProps>

Static getDescriptiveName

  • getDescriptiveName(record: Record<any>): string

  • Parameters

    • record: Record<any>

    Returns string

Static isRecord

  • isRecord(maybeRecord: any): boolean

  • Parameters

    • maybeRecord: any

    Returns boolean