copper3d / Modules / Scene/baseScene / baseScene

Class: baseScene ​

Scene/baseScene.baseScene

Hierarchy ​

• commonScene

  ↳ baseScene

  ↳↳ copperScene

  ↳↳ copperSceneOnDemond

Table of contents ​

Constructors ​

• constructor

Properties ​

• ambientLight
• camera
• cameraPositionFlag
• color1
• color2
• container
• content
• controls
• copperControl
• copperOrthographicCamera
• copperPerspectiveCamera
• depthStep
• directionalLight
• exportContent
• isHalfed
• lights
• pickableObjects
• preRenderCallbackFunctions
• renderNrrdVolume
• renderer
• scene
• sceneName
• sort
• subCamera
• subCopperControl
• subDiv
• subRender
• subScene
• viewPoint
• vignette

Methods ​

• addLights
• addObject
• addPreRenderCallbackFunction
• addSubView
• createDemoMesh
• getDefaultViewPoint
• init
• loadDicom
• loadMetadataUrl
• loadNrrd
• loadNrrdTexture3d
• loadOBJ
• loadView
• loadViewUrl
• onRenderCameraChange
• onWindowResize
• pickModel
• pickSpecifiedModel
• removeLights
• removePreRenderCallbackFunction
• render
• setDepth
• setDicomFilesOrder
• setViewPoint
• updateBackground
• updateControls
• updateDisplay
• updateLights
• updateModelChildrenVisualisation

Constructors ​

constructor ​

• new baseScene(container, renderer, opt?)

Parameters ​

Overrides ​

commonScene.constructor

Defined in ​

src/Scene/baseScene.ts:30

Properties ​

ambientLight ​

• ambientLight: AmbientLight

Defined in ​

src/Scene/baseScene.ts:18

camera ​

• camera: PerspectiveCamera | OrthographicCamera

Inherited from ​

commonScene.camera

Defined in ​

src/Scene/commonSceneMethod.ts:30

cameraPositionFlag ​

• cameraPositionFlag: boolean = false

Defined in ​

src/Scene/baseScene.ts:20

color1 ​

• Private color1: string = "#5454ad"

Defined in ​

src/Scene/baseScene.ts:26

color2 ​

• Private color2: string = "#18e5a7"

Defined in ​

src/Scene/baseScene.ts:27

container ​

• container: HTMLDivElement

Inherited from ​

commonScene.container

Defined in ​

src/Scene/commonSceneMethod.ts:28

content ​

• content: Group<Object3DEventMap>

Defined in ​

src/Scene/baseScene.ts:21

controls ​

• controls: Copper3dTrackballControls | OrbitControls<Camera> | TrackballControls

Inherited from ​

commonScene.controls

Defined in ​

src/Scene/commonSceneMethod.ts:38

copperControl ​

• copperControl: Controls

Defined in ​

src/Scene/baseScene.ts:19

copperOrthographicCamera ​

• copperOrthographicCamera: OrthographicCamera

Inherited from ​

commonScene.copperOrthographicCamera

Defined in ​

src/Scene/commonSceneMethod.ts:33

copperPerspectiveCamera ​

• copperPerspectiveCamera: PerspectiveCamera

Inherited from ​

commonScene.copperPerspectiveCamera

Defined in ​

src/Scene/commonSceneMethod.ts:32

depthStep ​

• Protected depthStep: number = 0.4

Inherited from ​

commonScene.depthStep

Defined in ​

src/Scene/commonSceneMethod.ts:45

directionalLight ​

• directionalLight: DirectionalLight

Defined in ​

src/Scene/baseScene.ts:17

exportContent ​

• exportContent: Group<Object3DEventMap>

Defined in ​

src/Scene/baseScene.ts:22

isHalfed ​

• isHalfed: boolean = false

Defined in ​

src/Scene/baseScene.ts:23

lights ​

• Private lights: any[] = []

Defined in ​

src/Scene/baseScene.ts:28

pickableObjects ​

• Protected pickableObjects: Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>[] = []

Inherited from ​

commonScene.pickableObjects

Defined in ​

src/Scene/commonSceneMethod.ts:47

preRenderCallbackFunctions ​

• Protected preRenderCallbackFunctions: preRenderCallbackFunctionType

Inherited from ​

commonScene.preRenderCallbackFunctions

Defined in ​

src/Scene/commonSceneMethod.ts:43

renderNrrdVolume ​

• Protected renderNrrdVolume: boolean = false

Inherited from ​

commonScene.renderNrrdVolume

Defined in ​

src/Scene/commonSceneMethod.ts:41

renderer ​

• renderer: WebGLRenderer

Defined in ​

src/Scene/baseScene.ts:12

scene ​

• scene: Scene<Object3DEventMap>

Inherited from ​

commonScene.scene

Defined in ​

src/Scene/commonSceneMethod.ts:29

sceneName ​

• sceneName: string = ""

Defined in ​

src/Scene/baseScene.ts:15

sort ​

• Protected sort: boolean = true

Inherited from ​

commonScene.sort

Defined in ​

src/Scene/commonSceneMethod.ts:44

subCamera ​

• subCamera: null | PerspectiveCamera = null

Inherited from ​

commonScene.subCamera

Defined in ​

src/Scene/commonSceneMethod.ts:37

subCopperControl ​

• Protected subCopperControl: null | Controls = null

Inherited from ​

commonScene.subCopperControl

Defined in ​

src/Scene/commonSceneMethod.ts:40

subDiv ​

• subDiv: null | HTMLDivElement = null

Inherited from ​

commonScene.subDiv

Defined in ​

src/Scene/commonSceneMethod.ts:35

subRender ​

• Protected subRender: null | WebGLRenderer = null

Inherited from ​

commonScene.subRender

Defined in ​

src/Scene/commonSceneMethod.ts:39

subScene ​

• subScene: Scene<Object3DEventMap>

Inherited from ​

commonScene.subScene

Defined in ​

src/Scene/commonSceneMethod.ts:36

viewPoint ​

• viewPoint: CameraViewPoint

Defined in ​

src/Scene/baseScene.ts:24

vignette ​

• vignette: undefined | customMeshType

Defined in ​

src/Scene/baseScene.ts:16

Methods ​

addLights ​

▸ addLights(): void

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:142

addObject ​

▸ addObject(obj): void

Parameters ​

Returns ​

void

Overrides ​

commonScene.addObject

Defined in ​

src/Scene/baseScene.ts:138

addPreRenderCallbackFunction ​

▸ addPreRenderCallbackFunction(callbackFunction): number

Registers a per-frame callback and returns its id, for removePreRenderCallbackFunction.

Parameters ​

Returns ​

number

Inherited from ​

commonScene.addPreRenderCallbackFunction

Defined in ​

src/Scene/commonSceneMethod.ts:109

addSubView ​

▸ addSubView(): HTMLDivElement

create a new sub view to display models

Returns ​

HTMLDivElement

Inherited from ​

commonScene.addSubView

Defined in ​

src/Scene/commonSceneMethod.ts:159

createDemoMesh ​

▸ createDemoMesh(): void

Returns ​

void

Inherited from ​

commonScene.createDemoMesh

Defined in ​

src/Scene/commonSceneMethod.ts:82

getDefaultViewPoint ​

▸ getDefaultViewPoint(): CameraViewPoint

Returns ​

CameraViewPoint

Defined in ​

src/Scene/baseScene.ts:113

init ​

▸ init(): void

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:57

loadDicom ​

▸ loadDicom(urls, opts?): void

Parameters ​

Returns ​

void

Inherited from ​

commonScene.loadDicom

Defined in ​

src/Scene/commonSceneMethod.ts:183

loadMetadataUrl ​

▸ loadMetadataUrl(url): void

Parameters ​

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:71

loadNrrd ​

▸ loadNrrd(url, loadingBar, callback?, opts?): void

Loads an NRRD in the canonical voxel order (i -> patient Left, j -> Posterior, k -> Superior), whatever order its file stores; see copperNrrdLoader.

Parameters ​

Returns ​

void

Inherited from ​

commonScene.loadNrrd

Defined in ​

src/Scene/commonSceneMethod.ts:302

loadNrrdTexture3d ​

▸ loadNrrdTexture3d(url, callback?): void

Parameters ​

Returns ​

void

Deprecated

Shows the file in its stored voxel order, not the canonical LPS order every other loader uses, with window and threshold values fixed for one demo case. Use loadNrrd (copperNrrdLoader) instead. Will be removed in a future major release.

Inherited from ​

commonScene.loadNrrdTexture3d

Defined in ​

src/Scene/commonSceneMethod.ts:330

loadOBJ ​

▸ loadOBJ(url, callback?, opts?): void

Parameters ​

Returns ​

void

Inherited from ​

commonScene.loadOBJ

Defined in ​

src/Scene/commonSceneMethod.ts:342

loadView ​

▸ loadView(viewpointData): void

Parameters ​

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:100

loadViewUrl ​

▸ loadViewUrl(url): void

Parameters ​

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:88

onRenderCameraChange ​

▸ onRenderCameraChange(): void

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:215

onWindowResize ​

▸ onWindowResize(): void

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:221

pickModel ​

▸ pickModel(content, callback, options?): void

Parameters ​

Returns ​

void

Inherited from ​

commonScene.pickModel

Defined in ​

src/Scene/commonSceneMethod.ts:117

pickSpecifiedModel ​

▸ pickSpecifiedModel(content, mousePosition): Object

Parameters ​

Returns ​

Object

Inherited from ​

commonScene.pickSpecifiedModel

Defined in ​

src/Scene/commonSceneMethod.ts:139

removeLights ​

▸ removeLights(): void

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:173

removePreRenderCallbackFunction ​

▸ removePreRenderCallbackFunction(id): void

Parameters ​

Returns ​

void

Inherited from ​

commonScene.removePreRenderCallbackFunction

Defined in ​

src/Scene/commonSceneMethod.ts:113

render ​

▸ render(time?): void

Parameters ​

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:236

setDepth ​

▸ setDepth(value): void

Parameters ​

Returns ​

void

Inherited from ​

commonScene.setDepth

Defined in ​

src/Scene/commonSceneMethod.ts:97

setDicomFilesOrder ​

▸ setDicomFilesOrder(value): void

Parameters ​

Returns ​

void

Inherited from ​

commonScene.setDicomFilesOrder

Defined in ​

src/Scene/commonSceneMethod.ts:100

setViewPoint ​

▸ setViewPoint(camera, target?): CameraViewPoint

Parameters ​

Returns ​

CameraViewPoint

Defined in ​

src/Scene/baseScene.ts:117

updateBackground ​

▸ updateBackground(color1, color2): void

Parameters ​

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:201

updateControls ​

▸ updateControls(camera): void

Parameters ​

Returns ​

void

Inherited from ​

commonScene.updateControls

Defined in ​

src/Scene/commonSceneMethod.ts:316

updateDisplay ​

▸ updateDisplay(state): void

Parameters ​

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:196

updateLights ​

▸ updateLights(state): void

Parameters ​

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:179

updateModelChildrenVisualisation ​

▸ updateModelChildrenVisualisation(child): void

Parameters ​

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:206