Options
All
  • Public
Menu

Class RenderParams

Hierarchy

  • RenderParams

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

ambience

ambience: number

autoNavEnabled

autoNavEnabled: boolean

autoNavSpeed

autoNavSpeed: number

backgroundColor

backgroundColor: Color

brightness

brightness: number

cutPlaneList

cutPlaneList: Array<CutPlane>

desiredFPS

desiredFPS: number

enableFrontClippingPlane

enableFrontClippingPlane: boolean

enableGradientRendering

enableGradientRendering: boolean

enableSlabMode

enableSlabMode: boolean

frontSlabPolygonTransparency

frontSlabPolygonTransparency: number

gradientLightingAtSlabSurface

gradientLightingAtSlabSurface: number

imageHeight

imageHeight: number

imageWidth

imageWidth: number

level

level: number

lightAttachmentMode

lightAttachmentMode: LightAttachmentMode

lightDirection

lightDirection: Vector

minQualityBias

minQualityBias: number

name

name: string = RenderParams.className

normalizeTFflag

normalizeTFflag: boolean

numRenderingThreads

numRenderingThreads: number

outputRGBForThinMode

outputRGBForThinMode: boolean

polygonColorization

polygonColorization: boolean

polygonLinesInScreenSpace

polygonLinesInScreenSpace: boolean

polygonLongTriangleForPerspecitveMode

polygonLongTriangleForPerspecitveMode: boolean

polygonsUseCutPlanes

polygonsUseCutPlanes: boolean

printDebug

printDebug: boolean

quality

quality: number

raycastingPrecision

raycastingPrecision: number

rearSlabPolygonTransparency

rearSlabPolygonTransparency: number

reflection

reflection: number

renderPolygonAsCrossSectionLines

renderPolygonAsCrossSectionLines: boolean

renderRanges

renderRanges: Array<RenderRangeParams>

renderSamples

renderSamples: number

renderType

renderType: RenderType

shininess

shininess: number

slabThickness

slabThickness: number

stereoMode

stereoMode: StereoMode

stereoSeparation

stereoSeparation: number

transform

transform: Matrix

viewAngle

viewAngle: number

window

window: number

zoom

zoom: number

Static className

className: string = "RenderParams"

Methods

combinewithRP

  • Parameters

    Returns void

setAmbience

  • setAmbience(ambience: number): void

  • Parameters

    • ambience: number

    Returns void

setBackgroundColor

  • setBackgroundColor(r: any, g?: any, b?: any): void

  • Parameters

    • r: any
    • Default value g: any = 0
    • Default value b: any = 0

    Returns void

setBrightness

  • setBrightness(brightness: number): void

  • Parameters

    • brightness: number

    Returns void

setCutPlanes

  • setCutPlanes(cutPlaneList: Array<CutPlane>): void

  • Parameters

    Returns void

setDesiredFPS

  • setDesiredFPS(desiredFPS: number): void

  • Parameters

    • desiredFPS: number

    Returns void

setEnableFrontClippingPlane

  • setEnableFrontClippingPlane(enableFrontClippingPlane: boolean): void

  • Parameters

    • enableFrontClippingPlane: boolean

    Returns void

setEnableGradientLighting

  • setEnableGradientLighting(enable: boolean): void

  • Parameters

    • enable: boolean

    Returns void

setEnableSlabMode

  • setEnableSlabMode(enableSlabMode: boolean): void

  • Parameters

    • enableSlabMode: boolean

    Returns void

setFrontSlabPolygonTransparency

  • setFrontSlabPolygonTransparency(frontSlabPolygonTransparency: number): void

  • Parameters

    • frontSlabPolygonTransparency: number

    Returns void

setGradientLightingAtSlabSurface

  • setGradientLightingAtSlabSurface(enable: number): void

  • Parameters

    • enable: number

    Returns void

setLightModel

Private setMinQualityBias

  • setMinQualityBias(minQualityBias: number): void

  • Parameters

    • minQualityBias: number

    Returns void

setNormalizeTFflag

  • setNormalizeTFflag(normalizeTFflag: boolean): void

  • Parameters

    • normalizeTFflag: boolean

    Returns void

Private setNumRenderingThreads

  • setNumRenderingThreads(numRenderingThreads: number): void

  • Parameters

    • numRenderingThreads: number

    Returns void

setOutputRGBForThinMode

  • setOutputRGBForThinMode(outputRGBForThinMode: boolean): void

  • Parameters

    • outputRGBForThinMode: boolean

    Returns void

setPolygonColorization

  • setPolygonColorization(enable: boolean): void

  • Parameters

    • enable: boolean

    Returns void

setPolygonLinesInScreenSpace

  • setPolygonLinesInScreenSpace(enable: boolean): void

  • Parameters

    • enable: boolean

    Returns void

Private setPolygonLongTriangleForPerspecitveMode

  • setPolygonLongTriangleForPerspecitveMode(enable: boolean): void

  • Parameters

    • enable: boolean

    Returns void

setPolygonsUseCutPlanes

  • setPolygonsUseCutPlanes(enable: boolean): void

  • Parameters

    • enable: boolean

    Returns void

setQuality

  • Parameters

    Returns void

Private setRaycastingPrecision

  • setRaycastingPrecision(raycastingPrecision: number): void

  • Parameters

    • raycastingPrecision: number

    Returns void

setRearSlabPolygonTransparency

  • setRearSlabPolygonTransparency(rearSlabPolygonTransparency: number): void

  • Parameters

    • rearSlabPolygonTransparency: number

    Returns void

setReflection

  • setReflection(reflection: number): void

  • Parameters

    • reflection: number

    Returns void

setRenderImageSize

  • setRenderImageSize(width: number, height: number): void

  • Parameters

    • width: number
    • height: number

    Returns void

setRenderPolygonAsCrossSectionLines

  • setRenderPolygonAsCrossSectionLines(enable: boolean): void

  • Parameters

    • enable: boolean

    Returns void

setRenderType

  • Parameters

    Returns void

setShininess

  • setShininess(shininess: number): void

  • Parameters

    • shininess: number

    Returns void

setSlabThickness

  • setSlabThickness(slabThickness: number): void

  • Parameters

    • slabThickness: number

    Returns void

setStereoMode

  • Parameters

    Returns void

setStereoSeparation

  • setStereoSeparation(stereoSeparation: number): void

  • Parameters

    • stereoSeparation: number

    Returns void

setTransferFunction

  • Parameters

    Returns void

setTransform

  • setTransform(transform: Matrix): void

  • Parameters

    Returns void

setViewAngle

  • setViewAngle(viewAngle: number): void

  • Parameters

    • viewAngle: number

    Returns void

setWindowLevel

  • setWindowLevel(window: number, level: number): void

  • Parameters

    • window: number
    • level: number

    Returns void

setZoom

  • setZoom(zoom: number): void

  • Parameters

    • zoom: number

    Returns void

toString

  • toString(): String

  • Returns String

Static loadXMLPreset

  • loadXMLPreset(xmlPresetName: String, callback?: any): Promise<Object>

  • Parameters

    • xmlPresetName: String
    • Optional callback: any

    Returns Promise<Object>

Static saveXMLPreset

  • saveXMLPreset(xmlPresetName: String, rp: RenderParams, callback?: any): Promise<Object>

  • Parameters

    • xmlPresetName: String
    • rp: RenderParams
    • Optional callback: any

    Returns Promise<Object>

Generated using TypeDoc