Copper3d API

Appearance

copper3d / Modules / Scene/baseScene / baseScene

Class: baseScene ​

Scene/baseScene.baseScene

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new baseScene(container, renderer, opt?)

Parameters ​

NameType
containerHTMLDivElement
rendererWebGLRenderer
opt?ICopperSceneOpts

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:29

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:27

content ​

• content: Group<Object3DEventMap>

Defined in ​

src/Scene/baseScene.ts:21

controls ​

• controls: Copper3dTrackballControls | OrbitControls | TrackballControls

Inherited from ​

commonScene.controls

Defined in ​

src/Scene/commonSceneMethod.ts:37

copperControl ​

• copperControl: Controls

Defined in ​

src/Scene/baseScene.ts:19

copperOrthographicCamera ​

• copperOrthographicCamera: OrthographicCamera

Inherited from ​

commonScene.copperOrthographicCamera

Defined in ​

src/Scene/commonSceneMethod.ts:32

copperPerspectiveCamera ​

• copperPerspectiveCamera: PerspectiveCamera

Inherited from ​

commonScene.copperPerspectiveCamera

Defined in ​

src/Scene/commonSceneMethod.ts:31

depthStep ​

• Protected depthStep: number = 0.4

Inherited from ​

commonScene.depthStep

Defined in ​

src/Scene/commonSceneMethod.ts:44

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>, Material | Material[], Object3DEventMap>[] = []

Inherited from ​

commonScene.pickableObjects

Defined in ​

src/Scene/commonSceneMethod.ts:46

preRenderCallbackFunctions ​

• Protected preRenderCallbackFunctions: preRenderCallbackFunctionType

Inherited from ​

commonScene.preRenderCallbackFunctions

Defined in ​

src/Scene/commonSceneMethod.ts:42

renderNrrdVolume ​

• Protected renderNrrdVolume: boolean = false

Inherited from ​

commonScene.renderNrrdVolume

Defined in ​

src/Scene/commonSceneMethod.ts:40

renderer ​

• renderer: WebGLRenderer

Defined in ​

src/Scene/baseScene.ts:12

scene ​

• scene: Scene

Inherited from ​

commonScene.scene

Defined in ​

src/Scene/commonSceneMethod.ts:28

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:43

subCamera ​

• subCamera: null | PerspectiveCamera = null

Inherited from ​

commonScene.subCamera

Defined in ​

src/Scene/commonSceneMethod.ts:36

subCopperControl ​

• Protected subCopperControl: null | Controls = null

Inherited from ​

commonScene.subCopperControl

Defined in ​

src/Scene/commonSceneMethod.ts:39

subDiv ​

• subDiv: null | HTMLDivElement = null

Inherited from ​

commonScene.subDiv

Defined in ​

src/Scene/commonSceneMethod.ts:34

subRender ​

• Protected subRender: null | WebGLRenderer = null

Inherited from ​

commonScene.subRender

Defined in ​

src/Scene/commonSceneMethod.ts:38

subScene ​

• subScene: Scene

Inherited from ​

commonScene.subScene

Defined in ​

src/Scene/commonSceneMethod.ts:35

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:138

addObject ​

▸ addObject(obj): void

Parameters ​

NameType
objany

Returns ​

void

Overrides ​

commonScene.addObject

Defined in ​

src/Scene/baseScene.ts:134

addPreRenderCallbackFunction ​

▸ addPreRenderCallbackFunction(callbackFunction): number

Parameters ​

NameType
callbackFunctionFunction

Returns ​

number

Inherited from ​

commonScene.addPreRenderCallbackFunction

Defined in ​

src/Scene/commonSceneMethod.ts:122

addSubView ​

▸ addSubView(): HTMLDivElement

create a new sub view to display models

Returns ​

HTMLDivElement

Inherited from ​

commonScene.addSubView

Defined in ​

src/Scene/commonSceneMethod.ts:174

createDemoMesh ​

▸ createDemoMesh(): void

Returns ​

void

Inherited from ​

commonScene.createDemoMesh

Defined in ​

src/Scene/commonSceneMethod.ts:96

getDefaultViewPoint ​

▸ getDefaultViewPoint(): CameraViewPoint

Returns ​

CameraViewPoint

Defined in ​

src/Scene/baseScene.ts:109

init ​

▸ init(): void

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:54

loadDicom ​

▸ loadDicom(urls, opts?): void

Parameters ​

NameType
urlsstring | string[]
opts?dicomLoaderOptsType

Returns ​

void

Inherited from ​

commonScene.loadDicom

Defined in ​

src/Scene/commonSceneMethod.ts:198

loadMetadataUrl ​

▸ loadMetadataUrl(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:68

loadNrrd ​

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

Parameters ​

NameType
urlstring
loadingBarloadingBarType
segmentationboolean
callback?(volume: any, nrrdMeshes: nrrdMeshesType, nrrdSlices: nrrdSliceType, gui?: GUI) => void
opts?optsType

Returns ​

void

Inherited from ​

commonScene.loadNrrd

Defined in ​

src/Scene/commonSceneMethod.ts:314

loadNrrdTexture3d ​

▸ loadNrrdTexture3d(url, callback?): void

Parameters ​

NameType
urlstring
callback?(volume: any, gui?: GUI) => void

Returns ​

void

Inherited from ​

commonScene.loadNrrdTexture3d

Defined in ​

src/Scene/commonSceneMethod.ts:338

loadOBJ ​

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

Parameters ​

NameType
urlstring
callback?(mesh: Group<Object3DEventMap>) => void
opts?Object
opts.colorstring

Returns ​

void

Inherited from ​

commonScene.loadOBJ

Defined in ​

src/Scene/commonSceneMethod.ts:350

loadView ​

▸ loadView(viewpointData): void

Parameters ​

NameType
viewpointDataCameraViewPoint

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:97

loadViewUrl ​

▸ loadViewUrl(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:85

onRenderCameraChange ​

▸ onRenderCameraChange(): void

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:193

onWindowResize ​

▸ onWindowResize(): void

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:199

pickModel ​

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

Parameters ​

NameType
contentGroup<Object3DEventMap>
callback(selectMesh: undefined | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>) => void
options?string[]

Returns ​

void

Inherited from ​

commonScene.pickModel

Defined in ​

src/Scene/commonSceneMethod.ts:132

pickSpecifiedModel ​

▸ pickSpecifiedModel(content, mousePosition): Object

Parameters ​

NameType
contentMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap> | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>[]
mousePositionmouseMovePositionType

Returns ​

Object

NameType
intersectedObjectnull | Object3D<Object3DEventMap>
intersectsIntersection<Object3D<Object3DEventMap>>[]

Inherited from ​

commonScene.pickSpecifiedModel

Defined in ​

src/Scene/commonSceneMethod.ts:154

removeLights ​

▸ removeLights(): void

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:151

removePreRenderCallbackFunction ​

▸ removePreRenderCallbackFunction(id): void

Parameters ​

NameType
idnumber

Returns ​

void

Inherited from ​

commonScene.removePreRenderCallbackFunction

Defined in ​

src/Scene/commonSceneMethod.ts:128

render ​

▸ render(time?): void

Parameters ​

NameType
time?number

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:214

setDepth ​

▸ setDepth(value): void

Parameters ​

NameType
valuenumber

Returns ​

void

Inherited from ​

commonScene.setDepth

Defined in ​

src/Scene/commonSceneMethod.ts:111

setDicomFilesOrder ​

▸ setDicomFilesOrder(value): void

Parameters ​

NameType
value"ascending" | "descending"

Returns ​

void

Inherited from ​

commonScene.setDicomFilesOrder

Defined in ​

src/Scene/commonSceneMethod.ts:114

setViewPoint ​

▸ setViewPoint(camera, target?): CameraViewPoint

Parameters ​

NameType
cameraPerspectiveCamera
target?number[]

Returns ​

CameraViewPoint

Defined in ​

src/Scene/baseScene.ts:113

updateBackground ​

▸ updateBackground(color1, color2): void

Parameters ​

NameType
color1string
color2string

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:179

updateControls ​

▸ updateControls(camera): void

Parameters ​

NameType
cameraPerspectiveCamera | OrthographicCamera

Returns ​

void

Inherited from ​

commonScene.updateControls

Defined in ​

src/Scene/commonSceneMethod.ts:329

updateDisplay ​

▸ updateDisplay(state): void

Parameters ​

NameType
statebaseStateType

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:174

updateLights ​

▸ updateLights(state): void

Parameters ​

NameType
statebaseStateType

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:157

updateModelChildrenVisualisation ​

▸ updateModelChildrenVisualisation(child): void

Parameters ​

NameType
childMesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:184