copper3d / Modules / Scene/commonSceneMethod / commonScene

Class: commonScene ​

Scene/commonSceneMethod.commonScene

Hierarchy ​

• commonScene

  ↳ baseScene

  ↳ copperMScene

Table of contents ​

Constructors ​

• constructor

Properties ​

• camera
• container
• controls
• copperOrthographicCamera
• copperPerspectiveCamera
• depthStep
• pickableObjects
• preRenderCallbackFunctions
• renderNrrdVolume
• scene
• sort
• subCamera
• subCopperControl
• subDiv
• subRender
• subScene

Methods ​

• addObject
• addPreRenderCallbackFunction
• addSubView
• createDemoMesh
• loadDicom
• loadNrrd
• loadNrrdTexture3d
• loadOBJ
• pickModel
• pickSpecifiedModel
• removePreRenderCallbackFunction
• setDepth
• setDicomFilesOrder
• updateControls

Constructors ​

constructor ​

• new commonScene(container, opt?)

Parameters ​

Defined in ​

src/Scene/commonSceneMethod.ts:49

Properties ​

camera ​

• camera: PerspectiveCamera | OrthographicCamera

Defined in ​

src/Scene/commonSceneMethod.ts:30

container ​

• container: HTMLDivElement

Defined in ​

src/Scene/commonSceneMethod.ts:28

controls ​

• controls: Copper3dTrackballControls | OrbitControls<Camera> | TrackballControls

Defined in ​

src/Scene/commonSceneMethod.ts:38

copperOrthographicCamera ​

• copperOrthographicCamera: OrthographicCamera

Defined in ​

src/Scene/commonSceneMethod.ts:33

copperPerspectiveCamera ​

• copperPerspectiveCamera: PerspectiveCamera

Defined in ​

src/Scene/commonSceneMethod.ts:32

depthStep ​

• Protected depthStep: number = 0.4

Defined in ​

src/Scene/commonSceneMethod.ts:45

pickableObjects ​

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

Defined in ​

src/Scene/commonSceneMethod.ts:47

preRenderCallbackFunctions ​

• Protected preRenderCallbackFunctions: preRenderCallbackFunctionType

Defined in ​

src/Scene/commonSceneMethod.ts:43

renderNrrdVolume ​

• Protected renderNrrdVolume: boolean = false

Defined in ​

src/Scene/commonSceneMethod.ts:41

scene ​

• scene: Scene<Object3DEventMap>

Defined in ​

src/Scene/commonSceneMethod.ts:29

sort ​

• Protected sort: boolean = true

Defined in ​

src/Scene/commonSceneMethod.ts:44

subCamera ​

• subCamera: null | PerspectiveCamera = null

Defined in ​

src/Scene/commonSceneMethod.ts:37

subCopperControl ​

• Protected subCopperControl: null | Controls = null

Defined in ​

src/Scene/commonSceneMethod.ts:40

subDiv ​

• subDiv: null | HTMLDivElement = null

Defined in ​

src/Scene/commonSceneMethod.ts:35

subRender ​

• Protected subRender: null | WebGLRenderer = null

Defined in ​

src/Scene/commonSceneMethod.ts:39

subScene ​

• subScene: Scene<Object3DEventMap>

Defined in ​

src/Scene/commonSceneMethod.ts:36

Methods ​

addObject ​

▸ addObject(obj): void

Parameters ​

Returns ​

void

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

Defined in ​

src/Scene/commonSceneMethod.ts:109

addSubView ​

▸ addSubView(): HTMLDivElement

create a new sub view to display models

Returns ​

HTMLDivElement

Defined in ​

src/Scene/commonSceneMethod.ts:159

createDemoMesh ​

▸ createDemoMesh(): void

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:82

loadDicom ​

▸ loadDicom(urls, opts?): void

Parameters ​

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:183

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

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.

Defined in ​

src/Scene/commonSceneMethod.ts:330

loadOBJ ​

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

Parameters ​

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:342

pickModel ​

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

Parameters ​

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:117

pickSpecifiedModel ​

▸ pickSpecifiedModel(content, mousePosition): Object

Parameters ​

Returns ​

Object

Defined in ​

src/Scene/commonSceneMethod.ts:139

removePreRenderCallbackFunction ​

▸ removePreRenderCallbackFunction(id): void

Parameters ​

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:113

setDepth ​

▸ setDepth(value): void

Parameters ​

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:97

setDicomFilesOrder ​

▸ setDicomFilesOrder(value): void

Parameters ​

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:100

updateControls ​

▸ updateControls(camera): void

Parameters ​

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:316