copper3d / Modules / Scene/copperMScene / copperMScene

Class: copperMScene ​

Scene/copperMScene.copperMScene

Hierarchy ​

• commonScene

  ↳ copperMScene

Table of contents ​

Constructors ​

• constructor

Properties ​

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

Methods ​

• addLights
• addObject
• addPreRenderCallbackFunction
• addSubView
• createDemoMesh
• drawWholeNrrd
• init
• loadDicom
• loadGltf
• loadNrrd
• loadNrrdTexture3d
• loadOBJ
• loadView
• loadViewUrl
• onWindowResize
• pickModel
• pickSpecifiedModel
• removeLights
• removePreRenderCallbackFunction
• render
• resetView
• setCameraPosition
• setControls
• setDepth
• setDicomFilesOrder
• setViewPoint
• updateBackground
• updateCamera
• updateControls

Constructors ​

constructor ​

• new copperMScene(container, renderer)

Parameters ​

Overrides ​

commonScene.constructor

Defined in ​

src/Scene/copperMScene.ts:53

Properties ​

ambientLight ​

• ambientLight: AmbientLight

Defined in ​

src/Scene/copperMScene.ts:41

camera ​

• camera: PerspectiveCamera | OrthographicCamera

Inherited from ​

commonScene.camera

Defined in ​

src/Scene/commonSceneMethod.ts:30

cameraPositionFlag ​

• cameraPositionFlag: boolean = false

Defined in ​

src/Scene/copperMScene.ts:44

color1 ​

• Private color1: string = "#5454ad"

Defined in ​

src/Scene/copperMScene.ts:48

color2 ​

• Private color2: string = "#18e5a7"

Defined in ​

src/Scene/copperMScene.ts:49

container ​

• container: HTMLDivElement

Overrides ​

commonScene.container

Defined in ​

src/Scene/copperMScene.ts:36

content ​

• content: Group<Object3DEventMap>

Defined in ​

src/Scene/copperMScene.ts:45

controls ​

• controls: Copper3dTrackballControls | OrbitControls<Camera> | TrackballControls

Inherited from ​

commonScene.controls

Defined in ​

src/Scene/commonSceneMethod.ts:38

copperControl ​

• copperControl: Controls

Defined in ​

src/Scene/copperMScene.ts:42

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/copperMScene.ts:40

gui ​

• gui: GUI

Defined in ​

src/Scene/copperMScene.ts:32

guiContainer ​

• Private guiContainer: HTMLDivElement

Defined in ​

src/Scene/copperMScene.ts:51

isHalfed ​

• isHalfed: boolean = false

Defined in ​

src/Scene/copperMScene.ts:46

lights ​

• Private lights: any[] = []

Defined in ​

src/Scene/copperMScene.ts:50

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/copperMScene.ts:37

scene ​

• scene: Scene<Object3DEventMap>

Inherited from ​

commonScene.scene

Defined in ​

src/Scene/commonSceneMethod.ts:29

sceneName ​

• sceneName: string = ""

Defined in ​

src/Scene/copperMScene.ts:38

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/copperMScene.ts:43

vignette ​

• vignette: customMeshType

Defined in ​

src/Scene/copperMScene.ts:39

Methods ​

addLights ​

▸ addLights(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:292

addObject ​

▸ addObject(obj): void

Parameters ​

Returns ​

void

Inherited from ​

commonScene.addObject

Defined in ​

src/Scene/commonSceneMethod.ts:93

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

drawWholeNrrd ​

▸ drawWholeNrrd(nrrdSlices): void

Parameters ​

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:277

init ​

▸ init(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:83

loadDicom ​

▸ loadDicom(urls, opts?): void

Parameters ​

Returns ​

void

Inherited from ​

commonScene.loadDicom

Defined in ​

src/Scene/commonSceneMethod.ts:183

loadGltf ​

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

Parameters ​

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:133

loadNrrd ​

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

Parameters ​

Returns ​

void

Inherited from ​

commonScene.loadNrrd

Defined in ​

src/Scene/commonSceneMethod.ts:299

loadNrrdTexture3d ​

▸ loadNrrdTexture3d(url, callback?): void

Parameters ​

Returns ​

void

Inherited from ​

commonScene.loadNrrdTexture3d

Defined in ​

src/Scene/commonSceneMethod.ts:323

loadOBJ ​

▸ loadOBJ(url, callback?): void

Parameters ​

Returns ​

void

Overrides ​

commonScene.loadOBJ

Defined in ​

src/Scene/copperMScene.ts:230

loadView ​

▸ loadView(viewpointData): void

Parameters ​

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:324

loadViewUrl ​

▸ loadViewUrl(url): void

Parameters ​

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:312

onWindowResize ​

▸ onWindowResize(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:367

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/copperMScene.ts:305

removePreRenderCallbackFunction ​

▸ removePreRenderCallbackFunction(id): void

Parameters ​

Returns ​

void

Overrides ​

commonScene.removePreRenderCallbackFunction

Defined in ​

src/Scene/copperMScene.ts:358

render ​

▸ render(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:391

resetView ​

▸ resetView(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:362

setCameraPosition ​

▸ setCameraPosition(position): void

Parameters ​

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:351

setControls ​

▸ setControls(type): void

Parameters ​

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:112

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/copperMScene.ts:208

updateBackground ​

▸ updateBackground(color1, color2): void

Parameters ​

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:286

updateCamera ​

▸ updateCamera(viewpoint): void

Parameters ​

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:346

updateControls ​

▸ updateControls(camera): void

Parameters ​

Returns ​

void

Inherited from ​

commonScene.updateControls

Defined in ​

src/Scene/commonSceneMethod.ts:314