Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ViewportScreenshotHelper

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private _imagePass

_imagePass: any

Private _params

_params: any

Private _previewPass

_previewPass: any

Readonly behaviors

behaviors: { cropParams: BehaviorSubject<{ auto: boolean; relativePadding: number }>; relativeCrop: BehaviorSubject<<internal>.Viewport>; values: BehaviorSubject<<internal>.Values<{ axes: <internal>.Mapped<NamedParams<Normalize<unknown>, "off"> | NamedParams<Normalize<{ alpha: number; bumpAmplitude: number; bumpFrequency: number; clip: Normalize<{ objects: any; variant: any }>; colorX: <internal>.Color; colorY: <internal>.Color; colorZ: <internal>.Color; doubleSided: boolean; flatShaded: boolean; flipSided: boolean; ignoreLight: boolean; material: Normalize<{ bumpiness: number; metalness: number; roughness: number }>; quality: "custom" | "auto" | "medium" | "high" | "low" | "highest" | "higher" | "lower" | "lowest"; scale: number; transparentBackfaces: string; xrayShaded: boolean }>, "on">>; resolution: <internal>.Mapped<NamedParams<Normalize<unknown>, "viewport"> | NamedParams<Normalize<unknown>, "hd"> | NamedParams<Normalize<unknown>, "full-hd"> | NamedParams<Normalize<unknown>, "ultra-hd"> | NamedParams<Normalize<{ height: number; width: number }>, "custom">>; transparent: BooleanParam }>> }

Type declaration

Private canvas

canvas: any

Private copyToClipboardTask

copyToClipboardTask: any

Private createParams

createParams: any

Private createPass

createPass: any

Private downloadTask

downloadTask: any

Private draw

draw: any

Readonly events

events: { previewed: Subject<any> }

Type declaration

Private getCanvasSize

getCanvasSize: any

Private getSize

getSize: any

Private plugin

plugin: any

Private previewCanvas

previewCanvas: any

Private previewData

previewData: any

Accessors

cropParams

  • get cropParams(): { auto: boolean; relativePadding: number }

  • Returns { auto: boolean; relativePadding: number }

    • auto: boolean
    • relativePadding: number

Protected ev

  • Returns RxEventHelper

imagePass

  • Returns ImagePass

isFullFrame

  • get isFullFrame(): boolean

  • Returns boolean

params

Private previewPass

  • get previewPass(): any

  • Returns any

relativeCrop

  • Returns <internal>.Viewport

values

Methods

autocrop

  • autocrop(relativePadding?: number): void

  • Parameters

    • Optional relativePadding: number

    Returns void

copyToClipboard

  • copyToClipboard(): undefined | Promise<void>

  • Returns undefined | Promise<void>

dispose

  • dispose(): void

  • Returns void

download

  • download(filename?: string): void

  • Parameters

    • Optional filename: string

    Returns void

getFilename

  • getFilename(extension?: string): string

  • Parameters

    • Optional extension: string

    Returns string

getImageDataUri

  • getImageDataUri(): Promise<string>

  • Returns Promise<string>

getPreview

  • getPreview(maxDim?: number): undefined | { canvas: HTMLCanvasElement; height: number; width: number }

  • Parameters

    • Optional maxDim: number

    Returns undefined | { canvas: HTMLCanvasElement; height: number; width: number }

getSizeAndViewport

  • Returns { height: number; viewport: <internal>.Viewport; width: number }

resetCrop

  • resetCrop(): void

  • Returns void

Protected subscribe

  • subscribe<T>(obs: Observable<T>, action: (v: T) => void): { unsubscribe: any }

  • Type parameters

    • T

    Parameters

    • obs: Observable<T>
    • action: (v: T) => void
        • (v: T): void

        • Parameters

          • v: T

          Returns void

    Returns { unsubscribe: any }

    • unsubscribe:function
      • unsubscribe(): void

      • Returns void

toggleAutocrop

  • toggleAutocrop(): void

  • Returns void

Generated using TypeDoc