Options
All
  • Public
  • Public/Protected
  • All
Menu

Manager of all story postprocesses, the pipeline will not impact UI (Progress bar, hotspot, etc)

Hierarchy

  • pipeline

Index

Constructors

constructor

Properties

cameras

cameras: Array<Camera> = []

List of the cameras used by pipeline

maxVignetteRatio

maxVignetteRatio: number = 0.6

Limit vignette ratio in order to have correct effect

options

Save current pipeline options

Methods

addCamera

  • addCamera(camera: Camera): void

checkOption

checkSharpen

  • checkSharpen(): void
  • Check if sharpen post process must be enabled depending on sharpen options

    Returns void

checkVignetteWigthRatio

  • checkVignetteWigthRatio(): void

removeCamera

  • removeCamera(camera: Camera): void

reset

  • reset(): void

setBloom

  • setBloom(bloom: number): void
  • Set the bloom postprocess

    Parameters

    • bloom: number

      Bloom of the scene

    Returns void

setChromatic

  • setChromatic(chromatic: number): void
  • Set the chromatic postprocess

    Parameters

    • chromatic: number

      Chromatic of the scene

    Returns void

setContrast

  • setContrast(contrast: number): void
  • Set the contrast postprocess

    Parameters

    • contrast: number

      Contrast of the scene

    Returns void

setExposure

  • setExposure(exposure: number): void
  • Set the exposure postprocess

    Parameters

    • exposure: number

      Exposure of the scene

    Returns void

setFieldOfView

  • setFieldOfView(fieldOfView: number): void
  • Set the field of view

    Parameters

    • fieldOfView: number

      of the scene camera

    Returns void

setFocalDistance

  • setFocalDistance(focalDistance: number): void
  • Set the focal distance of the depth of field postprocess

    Parameters

    • focalDistance: number

      Focal distance in meters

    Returns void

setFocalLength

  • setFocalLength(focalLength: number): void
  • Set the focal length of the depth of field postprocess

    Parameters

    • focalLength: number

      Focal length of the effect

    Returns void

setOption

setOptionProgress

  • Set pipeline with betweeen two option values

    Parameters

    • startPipeline: pipelineOptions

      The options at the beginning of the transition

    • endPipeline: pipelineOptions

      The options at the end of the transition

    • transition: number

      Transition between the two options in percentage

    Returns void

setSharpenColor

  • setSharpenColor(sharpenColor: number): void
  • Set the sharpen color postprocess

    Parameters

    • sharpenColor: number

      SharpenColor of the scene

    Returns void

setSharpenEdge

  • setSharpenEdge(sharpenEdge: number): void
  • Set the sharpen edge postprocess

    Parameters

    • sharpenEdge: number

      SharpenEdge of the scene

    Returns void

setVignette

  • setVignette(color: Array<number>): void
  • Set the vignette postprocess

    Parameters

    • color: Array<number>

      Color of the vignette

    Returns void

setVignetteOffset

  • setVignetteOffset(offset: number): void
  • Allow to offset the vignette center, used in hotspot/text transition

    Parameters

    • offset: number

      How much the vignette must be offseted

    Returns void

setVignetteWeight

  • setVignetteWeight(weight: number): void
  • Set the weight of the vignette

    Parameters

    • weight: number

      How strong is the weight of vignette

    Returns void

start

  • start(): void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc