diff --git a/404.html b/404.html index cad22da..d8bc346 100644 --- a/404.html +++ b/404.html @@ -14,7 +14,7 @@
Copper3d API

Appearance

404

PAGE NOT FOUND

But if you don't change your direction, and if you keep looking, you may end up where you are heading.
Take me home
- + \ No newline at end of file diff --git a/apidist/README.html b/apidist/README.html index 544285f..10a4dab 100644 --- a/apidist/README.html +++ b/apidist/README.html @@ -101,7 +101,7 @@ targetPosition: Array<number> = [0.0, 0.0, 0.0]; upVector: Array<number> = [0.0, 1.0, 0.0]; }

Acknowledgements ​

Special thanks to Duke University dataset provides these awsome MRI data!!!

- + \ No newline at end of file diff --git a/apidist/classes/Controls_Copper3dTrackballControls.Copper3dTrackballControls.html b/apidist/classes/Controls_Copper3dTrackballControls.Copper3dTrackballControls.html index db99b28..588c259 100644 --- a/apidist/classes/Controls_Copper3dTrackballControls.Copper3dTrackballControls.html +++ b/apidist/classes/Controls_Copper3dTrackballControls.Copper3dTrackballControls.html @@ -11,13 +11,13 @@ - + -
Copper3d API

Appearance

copper3d / Modules / Controls/Copper3dTrackballControls / Copper3dTrackballControls

Class: Copper3dTrackballControls ​

Controls/Copper3dTrackballControls.Copper3dTrackballControls

Hierarchy ​

  • EventDispatcher

    ↳ Copper3dTrackballControls

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new Copper3dTrackballControls(object, domElement)

Parameters ​

NameType
objectPerspectiveCamera | OrthographicCamera
domElementHTMLElement

Overrides ​

EventDispatcher.constructor

Defined in ​

src/Controls/Copper3dTrackballControls.ts:79

Properties ​

checkDistances ​

• checkDistances: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:72

dispose ​

• dispose: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:77

domElement ​

• domElement: HTMLElement

Defined in ​

src/Controls/Copper3dTrackballControls.ts:29

dynamicDampingFactor ​

• dynamicDampingFactor: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:42

enabled ​

• enabled: boolean

Defined in ​

src/Controls/Copper3dTrackballControls.ts:30

handleResize ​

• handleResize: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:66

keys ​

• keys: ["KeyA", "KeyS", "KeyD"]

Defined in ​

src/Controls/Copper3dTrackballControls.ts:50

maxDistance ​

• maxDistance: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:45

maxZoom ​

• maxZoom: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:48

minDistance ​

• minDistance: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:44

minZoom ​

• minZoom: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:47

mouseButtons ​

• mouseButtons: Object

Type declaration ​

NameType
LEFT-1 | LEFT | RIGHT
MIDDLE-1 | LEFT | MIDDLE | RIGHT
RIGHT-1 | LEFT | RIGHT

Defined in ​

src/Controls/Copper3dTrackballControls.ts:52

noPan ​

• noPan: boolean

Defined in ​

src/Controls/Copper3dTrackballControls.ts:39

noRotate ​

• noRotate: boolean

Defined in ​

src/Controls/Copper3dTrackballControls.ts:37

noZoom ​

• noZoom: boolean

Defined in ​

src/Controls/Copper3dTrackballControls.ts:38

object ​

• object: PerspectiveCamera | OrthographicCamera

Defined in ​

src/Controls/Copper3dTrackballControls.ts:28

panCamera ​

• panCamera: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:70

panSpeed ​

• panSpeed: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:35

position0 ​

• position0: Vector3

Defined in ​

src/Controls/Copper3dTrackballControls.ts:61

reset ​

• reset: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:75

rotateCamera ​

• rotateCamera: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:68

rotateSpeed ​

• rotateSpeed: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:33

screen ​

• screen: Object

Type declaration ​

NameType
heightnumber
leftnumber
topnumber
widthnumber

Defined in ​

src/Controls/Copper3dTrackballControls.ts:31

staticMoving ​

• staticMoving: boolean

Defined in ​

src/Controls/Copper3dTrackballControls.ts:41

target ​

• target: Vector3

Defined in ​

src/Controls/Copper3dTrackballControls.ts:58

target0 ​

• target0: Vector3

Defined in ​

src/Controls/Copper3dTrackballControls.ts:60

up0 ​

• up0: Vector3

Defined in ​

src/Controls/Copper3dTrackballControls.ts:62

update ​

• update: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:74

zoom0 ​

• zoom0: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:63

zoomCamera ​

• zoomCamera: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:69

zoomSpeed ​

• zoomSpeed: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:34

Methods ​

addEventListener ​

▸ addEventListener<T>(type, listener): void

Adds a listener to an event type.

Type parameters ​

NameType
Textends string

Parameters ​

NameTypeDescription
typeTThe type of event to listen to.
listenerEventListener<Event, T, Copper3dTrackballControls>The function that gets called when the event is fired.

Returns ​

void

Inherited from ​

EventDispatcher.addEventListener

Defined in ​

node_modules/@types/three/src/core/EventDispatcher.d.ts:46

dispatchEvent ​

▸ dispatchEvent(event): void

Fire an event type.

Parameters ​

NameTypeDescription
eventEventThe event that gets fired.

Returns ​

void

Inherited from ​

EventDispatcher.dispatchEvent

Defined in ​

node_modules/@types/three/src/core/EventDispatcher.d.ts:66

hasEventListener ​

▸ hasEventListener<T>(type, listener): boolean

Checks if listener is added to an event type.

Type parameters ​

NameType
Textends string

Parameters ​

NameTypeDescription
typeTThe type of event to listen to.
listenerEventListener<Event, T, Copper3dTrackballControls>The function that gets called when the event is fired.

Returns ​

boolean

Inherited from ​

EventDispatcher.hasEventListener

Defined in ​

node_modules/@types/three/src/core/EventDispatcher.d.ts:53

removeEventListener ​

▸ removeEventListener<T>(type, listener): void

Removes a listener from an event type.

Type parameters ​

NameType
Textends string

Parameters ​

NameTypeDescription
typeTThe type of the listener that gets removed.
listenerEventListener<Event, T, Copper3dTrackballControls>The listener function that gets removed.

Returns ​

void

Inherited from ​

EventDispatcher.removeEventListener

Defined in ​

node_modules/@types/three/src/core/EventDispatcher.d.ts:60

- +
Copper3d API

Appearance

copper3d / Modules / Controls/Copper3dTrackballControls / Copper3dTrackballControls

Class: Copper3dTrackballControls ​

Controls/Copper3dTrackballControls.Copper3dTrackballControls

Hierarchy ​

  • EventDispatcher

    ↳ Copper3dTrackballControls

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new Copper3dTrackballControls(object, domElement)

Parameters ​

NameType
objectPerspectiveCamera | OrthographicCamera
domElementHTMLElement

Overrides ​

EventDispatcher.constructor

Defined in ​

src/Controls/Copper3dTrackballControls.ts:79

Properties ​

checkDistances ​

• checkDistances: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:72

dispose ​

• dispose: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:77

domElement ​

• domElement: HTMLElement

Defined in ​

src/Controls/Copper3dTrackballControls.ts:29

dynamicDampingFactor ​

• dynamicDampingFactor: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:42

enabled ​

• enabled: boolean

Defined in ​

src/Controls/Copper3dTrackballControls.ts:30

handleResize ​

• handleResize: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:66

keys ​

• keys: ["KeyA", "KeyS", "KeyD"]

Defined in ​

src/Controls/Copper3dTrackballControls.ts:50

maxDistance ​

• maxDistance: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:45

maxZoom ​

• maxZoom: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:48

minDistance ​

• minDistance: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:44

minZoom ​

• minZoom: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:47

mouseButtons ​

• mouseButtons: Object

Type declaration ​

NameType
LEFT-1 | LEFT | RIGHT
MIDDLE-1 | LEFT | MIDDLE | RIGHT
RIGHT-1 | LEFT | RIGHT

Defined in ​

src/Controls/Copper3dTrackballControls.ts:52

noPan ​

• noPan: boolean

Defined in ​

src/Controls/Copper3dTrackballControls.ts:39

noRotate ​

• noRotate: boolean

Defined in ​

src/Controls/Copper3dTrackballControls.ts:37

noZoom ​

• noZoom: boolean

Defined in ​

src/Controls/Copper3dTrackballControls.ts:38

object ​

• object: PerspectiveCamera | OrthographicCamera

Defined in ​

src/Controls/Copper3dTrackballControls.ts:28

panCamera ​

• panCamera: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:70

panSpeed ​

• panSpeed: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:35

position0 ​

• position0: Vector3

Defined in ​

src/Controls/Copper3dTrackballControls.ts:61

reset ​

• reset: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:75

rotateCamera ​

• rotateCamera: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:68

rotateSpeed ​

• rotateSpeed: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:33

screen ​

• screen: Object

Type declaration ​

NameType
heightnumber
leftnumber
topnumber
widthnumber

Defined in ​

src/Controls/Copper3dTrackballControls.ts:31

staticMoving ​

• staticMoving: boolean

Defined in ​

src/Controls/Copper3dTrackballControls.ts:41

target ​

• target: Vector3

Defined in ​

src/Controls/Copper3dTrackballControls.ts:58

target0 ​

• target0: Vector3

Defined in ​

src/Controls/Copper3dTrackballControls.ts:60

up0 ​

• up0: Vector3

Defined in ​

src/Controls/Copper3dTrackballControls.ts:62

update ​

• update: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:74

zoom0 ​

• zoom0: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:63

zoomCamera ​

• zoomCamera: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:69

zoomSpeed ​

• zoomSpeed: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:34

Methods ​

addEventListener ​

▸ addEventListener<T>(type, listener): void

Adds a listener to an event type.

Type parameters ​

NameType
Textends string

Parameters ​

NameTypeDescription
typeTThe type of event to listen to.
listenerEventListener<Event, T, Copper3dTrackballControls>The function that gets called when the event is fired.

Returns ​

void

Inherited from ​

EventDispatcher.addEventListener

Defined in ​

node_modules/@types/three/src/core/EventDispatcher.d.ts:46

dispatchEvent ​

▸ dispatchEvent(event): void

Fire an event type.

Parameters ​

NameTypeDescription
eventEventThe event that gets fired.

Returns ​

void

Inherited from ​

EventDispatcher.dispatchEvent

Defined in ​

node_modules/@types/three/src/core/EventDispatcher.d.ts:66

hasEventListener ​

▸ hasEventListener<T>(type, listener): boolean

Checks if listener is added to an event type.

Type parameters ​

NameType
Textends string

Parameters ​

NameTypeDescription
typeTThe type of event to listen to.
listenerEventListener<Event, T, Copper3dTrackballControls>The function that gets called when the event is fired.

Returns ​

boolean

Inherited from ​

EventDispatcher.hasEventListener

Defined in ​

node_modules/@types/three/src/core/EventDispatcher.d.ts:53

removeEventListener ​

▸ removeEventListener<T>(type, listener): void

Removes a listener from an event type.

Type parameters ​

NameType
Textends string

Parameters ​

NameTypeDescription
typeTThe type of the listener that gets removed.
listenerEventListener<Event, T, Copper3dTrackballControls>The listener function that gets removed.

Returns ​

void

Inherited from ​

EventDispatcher.removeEventListener

Defined in ​

node_modules/@types/three/src/core/EventDispatcher.d.ts:60

+ \ No newline at end of file diff --git a/apidist/classes/Controls_copperControls.CameraViewPoint.html b/apidist/classes/Controls_copperControls.CameraViewPoint.html index f433cbd..ea6dd63 100644 --- a/apidist/classes/Controls_copperControls.CameraViewPoint.html +++ b/apidist/classes/Controls_copperControls.CameraViewPoint.html @@ -11,13 +11,13 @@ - + -
Copper3d API

Appearance

copper3d / Modules / Controls/copperControls / CameraViewPoint

Class: CameraViewPoint ​

Controls/copperControls.CameraViewPoint

Table of contents ​

Constructors ​

Properties ​

Constructors ​

constructor ​

• new CameraViewPoint()

Properties ​

eyePosition ​

• eyePosition: number[]

Defined in ​

src/Controls/copperControls.ts:53

farPlane ​

• farPlane: number = 2000.0

Defined in ​

src/Controls/copperControls.ts:52

nearPlane ​

• nearPlane: number = 0.1

Defined in ​

src/Controls/copperControls.ts:51

targetPosition ​

• targetPosition: number[]

Defined in ​

src/Controls/copperControls.ts:54

upVector ​

• upVector: number[]

Defined in ​

src/Controls/copperControls.ts:55

- +
Copper3d API

Appearance

copper3d / Modules / Controls/copperControls / CameraViewPoint

Class: CameraViewPoint ​

Controls/copperControls.CameraViewPoint

Table of contents ​

Constructors ​

Properties ​

Constructors ​

constructor ​

• new CameraViewPoint()

Properties ​

eyePosition ​

• eyePosition: number[]

Defined in ​

src/Controls/copperControls.ts:53

farPlane ​

• farPlane: number = 2000.0

Defined in ​

src/Controls/copperControls.ts:52

nearPlane ​

• nearPlane: number = 0.1

Defined in ​

src/Controls/copperControls.ts:51

targetPosition ​

• targetPosition: number[]

Defined in ​

src/Controls/copperControls.ts:54

upVector ​

• upVector: number[]

Defined in ​

src/Controls/copperControls.ts:55

+ \ No newline at end of file diff --git a/apidist/classes/Controls_copperControls.Controls.html b/apidist/classes/Controls_copperControls.Controls.html index 1f14b14..8d21482 100644 --- a/apidist/classes/Controls_copperControls.Controls.html +++ b/apidist/classes/Controls_copperControls.Controls.html @@ -11,13 +11,13 @@ - + -
Copper3d API

Appearance

copper3d / Modules / Controls/copperControls / Controls

Class: Controls ​

Controls/copperControls.Controls

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new Controls(camera)

Parameters ​

NameType
cameraPerspectiveCamera

Defined in ​

src/Controls/copperControls.ts:7

Properties ​

currentCamera ​

• Private currentCamera: PerspectiveCamera

Defined in ​

src/Controls/copperControls.ts:3

directionalLight ​

• Private directionalLight: null | DirectionalLight = null

Defined in ​

src/Controls/copperControls.ts:4

viewpoint ​

• Private viewpoint: CameraViewPoint

Defined in ​

src/Controls/copperControls.ts:5

Methods ​

setCameraViewPoint ​

▸ setCameraViewPoint(): void

Returns ​

void

Defined in ​

src/Controls/copperControls.ts:12

updateCameraViewPoint ​

▸ updateCameraViewPoint(viewpoint): void

Parameters ​

NameType
viewpointCameraViewPoint

Returns ​

void

Defined in ​

src/Controls/copperControls.ts:33

updateDirectionalLight ​

▸ updateDirectionalLight(directionalLight?): void

Parameters ​

NameType
directionalLight?DirectionalLight

Returns ​

void

Defined in ​

src/Controls/copperControls.ts:38

- +
Copper3d API

Appearance

copper3d / Modules / Controls/copperControls / Controls

Class: Controls ​

Controls/copperControls.Controls

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new Controls(camera)

Parameters ​

NameType
cameraPerspectiveCamera

Defined in ​

src/Controls/copperControls.ts:7

Properties ​

currentCamera ​

• Private currentCamera: PerspectiveCamera

Defined in ​

src/Controls/copperControls.ts:3

directionalLight ​

• Private directionalLight: null | DirectionalLight = null

Defined in ​

src/Controls/copperControls.ts:4

viewpoint ​

• Private viewpoint: CameraViewPoint

Defined in ​

src/Controls/copperControls.ts:5

Methods ​

setCameraViewPoint ​

▸ setCameraViewPoint(): void

Returns ​

void

Defined in ​

src/Controls/copperControls.ts:12

updateCameraViewPoint ​

▸ updateCameraViewPoint(viewpoint): void

Parameters ​

NameType
viewpointCameraViewPoint

Returns ​

void

Defined in ​

src/Controls/copperControls.ts:33

updateDirectionalLight ​

▸ updateDirectionalLight(directionalLight?): void

Parameters ​

NameType
directionalLight?DirectionalLight

Returns ​

void

Defined in ​

src/Controls/copperControls.ts:38

+ \ No newline at end of file diff --git a/apidist/classes/Renderer_baseRenderer.baseRenderer.html b/apidist/classes/Renderer_baseRenderer.baseRenderer.html index 88403ec..32f507d 100644 --- a/apidist/classes/Renderer_baseRenderer.baseRenderer.html +++ b/apidist/classes/Renderer_baseRenderer.baseRenderer.html @@ -11,13 +11,13 @@ - + -
Copper3d API

Appearance

copper3d / Modules / Renderer/baseRenderer / baseRenderer

Class: baseRenderer ​

Renderer/baseRenderer.baseRenderer

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new baseRenderer(container, options?)

Parameters ​

NameType
containerHTMLDivElement
options?ICopperRenderOpt

Defined in ​

src/Renderer/baseRenderer.ts:31

Properties ​

cameraFolder ​

• Private cameraFolder: null | GUI

Defined in ​

src/Renderer/baseRenderer.ts:29

container ​

• container: HTMLDivElement

Defined in ​

src/Renderer/baseRenderer.ts:15

currentScene ​

• currentScene: baseScene

Defined in ​

src/Renderer/baseRenderer.ts:20

gui ​

• gui: null | GUI

Defined in ​

src/Renderer/baseRenderer.ts:17

options ​

• options: undefined | ICopperRenderOpt

Defined in ​

src/Renderer/baseRenderer.ts:23

pmremGenerator ​

• pmremGenerator: PMREMGenerator

Defined in ​

src/Renderer/baseRenderer.ts:21

renderer ​

• renderer: WebGLRenderer

Defined in ​

src/Renderer/baseRenderer.ts:16

state ​

• Private state: stateType

Defined in ​

src/Renderer/baseRenderer.ts:24

stats ​

• stats: Stats

Defined in ​

src/Renderer/baseRenderer.ts:18

visualCtrls ​

• Private visualCtrls: GUIController<object>[] = []

Defined in ​

src/Renderer/baseRenderer.ts:28

visualiseFolder ​

• Private visualiseFolder: null | GUI

Defined in ​

src/Renderer/baseRenderer.ts:27

Methods ​

addGui ​

▸ addGui(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:140

closeGui ​

▸ closeGui(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:132

getCubeMapTexture ​

▸ Private getCubeMapTexture(environment): Promise<unknown>

Parameters ​

NameType
environmentenvironmentType

Returns ​

Promise<unknown>

Defined in ​

src/Renderer/baseRenderer.ts:108

getCurrentScene ​

▸ getCurrentScene(): baseScene

Returns ​

baseScene

Defined in ​

src/Renderer/baseRenderer.ts:126

hideGui ​

▸ hideGui(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:129

init ​

▸ init(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:83

setClearColor ​

▸ setClearColor(clearColor?, alpha?): void

Parameters ​

NameTypeDefault value
clearColornumber0x000000
alphanumber0

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:136

updateEnvironment ​

▸ updateEnvironment(vignette?): void

Parameters ​

NameType
vignette?customMeshType

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:95

updateGui ​

▸ updateGui(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:198

- +
Copper3d API

Appearance

copper3d / Modules / Renderer/baseRenderer / baseRenderer

Class: baseRenderer ​

Renderer/baseRenderer.baseRenderer

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new baseRenderer(container, options?)

Parameters ​

NameType
containerHTMLDivElement
options?ICopperRenderOpt

Defined in ​

src/Renderer/baseRenderer.ts:31

Properties ​

cameraFolder ​

• Private cameraFolder: null | GUI

Defined in ​

src/Renderer/baseRenderer.ts:29

container ​

• container: HTMLDivElement

Defined in ​

src/Renderer/baseRenderer.ts:15

currentScene ​

• currentScene: baseScene

Defined in ​

src/Renderer/baseRenderer.ts:20

gui ​

• gui: null | GUI

Defined in ​

src/Renderer/baseRenderer.ts:17

options ​

• options: undefined | ICopperRenderOpt

Defined in ​

src/Renderer/baseRenderer.ts:23

pmremGenerator ​

• pmremGenerator: PMREMGenerator

Defined in ​

src/Renderer/baseRenderer.ts:21

renderer ​

• renderer: WebGLRenderer

Defined in ​

src/Renderer/baseRenderer.ts:16

state ​

• Private state: stateType

Defined in ​

src/Renderer/baseRenderer.ts:24

stats ​

• stats: Stats

Defined in ​

src/Renderer/baseRenderer.ts:18

visualCtrls ​

• Private visualCtrls: GUIController<object>[] = []

Defined in ​

src/Renderer/baseRenderer.ts:28

visualiseFolder ​

• Private visualiseFolder: null | GUI

Defined in ​

src/Renderer/baseRenderer.ts:27

Methods ​

addGui ​

▸ addGui(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:140

closeGui ​

▸ closeGui(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:132

getCubeMapTexture ​

▸ Private getCubeMapTexture(environment): Promise<unknown>

Parameters ​

NameType
environmentenvironmentType

Returns ​

Promise<unknown>

Defined in ​

src/Renderer/baseRenderer.ts:108

getCurrentScene ​

▸ getCurrentScene(): baseScene

Returns ​

baseScene

Defined in ​

src/Renderer/baseRenderer.ts:126

hideGui ​

▸ hideGui(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:129

init ​

▸ init(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:83

setClearColor ​

▸ setClearColor(clearColor?, alpha?): void

Parameters ​

NameTypeDefault value
clearColornumber0x000000
alphanumber0

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:136

updateEnvironment ​

▸ updateEnvironment(vignette?): void

Parameters ​

NameType
vignette?customMeshType

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:95

updateGui ​

▸ updateGui(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:198

+ \ No newline at end of file diff --git a/apidist/classes/Renderer_copperMSceneRenderer.copperMSceneRenderer.html b/apidist/classes/Renderer_copperMSceneRenderer.copperMSceneRenderer.html index 0659772..ef90b66 100644 --- a/apidist/classes/Renderer_copperMSceneRenderer.copperMSceneRenderer.html +++ b/apidist/classes/Renderer_copperMSceneRenderer.copperMSceneRenderer.html @@ -11,13 +11,13 @@ - + -
Copper3d API

Appearance

copper3d / Modules / Renderer/copperMSceneRenderer / copperMSceneRenderer

Class: copperMSceneRenderer ​

Renderer/copperMSceneRenderer.copperMSceneRenderer

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new copperMSceneRenderer(container, numberOfScene, cameraPosition?)

Parameters ​

NameType
containerHTMLDivElement
numberOfScenenumber
cameraPosition?positionType

Defined in ​

src/Renderer/copperMSceneRenderer.ts:21

Properties ​

cameras ​

• cameras: PerspectiveCamera[]

Defined in ​

src/Renderer/copperMSceneRenderer.ts:12

canvas ​

• canvas: HTMLCanvasElement

Defined in ​

src/Renderer/copperMSceneRenderer.ts:17

container ​

• container: HTMLDivElement

Defined in ​

src/Renderer/copperMSceneRenderer.ts:9

elems ​

• elems: HTMLDivElement[]

Defined in ​

src/Renderer/copperMSceneRenderer.ts:10

numberOfScene ​

• numberOfScene: number

Defined in ​

src/Renderer/copperMSceneRenderer.ts:8

pmremGenerator ​

• pmremGenerator: PMREMGenerator

Defined in ​

src/Renderer/copperMSceneRenderer.ts:19

renderer ​

• renderer: WebGLRenderer

Defined in ​

src/Renderer/copperMSceneRenderer.ts:13

sceneInfos ​

• sceneInfos: copperMScene[]

Defined in ​

src/Renderer/copperMSceneRenderer.ts:18

scenes ​

• scenes: Scene[]

Defined in ​

src/Renderer/copperMSceneRenderer.ts:11

Methods ​

animate ​

▸ animate(): void

Returns ​

void

Defined in ​

src/Renderer/copperMSceneRenderer.ts:139

getCubeMapTexture ​

▸ Private getCubeMapTexture(environment): Promise<unknown>

Parameters ​

NameType
environmentenvironmentType

Returns ​

Promise<unknown>

Defined in ​

src/Renderer/copperMSceneRenderer.ts:76

init ​

▸ init(): void

Returns ​

void

Defined in ​

src/Renderer/copperMSceneRenderer.ts:39

renderSceneInfo ​

▸ renderSceneInfo(sceneInfo): void

Parameters ​

NameType
sceneInfocopperMScene

Returns ​

void

Defined in ​

src/Renderer/copperMSceneRenderer.ts:94

resizeRendererToDisplaySize ​

▸ resizeRendererToDisplaySize(): void

Returns ​

void

Defined in ​

src/Renderer/copperMSceneRenderer.ts:117

updateEnvironment ​

▸ updateEnvironment(sceneIn): void

Parameters ​

NameType
sceneIncopperMScene

Returns ​

void

Defined in ​

src/Renderer/copperMSceneRenderer.ts:64

- +
Copper3d API

Appearance

copper3d / Modules / Renderer/copperMSceneRenderer / copperMSceneRenderer

Class: copperMSceneRenderer ​

Renderer/copperMSceneRenderer.copperMSceneRenderer

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new copperMSceneRenderer(container, numberOfScene, cameraPosition?)

Parameters ​

NameType
containerHTMLDivElement
numberOfScenenumber
cameraPosition?positionType

Defined in ​

src/Renderer/copperMSceneRenderer.ts:21

Properties ​

cameras ​

• cameras: PerspectiveCamera[]

Defined in ​

src/Renderer/copperMSceneRenderer.ts:12

canvas ​

• canvas: HTMLCanvasElement

Defined in ​

src/Renderer/copperMSceneRenderer.ts:17

container ​

• container: HTMLDivElement

Defined in ​

src/Renderer/copperMSceneRenderer.ts:9

elems ​

• elems: HTMLDivElement[]

Defined in ​

src/Renderer/copperMSceneRenderer.ts:10

numberOfScene ​

• numberOfScene: number

Defined in ​

src/Renderer/copperMSceneRenderer.ts:8

pmremGenerator ​

• pmremGenerator: PMREMGenerator

Defined in ​

src/Renderer/copperMSceneRenderer.ts:19

renderer ​

• renderer: WebGLRenderer

Defined in ​

src/Renderer/copperMSceneRenderer.ts:13

sceneInfos ​

• sceneInfos: copperMScene[]

Defined in ​

src/Renderer/copperMSceneRenderer.ts:18

scenes ​

• scenes: Scene[]

Defined in ​

src/Renderer/copperMSceneRenderer.ts:11

Methods ​

animate ​

▸ animate(): void

Returns ​

void

Defined in ​

src/Renderer/copperMSceneRenderer.ts:139

getCubeMapTexture ​

▸ Private getCubeMapTexture(environment): Promise<unknown>

Parameters ​

NameType
environmentenvironmentType

Returns ​

Promise<unknown>

Defined in ​

src/Renderer/copperMSceneRenderer.ts:76

init ​

▸ init(): void

Returns ​

void

Defined in ​

src/Renderer/copperMSceneRenderer.ts:39

renderSceneInfo ​

▸ renderSceneInfo(sceneInfo): void

Parameters ​

NameType
sceneInfocopperMScene

Returns ​

void

Defined in ​

src/Renderer/copperMSceneRenderer.ts:94

resizeRendererToDisplaySize ​

▸ resizeRendererToDisplaySize(): void

Returns ​

void

Defined in ​

src/Renderer/copperMSceneRenderer.ts:117

updateEnvironment ​

▸ updateEnvironment(sceneIn): void

Parameters ​

NameType
sceneIncopperMScene

Returns ​

void

Defined in ​

src/Renderer/copperMSceneRenderer.ts:64

+ \ No newline at end of file diff --git a/apidist/classes/Renderer_copperRenderer.copperRenderer.html b/apidist/classes/Renderer_copperRenderer.copperRenderer.html index e5d4c49..875fd23 100644 --- a/apidist/classes/Renderer_copperRenderer.copperRenderer.html +++ b/apidist/classes/Renderer_copperRenderer.copperRenderer.html @@ -11,13 +11,13 @@ - + -
Copper3d API

Appearance

copper3d / Modules / Renderer/copperRenderer / copperRenderer

Class: copperRenderer ​

Renderer/copperRenderer.copperRenderer

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new copperRenderer(container, options?)

Parameters ​

NameType
containerHTMLDivElement
options?ICopperRenderOpt

Overrides ​

baseRenderer.constructor

Defined in ​

src/Renderer/copperRenderer.ts:19

Properties ​

container ​

• container: HTMLDivElement

Inherited from ​

baseRenderer.container

Defined in ​

src/Renderer/baseRenderer.ts:15

currentScene ​

• currentScene: baseScene

Inherited from ​

baseRenderer.currentScene

Defined in ​

src/Renderer/baseRenderer.ts:20

delta ​

• Private delta: number = 0

Defined in ​

src/Renderer/copperRenderer.ts:14

fps ​

• Private fps: number = 30

Defined in ​

src/Renderer/copperRenderer.ts:12

gui ​

• gui: null | GUI

Inherited from ​

baseRenderer.gui

Defined in ​

src/Renderer/baseRenderer.ts:17

interval ​

• Private interval: number

Defined in ​

src/Renderer/copperRenderer.ts:15

options ​

• options: undefined | ICopperRenderOpt

Inherited from ​

baseRenderer.options

Defined in ​

src/Renderer/baseRenderer.ts:23

pmremGenerator ​

• pmremGenerator: PMREMGenerator

Inherited from ​

baseRenderer.pmremGenerator

Defined in ​

src/Renderer/baseRenderer.ts:21

preRenderCallbackFunctions ​

• preRenderCallbackFunctions: Function[] = []

Defined in ​

src/Renderer/copperRenderer.ts:17

renderClock ​

• Private renderClock: Clock

Defined in ​

src/Renderer/copperRenderer.ts:13

renderer ​

• renderer: WebGLRenderer

Inherited from ​

baseRenderer.renderer

Defined in ​

src/Renderer/baseRenderer.ts:16

sceneMap ​

• Private sceneMap: SceneMapType = {}

Defined in ​

src/Renderer/copperRenderer.ts:11

stats ​

• stats: Stats

Inherited from ​

baseRenderer.stats

Defined in ​

src/Renderer/baseRenderer.ts:18

Methods ​

addGui ​

▸ addGui(): void

Returns ​

void

Inherited from ​

baseRenderer.addGui

Defined in ​

src/Renderer/baseRenderer.ts:140

addPreRenderCallbackFunction ​

▸ addPreRenderCallbackFunction(callbackFunction): void

Parameters ​

NameType
callbackFunctionFunction

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:58

animate ​

▸ animate(time?): void

Parameters ​

NameType
time?number

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:64

closeGui ​

▸ closeGui(): void

Returns ​

void

Inherited from ​

baseRenderer.closeGui

Defined in ​

src/Renderer/baseRenderer.ts:132

createScene ​

▸ createScene(name): undefined | copperScene

Parameters ​

NameType
namestring

Returns ​

undefined | copperScene

Defined in ​

src/Renderer/copperRenderer.ts:41

getCurrentScene ​

▸ getCurrentScene(): baseScene

Returns ​

baseScene

Inherited from ​

baseRenderer.getCurrentScene

Defined in ​

src/Renderer/baseRenderer.ts:126

getSceneByName ​

▸ getSceneByName(name): copperScene | baseScene | copperMScene

Parameters ​

NameType
namestring

Returns ​

copperScene | baseScene | copperMScene

Defined in ​

src/Renderer/copperRenderer.ts:23

hideGui ​

▸ hideGui(): void

Returns ​

void

Inherited from ​

baseRenderer.hideGui

Defined in ​

src/Renderer/baseRenderer.ts:129

init ​

▸ init(): void

Returns ​

void

Inherited from ​

baseRenderer.init

Defined in ​

src/Renderer/baseRenderer.ts:83

onWindowResize ​

▸ onWindowResize(): void

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:62

render ​

▸ render(): void

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:89

setClearColor ​

▸ setClearColor(clearColor?, alpha?): void

Parameters ​

NameTypeDefault value
clearColornumber0x000000
alphanumber0

Returns ​

void

Inherited from ​

baseRenderer.setClearColor

Defined in ​

src/Renderer/baseRenderer.ts:136

setCurrentScene ​

▸ setCurrentScene(sceneIn): void

Parameters ​

NameType
sceneIncopperScene

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:31

setFPS ​

▸ setFPS(fps): void

Parameters ​

NameType
fpsnumber

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:27

updateEnvironment ​

▸ updateEnvironment(vignette?): void

Parameters ​

NameType
vignette?customMeshType

Returns ​

void

Inherited from ​

baseRenderer.updateEnvironment

Defined in ​

src/Renderer/baseRenderer.ts:95

updateGui ​

▸ updateGui(): void

Returns ​

void

Inherited from ​

baseRenderer.updateGui

Defined in ​

src/Renderer/baseRenderer.ts:198

- +
Copper3d API

Appearance

copper3d / Modules / Renderer/copperRenderer / copperRenderer

Class: copperRenderer ​

Renderer/copperRenderer.copperRenderer

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new copperRenderer(container, options?)

Parameters ​

NameType
containerHTMLDivElement
options?ICopperRenderOpt

Overrides ​

baseRenderer.constructor

Defined in ​

src/Renderer/copperRenderer.ts:19

Properties ​

container ​

• container: HTMLDivElement

Inherited from ​

baseRenderer.container

Defined in ​

src/Renderer/baseRenderer.ts:15

currentScene ​

• currentScene: baseScene

Inherited from ​

baseRenderer.currentScene

Defined in ​

src/Renderer/baseRenderer.ts:20

delta ​

• Private delta: number = 0

Defined in ​

src/Renderer/copperRenderer.ts:14

fps ​

• Private fps: number = 30

Defined in ​

src/Renderer/copperRenderer.ts:12

gui ​

• gui: null | GUI

Inherited from ​

baseRenderer.gui

Defined in ​

src/Renderer/baseRenderer.ts:17

interval ​

• Private interval: number

Defined in ​

src/Renderer/copperRenderer.ts:15

options ​

• options: undefined | ICopperRenderOpt

Inherited from ​

baseRenderer.options

Defined in ​

src/Renderer/baseRenderer.ts:23

pmremGenerator ​

• pmremGenerator: PMREMGenerator

Inherited from ​

baseRenderer.pmremGenerator

Defined in ​

src/Renderer/baseRenderer.ts:21

preRenderCallbackFunctions ​

• preRenderCallbackFunctions: Function[] = []

Defined in ​

src/Renderer/copperRenderer.ts:17

renderClock ​

• Private renderClock: Clock

Defined in ​

src/Renderer/copperRenderer.ts:13

renderer ​

• renderer: WebGLRenderer

Inherited from ​

baseRenderer.renderer

Defined in ​

src/Renderer/baseRenderer.ts:16

sceneMap ​

• Private sceneMap: SceneMapType = {}

Defined in ​

src/Renderer/copperRenderer.ts:11

stats ​

• stats: Stats

Inherited from ​

baseRenderer.stats

Defined in ​

src/Renderer/baseRenderer.ts:18

Methods ​

addGui ​

▸ addGui(): void

Returns ​

void

Inherited from ​

baseRenderer.addGui

Defined in ​

src/Renderer/baseRenderer.ts:140

addPreRenderCallbackFunction ​

▸ addPreRenderCallbackFunction(callbackFunction): void

Parameters ​

NameType
callbackFunctionFunction

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:58

animate ​

▸ animate(time?): void

Parameters ​

NameType
time?number

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:64

closeGui ​

▸ closeGui(): void

Returns ​

void

Inherited from ​

baseRenderer.closeGui

Defined in ​

src/Renderer/baseRenderer.ts:132

createScene ​

▸ createScene(name): undefined | copperScene

Parameters ​

NameType
namestring

Returns ​

undefined | copperScene

Defined in ​

src/Renderer/copperRenderer.ts:41

getCurrentScene ​

▸ getCurrentScene(): baseScene

Returns ​

baseScene

Inherited from ​

baseRenderer.getCurrentScene

Defined in ​

src/Renderer/baseRenderer.ts:126

getSceneByName ​

▸ getSceneByName(name): copperScene | baseScene | copperMScene

Parameters ​

NameType
namestring

Returns ​

copperScene | baseScene | copperMScene

Defined in ​

src/Renderer/copperRenderer.ts:23

hideGui ​

▸ hideGui(): void

Returns ​

void

Inherited from ​

baseRenderer.hideGui

Defined in ​

src/Renderer/baseRenderer.ts:129

init ​

▸ init(): void

Returns ​

void

Inherited from ​

baseRenderer.init

Defined in ​

src/Renderer/baseRenderer.ts:83

onWindowResize ​

▸ onWindowResize(): void

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:62

render ​

▸ render(): void

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:89

setClearColor ​

▸ setClearColor(clearColor?, alpha?): void

Parameters ​

NameTypeDefault value
clearColornumber0x000000
alphanumber0

Returns ​

void

Inherited from ​

baseRenderer.setClearColor

Defined in ​

src/Renderer/baseRenderer.ts:136

setCurrentScene ​

▸ setCurrentScene(sceneIn): void

Parameters ​

NameType
sceneIncopperScene

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:31

setFPS ​

▸ setFPS(fps): void

Parameters ​

NameType
fpsnumber

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:27

updateEnvironment ​

▸ updateEnvironment(vignette?): void

Parameters ​

NameType
vignette?customMeshType

Returns ​

void

Inherited from ​

baseRenderer.updateEnvironment

Defined in ​

src/Renderer/baseRenderer.ts:95

updateGui ​

▸ updateGui(): void

Returns ​

void

Inherited from ​

baseRenderer.updateGui

Defined in ​

src/Renderer/baseRenderer.ts:198

+ \ No newline at end of file diff --git a/apidist/classes/Scene_baseScene.baseScene.html b/apidist/classes/Scene_baseScene.baseScene.html index b748f5c..0a8158d 100644 --- a/apidist/classes/Scene_baseScene.baseScene.html +++ b/apidist/classes/Scene_baseScene.baseScene.html @@ -11,13 +11,13 @@ - + -
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

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

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[]>[] = []

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) => 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
callback(selectMesh: undefined | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>) => 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[]> | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]
mousePositionmouseMovePositionType

Returns ​

Object

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

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[]>

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:184

- +
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

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

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[]>[] = []

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) => 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
callback(selectMesh: undefined | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>) => 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[]> | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]
mousePositionmouseMovePositionType

Returns ​

Object

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

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[]>

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:184

+ \ No newline at end of file diff --git a/apidist/classes/Scene_commonSceneMethod.commonScene.html b/apidist/classes/Scene_commonSceneMethod.commonScene.html index fd51b9b..1bd7e4e 100644 --- a/apidist/classes/Scene_commonSceneMethod.commonScene.html +++ b/apidist/classes/Scene_commonSceneMethod.commonScene.html @@ -11,13 +11,13 @@ - + -
Copper3d API

Appearance

copper3d / Modules / Scene/commonSceneMethod / commonScene

Class: commonScene ​

Scene/commonSceneMethod.commonScene

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new commonScene(container, opt?)

Parameters ​

NameType
containerHTMLDivElement
opt?ICopperSceneOpts

Defined in ​

src/Scene/commonSceneMethod.ts:48

Properties ​

camera ​

• camera: PerspectiveCamera | OrthographicCamera

Defined in ​

src/Scene/commonSceneMethod.ts:29

container ​

• container: HTMLDivElement

Defined in ​

src/Scene/commonSceneMethod.ts:27

controls ​

• controls: Copper3dTrackballControls | OrbitControls | TrackballControls

Defined in ​

src/Scene/commonSceneMethod.ts:37

copperOrthographicCamera ​

• copperOrthographicCamera: OrthographicCamera

Defined in ​

src/Scene/commonSceneMethod.ts:32

copperPerspectiveCamera ​

• copperPerspectiveCamera: PerspectiveCamera

Defined in ​

src/Scene/commonSceneMethod.ts:31

depthStep ​

• Protected depthStep: number = 0.4

Defined in ​

src/Scene/commonSceneMethod.ts:44

pickableObjects ​

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

Defined in ​

src/Scene/commonSceneMethod.ts:46

preRenderCallbackFunctions ​

• Protected preRenderCallbackFunctions: preRenderCallbackFunctionType

Defined in ​

src/Scene/commonSceneMethod.ts:42

renderNrrdVolume ​

• Protected renderNrrdVolume: boolean = false

Defined in ​

src/Scene/commonSceneMethod.ts:40

scene ​

• scene: Scene

Defined in ​

src/Scene/commonSceneMethod.ts:28

sort ​

• Protected sort: boolean = true

Defined in ​

src/Scene/commonSceneMethod.ts:43

subCamera ​

• subCamera: null | PerspectiveCamera = null

Defined in ​

src/Scene/commonSceneMethod.ts:36

subCopperControl ​

• Protected subCopperControl: null | Controls = null

Defined in ​

src/Scene/commonSceneMethod.ts:39

subDiv ​

• subDiv: null | HTMLDivElement = null

Defined in ​

src/Scene/commonSceneMethod.ts:34

subRender ​

• Protected subRender: null | WebGLRenderer = null

Defined in ​

src/Scene/commonSceneMethod.ts:38

subScene ​

• subScene: Scene

Defined in ​

src/Scene/commonSceneMethod.ts:35

Methods ​

addObject ​

▸ addObject(obj): void

Parameters ​

NameType
objany

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:107

addPreRenderCallbackFunction ​

▸ addPreRenderCallbackFunction(callbackFunction): number

Parameters ​

NameType
callbackFunctionFunction

Returns ​

number

Defined in ​

src/Scene/commonSceneMethod.ts:122

addSubView ​

▸ addSubView(): HTMLDivElement

create a new sub view to display models

Returns ​

HTMLDivElement

Defined in ​

src/Scene/commonSceneMethod.ts:174

createDemoMesh ​

▸ createDemoMesh(): void

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:96

loadDicom ​

▸ loadDicom(urls, opts?): void

Parameters ​

NameType
urlsstring | string[]
opts?dicomLoaderOptsType

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:198

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

Defined in ​

src/Scene/commonSceneMethod.ts:314

loadNrrdTexture3d ​

▸ loadNrrdTexture3d(url, callback?): void

Parameters ​

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

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:338

loadOBJ ​

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

Parameters ​

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

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:350

pickModel ​

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

Parameters ​

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

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:132

pickSpecifiedModel ​

▸ pickSpecifiedModel(content, mousePosition): Object

Parameters ​

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

Returns ​

Object

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

Defined in ​

src/Scene/commonSceneMethod.ts:154

removePreRenderCallbackFunction ​

▸ removePreRenderCallbackFunction(id): void

Parameters ​

NameType
idnumber

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:128

setDepth ​

▸ setDepth(value): void

Parameters ​

NameType
valuenumber

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:111

setDicomFilesOrder ​

▸ setDicomFilesOrder(value): void

Parameters ​

NameType
value"ascending" | "descending"

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:114

updateControls ​

▸ updateControls(camera): void

Parameters ​

NameType
cameraPerspectiveCamera | OrthographicCamera

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:329

- +
Copper3d API

Appearance

copper3d / Modules / Scene/commonSceneMethod / commonScene

Class: commonScene ​

Scene/commonSceneMethod.commonScene

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new commonScene(container, opt?)

Parameters ​

NameType
containerHTMLDivElement
opt?ICopperSceneOpts

Defined in ​

src/Scene/commonSceneMethod.ts:48

Properties ​

camera ​

• camera: PerspectiveCamera | OrthographicCamera

Defined in ​

src/Scene/commonSceneMethod.ts:29

container ​

• container: HTMLDivElement

Defined in ​

src/Scene/commonSceneMethod.ts:27

controls ​

• controls: Copper3dTrackballControls | OrbitControls | TrackballControls

Defined in ​

src/Scene/commonSceneMethod.ts:37

copperOrthographicCamera ​

• copperOrthographicCamera: OrthographicCamera

Defined in ​

src/Scene/commonSceneMethod.ts:32

copperPerspectiveCamera ​

• copperPerspectiveCamera: PerspectiveCamera

Defined in ​

src/Scene/commonSceneMethod.ts:31

depthStep ​

• Protected depthStep: number = 0.4

Defined in ​

src/Scene/commonSceneMethod.ts:44

pickableObjects ​

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

Defined in ​

src/Scene/commonSceneMethod.ts:46

preRenderCallbackFunctions ​

• Protected preRenderCallbackFunctions: preRenderCallbackFunctionType

Defined in ​

src/Scene/commonSceneMethod.ts:42

renderNrrdVolume ​

• Protected renderNrrdVolume: boolean = false

Defined in ​

src/Scene/commonSceneMethod.ts:40

scene ​

• scene: Scene

Defined in ​

src/Scene/commonSceneMethod.ts:28

sort ​

• Protected sort: boolean = true

Defined in ​

src/Scene/commonSceneMethod.ts:43

subCamera ​

• subCamera: null | PerspectiveCamera = null

Defined in ​

src/Scene/commonSceneMethod.ts:36

subCopperControl ​

• Protected subCopperControl: null | Controls = null

Defined in ​

src/Scene/commonSceneMethod.ts:39

subDiv ​

• subDiv: null | HTMLDivElement = null

Defined in ​

src/Scene/commonSceneMethod.ts:34

subRender ​

• Protected subRender: null | WebGLRenderer = null

Defined in ​

src/Scene/commonSceneMethod.ts:38

subScene ​

• subScene: Scene

Defined in ​

src/Scene/commonSceneMethod.ts:35

Methods ​

addObject ​

▸ addObject(obj): void

Parameters ​

NameType
objany

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:107

addPreRenderCallbackFunction ​

▸ addPreRenderCallbackFunction(callbackFunction): number

Parameters ​

NameType
callbackFunctionFunction

Returns ​

number

Defined in ​

src/Scene/commonSceneMethod.ts:122

addSubView ​

▸ addSubView(): HTMLDivElement

create a new sub view to display models

Returns ​

HTMLDivElement

Defined in ​

src/Scene/commonSceneMethod.ts:174

createDemoMesh ​

▸ createDemoMesh(): void

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:96

loadDicom ​

▸ loadDicom(urls, opts?): void

Parameters ​

NameType
urlsstring | string[]
opts?dicomLoaderOptsType

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:198

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

Defined in ​

src/Scene/commonSceneMethod.ts:314

loadNrrdTexture3d ​

▸ loadNrrdTexture3d(url, callback?): void

Parameters ​

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

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:338

loadOBJ ​

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

Parameters ​

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

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:350

pickModel ​

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

Parameters ​

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

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:132

pickSpecifiedModel ​

▸ pickSpecifiedModel(content, mousePosition): Object

Parameters ​

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

Returns ​

Object

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

Defined in ​

src/Scene/commonSceneMethod.ts:154

removePreRenderCallbackFunction ​

▸ removePreRenderCallbackFunction(id): void

Parameters ​

NameType
idnumber

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:128

setDepth ​

▸ setDepth(value): void

Parameters ​

NameType
valuenumber

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:111

setDicomFilesOrder ​

▸ setDicomFilesOrder(value): void

Parameters ​

NameType
value"ascending" | "descending"

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:114

updateControls ​

▸ updateControls(camera): void

Parameters ​

NameType
cameraPerspectiveCamera | OrthographicCamera

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:329

+ \ No newline at end of file diff --git a/apidist/classes/Scene_copperMScene.copperMScene.html b/apidist/classes/Scene_copperMScene.copperMScene.html index 4640ec1..8e7d2ca 100644 --- a/apidist/classes/Scene_copperMScene.copperMScene.html +++ b/apidist/classes/Scene_copperMScene.copperMScene.html @@ -11,13 +11,13 @@ - + -
Copper3d API

Appearance

copper3d / Modules / Scene/copperMScene / copperMScene

Class: copperMScene ​

Scene/copperMScene.copperMScene

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new copperMScene(container, renderer)

Parameters ​

NameType
containerHTMLDivElement
rendererWebGLRenderer

Overrides ​

commonScene.constructor

Defined in ​

src/Scene/copperMScene.ts:51

Properties ​

ambientLight ​

• ambientLight: AmbientLight

Defined in ​

src/Scene/copperMScene.ts:39

camera ​

• camera: PerspectiveCamera | OrthographicCamera

Inherited from ​

commonScene.camera

Defined in ​

src/Scene/commonSceneMethod.ts:29

cameraPositionFlag ​

• cameraPositionFlag: boolean = false

Defined in ​

src/Scene/copperMScene.ts:42

color1 ​

• Private color1: string = "#5454ad"

Defined in ​

src/Scene/copperMScene.ts:46

color2 ​

• Private color2: string = "#18e5a7"

Defined in ​

src/Scene/copperMScene.ts:47

container ​

• container: HTMLDivElement

Overrides ​

commonScene.container

Defined in ​

src/Scene/copperMScene.ts:34

content ​

• content: Group

Defined in ​

src/Scene/copperMScene.ts:43

controls ​

• controls: Copper3dTrackballControls | OrbitControls | TrackballControls

Inherited from ​

commonScene.controls

Defined in ​

src/Scene/commonSceneMethod.ts:37

copperControl ​

• copperControl: Controls

Defined in ​

src/Scene/copperMScene.ts:40

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

gui ​

• gui: GUI

Defined in ​

src/Scene/copperMScene.ts:30

guiContainer ​

• Private guiContainer: HTMLDivElement

Defined in ​

src/Scene/copperMScene.ts:49

isHalfed ​

• isHalfed: boolean = false

Defined in ​

src/Scene/copperMScene.ts:44

lights ​

• Private lights: any[] = []

Defined in ​

src/Scene/copperMScene.ts:48

pickableObjects ​

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

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

scene ​

• scene: Scene

Inherited from ​

commonScene.scene

Defined in ​

src/Scene/commonSceneMethod.ts:28

sceneName ​

• sceneName: string = ""

Defined in ​

src/Scene/copperMScene.ts:36

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

vignette ​

• vignette: customMeshType

Defined in ​

src/Scene/copperMScene.ts:37

Methods ​

addLights ​

▸ addLights(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:299

addObject ​

▸ addObject(obj): void

Parameters ​

NameType
objany

Returns ​

void

Inherited from ​

commonScene.addObject

Defined in ​

src/Scene/commonSceneMethod.ts:107

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

drawWholeNrrd ​

▸ drawWholeNrrd(nrrdSlices): void

Parameters ​

NameType
nrrdSlicesnrrdSliceType

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:284

init ​

▸ init(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:94

loadDicom ​

▸ loadDicom(urls, opts?): void

Parameters ​

NameType
urlsstring | string[]
opts?dicomLoaderOptsType

Returns ​

void

Inherited from ​

commonScene.loadDicom

Defined in ​

src/Scene/commonSceneMethod.ts:198

loadGltf ​

▸ loadGltf(url, callback?): void

Parameters ​

NameType
urlstring
callback?(content: Group) => void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:144

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?): void

Parameters ​

NameType
urlstring
callback?(mesh: Group) => void

Returns ​

void

Overrides ​

commonScene.loadOBJ

Defined in ​

src/Scene/copperMScene.ts:237

loadView ​

▸ loadView(viewpointData): void

Parameters ​

NameType
viewpointDataCameraViewPoint

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:331

loadViewUrl ​

▸ loadViewUrl(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:319

onWindowResize ​

▸ onWindowResize(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:366

pickModel ​

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

Parameters ​

NameType
contentGroup
callback(selectMesh: undefined | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>) => 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[]> | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]
mousePositionmouseMovePositionType

Returns ​

Object

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

Inherited from ​

commonScene.pickSpecifiedModel

Defined in ​

src/Scene/commonSceneMethod.ts:154

removeLights ​

▸ removeLights(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:312

removePreRenderCallbackFunction ​

▸ removePreRenderCallbackFunction(id): void

Parameters ​

NameType
idnumber

Returns ​

void

Overrides ​

commonScene.removePreRenderCallbackFunction

Defined in ​

src/Scene/copperMScene.ts:357

render ​

▸ render(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:390

resetView ​

▸ resetView(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:361

setCameraPosition ​

▸ setCameraPosition(position): void

Parameters ​

NameType
positionpositionType

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:350

setControls ​

▸ setControls(type): void

Parameters ​

NameType
typenumber

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:123

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

updateBackground ​

▸ updateBackground(color1, color2): void

Parameters ​

NameType
color1string
color2string

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:293

updateCamera ​

▸ updateCamera(viewpoint): void

Parameters ​

NameType
viewpointCameraViewPoint

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:345

updateControls ​

▸ updateControls(camera): void

Parameters ​

NameType
cameraPerspectiveCamera | OrthographicCamera

Returns ​

void

Inherited from ​

commonScene.updateControls

Defined in ​

src/Scene/commonSceneMethod.ts:329

- +
Copper3d API

Appearance

copper3d / Modules / Scene/copperMScene / copperMScene

Class: copperMScene ​

Scene/copperMScene.copperMScene

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new copperMScene(container, renderer)

Parameters ​

NameType
containerHTMLDivElement
rendererWebGLRenderer

Overrides ​

commonScene.constructor

Defined in ​

src/Scene/copperMScene.ts:51

Properties ​

ambientLight ​

• ambientLight: AmbientLight

Defined in ​

src/Scene/copperMScene.ts:39

camera ​

• camera: PerspectiveCamera | OrthographicCamera

Inherited from ​

commonScene.camera

Defined in ​

src/Scene/commonSceneMethod.ts:29

cameraPositionFlag ​

• cameraPositionFlag: boolean = false

Defined in ​

src/Scene/copperMScene.ts:42

color1 ​

• Private color1: string = "#5454ad"

Defined in ​

src/Scene/copperMScene.ts:46

color2 ​

• Private color2: string = "#18e5a7"

Defined in ​

src/Scene/copperMScene.ts:47

container ​

• container: HTMLDivElement

Overrides ​

commonScene.container

Defined in ​

src/Scene/copperMScene.ts:34

content ​

• content: Group

Defined in ​

src/Scene/copperMScene.ts:43

controls ​

• controls: Copper3dTrackballControls | OrbitControls | TrackballControls

Inherited from ​

commonScene.controls

Defined in ​

src/Scene/commonSceneMethod.ts:37

copperControl ​

• copperControl: Controls

Defined in ​

src/Scene/copperMScene.ts:40

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

gui ​

• gui: GUI

Defined in ​

src/Scene/copperMScene.ts:30

guiContainer ​

• Private guiContainer: HTMLDivElement

Defined in ​

src/Scene/copperMScene.ts:49

isHalfed ​

• isHalfed: boolean = false

Defined in ​

src/Scene/copperMScene.ts:44

lights ​

• Private lights: any[] = []

Defined in ​

src/Scene/copperMScene.ts:48

pickableObjects ​

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

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

scene ​

• scene: Scene

Inherited from ​

commonScene.scene

Defined in ​

src/Scene/commonSceneMethod.ts:28

sceneName ​

• sceneName: string = ""

Defined in ​

src/Scene/copperMScene.ts:36

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

vignette ​

• vignette: customMeshType

Defined in ​

src/Scene/copperMScene.ts:37

Methods ​

addLights ​

▸ addLights(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:299

addObject ​

▸ addObject(obj): void

Parameters ​

NameType
objany

Returns ​

void

Inherited from ​

commonScene.addObject

Defined in ​

src/Scene/commonSceneMethod.ts:107

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

drawWholeNrrd ​

▸ drawWholeNrrd(nrrdSlices): void

Parameters ​

NameType
nrrdSlicesnrrdSliceType

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:284

init ​

▸ init(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:94

loadDicom ​

▸ loadDicom(urls, opts?): void

Parameters ​

NameType
urlsstring | string[]
opts?dicomLoaderOptsType

Returns ​

void

Inherited from ​

commonScene.loadDicom

Defined in ​

src/Scene/commonSceneMethod.ts:198

loadGltf ​

▸ loadGltf(url, callback?): void

Parameters ​

NameType
urlstring
callback?(content: Group) => void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:144

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?): void

Parameters ​

NameType
urlstring
callback?(mesh: Group) => void

Returns ​

void

Overrides ​

commonScene.loadOBJ

Defined in ​

src/Scene/copperMScene.ts:237

loadView ​

▸ loadView(viewpointData): void

Parameters ​

NameType
viewpointDataCameraViewPoint

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:331

loadViewUrl ​

▸ loadViewUrl(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:319

onWindowResize ​

▸ onWindowResize(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:366

pickModel ​

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

Parameters ​

NameType
contentGroup
callback(selectMesh: undefined | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>) => 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[]> | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]
mousePositionmouseMovePositionType

Returns ​

Object

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

Inherited from ​

commonScene.pickSpecifiedModel

Defined in ​

src/Scene/commonSceneMethod.ts:154

removeLights ​

▸ removeLights(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:312

removePreRenderCallbackFunction ​

▸ removePreRenderCallbackFunction(id): void

Parameters ​

NameType
idnumber

Returns ​

void

Overrides ​

commonScene.removePreRenderCallbackFunction

Defined in ​

src/Scene/copperMScene.ts:357

render ​

▸ render(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:390

resetView ​

▸ resetView(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:361

setCameraPosition ​

▸ setCameraPosition(position): void

Parameters ​

NameType
positionpositionType

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:350

setControls ​

▸ setControls(type): void

Parameters ​

NameType
typenumber

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:123

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

updateBackground ​

▸ updateBackground(color1, color2): void

Parameters ​

NameType
color1string
color2string

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:293

updateCamera ​

▸ updateCamera(viewpoint): void

Parameters ​

NameType
viewpointCameraViewPoint

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:345

updateControls ​

▸ updateControls(camera): void

Parameters ​

NameType
cameraPerspectiveCamera | OrthographicCamera

Returns ​

void

Inherited from ​

commonScene.updateControls

Defined in ​

src/Scene/commonSceneMethod.ts:329

+ \ No newline at end of file diff --git a/apidist/classes/Scene_copperScene.copperScene.html b/apidist/classes/Scene_copperScene.copperScene.html index ec5b0d7..02831e8 100644 --- a/apidist/classes/Scene_copperScene.copperScene.html +++ b/apidist/classes/Scene_copperScene.copperScene.html @@ -11,13 +11,13 @@ - + -
Copper3d API

Appearance

copper3d / Modules / Scene/copperScene / copperScene

Class: copperScene ​

Scene/copperScene.copperScene

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new copperScene(container, renderer, opt?)

Parameters ​

NameType
containerHTMLDivElement
rendererWebGLRenderer
opt?ICopperSceneOpts

Overrides ​

baseScene.constructor

Defined in ​

src/Scene/copperScene.ts:30

Properties ​

ambientLight ​

• ambientLight: AmbientLight

Inherited from ​

baseScene.ambientLight

Defined in ​

src/Scene/baseScene.ts:18

camera ​

• camera: PerspectiveCamera | OrthographicCamera

Inherited from ​

baseScene.camera

Defined in ​

src/Scene/commonSceneMethod.ts:29

cameraPositionFlag ​

• cameraPositionFlag: boolean = false

Inherited from ​

baseScene.cameraPositionFlag

Defined in ​

src/Scene/baseScene.ts:20

clipAction ​

• Private clipAction: any

Defined in ​

src/Scene/copperScene.ts:24

clock ​

• clock: Clock

Defined in ​

src/Scene/copperScene.ts:17

container ​

• container: HTMLDivElement

Inherited from ​

baseScene.container

Defined in ​

src/Scene/commonSceneMethod.ts:27

content ​

• content: Group

Inherited from ​

baseScene.content

Defined in ​

src/Scene/baseScene.ts:21

controls ​

• controls: Copper3dTrackballControls | OrbitControls | TrackballControls

Overrides ​

baseScene.controls

Defined in ​

src/Scene/copperScene.ts:18

copperControl ​

• copperControl: Controls

Inherited from ​

baseScene.copperControl

Defined in ​

src/Scene/baseScene.ts:19

copperOrthographicCamera ​

• copperOrthographicCamera: OrthographicCamera

Inherited from ​

baseScene.copperOrthographicCamera

Defined in ​

src/Scene/commonSceneMethod.ts:32

copperPerspectiveCamera ​

• copperPerspectiveCamera: PerspectiveCamera

Inherited from ​

baseScene.copperPerspectiveCamera

Defined in ​

src/Scene/commonSceneMethod.ts:31

depthStep ​

• Protected depthStep: number = 0.4

Inherited from ​

baseScene.depthStep

Defined in ​

src/Scene/commonSceneMethod.ts:44

directionalLight ​

• directionalLight: DirectionalLight

Inherited from ​

baseScene.directionalLight

Defined in ​

src/Scene/baseScene.ts:17

exportContent ​

• exportContent: Group

Inherited from ​

baseScene.exportContent

Defined in ​

src/Scene/baseScene.ts:22

isHalfed ​

• isHalfed: boolean = false

Inherited from ​

baseScene.isHalfed

Defined in ​

src/Scene/baseScene.ts:23

mixer ​

• Private mixer: null | AnimationMixer = null

Defined in ​

src/Scene/copperScene.ts:21

modelReady ​

• Private modelReady: boolean = false

Defined in ​

src/Scene/copperScene.ts:23

pickableObjects ​

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

Inherited from ​

baseScene.pickableObjects

Defined in ​

src/Scene/commonSceneMethod.ts:46

playRate ​

• Private playRate: number = 1.0

Defined in ​

src/Scene/copperScene.ts:22

preRenderCallbackFunctions ​

• Protected preRenderCallbackFunctions: preRenderCallbackFunctionType

Inherited from ​

baseScene.preRenderCallbackFunctions

Defined in ​

src/Scene/commonSceneMethod.ts:42

renderNrrdVolume ​

• Protected renderNrrdVolume: boolean = false

Inherited from ​

baseScene.renderNrrdVolume

Defined in ​

src/Scene/commonSceneMethod.ts:40

renderer ​

• renderer: WebGLRenderer

Inherited from ​

baseScene.renderer

Defined in ​

src/Scene/baseScene.ts:12

scene ​

• scene: Scene

Inherited from ​

baseScene.scene

Defined in ​

src/Scene/commonSceneMethod.ts:28

sceneName ​

• sceneName: string = ""

Inherited from ​

baseScene.sceneName

Defined in ​

src/Scene/baseScene.ts:15

sort ​

• Protected sort: boolean = true

Inherited from ​

baseScene.sort

Defined in ​

src/Scene/commonSceneMethod.ts:43

subCamera ​

• subCamera: null | PerspectiveCamera = null

Inherited from ​

baseScene.subCamera

Defined in ​

src/Scene/commonSceneMethod.ts:36

subCopperControl ​

• Protected subCopperControl: null | Controls = null

Inherited from ​

baseScene.subCopperControl

Defined in ​

src/Scene/commonSceneMethod.ts:39

subDiv ​

• subDiv: null | HTMLDivElement = null

Inherited from ​

baseScene.subDiv

Defined in ​

src/Scene/commonSceneMethod.ts:34

subRender ​

• Protected subRender: null | WebGLRenderer = null

Inherited from ​

baseScene.subRender

Defined in ​

src/Scene/commonSceneMethod.ts:38

subScene ​

• subScene: Scene

Inherited from ​

baseScene.subScene

Defined in ​

src/Scene/commonSceneMethod.ts:35

texture2dMesh ​

• Private texture2dMesh: null | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]> = null

Defined in ​

src/Scene/copperScene.ts:28

viewPoint ​

• viewPoint: CameraViewPoint

Inherited from ​

baseScene.viewPoint

Defined in ​

src/Scene/baseScene.ts:24

vignette ​

• vignette: undefined | customMeshType

Inherited from ​

baseScene.vignette

Defined in ​

src/Scene/baseScene.ts:16

Methods ​

addLights ​

▸ addLights(): void

Returns ​

void

Inherited from ​

baseScene.addLights

Defined in ​

src/Scene/baseScene.ts:138

addObject ​

▸ addObject(obj): void

Parameters ​

NameType
objany

Returns ​

void

Inherited from ​

baseScene.addObject

Defined in ​

src/Scene/baseScene.ts:134

addPreRenderCallbackFunction ​

▸ addPreRenderCallbackFunction(callbackFunction): number

Parameters ​

NameType
callbackFunctionFunction

Returns ​

number

Inherited from ​

baseScene.addPreRenderCallbackFunction

Defined in ​

src/Scene/commonSceneMethod.ts:122

addSubView ​

▸ addSubView(): HTMLDivElement

create a new sub view to display models

Returns ​

HTMLDivElement

Inherited from ​

baseScene.addSubView

Defined in ​

src/Scene/commonSceneMethod.ts:174

createDemoMesh ​

▸ createDemoMesh(): void

Returns ​

void

Inherited from ​

baseScene.createDemoMesh

Defined in ​

src/Scene/commonSceneMethod.ts:96

getCurrentMixer ​

▸ getCurrentMixer(): null | AnimationMixer

Returns ​

null | AnimationMixer

Defined in ​

src/Scene/copperScene.ts:327

getCurrentTime ​

▸ getCurrentTime(): number

Returns ​

number

Defined in ​

src/Scene/copperScene.ts:319

getDefaultViewPoint ​

▸ getDefaultViewPoint(): CameraViewPoint

Returns ​

CameraViewPoint

Inherited from ​

baseScene.getDefaultViewPoint

Defined in ​

src/Scene/baseScene.ts:109

getPlayRate ​

▸ getPlayRate(): number

Returns ​

number

Defined in ​

src/Scene/copperScene.ts:292

init ​

▸ init(): void

Returns ​

void

Inherited from ​

baseScene.init

Defined in ​

src/Scene/baseScene.ts:54

loadDicom ​

▸ loadDicom(urls, opts?): void

Parameters ​

NameType
urlsstring | string[]
opts?dicomLoaderOptsType

Returns ​

void

Inherited from ​

baseScene.loadDicom

Defined in ​

src/Scene/commonSceneMethod.ts:198

loadGltf ​

▸ loadGltf(url, callback?): void

Parameters ​

NameType
urlstring
callback?(content: Group) => void

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:56

loadMetadataUrl ​

▸ loadMetadataUrl(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Inherited from ​

baseScene.loadMetadataUrl

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 ​

baseScene.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 ​

baseScene.loadNrrdTexture3d

Defined in ​

src/Scene/commonSceneMethod.ts:338

loadOBJ ​

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

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.loadOBJ

Defined in ​

src/Scene/commonSceneMethod.ts:350

loadView ​

▸ loadView(viewpointData): void

Parameters ​

NameType
viewpointDataCameraViewPoint

Returns ​

void

Inherited from ​

baseScene.loadView

Defined in ​

src/Scene/baseScene.ts:97

loadViewUrl ​

▸ loadViewUrl(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Inherited from ​

baseScene.loadViewUrl

Defined in ​

src/Scene/baseScene.ts:85

loadVtk ​

▸ loadVtk(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:146

loadVtks ​

▸ loadVtks(models): void

Parameters ​

NameType
modelsvtkModels[]

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:150

onRenderCameraChange ​

▸ onRenderCameraChange(): void

Returns ​

void

Overrides ​

baseScene.onRenderCameraChange

Defined in ​

src/Scene/copperScene.ts:344

onWindowResize ​

▸ onWindowResize(): void

Returns ​

void

Inherited from ​

baseScene.onWindowResize

Defined in ​

src/Scene/baseScene.ts:199

pickModel ​

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

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.pickModel

Defined in ​

src/Scene/commonSceneMethod.ts:132

pickSpecifiedModel ​

▸ pickSpecifiedModel(content, mousePosition): Object

Parameters ​

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

Returns ​

Object

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

Inherited from ​

baseScene.pickSpecifiedModel

Defined in ​

src/Scene/commonSceneMethod.ts:154

removeLights ​

▸ removeLights(): void

Returns ​

void

Inherited from ​

baseScene.removeLights

Defined in ​

src/Scene/baseScene.ts:151

removePreRenderCallbackFunction ​

▸ removePreRenderCallbackFunction(id): void

Parameters ​

NameType
idnumber

Returns ​

void

Inherited from ​

baseScene.removePreRenderCallbackFunction

Defined in ​

src/Scene/commonSceneMethod.ts:128

render ​

▸ render(time?): void

Parameters ​

NameType
time?number

Returns ​

void

Overrides ​

baseScene.render

Defined in ​

src/Scene/copperScene.ts:359

resetView ​

▸ resetView(): void

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:309

setDepth ​

▸ setDepth(value): void

Parameters ​

NameType
valuenumber

Returns ​

void

Inherited from ​

baseScene.setDepth

Defined in ​

src/Scene/commonSceneMethod.ts:111

setDicomFilesOrder ​

▸ setDicomFilesOrder(value): void

Parameters ​

NameType
value"ascending" | "descending"

Returns ​

void

Inherited from ​

baseScene.setDicomFilesOrder

Defined in ​

src/Scene/commonSceneMethod.ts:114

setModelPosition ​

▸ setModelPosition(model, position): void

Parameters ​

NameType
modelGroup | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>
positionObject
position.x?number
position.y?number
position.z?number

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:300

setPlayRate ​

▸ setPlayRate(playRate): void

Parameters ​

NameType
playRatenumber

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:296

setViewPoint ​

▸ setViewPoint(camera, target?): CameraViewPoint

Parameters ​

NameType
cameraPerspectiveCamera
target?number[]

Returns ​

CameraViewPoint

Inherited from ​

baseScene.setViewPoint

Defined in ​

src/Scene/baseScene.ts:113

texture2d ​

▸ texture2d(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:255

updateBackground ​

▸ updateBackground(color1, color2): void

Parameters ​

NameType
color1string
color2string

Returns ​

void

Inherited from ​

baseScene.updateBackground

Defined in ​

src/Scene/baseScene.ts:179

updateCamera ​

▸ updateCamera(viewpoint): void

Parameters ​

NameType
viewpointCameraViewPoint

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:314

updateControls ​

▸ updateControls(camera): void

Parameters ​

NameType
cameraPerspectiveCamera | OrthographicCamera

Returns ​

void

Overrides ​

baseScene.updateControls

Defined in ​

src/Scene/copperScene.ts:331

updateDisplay ​

▸ updateDisplay(state): void

Parameters ​

NameType
statebaseStateType

Returns ​

void

Inherited from ​

baseScene.updateDisplay

Defined in ​

src/Scene/baseScene.ts:174

updateLights ​

▸ updateLights(state): void

Parameters ​

NameType
statebaseStateType

Returns ​

void

Inherited from ​

baseScene.updateLights

Defined in ​

src/Scene/baseScene.ts:157

updateModelChildrenVisualisation ​

▸ updateModelChildrenVisualisation(child): void

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.updateModelChildrenVisualisation

Defined in ​

src/Scene/baseScene.ts:184

- +
Copper3d API

Appearance

copper3d / Modules / Scene/copperScene / copperScene

Class: copperScene ​

Scene/copperScene.copperScene

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new copperScene(container, renderer, opt?)

Parameters ​

NameType
containerHTMLDivElement
rendererWebGLRenderer
opt?ICopperSceneOpts

Overrides ​

baseScene.constructor

Defined in ​

src/Scene/copperScene.ts:30

Properties ​

ambientLight ​

• ambientLight: AmbientLight

Inherited from ​

baseScene.ambientLight

Defined in ​

src/Scene/baseScene.ts:18

camera ​

• camera: PerspectiveCamera | OrthographicCamera

Inherited from ​

baseScene.camera

Defined in ​

src/Scene/commonSceneMethod.ts:29

cameraPositionFlag ​

• cameraPositionFlag: boolean = false

Inherited from ​

baseScene.cameraPositionFlag

Defined in ​

src/Scene/baseScene.ts:20

clipAction ​

• Private clipAction: any

Defined in ​

src/Scene/copperScene.ts:24

clock ​

• clock: Clock

Defined in ​

src/Scene/copperScene.ts:17

container ​

• container: HTMLDivElement

Inherited from ​

baseScene.container

Defined in ​

src/Scene/commonSceneMethod.ts:27

content ​

• content: Group

Inherited from ​

baseScene.content

Defined in ​

src/Scene/baseScene.ts:21

controls ​

• controls: Copper3dTrackballControls | OrbitControls | TrackballControls

Overrides ​

baseScene.controls

Defined in ​

src/Scene/copperScene.ts:18

copperControl ​

• copperControl: Controls

Inherited from ​

baseScene.copperControl

Defined in ​

src/Scene/baseScene.ts:19

copperOrthographicCamera ​

• copperOrthographicCamera: OrthographicCamera

Inherited from ​

baseScene.copperOrthographicCamera

Defined in ​

src/Scene/commonSceneMethod.ts:32

copperPerspectiveCamera ​

• copperPerspectiveCamera: PerspectiveCamera

Inherited from ​

baseScene.copperPerspectiveCamera

Defined in ​

src/Scene/commonSceneMethod.ts:31

depthStep ​

• Protected depthStep: number = 0.4

Inherited from ​

baseScene.depthStep

Defined in ​

src/Scene/commonSceneMethod.ts:44

directionalLight ​

• directionalLight: DirectionalLight

Inherited from ​

baseScene.directionalLight

Defined in ​

src/Scene/baseScene.ts:17

exportContent ​

• exportContent: Group

Inherited from ​

baseScene.exportContent

Defined in ​

src/Scene/baseScene.ts:22

isHalfed ​

• isHalfed: boolean = false

Inherited from ​

baseScene.isHalfed

Defined in ​

src/Scene/baseScene.ts:23

mixer ​

• Private mixer: null | AnimationMixer = null

Defined in ​

src/Scene/copperScene.ts:21

modelReady ​

• Private modelReady: boolean = false

Defined in ​

src/Scene/copperScene.ts:23

pickableObjects ​

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

Inherited from ​

baseScene.pickableObjects

Defined in ​

src/Scene/commonSceneMethod.ts:46

playRate ​

• Private playRate: number = 1.0

Defined in ​

src/Scene/copperScene.ts:22

preRenderCallbackFunctions ​

• Protected preRenderCallbackFunctions: preRenderCallbackFunctionType

Inherited from ​

baseScene.preRenderCallbackFunctions

Defined in ​

src/Scene/commonSceneMethod.ts:42

renderNrrdVolume ​

• Protected renderNrrdVolume: boolean = false

Inherited from ​

baseScene.renderNrrdVolume

Defined in ​

src/Scene/commonSceneMethod.ts:40

renderer ​

• renderer: WebGLRenderer

Inherited from ​

baseScene.renderer

Defined in ​

src/Scene/baseScene.ts:12

scene ​

• scene: Scene

Inherited from ​

baseScene.scene

Defined in ​

src/Scene/commonSceneMethod.ts:28

sceneName ​

• sceneName: string = ""

Inherited from ​

baseScene.sceneName

Defined in ​

src/Scene/baseScene.ts:15

sort ​

• Protected sort: boolean = true

Inherited from ​

baseScene.sort

Defined in ​

src/Scene/commonSceneMethod.ts:43

subCamera ​

• subCamera: null | PerspectiveCamera = null

Inherited from ​

baseScene.subCamera

Defined in ​

src/Scene/commonSceneMethod.ts:36

subCopperControl ​

• Protected subCopperControl: null | Controls = null

Inherited from ​

baseScene.subCopperControl

Defined in ​

src/Scene/commonSceneMethod.ts:39

subDiv ​

• subDiv: null | HTMLDivElement = null

Inherited from ​

baseScene.subDiv

Defined in ​

src/Scene/commonSceneMethod.ts:34

subRender ​

• Protected subRender: null | WebGLRenderer = null

Inherited from ​

baseScene.subRender

Defined in ​

src/Scene/commonSceneMethod.ts:38

subScene ​

• subScene: Scene

Inherited from ​

baseScene.subScene

Defined in ​

src/Scene/commonSceneMethod.ts:35

texture2dMesh ​

• Private texture2dMesh: null | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]> = null

Defined in ​

src/Scene/copperScene.ts:28

viewPoint ​

• viewPoint: CameraViewPoint

Inherited from ​

baseScene.viewPoint

Defined in ​

src/Scene/baseScene.ts:24

vignette ​

• vignette: undefined | customMeshType

Inherited from ​

baseScene.vignette

Defined in ​

src/Scene/baseScene.ts:16

Methods ​

addLights ​

▸ addLights(): void

Returns ​

void

Inherited from ​

baseScene.addLights

Defined in ​

src/Scene/baseScene.ts:138

addObject ​

▸ addObject(obj): void

Parameters ​

NameType
objany

Returns ​

void

Inherited from ​

baseScene.addObject

Defined in ​

src/Scene/baseScene.ts:134

addPreRenderCallbackFunction ​

▸ addPreRenderCallbackFunction(callbackFunction): number

Parameters ​

NameType
callbackFunctionFunction

Returns ​

number

Inherited from ​

baseScene.addPreRenderCallbackFunction

Defined in ​

src/Scene/commonSceneMethod.ts:122

addSubView ​

▸ addSubView(): HTMLDivElement

create a new sub view to display models

Returns ​

HTMLDivElement

Inherited from ​

baseScene.addSubView

Defined in ​

src/Scene/commonSceneMethod.ts:174

createDemoMesh ​

▸ createDemoMesh(): void

Returns ​

void

Inherited from ​

baseScene.createDemoMesh

Defined in ​

src/Scene/commonSceneMethod.ts:96

getCurrentMixer ​

▸ getCurrentMixer(): null | AnimationMixer

Returns ​

null | AnimationMixer

Defined in ​

src/Scene/copperScene.ts:327

getCurrentTime ​

▸ getCurrentTime(): number

Returns ​

number

Defined in ​

src/Scene/copperScene.ts:319

getDefaultViewPoint ​

▸ getDefaultViewPoint(): CameraViewPoint

Returns ​

CameraViewPoint

Inherited from ​

baseScene.getDefaultViewPoint

Defined in ​

src/Scene/baseScene.ts:109

getPlayRate ​

▸ getPlayRate(): number

Returns ​

number

Defined in ​

src/Scene/copperScene.ts:292

init ​

▸ init(): void

Returns ​

void

Inherited from ​

baseScene.init

Defined in ​

src/Scene/baseScene.ts:54

loadDicom ​

▸ loadDicom(urls, opts?): void

Parameters ​

NameType
urlsstring | string[]
opts?dicomLoaderOptsType

Returns ​

void

Inherited from ​

baseScene.loadDicom

Defined in ​

src/Scene/commonSceneMethod.ts:198

loadGltf ​

▸ loadGltf(url, callback?): void

Parameters ​

NameType
urlstring
callback?(content: Group) => void

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:56

loadMetadataUrl ​

▸ loadMetadataUrl(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Inherited from ​

baseScene.loadMetadataUrl

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 ​

baseScene.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 ​

baseScene.loadNrrdTexture3d

Defined in ​

src/Scene/commonSceneMethod.ts:338

loadOBJ ​

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

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.loadOBJ

Defined in ​

src/Scene/commonSceneMethod.ts:350

loadView ​

▸ loadView(viewpointData): void

Parameters ​

NameType
viewpointDataCameraViewPoint

Returns ​

void

Inherited from ​

baseScene.loadView

Defined in ​

src/Scene/baseScene.ts:97

loadViewUrl ​

▸ loadViewUrl(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Inherited from ​

baseScene.loadViewUrl

Defined in ​

src/Scene/baseScene.ts:85

loadVtk ​

▸ loadVtk(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:146

loadVtks ​

▸ loadVtks(models): void

Parameters ​

NameType
modelsvtkModels[]

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:150

onRenderCameraChange ​

▸ onRenderCameraChange(): void

Returns ​

void

Overrides ​

baseScene.onRenderCameraChange

Defined in ​

src/Scene/copperScene.ts:344

onWindowResize ​

▸ onWindowResize(): void

Returns ​

void

Inherited from ​

baseScene.onWindowResize

Defined in ​

src/Scene/baseScene.ts:199

pickModel ​

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

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.pickModel

Defined in ​

src/Scene/commonSceneMethod.ts:132

pickSpecifiedModel ​

▸ pickSpecifiedModel(content, mousePosition): Object

Parameters ​

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

Returns ​

Object

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

Inherited from ​

baseScene.pickSpecifiedModel

Defined in ​

src/Scene/commonSceneMethod.ts:154

removeLights ​

▸ removeLights(): void

Returns ​

void

Inherited from ​

baseScene.removeLights

Defined in ​

src/Scene/baseScene.ts:151

removePreRenderCallbackFunction ​

▸ removePreRenderCallbackFunction(id): void

Parameters ​

NameType
idnumber

Returns ​

void

Inherited from ​

baseScene.removePreRenderCallbackFunction

Defined in ​

src/Scene/commonSceneMethod.ts:128

render ​

▸ render(time?): void

Parameters ​

NameType
time?number

Returns ​

void

Overrides ​

baseScene.render

Defined in ​

src/Scene/copperScene.ts:359

resetView ​

▸ resetView(): void

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:309

setDepth ​

▸ setDepth(value): void

Parameters ​

NameType
valuenumber

Returns ​

void

Inherited from ​

baseScene.setDepth

Defined in ​

src/Scene/commonSceneMethod.ts:111

setDicomFilesOrder ​

▸ setDicomFilesOrder(value): void

Parameters ​

NameType
value"ascending" | "descending"

Returns ​

void

Inherited from ​

baseScene.setDicomFilesOrder

Defined in ​

src/Scene/commonSceneMethod.ts:114

setModelPosition ​

▸ setModelPosition(model, position): void

Parameters ​

NameType
modelGroup | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>
positionObject
position.x?number
position.y?number
position.z?number

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:300

setPlayRate ​

▸ setPlayRate(playRate): void

Parameters ​

NameType
playRatenumber

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:296

setViewPoint ​

▸ setViewPoint(camera, target?): CameraViewPoint

Parameters ​

NameType
cameraPerspectiveCamera
target?number[]

Returns ​

CameraViewPoint

Inherited from ​

baseScene.setViewPoint

Defined in ​

src/Scene/baseScene.ts:113

texture2d ​

▸ texture2d(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:255

updateBackground ​

▸ updateBackground(color1, color2): void

Parameters ​

NameType
color1string
color2string

Returns ​

void

Inherited from ​

baseScene.updateBackground

Defined in ​

src/Scene/baseScene.ts:179

updateCamera ​

▸ updateCamera(viewpoint): void

Parameters ​

NameType
viewpointCameraViewPoint

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:314

updateControls ​

▸ updateControls(camera): void

Parameters ​

NameType
cameraPerspectiveCamera | OrthographicCamera

Returns ​

void

Overrides ​

baseScene.updateControls

Defined in ​

src/Scene/copperScene.ts:331

updateDisplay ​

▸ updateDisplay(state): void

Parameters ​

NameType
statebaseStateType

Returns ​

void

Inherited from ​

baseScene.updateDisplay

Defined in ​

src/Scene/baseScene.ts:174

updateLights ​

▸ updateLights(state): void

Parameters ​

NameType
statebaseStateType

Returns ​

void

Inherited from ​

baseScene.updateLights

Defined in ​

src/Scene/baseScene.ts:157

updateModelChildrenVisualisation ​

▸ updateModelChildrenVisualisation(child): void

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.updateModelChildrenVisualisation

Defined in ​

src/Scene/baseScene.ts:184

+ \ No newline at end of file diff --git a/apidist/classes/Scene_copperSceneOnDemond.copperSceneOnDemond.html b/apidist/classes/Scene_copperSceneOnDemond.copperSceneOnDemond.html index b09475a..a010feb 100644 --- a/apidist/classes/Scene_copperSceneOnDemond.copperSceneOnDemond.html +++ b/apidist/classes/Scene_copperSceneOnDemond.copperSceneOnDemond.html @@ -11,13 +11,13 @@ - + -
Copper3d API

Appearance

copper3d / Modules / Scene/copperSceneOnDemond / copperSceneOnDemond

Class: copperSceneOnDemond ​

Scene/copperSceneOnDemond.copperSceneOnDemond

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new copperSceneOnDemond(container, renderer)

Parameters ​

NameType
containerHTMLDivElement
rendererWebGLRenderer

Overrides ​

baseScene.constructor

Defined in ​

src/Scene/copperSceneOnDemond.ts:12

Properties ​

ambientLight ​

• ambientLight: AmbientLight

Inherited from ​

baseScene.ambientLight

Defined in ​

src/Scene/baseScene.ts:18

camera ​

• camera: PerspectiveCamera | OrthographicCamera

Inherited from ​

baseScene.camera

Defined in ​

src/Scene/commonSceneMethod.ts:29

cameraPositionFlag ​

• cameraPositionFlag: boolean = false

Inherited from ​

baseScene.cameraPositionFlag

Defined in ​

src/Scene/baseScene.ts:20

container ​

• container: HTMLDivElement

Inherited from ​

baseScene.container

Defined in ​

src/Scene/commonSceneMethod.ts:27

content ​

• content: Group

Inherited from ​

baseScene.content

Defined in ​

src/Scene/baseScene.ts:21

controls ​

• controls: OrbitControls

Overrides ​

baseScene.controls

Defined in ​

src/Scene/copperSceneOnDemond.ts:8

copperControl ​

• copperControl: Controls

Inherited from ​

baseScene.copperControl

Defined in ​

src/Scene/baseScene.ts:19

copperOrthographicCamera ​

• copperOrthographicCamera: OrthographicCamera

Inherited from ​

baseScene.copperOrthographicCamera

Defined in ​

src/Scene/commonSceneMethod.ts:32

copperPerspectiveCamera ​

• copperPerspectiveCamera: PerspectiveCamera

Inherited from ​

baseScene.copperPerspectiveCamera

Defined in ​

src/Scene/commonSceneMethod.ts:31

depthStep ​

• Protected depthStep: number = 0.4

Inherited from ​

baseScene.depthStep

Defined in ​

src/Scene/commonSceneMethod.ts:44

directionalLight ​

• directionalLight: DirectionalLight

Inherited from ​

baseScene.directionalLight

Defined in ​

src/Scene/baseScene.ts:17

exportContent ​

• exportContent: Group

Inherited from ​

baseScene.exportContent

Defined in ​

src/Scene/baseScene.ts:22

isHalfed ​

• isHalfed: boolean = false

Inherited from ​

baseScene.isHalfed

Defined in ​

src/Scene/baseScene.ts:23

isResize ​

• isResize: boolean = false

Defined in ​

src/Scene/copperSceneOnDemond.ts:10

pickableObjects ​

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

Inherited from ​

baseScene.pickableObjects

Defined in ​

src/Scene/commonSceneMethod.ts:46

preRenderCallbackFunctions ​

• Protected preRenderCallbackFunctions: preRenderCallbackFunctionType

Inherited from ​

baseScene.preRenderCallbackFunctions

Defined in ​

src/Scene/commonSceneMethod.ts:42

renderNrrdVolume ​

• Protected renderNrrdVolume: boolean = false

Inherited from ​

baseScene.renderNrrdVolume

Defined in ​

src/Scene/commonSceneMethod.ts:40

renderRequested ​

• renderRequested: undefined | boolean = false

Defined in ​

src/Scene/copperSceneOnDemond.ts:9

renderer ​

• renderer: WebGLRenderer

Inherited from ​

baseScene.renderer

Defined in ​

src/Scene/baseScene.ts:12

scene ​

• scene: Scene

Inherited from ​

baseScene.scene

Defined in ​

src/Scene/commonSceneMethod.ts:28

sceneName ​

• sceneName: string = ""

Inherited from ​

baseScene.sceneName

Defined in ​

src/Scene/baseScene.ts:15

sort ​

• Protected sort: boolean = true

Inherited from ​

baseScene.sort

Defined in ​

src/Scene/commonSceneMethod.ts:43

subCamera ​

• subCamera: null | PerspectiveCamera = null

Inherited from ​

baseScene.subCamera

Defined in ​

src/Scene/commonSceneMethod.ts:36

subCopperControl ​

• Protected subCopperControl: null | Controls = null

Inherited from ​

baseScene.subCopperControl

Defined in ​

src/Scene/commonSceneMethod.ts:39

subDiv ​

• subDiv: null | HTMLDivElement = null

Inherited from ​

baseScene.subDiv

Defined in ​

src/Scene/commonSceneMethod.ts:34

subRender ​

• Protected subRender: null | WebGLRenderer = null

Inherited from ​

baseScene.subRender

Defined in ​

src/Scene/commonSceneMethod.ts:38

subScene ​

• subScene: Scene

Inherited from ​

baseScene.subScene

Defined in ​

src/Scene/commonSceneMethod.ts:35

viewPoint ​

• viewPoint: CameraViewPoint

Inherited from ​

baseScene.viewPoint

Defined in ​

src/Scene/baseScene.ts:24

vignette ​

• vignette: undefined | customMeshType

Inherited from ​

baseScene.vignette

Defined in ​

src/Scene/baseScene.ts:16

Methods ​

addLights ​

▸ addLights(): void

Returns ​

void

Inherited from ​

baseScene.addLights

Defined in ​

src/Scene/baseScene.ts:138

addObject ​

▸ addObject(obj): void

Parameters ​

NameType
objany

Returns ​

void

Inherited from ​

baseScene.addObject

Defined in ​

src/Scene/baseScene.ts:134

addPreRenderCallbackFunction ​

▸ addPreRenderCallbackFunction(callbackFunction): number

Parameters ​

NameType
callbackFunctionFunction

Returns ​

number

Inherited from ​

baseScene.addPreRenderCallbackFunction

Defined in ​

src/Scene/commonSceneMethod.ts:122

addSubView ​

▸ addSubView(): HTMLDivElement

create a new sub view to display models

Returns ​

HTMLDivElement

Inherited from ​

baseScene.addSubView

Defined in ​

src/Scene/commonSceneMethod.ts:174

confirmResize ​

▸ confirmResize(): void

Returns ​

void

Defined in ​

src/Scene/copperSceneOnDemond.ts:58

createDemoMesh ​

▸ createDemoMesh(): void

Returns ​

void

Inherited from ​

baseScene.createDemoMesh

Defined in ​

src/Scene/commonSceneMethod.ts:96

getDefaultViewPoint ​

▸ getDefaultViewPoint(): CameraViewPoint

Returns ​

CameraViewPoint

Inherited from ​

baseScene.getDefaultViewPoint

Defined in ​

src/Scene/baseScene.ts:109

init ​

▸ init(): void

Returns ​

void

Inherited from ​

baseScene.init

Defined in ​

src/Scene/baseScene.ts:54

loadDicom ​

▸ loadDicom(urls, opts?): void

Parameters ​

NameType
urlsstring | string[]
opts?dicomLoaderOptsType

Returns ​

void

Inherited from ​

baseScene.loadDicom

Defined in ​

src/Scene/commonSceneMethod.ts:198

loadGltf ​

▸ loadGltf(url, callback?): void

Parameters ​

NameType
urlstring
callback?(content: Group) => void

Returns ​

void

Defined in ​

src/Scene/copperSceneOnDemond.ts:21

loadMetadataUrl ​

▸ loadMetadataUrl(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Inherited from ​

baseScene.loadMetadataUrl

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 ​

baseScene.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 ​

baseScene.loadNrrdTexture3d

Defined in ​

src/Scene/commonSceneMethod.ts:338

loadOBJ ​

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

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.loadOBJ

Defined in ​

src/Scene/commonSceneMethod.ts:350

loadView ​

▸ loadView(viewpointData): void

Parameters ​

NameType
viewpointDataCameraViewPoint

Returns ​

void

Inherited from ​

baseScene.loadView

Defined in ​

src/Scene/baseScene.ts:97

loadViewUrl ​

▸ loadViewUrl(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Inherited from ​

baseScene.loadViewUrl

Defined in ​

src/Scene/baseScene.ts:85

onRenderCameraChange ​

▸ onRenderCameraChange(): void

Returns ​

void

Inherited from ​

baseScene.onRenderCameraChange

Defined in ​

src/Scene/baseScene.ts:193

onWindowResize ​

▸ onWindowResize(): void

Returns ​

void

Inherited from ​

baseScene.onWindowResize

Defined in ​

src/Scene/baseScene.ts:199

pickModel ​

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

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.pickModel

Defined in ​

src/Scene/commonSceneMethod.ts:132

pickSpecifiedModel ​

▸ pickSpecifiedModel(content, mousePosition): Object

Parameters ​

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

Returns ​

Object

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

Inherited from ​

baseScene.pickSpecifiedModel

Defined in ​

src/Scene/commonSceneMethod.ts:154

removeLights ​

▸ removeLights(): void

Returns ​

void

Inherited from ​

baseScene.removeLights

Defined in ​

src/Scene/baseScene.ts:151

removePreRenderCallbackFunction ​

▸ removePreRenderCallbackFunction(id): void

Parameters ​

NameType
idnumber

Returns ​

void

Inherited from ​

baseScene.removePreRenderCallbackFunction

Defined in ​

src/Scene/commonSceneMethod.ts:128

render ​

▸ render(): void

Returns ​

void

Overrides ​

baseScene.render

Defined in ​

src/Scene/copperSceneOnDemond.ts:63

requestRenderIfNotRequested ​

▸ requestRenderIfNotRequested(): void

Returns ​

void

Defined in ​

src/Scene/copperSceneOnDemond.ts:70

setDepth ​

▸ setDepth(value): void

Parameters ​

NameType
valuenumber

Returns ​

void

Inherited from ​

baseScene.setDepth

Defined in ​

src/Scene/commonSceneMethod.ts:111

setDicomFilesOrder ​

▸ setDicomFilesOrder(value): void

Parameters ​

NameType
value"ascending" | "descending"

Returns ​

void

Inherited from ​

baseScene.setDicomFilesOrder

Defined in ​

src/Scene/commonSceneMethod.ts:114

setViewPoint ​

▸ setViewPoint(camera, target?): CameraViewPoint

Parameters ​

NameType
cameraPerspectiveCamera
target?number[]

Returns ​

CameraViewPoint

Inherited from ​

baseScene.setViewPoint

Defined in ​

src/Scene/baseScene.ts:113

updateBackground ​

▸ updateBackground(color1, color2): void

Parameters ​

NameType
color1string
color2string

Returns ​

void

Inherited from ​

baseScene.updateBackground

Defined in ​

src/Scene/baseScene.ts:179

updateControls ​

▸ updateControls(camera): void

Parameters ​

NameType
cameraPerspectiveCamera | OrthographicCamera

Returns ​

void

Inherited from ​

baseScene.updateControls

Defined in ​

src/Scene/commonSceneMethod.ts:329

updateDisplay ​

▸ updateDisplay(state): void

Parameters ​

NameType
statebaseStateType

Returns ​

void

Inherited from ​

baseScene.updateDisplay

Defined in ​

src/Scene/baseScene.ts:174

updateLights ​

▸ updateLights(state): void

Parameters ​

NameType
statebaseStateType

Returns ​

void

Inherited from ​

baseScene.updateLights

Defined in ​

src/Scene/baseScene.ts:157

updateModelChildrenVisualisation ​

▸ updateModelChildrenVisualisation(child): void

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.updateModelChildrenVisualisation

Defined in ​

src/Scene/baseScene.ts:184

- +
Copper3d API

Appearance

copper3d / Modules / Scene/copperSceneOnDemond / copperSceneOnDemond

Class: copperSceneOnDemond ​

Scene/copperSceneOnDemond.copperSceneOnDemond

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new copperSceneOnDemond(container, renderer)

Parameters ​

NameType
containerHTMLDivElement
rendererWebGLRenderer

Overrides ​

baseScene.constructor

Defined in ​

src/Scene/copperSceneOnDemond.ts:12

Properties ​

ambientLight ​

• ambientLight: AmbientLight

Inherited from ​

baseScene.ambientLight

Defined in ​

src/Scene/baseScene.ts:18

camera ​

• camera: PerspectiveCamera | OrthographicCamera

Inherited from ​

baseScene.camera

Defined in ​

src/Scene/commonSceneMethod.ts:29

cameraPositionFlag ​

• cameraPositionFlag: boolean = false

Inherited from ​

baseScene.cameraPositionFlag

Defined in ​

src/Scene/baseScene.ts:20

container ​

• container: HTMLDivElement

Inherited from ​

baseScene.container

Defined in ​

src/Scene/commonSceneMethod.ts:27

content ​

• content: Group

Inherited from ​

baseScene.content

Defined in ​

src/Scene/baseScene.ts:21

controls ​

• controls: OrbitControls

Overrides ​

baseScene.controls

Defined in ​

src/Scene/copperSceneOnDemond.ts:8

copperControl ​

• copperControl: Controls

Inherited from ​

baseScene.copperControl

Defined in ​

src/Scene/baseScene.ts:19

copperOrthographicCamera ​

• copperOrthographicCamera: OrthographicCamera

Inherited from ​

baseScene.copperOrthographicCamera

Defined in ​

src/Scene/commonSceneMethod.ts:32

copperPerspectiveCamera ​

• copperPerspectiveCamera: PerspectiveCamera

Inherited from ​

baseScene.copperPerspectiveCamera

Defined in ​

src/Scene/commonSceneMethod.ts:31

depthStep ​

• Protected depthStep: number = 0.4

Inherited from ​

baseScene.depthStep

Defined in ​

src/Scene/commonSceneMethod.ts:44

directionalLight ​

• directionalLight: DirectionalLight

Inherited from ​

baseScene.directionalLight

Defined in ​

src/Scene/baseScene.ts:17

exportContent ​

• exportContent: Group

Inherited from ​

baseScene.exportContent

Defined in ​

src/Scene/baseScene.ts:22

isHalfed ​

• isHalfed: boolean = false

Inherited from ​

baseScene.isHalfed

Defined in ​

src/Scene/baseScene.ts:23

isResize ​

• isResize: boolean = false

Defined in ​

src/Scene/copperSceneOnDemond.ts:10

pickableObjects ​

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

Inherited from ​

baseScene.pickableObjects

Defined in ​

src/Scene/commonSceneMethod.ts:46

preRenderCallbackFunctions ​

• Protected preRenderCallbackFunctions: preRenderCallbackFunctionType

Inherited from ​

baseScene.preRenderCallbackFunctions

Defined in ​

src/Scene/commonSceneMethod.ts:42

renderNrrdVolume ​

• Protected renderNrrdVolume: boolean = false

Inherited from ​

baseScene.renderNrrdVolume

Defined in ​

src/Scene/commonSceneMethod.ts:40

renderRequested ​

• renderRequested: undefined | boolean = false

Defined in ​

src/Scene/copperSceneOnDemond.ts:9

renderer ​

• renderer: WebGLRenderer

Inherited from ​

baseScene.renderer

Defined in ​

src/Scene/baseScene.ts:12

scene ​

• scene: Scene

Inherited from ​

baseScene.scene

Defined in ​

src/Scene/commonSceneMethod.ts:28

sceneName ​

• sceneName: string = ""

Inherited from ​

baseScene.sceneName

Defined in ​

src/Scene/baseScene.ts:15

sort ​

• Protected sort: boolean = true

Inherited from ​

baseScene.sort

Defined in ​

src/Scene/commonSceneMethod.ts:43

subCamera ​

• subCamera: null | PerspectiveCamera = null

Inherited from ​

baseScene.subCamera

Defined in ​

src/Scene/commonSceneMethod.ts:36

subCopperControl ​

• Protected subCopperControl: null | Controls = null

Inherited from ​

baseScene.subCopperControl

Defined in ​

src/Scene/commonSceneMethod.ts:39

subDiv ​

• subDiv: null | HTMLDivElement = null

Inherited from ​

baseScene.subDiv

Defined in ​

src/Scene/commonSceneMethod.ts:34

subRender ​

• Protected subRender: null | WebGLRenderer = null

Inherited from ​

baseScene.subRender

Defined in ​

src/Scene/commonSceneMethod.ts:38

subScene ​

• subScene: Scene

Inherited from ​

baseScene.subScene

Defined in ​

src/Scene/commonSceneMethod.ts:35

viewPoint ​

• viewPoint: CameraViewPoint

Inherited from ​

baseScene.viewPoint

Defined in ​

src/Scene/baseScene.ts:24

vignette ​

• vignette: undefined | customMeshType

Inherited from ​

baseScene.vignette

Defined in ​

src/Scene/baseScene.ts:16

Methods ​

addLights ​

▸ addLights(): void

Returns ​

void

Inherited from ​

baseScene.addLights

Defined in ​

src/Scene/baseScene.ts:138

addObject ​

▸ addObject(obj): void

Parameters ​

NameType
objany

Returns ​

void

Inherited from ​

baseScene.addObject

Defined in ​

src/Scene/baseScene.ts:134

addPreRenderCallbackFunction ​

▸ addPreRenderCallbackFunction(callbackFunction): number

Parameters ​

NameType
callbackFunctionFunction

Returns ​

number

Inherited from ​

baseScene.addPreRenderCallbackFunction

Defined in ​

src/Scene/commonSceneMethod.ts:122

addSubView ​

▸ addSubView(): HTMLDivElement

create a new sub view to display models

Returns ​

HTMLDivElement

Inherited from ​

baseScene.addSubView

Defined in ​

src/Scene/commonSceneMethod.ts:174

confirmResize ​

▸ confirmResize(): void

Returns ​

void

Defined in ​

src/Scene/copperSceneOnDemond.ts:58

createDemoMesh ​

▸ createDemoMesh(): void

Returns ​

void

Inherited from ​

baseScene.createDemoMesh

Defined in ​

src/Scene/commonSceneMethod.ts:96

getDefaultViewPoint ​

▸ getDefaultViewPoint(): CameraViewPoint

Returns ​

CameraViewPoint

Inherited from ​

baseScene.getDefaultViewPoint

Defined in ​

src/Scene/baseScene.ts:109

init ​

▸ init(): void

Returns ​

void

Inherited from ​

baseScene.init

Defined in ​

src/Scene/baseScene.ts:54

loadDicom ​

▸ loadDicom(urls, opts?): void

Parameters ​

NameType
urlsstring | string[]
opts?dicomLoaderOptsType

Returns ​

void

Inherited from ​

baseScene.loadDicom

Defined in ​

src/Scene/commonSceneMethod.ts:198

loadGltf ​

▸ loadGltf(url, callback?): void

Parameters ​

NameType
urlstring
callback?(content: Group) => void

Returns ​

void

Defined in ​

src/Scene/copperSceneOnDemond.ts:21

loadMetadataUrl ​

▸ loadMetadataUrl(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Inherited from ​

baseScene.loadMetadataUrl

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 ​

baseScene.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 ​

baseScene.loadNrrdTexture3d

Defined in ​

src/Scene/commonSceneMethod.ts:338

loadOBJ ​

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

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.loadOBJ

Defined in ​

src/Scene/commonSceneMethod.ts:350

loadView ​

▸ loadView(viewpointData): void

Parameters ​

NameType
viewpointDataCameraViewPoint

Returns ​

void

Inherited from ​

baseScene.loadView

Defined in ​

src/Scene/baseScene.ts:97

loadViewUrl ​

▸ loadViewUrl(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Inherited from ​

baseScene.loadViewUrl

Defined in ​

src/Scene/baseScene.ts:85

onRenderCameraChange ​

▸ onRenderCameraChange(): void

Returns ​

void

Inherited from ​

baseScene.onRenderCameraChange

Defined in ​

src/Scene/baseScene.ts:193

onWindowResize ​

▸ onWindowResize(): void

Returns ​

void

Inherited from ​

baseScene.onWindowResize

Defined in ​

src/Scene/baseScene.ts:199

pickModel ​

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

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.pickModel

Defined in ​

src/Scene/commonSceneMethod.ts:132

pickSpecifiedModel ​

▸ pickSpecifiedModel(content, mousePosition): Object

Parameters ​

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

Returns ​

Object

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

Inherited from ​

baseScene.pickSpecifiedModel

Defined in ​

src/Scene/commonSceneMethod.ts:154

removeLights ​

▸ removeLights(): void

Returns ​

void

Inherited from ​

baseScene.removeLights

Defined in ​

src/Scene/baseScene.ts:151

removePreRenderCallbackFunction ​

▸ removePreRenderCallbackFunction(id): void

Parameters ​

NameType
idnumber

Returns ​

void

Inherited from ​

baseScene.removePreRenderCallbackFunction

Defined in ​

src/Scene/commonSceneMethod.ts:128

render ​

▸ render(): void

Returns ​

void

Overrides ​

baseScene.render

Defined in ​

src/Scene/copperSceneOnDemond.ts:63

requestRenderIfNotRequested ​

▸ requestRenderIfNotRequested(): void

Returns ​

void

Defined in ​

src/Scene/copperSceneOnDemond.ts:70

setDepth ​

▸ setDepth(value): void

Parameters ​

NameType
valuenumber

Returns ​

void

Inherited from ​

baseScene.setDepth

Defined in ​

src/Scene/commonSceneMethod.ts:111

setDicomFilesOrder ​

▸ setDicomFilesOrder(value): void

Parameters ​

NameType
value"ascending" | "descending"

Returns ​

void

Inherited from ​

baseScene.setDicomFilesOrder

Defined in ​

src/Scene/commonSceneMethod.ts:114

setViewPoint ​

▸ setViewPoint(camera, target?): CameraViewPoint

Parameters ​

NameType
cameraPerspectiveCamera
target?number[]

Returns ​

CameraViewPoint

Inherited from ​

baseScene.setViewPoint

Defined in ​

src/Scene/baseScene.ts:113

updateBackground ​

▸ updateBackground(color1, color2): void

Parameters ​

NameType
color1string
color2string

Returns ​

void

Inherited from ​

baseScene.updateBackground

Defined in ​

src/Scene/baseScene.ts:179

updateControls ​

▸ updateControls(camera): void

Parameters ​

NameType
cameraPerspectiveCamera | OrthographicCamera

Returns ​

void

Inherited from ​

baseScene.updateControls

Defined in ​

src/Scene/commonSceneMethod.ts:329

updateDisplay ​

▸ updateDisplay(state): void

Parameters ​

NameType
statebaseStateType

Returns ​

void

Inherited from ​

baseScene.updateDisplay

Defined in ​

src/Scene/baseScene.ts:174

updateLights ​

▸ updateLights(state): void

Parameters ​

NameType
statebaseStateType

Returns ​

void

Inherited from ​

baseScene.updateLights

Defined in ​

src/Scene/baseScene.ts:157

updateModelChildrenVisualisation ​

▸ updateModelChildrenVisualisation(child): void

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.updateModelChildrenVisualisation

Defined in ​

src/Scene/baseScene.ts:184

+ \ No newline at end of file diff --git a/apidist/classes/Utils_MeshNodeTool.Element.html b/apidist/classes/Utils_MeshNodeTool.Element.html index 10f4085..7f8cf36 100644 --- a/apidist/classes/Utils_MeshNodeTool.Element.html +++ b/apidist/classes/Utils_MeshNodeTool.Element.html @@ -11,13 +11,13 @@ - + -
Copper3d API

Appearance

copper3d / Modules / Utils/MeshNodeTool / Element

Class: Element ​

Utils/MeshNodeTool.Element

Table of contents ​

Constructors ​

Properties ​

Constructors ​

constructor ​

• new Element(id, basis, nodes)

Parameters ​

NameType
idstring
basisstring[]
nodesNode[]

Defined in ​

src/Utils/MeshNodeTool.ts:19

Properties ​

basis ​

• basis: string[]

Defined in ​

src/Utils/MeshNodeTool.ts:17

id ​

• id: string

Defined in ​

src/Utils/MeshNodeTool.ts:16

nodes ​

• nodes: Node[]

Defined in ​

src/Utils/MeshNodeTool.ts:18

- +
Copper3d API

Appearance

copper3d / Modules / Utils/MeshNodeTool / Element

Class: Element ​

Utils/MeshNodeTool.Element

Table of contents ​

Constructors ​

Properties ​

Constructors ​

constructor ​

• new Element(id, basis, nodes)

Parameters ​

NameType
idstring
basisstring[]
nodesNode[]

Defined in ​

src/Utils/MeshNodeTool.ts:19

Properties ​

basis ​

• basis: string[]

Defined in ​

src/Utils/MeshNodeTool.ts:17

id ​

• id: string

Defined in ​

src/Utils/MeshNodeTool.ts:16

nodes ​

• nodes: Node[]

Defined in ​

src/Utils/MeshNodeTool.ts:18

+ \ No newline at end of file diff --git a/apidist/classes/Utils_MeshNodeTool.MeshNodeTool.html b/apidist/classes/Utils_MeshNodeTool.MeshNodeTool.html index 7ac7c8b..0f4bae6 100644 --- a/apidist/classes/Utils_MeshNodeTool.MeshNodeTool.html +++ b/apidist/classes/Utils_MeshNodeTool.MeshNodeTool.html @@ -11,13 +11,13 @@ - + -
Copper3d API

Appearance

copper3d / Modules / Utils/MeshNodeTool / MeshNodeTool

Class: MeshNodeTool ​

Utils/MeshNodeTool.MeshNodeTool

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new MeshNodeTool()

Properties ​

elements ​

• elements: Object = {}

Index signature ​

▪ [key: string]: Element

Defined in ​

src/Utils/MeshNodeTool.ts:28

nodes ​

• nodes: Object = {}

Index signature ​

▪ [key: string]: Node

Defined in ​

src/Utils/MeshNodeTool.ts:27

Methods ​

addElement ​

▸ addElement(id, basis, nodeIds): void

Parameters ​

NameType
idstring
basisstring[]
nodeIdsstring[]

Returns ​

void

Defined in ​

src/Utils/MeshNodeTool.ts:33

addNode ​

▸ addNode(id, p): void

Parameters ​

NameType
idstring
pnumber[]

Returns ​

void

Defined in ​

src/Utils/MeshNodeTool.ts:30

evaluate ​

▸ evaluate(elementId, xi): number[]

Parameters ​

NameType
elementIdstring
xinumber[]

Returns ​

number[]

Defined in ​

src/Utils/MeshNodeTool.ts:56

find ​

▸ find(point, startingNodeId): Object

Parameters ​

NameType
pointVector3
startingNodeIdstring

Returns ​

Object

NameType
elementIdstring
xinumber[]

Defined in ​

src/Utils/MeshNodeTool.ts:61

getNodeMaterialPoints ​

▸ getNodeMaterialPoints(nodeId): { [key: string]: any; elementId: string ; xi: number[] }[]

Parameters ​

NameType
nodeIdstring

Returns ​

{ [key: string]: any; elementId: string ; xi: number[] }[]

Defined in ​

src/Utils/MeshNodeTool.ts:215

loadMesh ​

▸ loadMesh(json): void

Parameters ​

NameType
jsonIMeshNodes

Returns ​

void

Defined in ​

src/Utils/MeshNodeTool.ts:46

▸ search(point, startingNodeId, tol): Object

Parameters ​

NameType
pointVector3
startingNodeIdstring
tolnumber

Returns ​

Object

NameType
elementIdstring
xinumber[]

Defined in ​

src/Utils/MeshNodeTool.ts:118

- +
Copper3d API

Appearance

copper3d / Modules / Utils/MeshNodeTool / MeshNodeTool

Class: MeshNodeTool ​

Utils/MeshNodeTool.MeshNodeTool

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new MeshNodeTool()

Properties ​

elements ​

• elements: Object = {}

Index signature ​

▪ [key: string]: Element

Defined in ​

src/Utils/MeshNodeTool.ts:28

nodes ​

• nodes: Object = {}

Index signature ​

▪ [key: string]: Node

Defined in ​

src/Utils/MeshNodeTool.ts:27

Methods ​

addElement ​

▸ addElement(id, basis, nodeIds): void

Parameters ​

NameType
idstring
basisstring[]
nodeIdsstring[]

Returns ​

void

Defined in ​

src/Utils/MeshNodeTool.ts:33

addNode ​

▸ addNode(id, p): void

Parameters ​

NameType
idstring
pnumber[]

Returns ​

void

Defined in ​

src/Utils/MeshNodeTool.ts:30

evaluate ​

▸ evaluate(elementId, xi): number[]

Parameters ​

NameType
elementIdstring
xinumber[]

Returns ​

number[]

Defined in ​

src/Utils/MeshNodeTool.ts:56

find ​

▸ find(point, startingNodeId): Object

Parameters ​

NameType
pointVector3
startingNodeIdstring

Returns ​

Object

NameType
elementIdstring
xinumber[]

Defined in ​

src/Utils/MeshNodeTool.ts:61

getNodeMaterialPoints ​

▸ getNodeMaterialPoints(nodeId): { [key: string]: any; elementId: string ; xi: number[] }[]

Parameters ​

NameType
nodeIdstring

Returns ​

{ [key: string]: any; elementId: string ; xi: number[] }[]

Defined in ​

src/Utils/MeshNodeTool.ts:215

loadMesh ​

▸ loadMesh(json): void

Parameters ​

NameType
jsonIMeshNodes

Returns ​

void

Defined in ​

src/Utils/MeshNodeTool.ts:46

▸ search(point, startingNodeId, tol): Object

Parameters ​

NameType
pointVector3
startingNodeIdstring
tolnumber

Returns ​

Object

NameType
elementIdstring
xinumber[]

Defined in ​

src/Utils/MeshNodeTool.ts:118

+ \ No newline at end of file diff --git a/apidist/classes/Utils_MeshNodeTool.Node.html b/apidist/classes/Utils_MeshNodeTool.Node.html index 5f6ff21..422f1a2 100644 --- a/apidist/classes/Utils_MeshNodeTool.Node.html +++ b/apidist/classes/Utils_MeshNodeTool.Node.html @@ -11,13 +11,13 @@ - + -
Copper3d API

Appearance

copper3d / Modules / Utils/MeshNodeTool / Node

Class: Node ​

Utils/MeshNodeTool.Node

Table of contents ​

Constructors ​

Properties ​

Constructors ​

constructor ​

• new Node(id, p)

Parameters ​

NameType
idstring
pnumber[]

Defined in ​

src/Utils/MeshNodeTool.ts:9

Properties ​

elements ​

• elements: Element[] = []

Defined in ​

src/Utils/MeshNodeTool.ts:8

id ​

• id: string

Defined in ​

src/Utils/MeshNodeTool.ts:6

p ​

• p: number[]

Defined in ​

src/Utils/MeshNodeTool.ts:7

- +
Copper3d API

Appearance

copper3d / Modules / Utils/MeshNodeTool / Node

Class: Node ​

Utils/MeshNodeTool.Node

Table of contents ​

Constructors ​

Properties ​

Constructors ​

constructor ​

• new Node(id, p)

Parameters ​

NameType
idstring
pnumber[]

Defined in ​

src/Utils/MeshNodeTool.ts:9

Properties ​

elements ​

• elements: Element[] = []

Defined in ​

src/Utils/MeshNodeTool.ts:8

id ​

• id: string

Defined in ​

src/Utils/MeshNodeTool.ts:6

p ​

• p: number[]

Defined in ​

src/Utils/MeshNodeTool.ts:7

+ \ No newline at end of file diff --git a/apidist/classes/Utils_segmentation_CommToolsData.CommToolsData.html b/apidist/classes/Utils_segmentation_CommToolsData.CommToolsData.html index f7e432f..15f9548 100644 --- a/apidist/classes/Utils_segmentation_CommToolsData.CommToolsData.html +++ b/apidist/classes/Utils_segmentation_CommToolsData.CommToolsData.html @@ -11,13 +11,13 @@ - + -
Copper3d API

Appearance

copper3d / Modules / Utils/segmentation/CommToolsData / CommToolsData

Class: CommToolsData ​

Utils/segmentation/CommToolsData.CommToolsData

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new CommToolsData(container, mainAreaContainer)

Parameters ​

NameType
containerHTMLElement
mainAreaContainerHTMLElement

Defined in ​

src/Utils/segmentation/CommToolsData.ts:142

Properties ​

baseCanvasesSize ​

• baseCanvasesSize: number = 1

Defined in ​

src/Utils/segmentation/CommToolsData.ts:14

cursorPage ​

• cursorPage: ICursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:70

gui_states ​

• gui_states: IGUIStates

Defined in ​

src/Utils/segmentation/CommToolsData.ts:91

nrrd_states ​

• nrrd_states: INrrdStates

Defined in ​

src/Utils/segmentation/CommToolsData.ts:15

protectedData ​

• protectedData: IProtected

Defined in ​

src/Utils/segmentation/CommToolsData.ts:141

Methods ​

clearPaint ​

▸ clearPaint(): void

Rewrite this {clearPaint} function under DrawToolCore

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:213

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:229

convertCursorPoint ​

▸ convertCursorPoint(from, to, cursorNumX, cursorNumY, currentSliceIndex): undefined | IConvertObjType

Rewrite this {convertCursorPoint} function under NrrdTools

Parameters ​

NameType
from"z" | "y" | "x"
to"z" | "y" | "x"
cursorNumXnumber
cursorNumYnumber
currentSliceIndexnumber

Returns ​

undefined | IConvertObjType

Defined in ​

src/Utils/segmentation/CommToolsData.ts:285

filterDrawedImage ​

▸ filterDrawedImage(axis, sliceIndex, paintedImages): IPaintImage

Get a painted mask image (IPaintImage) based on current axis and input slice index.

Parameters ​

NameTypeDescription
axis"z" | "y" | "x""x" | "y" | "z"
sliceIndexnumbernumber
paintedImagesIPaintImagesIPaintImages, All painted mask images.

Returns ​

IPaintImage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:329

flipDisplayImageByAxis ​

▸ flipDisplayImageByAxis(): void

Rewrite this {flipDisplayImageByAxis} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:261

generateCanvases ​

▸ Private generateCanvases(): HTMLCanvasElement[]

Returns ​

HTMLCanvasElement[]

Defined in ​

src/Utils/segmentation/CommToolsData.ts:201

redrawDisplayCanvas ​

▸ redrawDisplayCanvas(): void

Rewrite this {redrawDisplayCanvas} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:315

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Rewrite this {resetLayerCanvas} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:299

resetPaintAreaUIPosition ​

▸ resetPaintAreaUIPosition(l?, t?): void

Rewrite this {resetPaintAreaUIPosition} function under NrrdTools

Parameters ​

NameType
l?number
t?number

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:269

resizePaintArea ​

▸ resizePaintArea(factor): void

Rewrite this {resizePaintArea} function under NrrdTools

Parameters ​

NameType
factornumber

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:237

setEmptyCanvasSize ​

▸ setEmptyCanvasSize(axis?): void

Rewrite this {resetPaintAreaUIPosition} function under NrrdTools

Parameters ​

NameType
axis?"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:277

setIsDrawFalse ​

▸ setIsDrawFalse(target): void

Rewrite this {setIsDrawFalse} function under NrrdTools

Parameters ​

NameType
targetnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:245

setSyncsliceNum ​

▸ setSyncsliceNum(): void

Rewrite this {setSyncsliceNum} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:307

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:221

updateOriginAndChangedWH ​

▸ updateOriginAndChangedWH(): void

Rewrite this {updateOriginAndChangedWH} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:253

- +
Copper3d API

Appearance

copper3d / Modules / Utils/segmentation/CommToolsData / CommToolsData

Class: CommToolsData ​

Utils/segmentation/CommToolsData.CommToolsData

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new CommToolsData(container, mainAreaContainer)

Parameters ​

NameType
containerHTMLElement
mainAreaContainerHTMLElement

Defined in ​

src/Utils/segmentation/CommToolsData.ts:142

Properties ​

baseCanvasesSize ​

• baseCanvasesSize: number = 1

Defined in ​

src/Utils/segmentation/CommToolsData.ts:14

cursorPage ​

• cursorPage: ICursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:70

gui_states ​

• gui_states: IGUIStates

Defined in ​

src/Utils/segmentation/CommToolsData.ts:91

nrrd_states ​

• nrrd_states: INrrdStates

Defined in ​

src/Utils/segmentation/CommToolsData.ts:15

protectedData ​

• protectedData: IProtected

Defined in ​

src/Utils/segmentation/CommToolsData.ts:141

Methods ​

clearPaint ​

▸ clearPaint(): void

Rewrite this {clearPaint} function under DrawToolCore

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:213

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:229

convertCursorPoint ​

▸ convertCursorPoint(from, to, cursorNumX, cursorNumY, currentSliceIndex): undefined | IConvertObjType

Rewrite this {convertCursorPoint} function under NrrdTools

Parameters ​

NameType
from"z" | "y" | "x"
to"z" | "y" | "x"
cursorNumXnumber
cursorNumYnumber
currentSliceIndexnumber

Returns ​

undefined | IConvertObjType

Defined in ​

src/Utils/segmentation/CommToolsData.ts:285

filterDrawedImage ​

▸ filterDrawedImage(axis, sliceIndex, paintedImages): IPaintImage

Get a painted mask image (IPaintImage) based on current axis and input slice index.

Parameters ​

NameTypeDescription
axis"z" | "y" | "x""x" | "y" | "z"
sliceIndexnumbernumber
paintedImagesIPaintImagesIPaintImages, All painted mask images.

Returns ​

IPaintImage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:329

flipDisplayImageByAxis ​

▸ flipDisplayImageByAxis(): void

Rewrite this {flipDisplayImageByAxis} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:261

generateCanvases ​

▸ Private generateCanvases(): HTMLCanvasElement[]

Returns ​

HTMLCanvasElement[]

Defined in ​

src/Utils/segmentation/CommToolsData.ts:201

redrawDisplayCanvas ​

▸ redrawDisplayCanvas(): void

Rewrite this {redrawDisplayCanvas} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:315

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Rewrite this {resetLayerCanvas} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:299

resetPaintAreaUIPosition ​

▸ resetPaintAreaUIPosition(l?, t?): void

Rewrite this {resetPaintAreaUIPosition} function under NrrdTools

Parameters ​

NameType
l?number
t?number

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:269

resizePaintArea ​

▸ resizePaintArea(factor): void

Rewrite this {resizePaintArea} function under NrrdTools

Parameters ​

NameType
factornumber

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:237

setEmptyCanvasSize ​

▸ setEmptyCanvasSize(axis?): void

Rewrite this {resetPaintAreaUIPosition} function under NrrdTools

Parameters ​

NameType
axis?"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:277

setIsDrawFalse ​

▸ setIsDrawFalse(target): void

Rewrite this {setIsDrawFalse} function under NrrdTools

Parameters ​

NameType
targetnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:245

setSyncsliceNum ​

▸ setSyncsliceNum(): void

Rewrite this {setSyncsliceNum} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:307

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:221

updateOriginAndChangedWH ​

▸ updateOriginAndChangedWH(): void

Rewrite this {updateOriginAndChangedWH} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:253

+ \ No newline at end of file diff --git a/apidist/classes/Utils_segmentation_DragOperator.DragOperator.html b/apidist/classes/Utils_segmentation_DragOperator.DragOperator.html index b269cb1..b328322 100644 --- a/apidist/classes/Utils_segmentation_DragOperator.DragOperator.html +++ b/apidist/classes/Utils_segmentation_DragOperator.DragOperator.html @@ -11,13 +11,13 @@ - + -
Copper3d API

Appearance

copper3d / Modules / Utils/segmentation/DragOperator / DragOperator

Class: DragOperator ​

Utils/segmentation/DragOperator.DragOperator

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new DragOperator(container, nrrd_sates, gui_states, protectedData, drawingPrameters, setSyncsliceNum, setIsDrawFalse, flipDisplayImageByAxis, setEmptyCanvasSize, filterDrawedImage)

Parameters ​

NameType
containerHTMLElement
nrrd_satesINrrdStates
gui_statesIGUIStates
protectedDataIProtected
drawingPrametersIDrawingEvents
setSyncsliceNum() => void
setIsDrawFalse(target: number) => void
flipDisplayImageByAxis() => void
setEmptyCanvasSize(axis?: "z" | "y" | "x") => void
filterDrawedImage(axis: "z" | "y" | "x", sliceIndex: number, paintedImages: IPaintImages) => IPaintImage

Defined in ​

src/Utils/segmentation/DragOperator.ts:53

Properties ​

container ​

• container: HTMLElement

Defined in ​

src/Utils/segmentation/DragOperator.ts:24

dragEffectCanvases ​

• Private dragEffectCanvases: undefined | IDragEffectCanvases

Defined in ​

src/Utils/segmentation/DragOperator.ts:41

dragPrameters ​

• Private dragPrameters: IDragPrameters

Defined in ​

src/Utils/segmentation/DragOperator.ts:26

drawingPrameters ​

• Private drawingPrameters: IDrawingEvents

Defined in ​

src/Utils/segmentation/DragOperator.ts:35

filterDrawedImage ​

• Private filterDrawedImage: (axis: "z" | "y" | "x", sliceIndex: number, paintedImages: IPaintImages) => IPaintImage

Type declaration ​

▸ (axis, sliceIndex, paintedImages): IPaintImage

Parameters ​
NameType
axis"z" | "y" | "x"
sliceIndexnumber
paintedImagesIPaintImages
Returns ​

IPaintImage

Defined in ​

src/Utils/segmentation/DragOperator.ts:47

flipDisplayImageByAxis ​

• Private flipDisplayImageByAxis: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:45

gui_states ​

• Private gui_states: IGUIStates

Defined in ​

src/Utils/segmentation/DragOperator.ts:39

nrrd_states ​

• Private nrrd_states: INrrdStates

Defined in ​

src/Utils/segmentation/DragOperator.ts:38

protectedData ​

• Private protectedData: IProtected

Defined in ​

src/Utils/segmentation/DragOperator.ts:40

sensitiveArray ​

• Private sensitiveArray: number[] = []

Defined in ​

src/Utils/segmentation/DragOperator.ts:36

setEmptyCanvasSize ​

• Private setEmptyCanvasSize: (axis?: "z" | "y" | "x") => void

Type declaration ​

▸ (axis?): void

Parameters ​
NameType
axis?"z" | "y" | "x"
Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:46

setIsDrawFalse ​

• Private setIsDrawFalse: (target: number) => void

Type declaration ​

▸ (target): void

Parameters ​
NameType
targetnumber
Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:44

setSyncsliceNum ​

• Private setSyncsliceNum: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:43

showDragNumberDiv ​

• Private showDragNumberDiv: HTMLDivElement

Defined in ​

src/Utils/segmentation/DragOperator.ts:37

Methods ​

cleanCanvases ​

▸ Private cleanCanvases(flag): void

Parameters ​

NameType
flagboolean

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:347

configDragMode ​

▸ configDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:388

drag ​

▸ drag(opts?): void

Parameters ​

NameType
opts?IDragOpts

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:104

drawDragSlice ​

▸ Private drawDragSlice(canvas): void

Parameters ​

NameType
canvasany

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:275

drawMaskToLabelCtx ​

▸ Private drawMaskToLabelCtx(paintedImages, ctx): void

Parameters ​

NameType
paintedImagesIPaintImages
ctxCanvasRenderingContext2D

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:322

init ​

▸ Private init(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:85

removeDragMode ​

▸ removeDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:401

setShowDragNumberDiv ​

▸ setShowDragNumberDiv(sliceIndexContainer): void

Parameters ​

NameType
sliceIndexContainerHTMLDivElement

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:100

updateCurrentContrastSlice ​

▸ updateCurrentContrastSlice(): any

Returns ​

any

Defined in ​

src/Utils/segmentation/DragOperator.ts:382

updateIndex ​

▸ updateIndex(move): void

Parameters ​

NameType
movenumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:190

updateMainSlice ​

▸ updateMainSlice(mainPreSlices): void

Parameters ​

NameType
mainPreSlicesany

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:416

updateShowNumDiv ​

▸ updateShowNumDiv(contrastNum): void

Parameters ​

NameType
contrastNumnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:361

- +
Copper3d API

Appearance

copper3d / Modules / Utils/segmentation/DragOperator / DragOperator

Class: DragOperator ​

Utils/segmentation/DragOperator.DragOperator

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new DragOperator(container, nrrd_sates, gui_states, protectedData, drawingPrameters, setSyncsliceNum, setIsDrawFalse, flipDisplayImageByAxis, setEmptyCanvasSize, filterDrawedImage)

Parameters ​

NameType
containerHTMLElement
nrrd_satesINrrdStates
gui_statesIGUIStates
protectedDataIProtected
drawingPrametersIDrawingEvents
setSyncsliceNum() => void
setIsDrawFalse(target: number) => void
flipDisplayImageByAxis() => void
setEmptyCanvasSize(axis?: "z" | "y" | "x") => void
filterDrawedImage(axis: "z" | "y" | "x", sliceIndex: number, paintedImages: IPaintImages) => IPaintImage

Defined in ​

src/Utils/segmentation/DragOperator.ts:53

Properties ​

container ​

• container: HTMLElement

Defined in ​

src/Utils/segmentation/DragOperator.ts:24

dragEffectCanvases ​

• Private dragEffectCanvases: undefined | IDragEffectCanvases

Defined in ​

src/Utils/segmentation/DragOperator.ts:41

dragPrameters ​

• Private dragPrameters: IDragPrameters

Defined in ​

src/Utils/segmentation/DragOperator.ts:26

drawingPrameters ​

• Private drawingPrameters: IDrawingEvents

Defined in ​

src/Utils/segmentation/DragOperator.ts:35

filterDrawedImage ​

• Private filterDrawedImage: (axis: "z" | "y" | "x", sliceIndex: number, paintedImages: IPaintImages) => IPaintImage

Type declaration ​

▸ (axis, sliceIndex, paintedImages): IPaintImage

Parameters ​
NameType
axis"z" | "y" | "x"
sliceIndexnumber
paintedImagesIPaintImages
Returns ​

IPaintImage

Defined in ​

src/Utils/segmentation/DragOperator.ts:47

flipDisplayImageByAxis ​

• Private flipDisplayImageByAxis: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:45

gui_states ​

• Private gui_states: IGUIStates

Defined in ​

src/Utils/segmentation/DragOperator.ts:39

nrrd_states ​

• Private nrrd_states: INrrdStates

Defined in ​

src/Utils/segmentation/DragOperator.ts:38

protectedData ​

• Private protectedData: IProtected

Defined in ​

src/Utils/segmentation/DragOperator.ts:40

sensitiveArray ​

• Private sensitiveArray: number[] = []

Defined in ​

src/Utils/segmentation/DragOperator.ts:36

setEmptyCanvasSize ​

• Private setEmptyCanvasSize: (axis?: "z" | "y" | "x") => void

Type declaration ​

▸ (axis?): void

Parameters ​
NameType
axis?"z" | "y" | "x"
Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:46

setIsDrawFalse ​

• Private setIsDrawFalse: (target: number) => void

Type declaration ​

▸ (target): void

Parameters ​
NameType
targetnumber
Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:44

setSyncsliceNum ​

• Private setSyncsliceNum: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:43

showDragNumberDiv ​

• Private showDragNumberDiv: HTMLDivElement

Defined in ​

src/Utils/segmentation/DragOperator.ts:37

Methods ​

cleanCanvases ​

▸ Private cleanCanvases(flag): void

Parameters ​

NameType
flagboolean

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:352

configDragMode ​

▸ configDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:393

drag ​

▸ drag(opts?): void

Parameters ​

NameType
opts?IDragOpts

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:104

drawDragSlice ​

▸ Private drawDragSlice(canvas): void

Parameters ​

NameType
canvasany

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:280

drawMaskToLabelCtx ​

▸ Private drawMaskToLabelCtx(paintedImages, ctx): void

Parameters ​

NameType
paintedImagesIPaintImages
ctxCanvasRenderingContext2D

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:327

init ​

▸ Private init(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:85

removeDragMode ​

▸ removeDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:406

setShowDragNumberDiv ​

▸ setShowDragNumberDiv(sliceIndexContainer): void

Parameters ​

NameType
sliceIndexContainerHTMLDivElement

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:100

updateCurrentContrastSlice ​

▸ updateCurrentContrastSlice(): any

Returns ​

any

Defined in ​

src/Utils/segmentation/DragOperator.ts:387

updateIndex ​

▸ updateIndex(move): void

Parameters ​

NameType
movenumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:195

updateMainSlice ​

▸ updateMainSlice(mainPreSlices): void

Parameters ​

NameType
mainPreSlicesany

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:421

updateShowNumDiv ​

▸ updateShowNumDiv(contrastNum): void

Parameters ​

NameType
contrastNumnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:366

+ \ No newline at end of file diff --git a/apidist/classes/Utils_segmentation_DrawToolCore.DrawToolCore.html b/apidist/classes/Utils_segmentation_DrawToolCore.DrawToolCore.html index 5588c87..2cd52e6 100644 --- a/apidist/classes/Utils_segmentation_DrawToolCore.DrawToolCore.html +++ b/apidist/classes/Utils_segmentation_DrawToolCore.DrawToolCore.html @@ -11,13 +11,13 @@ - + -
Copper3d API

Appearance

copper3d / Modules / Utils/segmentation/DrawToolCore / DrawToolCore

Class: DrawToolCore ​

Utils/segmentation/DrawToolCore.DrawToolCore

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new DrawToolCore(container)

Parameters ​

NameType
containerHTMLElement

Overrides ​

CommToolsData.constructor

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:48

Properties ​

baseCanvasesSize ​

• baseCanvasesSize: number = 1

Inherited from ​

CommToolsData.baseCanvasesSize

Defined in ​

src/Utils/segmentation/CommToolsData.ts:14

container ​

• container: HTMLElement

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:15

contrastEventPrameters ​

• contrastEventPrameters: IContrastEvents

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:28

cursorPage ​

• cursorPage: ICursorPage

Inherited from ​

CommToolsData.cursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:70

drawingPrameters ​

• drawingPrameters: IDrawingEvents

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:17

eraserUrls ​

• eraserUrls: string[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:41

gui_states ​

• gui_states: IGUIStates

Inherited from ​

CommToolsData.gui_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:91

mainAreaContainer ​

• mainAreaContainer: HTMLDivElement

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:16

nrrd_states ​

• nrrd_states: INrrdStates

Inherited from ​

CommToolsData.nrrd_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:15

pencilUrls ​

• pencilUrls: string[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:42

protectedData ​

• protectedData: IProtected

Inherited from ​

CommToolsData.protectedData

Defined in ​

src/Utils/segmentation/CommToolsData.ts:141

start ​

• start: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:46

undoArray ​

• undoArray: IUndoType[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:43

Methods ​

checkSharedPlaceSlice ​

▸ checkSharedPlaceSlice(width, height, imageData): Uint8ClampedArray

**************************** Utils for store image and itksnap core *************************************

Parameters ​

NameType
widthnumber
heightnumber
imageDataImageData

Returns ​

Uint8ClampedArray

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1682

clearPaint ​

▸ clearPaint(): void

Clear mask on current slice canvas

Returns ​

void

Overrides ​

CommToolsData.clearPaint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1217

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.clearStoreImages

Defined in ​

src/Utils/segmentation/CommToolsData.ts:229

configContrastDragMode ​

▸ configContrastDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1827

configMouseSphereWheel ​

▸ Private configMouseSphereWheel(): (e: WheelEvent) => void

Returns ​

fn

▸ (e): void

Parameters ​
NameType
eWheelEvent
Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:999

configMouseZoomWheel ​

▸ Private configMouseZoomWheel(): (e: WheelEvent) => void

Returns ​

fn

▸ (e): void

Parameters ​
NameType
eWheelEvent
Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:828

convertCursorPoint ​

▸ convertCursorPoint(from, to, cursorNumX, cursorNumY, currentSliceIndex): undefined | { convertCursorNumX: number ; convertCursorNumY: number ; currentIndex: number ; oldIndex: number }

We generate the MRI slice from threejs based on mm, but when we display it is based on pixel size/distance. So, the index munber on each axis (sagittal, axial, coronal) is the slice's depth in mm distance. And the width and height displayed on screen is the slice's width and height in pixel distance.

When we switch into different axis' views, we need to convert current view's the depth to the pixel distance in other views width or height, and convert the current view's width or height from pixel distance to mm distance as other views' depth (slice index) in general.

Then as for the crosshair (Cursor Inspector), we also need to convert the cursor point (x, y, z) to other views' (x, y, z).

Parameters ​

NameTypeDescription
from"z" | "y" | "x""x" | "y" | "z", current view axis, "x: sagittle, y: coronal, z: axial".
to"z" | "y" | "x""x" | "y" | "z", target view axis (where you want jump to), "x: sagittle, y: coronal, z: axial".
cursorNumXnumbernumber, cursor point x on current axis's slice. (pixel distance)
cursorNumYnumbernumber, cursor point y on current axis's slice. (pixel distance)
currentSliceIndexnumbernumber, current axis's slice's index/depth. (mm distance)

Returns ​

undefined | { convertCursorNumX: number ; convertCursorNumY: number ; currentIndex: number ; oldIndex: number }

Overrides ​

CommToolsData.convertCursorPoint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1060

draw ​

▸ draw(opts?): void

Parameters ​

NameType
opts?IDrawOpts

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:127

drawImageOnEmptyImage ​

▸ drawImageOnEmptyImage(canvas): void

Parameters ​

NameType
canvasHTMLCanvasElement

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:903

drawLine ​

▸ Private drawLine(x1, y1, x2, y2): void

***********************************May consider to move outside ******************************************

Parameters ​

NameType
x1number
y1number
x2number
y2number

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:686

drawLinesOnLayer ​

▸ Private drawLinesOnLayer(ctx, x, y): void

Parameters ​

NameType
ctxCanvasRenderingContext2D
xnumber
ynumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:694

drawSphere ​

▸ drawSphere(mouseX, mouseY, radius): void

Parameters ​

NameType
mouseXnumber
mouseYnumber
radiusnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1021

drawSphereCore ​

▸ Private drawSphereCore(ctx, x, y, radius): void

Parameters ​

NameType
ctxCanvasRenderingContext2D
xnumber
ynumber
radiusnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:963

drawSphereOnEachViews ​

▸ Private drawSphereOnEachViews(decay, axis): void

Parameters ​

NameType
decaynumber
axis"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:933

enableCrosshair ​

▸ Private enableCrosshair(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:882

filterDrawedImage ​

▸ filterDrawedImage(axis, sliceIndex, paintedImages): IPaintImage

Get a painted mask image (IPaintImage) based on current axis and input slice index.

Parameters ​

NameTypeDescription
axis"z" | "y" | "x""x" | "y" | "z"
sliceIndexnumbernumber
paintedImagesIPaintImagesIPaintImages, All painted mask images.

Returns ​

IPaintImage

Inherited from ​

CommToolsData.filterDrawedImage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:329

findSliceInSharedPlace ​

▸ findSliceInSharedPlace(): ImageData[]

Returns ​

ImageData[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1722

flipDisplayImageByAxis ​

▸ flipDisplayImageByAxis(): void

Rewrite this {flipDisplayImageByAxis} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.flipDisplayImageByAxis

Defined in ​

src/Utils/segmentation/CommToolsData.ts:261

getCurrentUndo ​

▸ Private getCurrentUndo(): IUndoType[]

************************** Undo clear functions***************************************************

Returns ​

IUndoType[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1208

getRestLabel ​

▸ getRestLabel(): ("label1" | "label2" | "label3")[]

label div controls*************************

Returns ​

("label1" | "label2" | "label3")[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1198

initAllCanvas ​

▸ Private initAllCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:729

initDrawToolCore ​

▸ Private initDrawToolCore(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:57

paintOnCanvas ​

▸ Private paintOnCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:135

paintOnCanvasLayer ​

▸ Private paintOnCanvasLayer(x, y): void

Parameters ​

NameType
xnumber
ynumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:717

redrawDisplayCanvas ​

▸ redrawDisplayCanvas(): void

Rewrite this {redrawDisplayCanvas} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.redrawDisplayCanvas

Defined in ​

src/Utils/segmentation/CommToolsData.ts:315

removeContrastDragMode ​

▸ removeContrastDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1841

replaceArray ​

▸ replaceArray(mainArr, replaceArr): void

Parameters ​

NameType
mainArrnumber[] | Uint8ClampedArray
replaceArrnumber[] | Uint8ClampedArray

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1709

replaceHorizontalRowPixels ​

▸ replaceHorizontalRowPixels(paintImageArray, length, ratio, markedArr, targetWidth, convertIndex): void

Parameters ​

NameTypeDescription
paintImageArrayIPaintImage[]: the target view slice's marked images array
lengthnumber: the target view slice's dimention (total slice index num)
rationumber: the target slice image's width/height ratio of its dimention length
markedArrnumber[][] | Uint8ClampedArray[]: current painted image's horizontal 2d Array
targetWidthnumber: the target image width
convertIndexnumber: Mapping current image's index to target slice image's width/height pixel start point

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1661

replaceVerticalColPixels ​

▸ replaceVerticalColPixels(paintImageArray, length, ratio, markedArr, targetWidth, convertIndex): void

Parameters ​

NameTypeDescription
paintImageArrayIPaintImage[]: the target view slice's marked images array
lengthnumber: the target view slice's dimention (total slice index num)
rationumber: the target slice image's width/height ratio of its dimention length
markedArrnumber[][] | Uint8ClampedArray[]: current painted image's vertical 2d Array
targetWidthnumber: the target image width
convertIndexnumber: Mapping current image's index to target slice image's width/height pixel start point

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1628

repraintCurrentContrastSlice ​

▸ repraintCurrentContrastSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1891

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Rewrite this {resetLayerCanvas} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.resetLayerCanvas

Defined in ​

src/Utils/segmentation/CommToolsData.ts:299

resetPaintAreaUIPosition ​

▸ resetPaintAreaUIPosition(l?, t?): void

Rewrite this {resetPaintAreaUIPosition} function under NrrdTools

Parameters ​

NameType
l?number
t?number

Returns ​

void

Inherited from ​

CommToolsData.resetPaintAreaUIPosition

Defined in ​

src/Utils/segmentation/CommToolsData.ts:269

resizePaintArea ​

▸ resizePaintArea(factor): void

Rewrite this {resizePaintArea} function under NrrdTools

Parameters ​

NameType
factornumber

Returns ​

void

Inherited from ​

CommToolsData.resizePaintArea

Defined in ​

src/Utils/segmentation/CommToolsData.ts:237

setCurrentLayer ​

▸ Private setCurrentLayer(): Object

Returns ​

Object

NameType
canvasHTMLCanvasElement
ctxCanvasRenderingContext2D

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:103

setEmptyCanvasSize ​

▸ setEmptyCanvasSize(axis?): void

Rewrite this {resetPaintAreaUIPosition} function under NrrdTools

Parameters ​

NameType
axis?"z" | "y" | "x"

Returns ​

void

Inherited from ​

CommToolsData.setEmptyCanvasSize

Defined in ​

src/Utils/segmentation/CommToolsData.ts:277

setEraserUrls ​

▸ setEraserUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:90

setIsDrawFalse ​

▸ setIsDrawFalse(target): void

Rewrite this {setIsDrawFalse} function under NrrdTools

Parameters ​

NameType
targetnumber

Returns ​

void

Inherited from ​

CommToolsData.setIsDrawFalse

Defined in ​

src/Utils/segmentation/CommToolsData.ts:245

setPencilIconUrls ​

▸ setPencilIconUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:93

setSphereCanvasSize ​

▸ Private setSphereCanvasSize(axis?): void

Parameters ​

NameType
axis?"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:976

setSyncsliceNum ​

▸ setSyncsliceNum(): void

Rewrite this {setSyncsliceNum} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.setSyncsliceNum

Defined in ​

src/Utils/segmentation/CommToolsData.ts:307

setUpSphereOrigins ​

▸ Private setUpSphereOrigins(mouseX, mouseY): void

Parameters ​

NameType
mouseXnumber
mouseYnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1155

setupConrastEvents ​

▸ setupConrastEvents(callback): void

Set up root container events fns for drag function

Parameters ​

NameType
callback(step: number, towards: "horizental" | "vertical") => void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1774

sliceArrayH ​

▸ sliceArrayH(arr, row, col): Uint8ClampedArray[]

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

Uint8ClampedArray[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1590

sliceArrayV ​

▸ sliceArrayV(arr, row, col): number[][]

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

number[][]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1601

storeAllImages ​

▸ storeAllImages(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1347

storeEachLayerImage ​

▸ storeEachLayerImage(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1548

storeImageToAxis ​

▸ storeImageToAxis(index, paintedImages, imageData, axis?): void

Store images*************************

Parameters ​

NameType
indexnumber
paintedImagesIPaintImages
imageDataImageData
axis?"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1313

storeImageToLabel ​

▸ storeImageToLabel(index, canvas, paintedImages): ImageData

Parameters ​

NameType
indexnumber
canvasHTMLCanvasElement
paintedImagesIPaintImages

Returns ​

ImageData

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1528

storeSphereImages ​

▸ Private storeSphereImages(index, axis): void

Sphere functions*************************

Parameters ​

NameType
indexnumber
axis"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:916

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Overrides ​

CommToolsData.undoLastPainting

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1236

updateOriginAndChangedWH ​

▸ updateOriginAndChangedWH(): void

Rewrite this {updateOriginAndChangedWH} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.updateOriginAndChangedWH

Defined in ​

src/Utils/segmentation/CommToolsData.ts:253

updateSlicesContrast ​

▸ updateSlicesContrast(value, flag): void

Parameters ​

NameType
valuenumber
flagstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1865

useEraser ​

▸ Private useEraser(): (x: number, y: number, radius: number) => void

Returns ​

fn

▸ (x, y, radius): void

Parameters ​
NameType
xnumber
ynumber
radiusnumber
Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:787

- +
Copper3d API

Appearance

copper3d / Modules / Utils/segmentation/DrawToolCore / DrawToolCore

Class: DrawToolCore ​

Utils/segmentation/DrawToolCore.DrawToolCore

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new DrawToolCore(container)

Parameters ​

NameType
containerHTMLElement

Overrides ​

CommToolsData.constructor

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:48

Properties ​

baseCanvasesSize ​

• baseCanvasesSize: number = 1

Inherited from ​

CommToolsData.baseCanvasesSize

Defined in ​

src/Utils/segmentation/CommToolsData.ts:14

container ​

• container: HTMLElement

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:15

contrastEventPrameters ​

• contrastEventPrameters: IContrastEvents

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:28

cursorPage ​

• cursorPage: ICursorPage

Inherited from ​

CommToolsData.cursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:70

drawingPrameters ​

• drawingPrameters: IDrawingEvents

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:17

eraserUrls ​

• eraserUrls: string[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:41

gui_states ​

• gui_states: IGUIStates

Inherited from ​

CommToolsData.gui_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:91

mainAreaContainer ​

• mainAreaContainer: HTMLDivElement

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:16

nrrd_states ​

• nrrd_states: INrrdStates

Inherited from ​

CommToolsData.nrrd_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:15

pencilUrls ​

• pencilUrls: string[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:42

protectedData ​

• protectedData: IProtected

Inherited from ​

CommToolsData.protectedData

Defined in ​

src/Utils/segmentation/CommToolsData.ts:141

start ​

• start: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:46

undoArray ​

• undoArray: IUndoType[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:43

Methods ​

checkSharedPlaceSlice ​

▸ checkSharedPlaceSlice(width, height, imageData): Uint8ClampedArray

**************************** Utils for store image and itksnap core *************************************

Parameters ​

NameType
widthnumber
heightnumber
imageDataImageData

Returns ​

Uint8ClampedArray

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1693

clearPaint ​

▸ clearPaint(): void

Clear mask on current slice canvas

Returns ​

void

Overrides ​

CommToolsData.clearPaint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1228

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.clearStoreImages

Defined in ​

src/Utils/segmentation/CommToolsData.ts:229

configContrastDragMode ​

▸ configContrastDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1838

configMouseSphereWheel ​

▸ Private configMouseSphereWheel(): (e: WheelEvent) => void

Returns ​

fn

▸ (e): void

Parameters ​
NameType
eWheelEvent
Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1010

configMouseZoomWheel ​

▸ Private configMouseZoomWheel(): (e: WheelEvent) => void

Returns ​

fn

▸ (e): void

Parameters ​
NameType
eWheelEvent
Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:839

convertCursorPoint ​

▸ convertCursorPoint(from, to, cursorNumX, cursorNumY, currentSliceIndex): undefined | { convertCursorNumX: number ; convertCursorNumY: number ; currentIndex: number ; oldIndex: number }

We generate the MRI slice from threejs based on mm, but when we display it is based on pixel size/distance. So, the index munber on each axis (sagittal, axial, coronal) is the slice's depth in mm distance. And the width and height displayed on screen is the slice's width and height in pixel distance.

When we switch into different axis' views, we need to convert current view's the depth to the pixel distance in other views width or height, and convert the current view's width or height from pixel distance to mm distance as other views' depth (slice index) in general.

Then as for the crosshair (Cursor Inspector), we also need to convert the cursor point (x, y, z) to other views' (x, y, z).

Parameters ​

NameTypeDescription
from"z" | "y" | "x""x" | "y" | "z", current view axis, "x: sagittle, y: coronal, z: axial".
to"z" | "y" | "x""x" | "y" | "z", target view axis (where you want jump to), "x: sagittle, y: coronal, z: axial".
cursorNumXnumbernumber, cursor point x on current axis's slice. (pixel distance)
cursorNumYnumbernumber, cursor point y on current axis's slice. (pixel distance)
currentSliceIndexnumbernumber, current axis's slice's index/depth. (mm distance)

Returns ​

undefined | { convertCursorNumX: number ; convertCursorNumY: number ; currentIndex: number ; oldIndex: number }

Overrides ​

CommToolsData.convertCursorPoint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1071

draw ​

▸ draw(opts?): void

Parameters ​

NameType
opts?IDrawOpts

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:142

drawImageOnEmptyImage ​

▸ drawImageOnEmptyImage(canvas): void

Parameters ​

NameType
canvasHTMLCanvasElement

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:914

drawLine ​

▸ Private drawLine(x1, y1, x2, y2): void

***********************************May consider to move outside ******************************************

Parameters ​

NameType
x1number
y1number
x2number
y2number

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:697

drawLinesOnLayer ​

▸ Private drawLinesOnLayer(ctx, x, y): void

Parameters ​

NameType
ctxCanvasRenderingContext2D
xnumber
ynumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:705

drawSphere ​

▸ drawSphere(mouseX, mouseY, radius): void

Parameters ​

NameType
mouseXnumber
mouseYnumber
radiusnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1032

drawSphereCore ​

▸ Private drawSphereCore(ctx, x, y, radius): void

Parameters ​

NameType
ctxCanvasRenderingContext2D
xnumber
ynumber
radiusnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:974

drawSphereOnEachViews ​

▸ Private drawSphereOnEachViews(decay, axis): void

Parameters ​

NameType
decaynumber
axis"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:944

enableCrosshair ​

▸ Private enableCrosshair(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:893

filterDrawedImage ​

▸ filterDrawedImage(axis, sliceIndex, paintedImages): IPaintImage

Get a painted mask image (IPaintImage) based on current axis and input slice index.

Parameters ​

NameTypeDescription
axis"z" | "y" | "x""x" | "y" | "z"
sliceIndexnumbernumber
paintedImagesIPaintImagesIPaintImages, All painted mask images.

Returns ​

IPaintImage

Inherited from ​

CommToolsData.filterDrawedImage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:329

findSliceInSharedPlace ​

▸ findSliceInSharedPlace(): ImageData[]

Returns ​

ImageData[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1733

flipDisplayImageByAxis ​

▸ flipDisplayImageByAxis(): void

Rewrite this {flipDisplayImageByAxis} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.flipDisplayImageByAxis

Defined in ​

src/Utils/segmentation/CommToolsData.ts:261

getCurrentUndo ​

▸ Private getCurrentUndo(): IUndoType[]

************************** Undo clear functions***************************************************

Returns ​

IUndoType[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1219

getRestLabel ​

▸ getRestLabel(): ("label1" | "label2" | "label3")[]

label div controls*************************

Returns ​

("label1" | "label2" | "label3")[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1209

initAllCanvas ​

▸ Private initAllCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:740

initDrawToolCore ​

▸ Private initDrawToolCore(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:57

paintOnCanvas ​

▸ Private paintOnCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:150

paintOnCanvasLayer ​

▸ Private paintOnCanvasLayer(x, y): void

Parameters ​

NameType
xnumber
ynumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:728

redrawDisplayCanvas ​

▸ redrawDisplayCanvas(): void

Rewrite this {redrawDisplayCanvas} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.redrawDisplayCanvas

Defined in ​

src/Utils/segmentation/CommToolsData.ts:315

removeContrastDragMode ​

▸ removeContrastDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1852

replaceArray ​

▸ replaceArray(mainArr, replaceArr): void

Parameters ​

NameType
mainArrnumber[] | Uint8ClampedArray
replaceArrnumber[] | Uint8ClampedArray

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1720

replaceHorizontalRowPixels ​

▸ replaceHorizontalRowPixels(paintImageArray, length, ratio, markedArr, targetWidth, convertIndex): void

Parameters ​

NameTypeDescription
paintImageArrayIPaintImage[]: the target view slice's marked images array
lengthnumber: the target view slice's dimention (total slice index num)
rationumber: the target slice image's width/height ratio of its dimention length
markedArrnumber[][] | Uint8ClampedArray[]: current painted image's horizontal 2d Array
targetWidthnumber: the target image width
convertIndexnumber: Mapping current image's index to target slice image's width/height pixel start point

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1672

replaceVerticalColPixels ​

▸ replaceVerticalColPixels(paintImageArray, length, ratio, markedArr, targetWidth, convertIndex): void

Parameters ​

NameTypeDescription
paintImageArrayIPaintImage[]: the target view slice's marked images array
lengthnumber: the target view slice's dimention (total slice index num)
rationumber: the target slice image's width/height ratio of its dimention length
markedArrnumber[][] | Uint8ClampedArray[]: current painted image's vertical 2d Array
targetWidthnumber: the target image width
convertIndexnumber: Mapping current image's index to target slice image's width/height pixel start point

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1639

repraintCurrentContrastSlice ​

▸ repraintCurrentContrastSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1902

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Rewrite this {resetLayerCanvas} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.resetLayerCanvas

Defined in ​

src/Utils/segmentation/CommToolsData.ts:299

resetPaintAreaUIPosition ​

▸ resetPaintAreaUIPosition(l?, t?): void

Rewrite this {resetPaintAreaUIPosition} function under NrrdTools

Parameters ​

NameType
l?number
t?number

Returns ​

void

Inherited from ​

CommToolsData.resetPaintAreaUIPosition

Defined in ​

src/Utils/segmentation/CommToolsData.ts:269

resizePaintArea ​

▸ resizePaintArea(factor): void

Rewrite this {resizePaintArea} function under NrrdTools

Parameters ​

NameType
factornumber

Returns ​

void

Inherited from ​

CommToolsData.resizePaintArea

Defined in ​

src/Utils/segmentation/CommToolsData.ts:237

setCurrentLayer ​

▸ Private setCurrentLayer(): Object

Returns ​

Object

NameType
canvasHTMLCanvasElement
ctxCanvasRenderingContext2D

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:118

setEmptyCanvasSize ​

▸ setEmptyCanvasSize(axis?): void

Rewrite this {resetPaintAreaUIPosition} function under NrrdTools

Parameters ​

NameType
axis?"z" | "y" | "x"

Returns ​

void

Inherited from ​

CommToolsData.setEmptyCanvasSize

Defined in ​

src/Utils/segmentation/CommToolsData.ts:277

setEraserUrls ​

▸ setEraserUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:105

setIsDrawFalse ​

▸ setIsDrawFalse(target): void

Rewrite this {setIsDrawFalse} function under NrrdTools

Parameters ​

NameType
targetnumber

Returns ​

void

Inherited from ​

CommToolsData.setIsDrawFalse

Defined in ​

src/Utils/segmentation/CommToolsData.ts:245

setPencilIconUrls ​

▸ setPencilIconUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:108

setSphereCanvasSize ​

▸ Private setSphereCanvasSize(axis?): void

Parameters ​

NameType
axis?"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:987

setSyncsliceNum ​

▸ setSyncsliceNum(): void

Rewrite this {setSyncsliceNum} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.setSyncsliceNum

Defined in ​

src/Utils/segmentation/CommToolsData.ts:307

setUpSphereOrigins ​

▸ Private setUpSphereOrigins(mouseX, mouseY): void

Parameters ​

NameType
mouseXnumber
mouseYnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1166

setupConrastEvents ​

▸ setupConrastEvents(callback): void

Set up root container events fns for drag function

Parameters ​

NameType
callback(step: number, towards: "horizental" | "vertical") => void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1785

sliceArrayH ​

▸ sliceArrayH(arr, row, col): Uint8ClampedArray[]

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

Uint8ClampedArray[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1601

sliceArrayV ​

▸ sliceArrayV(arr, row, col): number[][]

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

number[][]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1612

storeAllImages ​

▸ storeAllImages(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1358

storeEachLayerImage ​

▸ storeEachLayerImage(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1559

storeImageToAxis ​

▸ storeImageToAxis(index, paintedImages, imageData, axis?): void

Store images*************************

Parameters ​

NameType
indexnumber
paintedImagesIPaintImages
imageDataImageData
axis?"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1324

storeImageToLabel ​

▸ storeImageToLabel(index, canvas, paintedImages): ImageData

Parameters ​

NameType
indexnumber
canvasHTMLCanvasElement
paintedImagesIPaintImages

Returns ​

ImageData

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1539

storeSphereImages ​

▸ Private storeSphereImages(index, axis): void

Sphere functions*************************

Parameters ​

NameType
indexnumber
axis"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:927

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Overrides ​

CommToolsData.undoLastPainting

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1247

updateOriginAndChangedWH ​

▸ updateOriginAndChangedWH(): void

Rewrite this {updateOriginAndChangedWH} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.updateOriginAndChangedWH

Defined in ​

src/Utils/segmentation/CommToolsData.ts:253

updateSlicesContrast ​

▸ updateSlicesContrast(value, flag): void

Parameters ​

NameType
valuenumber
flagstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1876

useEraser ​

▸ Private useEraser(): (x: number, y: number, radius: number) => void

Returns ​

fn

▸ (x, y, radius): void

Parameters ​
NameType
xnumber
ynumber
radiusnumber
Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:798

+ \ No newline at end of file diff --git a/apidist/classes/Utils_segmentation_NrrdTools.NrrdTools.html b/apidist/classes/Utils_segmentation_NrrdTools.NrrdTools.html index 2708b3c..1e8dfa9 100644 --- a/apidist/classes/Utils_segmentation_NrrdTools.NrrdTools.html +++ b/apidist/classes/Utils_segmentation_NrrdTools.NrrdTools.html @@ -11,13 +11,13 @@ - + -
Copper3d API

Appearance

copper3d / Modules / Utils/segmentation/NrrdTools / NrrdTools

Class: NrrdTools ​

Utils/segmentation/NrrdTools.NrrdTools

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new NrrdTools(container)

Parameters ​

NameType
containerHTMLDivElement

Overrides ​

DrawToolCore.constructor

Defined in ​

src/Utils/segmentation/NrrdTools.ts:36

Properties ​

baseCanvasesSize ​

• baseCanvasesSize: number = 1

Inherited from ​

DrawToolCore.baseCanvasesSize

Defined in ​

src/Utils/segmentation/CommToolsData.ts:14

container ​

• container: HTMLDivElement

Overrides ​

DrawToolCore.container

Defined in ​

src/Utils/segmentation/NrrdTools.ts:24

contrastEventPrameters ​

• contrastEventPrameters: IContrastEvents

Inherited from ​

DrawToolCore.contrastEventPrameters

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:28

cursorPage ​

• cursorPage: ICursorPage

Inherited from ​

DrawToolCore.cursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:70

dragOperator ​

• dragOperator: DragOperator

Defined in ​

src/Utils/segmentation/NrrdTools.ts:27

drawingPrameters ​

• drawingPrameters: IDrawingEvents

Inherited from ​

DrawToolCore.drawingPrameters

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:17

eraserUrls ​

• eraserUrls: string[] = []

Inherited from ​

DrawToolCore.eraserUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:41

guiParameterSettings ​

• Private guiParameterSettings: undefined | IGuiParameterSettings

Defined in ​

src/Utils/segmentation/NrrdTools.ts:34

gui_states ​

• gui_states: IGUIStates

Inherited from ​

DrawToolCore.gui_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:91

initState ​

• Private initState: boolean = true

Defined in ​

src/Utils/segmentation/NrrdTools.ts:32

mainAreaContainer ​

• mainAreaContainer: HTMLDivElement

Inherited from ​

DrawToolCore.mainAreaContainer

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:16

nrrd_states ​

• nrrd_states: INrrdStates

Inherited from ​

DrawToolCore.nrrd_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:15

paintedImage ​

• Private paintedImage: undefined | IPaintImage

Defined in ​

src/Utils/segmentation/NrrdTools.ts:30

pencilUrls ​

• pencilUrls: string[] = []

Inherited from ​

DrawToolCore.pencilUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:42

preTimer ​

• Private preTimer: any

Defined in ​

src/Utils/segmentation/NrrdTools.ts:33

protectedData ​

• protectedData: IProtected

Inherited from ​

DrawToolCore.protectedData

Defined in ​

src/Utils/segmentation/CommToolsData.ts:141

start ​

• start: () => void

Type declaration ​

▸ (): void

Returns ​

void

Inherited from ​

DrawToolCore.start

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:46

storedPaintImages ​

• storedPaintImages: undefined | IStoredPaintImages

Defined in ​

src/Utils/segmentation/NrrdTools.ts:28

undoArray ​

• undoArray: IUndoType[] = []

Inherited from ​

DrawToolCore.undoArray

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:43

Methods ​

addSkip ​

▸ addSkip(index): void

Parameters ​

NameType
indexnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:590

afterLoadSlice ​

▸ Private afterLoadSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:820

appendLoadingbar ​

▸ appendLoadingbar(loadingbar): void

Parameters ​

NameType
loadingbarHTMLDivElement

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:876

checkSharedPlaceSlice ​

▸ checkSharedPlaceSlice(width, height, imageData): Uint8ClampedArray

**************************** Utils for store image and itksnap core *************************************

Parameters ​

NameType
widthnumber
heightnumber
imageDataImageData

Returns ​

Uint8ClampedArray

Inherited from ​

DrawToolCore.checkSharedPlaceSlice

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1682

clear ​

▸ clear(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:608

clearDictionary ​

▸ Private clearDictionary(dic): void

Parameters ​

NameType
dicISkipSlicesDictType

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1109

clearPaint ​

▸ clearPaint(): void

Clear mask on current slice canvas

Returns ​

void

Inherited from ​

DrawToolCore.clearPaint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1217

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Overrides ​

DrawToolCore.clearStoreImages

Defined in ​

src/Utils/segmentation/NrrdTools.ts:880

configContrastDragMode ​

▸ configContrastDragMode(): void

Returns ​

void

Inherited from ​

DrawToolCore.configContrastDragMode

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1827

convertCursorPoint ​

▸ convertCursorPoint(from, to, cursorNumX, cursorNumY, currentSliceIndex): undefined | { convertCursorNumX: number ; convertCursorNumY: number ; currentIndex: number ; oldIndex: number }

We generate the MRI slice from threejs based on mm, but when we display it is based on pixel size/distance. So, the index munber on each axis (sagittal, axial, coronal) is the slice's depth in mm distance. And the width and height displayed on screen is the slice's width and height in pixel distance.

When we switch into different axis' views, we need to convert current view's the depth to the pixel distance in other views width or height, and convert the current view's width or height from pixel distance to mm distance as other views' depth (slice index) in general.

Then as for the crosshair (Cursor Inspector), we also need to convert the cursor point (x, y, z) to other views' (x, y, z).

Parameters ​

NameTypeDescription
from"z" | "y" | "x""x" | "y" | "z", current view axis, "x: sagittle, y: coronal, z: axial".
to"z" | "y" | "x""x" | "y" | "z", target view axis (where you want jump to), "x: sagittle, y: coronal, z: axial".
cursorNumXnumbernumber, cursor point x on current axis's slice. (pixel distance)
cursorNumYnumbernumber, cursor point y on current axis's slice. (pixel distance)
currentSliceIndexnumbernumber, current axis's slice's index/depth. (mm distance)

Returns ​

undefined | { convertCursorNumX: number ; convertCursorNumY: number ; currentIndex: number ; oldIndex: number }

Inherited from ​

DrawToolCore.convertCursorPoint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1060

createEmptyPaintImage ​

▸ Private createEmptyPaintImage(dimensions, paintImages): void

Parameters ​

NameType
dimensionsnumber[]
paintImagesIPaintImages

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:391

drag ​

▸ drag(opts?): void

core function for drag slices

Parameters ​

NameType
opts?IDragOpts

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:67

draw ​

▸ draw(opts?): void

Parameters ​

NameType
opts?IDrawOpts

Returns ​

void

Inherited from ​

DrawToolCore.draw

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:127

drawImageOnEmptyImage ​

▸ drawImageOnEmptyImage(canvas): void

Parameters ​

NameType
canvasHTMLCanvasElement

Returns ​

void

Inherited from ​

DrawToolCore.drawImageOnEmptyImage

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:903

drawSphere ​

▸ drawSphere(mouseX, mouseY, radius): void

Parameters ​

NameType
mouseXnumber
mouseYnumber
radiusnumber

Returns ​

void

Inherited from ​

DrawToolCore.drawSphere

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1021

enableContrastDragEvents ​

▸ enableContrastDragEvents(callback): void

Enable the drag function for contrast images window center and window high.

Parameters ​

NameType
callback(step: number, towards: "horizental" | "vertical") => void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:101

filterDrawedImage ​

▸ filterDrawedImage(axis, sliceIndex, paintedImages): IPaintImage

Get a painted mask image (IPaintImage) based on current axis and input slice index.

Parameters ​

NameTypeDescription
axis"z" | "y" | "x""x" | "y" | "z"
sliceIndexnumbernumber
paintedImagesIPaintImagesIPaintImages, All painted mask images.

Returns ​

IPaintImage

Inherited from ​

DrawToolCore.filterDrawedImage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:329

findSliceInSharedPlace ​

▸ findSliceInSharedPlace(): ImageData[]

Returns ​

ImageData[]

Inherited from ​

DrawToolCore.findSliceInSharedPlace

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1722

flipDisplayImageByAxis ​

▸ flipDisplayImageByAxis(): void

flip the canvas to a correct position. This is because the slice canvas from threejs is not in a correct 2D postion. Thus, everytime when we redraw the display canvas, we need to flip to draw the origin canvas from threejs. Under different axis(sagittal, Axial, Coronal), the flip orientation is different.

Returns ​

void

Overrides ​

DrawToolCore.flipDisplayImageByAxis

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1092

getContainer ​

▸ getContainer(): HTMLElement

Returns ​

HTMLElement

Defined in ​

src/Utils/segmentation/NrrdTools.ts:672

getCurrentImageDimension ​

▸ getCurrentImageDimension(): number[]

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:333

getCurrentSliceIndex ​

▸ getCurrentSliceIndex(): number

Returns ​

number

Defined in ​

src/Utils/segmentation/NrrdTools.ts:699

getCurrentSlicesNumAndContrastNum ​

▸ getCurrentSlicesNumAndContrastNum(): Object

Returns ​

Object

NameType
contrastIndexnumber
currentIndexnumber

Defined in ​

src/Utils/segmentation/NrrdTools.ts:692

getDrawingCanvas ​

▸ getDrawingCanvas(): HTMLCanvasElement

Returns ​

HTMLCanvasElement

Defined in ​

src/Utils/segmentation/NrrdTools.ts:675

getGuiSettings ​

▸ getGuiSettings(): Object

Returns ​

Object

NameType
guiSettingundefined | IGuiParameterSettings
guiStateIGUIStates

Defined in ​

src/Utils/segmentation/NrrdTools.ts:159

getIsShowContrastState ​

▸ getIsShowContrastState(): boolean

Returns ​

boolean

Defined in ​

src/Utils/segmentation/NrrdTools.ts:705

getMaskData ​

▸ getMaskData(): IMaskData

Returns ​

IMaskData

Defined in ​

src/Utils/segmentation/NrrdTools.ts:343

getMaxSliceNum ​

▸ getMaxSliceNum(): number[]

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:682

getNrrdToolsSettings ​

▸ getNrrdToolsSettings(): INrrdStates

Returns ​

INrrdStates

Defined in ​

src/Utils/segmentation/NrrdTools.ts:678

getRestLabel ​

▸ getRestLabel(): ("label1" | "label2" | "label3")[]

label div controls*************************

Returns ​

("label1" | "label2" | "label3")[]

Inherited from ​

DrawToolCore.getRestLabel

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1198

getSharedPlace ​

▸ Private getSharedPlace(len, ratio): number[]

Parameters ​

NameType
lennumber
rationumber

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:347

getSpaceOrigin ​

▸ getSpaceOrigin(): number[]

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:340

getVoxelSpacing ​

▸ getVoxelSpacing(): number[]

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:337

init ​

▸ Private init(): void

A initialise function for nrrd_tools

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:176

initPaintImages ​

▸ Private initPaintImages(dimensions): void

init all painted images for store images

Parameters ​

NameType
dimensionsnumber[]

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:372

loadDisplaySlicesArray ​

▸ Private loadDisplaySlicesArray(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:738

loadingMaskByLabel ​

▸ Private loadingMaskByLabel(masks, index, imageData): ImageData

Parameters ​

NameType
masksexportPaintImageType[]
indexnumber
imageDataImageData

Returns ​

ImageData

Defined in ​

src/Utils/segmentation/NrrdTools.ts:248

redrawDisplayCanvas ​

▸ redrawDisplayCanvas(): void

Redraw current contrast image to display canvas. It is more related to change the contrast slice image's window width or center.

Returns ​

void

Overrides ​

DrawToolCore.redrawDisplayCanvas

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1149

redrawMianPreOnDisplayCanvas ​

▸ redrawMianPreOnDisplayCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:933

reloadMaskToLabel ​

▸ Private reloadMaskToLabel(paintImages, ctx): void

Used to init the mask on each label and reload

Parameters ​

NameType
paintImagesIPaintImages
ctxCanvasRenderingContext2D

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1031

removeContrastDragMode ​

▸ removeContrastDragMode(): void

Returns ​

void

Inherited from ​

DrawToolCore.removeContrastDragMode

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1841

removeSkip ​

▸ removeSkip(index): void

Parameters ​

NameType
indexnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:602

replaceArray ​

▸ replaceArray(mainArr, replaceArr): void

Parameters ​

NameType
mainArrnumber[] | Uint8ClampedArray
replaceArrnumber[] | Uint8ClampedArray

Returns ​

void

Inherited from ​

DrawToolCore.replaceArray

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1709

replaceHorizontalRowPixels ​

▸ replaceHorizontalRowPixels(paintImageArray, length, ratio, markedArr, targetWidth, convertIndex): void

Parameters ​

NameTypeDescription
paintImageArrayIPaintImage[]: the target view slice's marked images array
lengthnumber: the target view slice's dimention (total slice index num)
rationumber: the target slice image's width/height ratio of its dimention length
markedArrnumber[][] | Uint8ClampedArray[]: current painted image's horizontal 2d Array
targetWidthnumber: the target image width
convertIndexnumber: Mapping current image's index to target slice image's width/height pixel start point

Returns ​

void

Inherited from ​

DrawToolCore.replaceHorizontalRowPixels

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1661

replaceVerticalColPixels ​

▸ replaceVerticalColPixels(paintImageArray, length, ratio, markedArr, targetWidth, convertIndex): void

Parameters ​

NameTypeDescription
paintImageArrayIPaintImage[]: the target view slice's marked images array
lengthnumber: the target view slice's dimention (total slice index num)
rationumber: the target slice image's width/height ratio of its dimention length
markedArrnumber[][] | Uint8ClampedArray[]: current painted image's vertical 2d Array
targetWidthnumber: the target image width
convertIndexnumber: Mapping current image's index to target slice image's width/height pixel start point

Returns ​

void

Inherited from ​

DrawToolCore.replaceVerticalColPixels

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1628

repraintCurrentContrastSlice ​

▸ repraintCurrentContrastSlice(): void

Returns ​

void

Inherited from ​

DrawToolCore.repraintCurrentContrastSlice

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1891

resetDisplaySlicesStatus ​

▸ Private resetDisplaySlicesStatus(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:765

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Clear masks on drawingCanvas layers.

Returns ​

void

Overrides ​

DrawToolCore.resetLayerCanvas

Defined in ​

src/Utils/segmentation/NrrdTools.ts:922

resetPaintAreaUIPosition ​

▸ resetPaintAreaUIPosition(l?, t?): void

Reset the draw and display canvases layout after mouse pan. If no params in, then center the draw and display canvases.

Parameters ​

NameTypeDescription
l?numbernumber, Offset to the left
t?numbernumber, Offset to the top

Returns ​

void

Overrides ​

DrawToolCore.resetPaintAreaUIPosition

Defined in ​

src/Utils/segmentation/NrrdTools.ts:902

resizePaintArea ​

▸ resizePaintArea(factor): void

Resize the draw and display canvas size based on the input size factor number.

Parameters ​

NameTypeDescription
factornumbernumber

Returns ​

void

Overrides ​

DrawToolCore.resizePaintArea

Defined in ​

src/Utils/segmentation/NrrdTools.ts:961

setAllSlices ​

▸ setAllSlices(allSlices): void

entry function

  • { x:slice, y:slice, z:slice }

Parameters ​

NameTypeDescription
allSlicesnrrdSliceType[]all nrrd contrast slices

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:198

setBaseDrawDisplayCanvasesSize ​

▸ setBaseDrawDisplayCanvasesSize(size): void

Set the Draw Display Canvas base size

Parameters ​

NameTypeDescription
sizenumbernumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:83

setDisplaySliceIndexPanel ​

▸ setDisplaySliceIndexPanel(panel): void

Parameters ​

NameType
panelHTMLDivElement

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:93

setDisplaySlicesBaseOnAxis ​

▸ Private setDisplaySlicesBaseOnAxis(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:725

setEmptyCanvasSize ​

▸ setEmptyCanvasSize(axis?): void

Set the empty canvas width and height based on the axis (pixel distance not the mm), to reduce duplicate codes.

Parameters ​

NameType
axis?"z" | "y" | "x"

Returns ​

void

Overrides ​

DrawToolCore.setEmptyCanvasSize

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1120

setEraserUrls ​

▸ setEraserUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Inherited from ​

DrawToolCore.setEraserUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:90

setIsDrawFalse ​

▸ setIsDrawFalse(target): void

Give a delay time to finish the last drawing before upcoming interrupt opreations. Give a delay time number (ms) to disable the draw function, After your interrupt opeartion, you should enable the draw fucntion.

Parameters ​

NameTypeDescription
targetnumbernumber

Returns ​

void

Overrides ​

DrawToolCore.setIsDrawFalse

Defined in ​

src/Utils/segmentation/NrrdTools.ts:715

setMainAreaSize ​

▸ setMainAreaSize(factor): void

Parameters ​

NameType
factornumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:659

setMainPreSlice ​

▸ Private setMainPreSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:789

setMasksData ​

▸ setMasksData(masksData, loadingBar?): void

Parameters ​

NameType
masksDatastoreExportPaintImageType
loadingBar?loadingBarType

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:265

setOriginCanvasAndPre ​

▸ Private setOriginCanvasAndPre(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:796

setPencilIconUrls ​

▸ setPencilIconUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Inherited from ​

DrawToolCore.setPencilIconUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:93

setShowInMainArea ​

▸ Private setShowInMainArea(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:329

setSliceMoving ​

▸ setSliceMoving(step): void

Parameters ​

NameType
stepnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:650

setSliceOrientation ​

▸ setSliceOrientation(axisTo): void

Switch all contrast slices' orientation

Parameters ​

NameType
axisTo"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:436

setSyncsliceNum ​

▸ setSyncsliceNum(): void

Keep all contrast slice index to same. Synchronize the slice indexes of all the contrasts so that they are consistent with the main slice's index.

Returns ​

void

Overrides ​

DrawToolCore.setSyncsliceNum

Defined in ​

src/Utils/segmentation/NrrdTools.ts:868

setupConfigs ​

▸ Private setupConfigs(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:772

setupConrastEvents ​

▸ setupConrastEvents(callback): void

Set up root container events fns for drag function

Parameters ​

NameType
callback(step: number, towards: "horizental" | "vertical") => void

Returns ​

void

Inherited from ​

DrawToolCore.setupConrastEvents

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1774

setupGUI ​

▸ setupGUI(gui): void

Set up GUI for drawing panel

Parameters ​

NameTypeDescription
guiGUIGUI

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:109

sliceArrayH ​

▸ sliceArrayH(arr, row, col): Uint8ClampedArray[]

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

Uint8ClampedArray[]

Inherited from ​

DrawToolCore.sliceArrayH

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1590

sliceArrayV ​

▸ sliceArrayV(arr, row, col): number[][]

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

number[][]

Inherited from ​

DrawToolCore.sliceArrayV

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1601

storeAllImages ​

▸ storeAllImages(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Inherited from ​

DrawToolCore.storeAllImages

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1347

storeEachLayerImage ​

▸ storeEachLayerImage(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Inherited from ​

DrawToolCore.storeEachLayerImage

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1548

storeImageToAxis ​

▸ storeImageToAxis(index, paintedImages, imageData, axis?): void

Store images*************************

Parameters ​

NameType
indexnumber
paintedImagesIPaintImages
imageDataImageData
axis?"z" | "y" | "x"

Returns ​

void

Inherited from ​

DrawToolCore.storeImageToAxis

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1313

storeImageToLabel ​

▸ storeImageToLabel(index, canvas, paintedImages): ImageData

Parameters ​

NameType
indexnumber
canvasHTMLCanvasElement
paintedImagesIPaintImages

Returns ​

ImageData

Inherited from ​

DrawToolCore.storeImageToLabel

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1528

switchAllSlicesArrayData ​

▸ switchAllSlicesArrayData(allSlices): void

Parameters ​

NameType
allSlicesnrrdSliceType[]

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:759

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Inherited from ​

DrawToolCore.undoLastPainting

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1236

updateMaxIndex ​

▸ Private updateMaxIndex(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:840

updateOriginAndChangedWH ​

▸ updateOriginAndChangedWH(): void

Update the original canvas size, allow set to threejs load one (pixel distance not the mm). Then update the changedWidth and changedHeight based on the sizeFoctor.

Returns ​

void

Overrides ​

DrawToolCore.updateOriginAndChangedWH

Defined in ​

src/Utils/segmentation/NrrdTools.ts:850

updateSlicesContrast ​

▸ updateSlicesContrast(value, flag): void

Parameters ​

NameType
valuenumber
flagstring

Returns ​

void

Inherited from ​

DrawToolCore.updateSlicesContrast

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1865

- +
Copper3d API

Appearance

copper3d / Modules / Utils/segmentation/NrrdTools / NrrdTools

Class: NrrdTools ​

Utils/segmentation/NrrdTools.NrrdTools

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new NrrdTools(container)

Parameters ​

NameType
containerHTMLDivElement

Overrides ​

DrawToolCore.constructor

Defined in ​

src/Utils/segmentation/NrrdTools.ts:36

Properties ​

baseCanvasesSize ​

• baseCanvasesSize: number = 1

Inherited from ​

DrawToolCore.baseCanvasesSize

Defined in ​

src/Utils/segmentation/CommToolsData.ts:14

container ​

• container: HTMLDivElement

Overrides ​

DrawToolCore.container

Defined in ​

src/Utils/segmentation/NrrdTools.ts:24

contrastEventPrameters ​

• contrastEventPrameters: IContrastEvents

Inherited from ​

DrawToolCore.contrastEventPrameters

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:28

cursorPage ​

• cursorPage: ICursorPage

Inherited from ​

DrawToolCore.cursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:70

dragOperator ​

• dragOperator: DragOperator

Defined in ​

src/Utils/segmentation/NrrdTools.ts:27

drawingPrameters ​

• drawingPrameters: IDrawingEvents

Inherited from ​

DrawToolCore.drawingPrameters

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:17

eraserUrls ​

• eraserUrls: string[] = []

Inherited from ​

DrawToolCore.eraserUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:41

guiParameterSettings ​

• Private guiParameterSettings: undefined | IGuiParameterSettings

Defined in ​

src/Utils/segmentation/NrrdTools.ts:34

gui_states ​

• gui_states: IGUIStates

Inherited from ​

DrawToolCore.gui_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:91

initState ​

• Private initState: boolean = true

Defined in ​

src/Utils/segmentation/NrrdTools.ts:32

mainAreaContainer ​

• mainAreaContainer: HTMLDivElement

Inherited from ​

DrawToolCore.mainAreaContainer

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:16

nrrd_states ​

• nrrd_states: INrrdStates

Inherited from ​

DrawToolCore.nrrd_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:15

paintedImage ​

• Private paintedImage: undefined | IPaintImage

Defined in ​

src/Utils/segmentation/NrrdTools.ts:30

pencilUrls ​

• pencilUrls: string[] = []

Inherited from ​

DrawToolCore.pencilUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:42

preTimer ​

• Private preTimer: any

Defined in ​

src/Utils/segmentation/NrrdTools.ts:33

protectedData ​

• protectedData: IProtected

Inherited from ​

DrawToolCore.protectedData

Defined in ​

src/Utils/segmentation/CommToolsData.ts:141

start ​

• start: () => void

Type declaration ​

▸ (): void

Returns ​

void

Inherited from ​

DrawToolCore.start

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:46

storedPaintImages ​

• storedPaintImages: undefined | IStoredPaintImages

Defined in ​

src/Utils/segmentation/NrrdTools.ts:28

undoArray ​

• undoArray: IUndoType[] = []

Inherited from ​

DrawToolCore.undoArray

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:43

Methods ​

addSkip ​

▸ addSkip(index): void

Parameters ​

NameType
indexnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:590

afterLoadSlice ​

▸ Private afterLoadSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:820

appendLoadingbar ​

▸ appendLoadingbar(loadingbar): void

Parameters ​

NameType
loadingbarHTMLDivElement

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:876

checkSharedPlaceSlice ​

▸ checkSharedPlaceSlice(width, height, imageData): Uint8ClampedArray

**************************** Utils for store image and itksnap core *************************************

Parameters ​

NameType
widthnumber
heightnumber
imageDataImageData

Returns ​

Uint8ClampedArray

Inherited from ​

DrawToolCore.checkSharedPlaceSlice

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1693

clear ​

▸ clear(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:608

clearDictionary ​

▸ Private clearDictionary(dic): void

Parameters ​

NameType
dicISkipSlicesDictType

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1109

clearPaint ​

▸ clearPaint(): void

Clear mask on current slice canvas

Returns ​

void

Inherited from ​

DrawToolCore.clearPaint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1228

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Overrides ​

DrawToolCore.clearStoreImages

Defined in ​

src/Utils/segmentation/NrrdTools.ts:880

configContrastDragMode ​

▸ configContrastDragMode(): void

Returns ​

void

Inherited from ​

DrawToolCore.configContrastDragMode

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1838

convertCursorPoint ​

▸ convertCursorPoint(from, to, cursorNumX, cursorNumY, currentSliceIndex): undefined | { convertCursorNumX: number ; convertCursorNumY: number ; currentIndex: number ; oldIndex: number }

We generate the MRI slice from threejs based on mm, but when we display it is based on pixel size/distance. So, the index munber on each axis (sagittal, axial, coronal) is the slice's depth in mm distance. And the width and height displayed on screen is the slice's width and height in pixel distance.

When we switch into different axis' views, we need to convert current view's the depth to the pixel distance in other views width or height, and convert the current view's width or height from pixel distance to mm distance as other views' depth (slice index) in general.

Then as for the crosshair (Cursor Inspector), we also need to convert the cursor point (x, y, z) to other views' (x, y, z).

Parameters ​

NameTypeDescription
from"z" | "y" | "x""x" | "y" | "z", current view axis, "x: sagittle, y: coronal, z: axial".
to"z" | "y" | "x""x" | "y" | "z", target view axis (where you want jump to), "x: sagittle, y: coronal, z: axial".
cursorNumXnumbernumber, cursor point x on current axis's slice. (pixel distance)
cursorNumYnumbernumber, cursor point y on current axis's slice. (pixel distance)
currentSliceIndexnumbernumber, current axis's slice's index/depth. (mm distance)

Returns ​

undefined | { convertCursorNumX: number ; convertCursorNumY: number ; currentIndex: number ; oldIndex: number }

Inherited from ​

DrawToolCore.convertCursorPoint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1071

createEmptyPaintImage ​

▸ Private createEmptyPaintImage(dimensions, paintImages): void

Parameters ​

NameType
dimensionsnumber[]
paintImagesIPaintImages

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:391

drag ​

▸ drag(opts?): void

core function for drag slices

Parameters ​

NameType
opts?IDragOpts

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:67

draw ​

▸ draw(opts?): void

Parameters ​

NameType
opts?IDrawOpts

Returns ​

void

Inherited from ​

DrawToolCore.draw

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:142

drawImageOnEmptyImage ​

▸ drawImageOnEmptyImage(canvas): void

Parameters ​

NameType
canvasHTMLCanvasElement

Returns ​

void

Inherited from ​

DrawToolCore.drawImageOnEmptyImage

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:914

drawSphere ​

▸ drawSphere(mouseX, mouseY, radius): void

Parameters ​

NameType
mouseXnumber
mouseYnumber
radiusnumber

Returns ​

void

Inherited from ​

DrawToolCore.drawSphere

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1032

enableContrastDragEvents ​

▸ enableContrastDragEvents(callback): void

Enable the drag function for contrast images window center and window high.

Parameters ​

NameType
callback(step: number, towards: "horizental" | "vertical") => void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:101

filterDrawedImage ​

▸ filterDrawedImage(axis, sliceIndex, paintedImages): IPaintImage

Get a painted mask image (IPaintImage) based on current axis and input slice index.

Parameters ​

NameTypeDescription
axis"z" | "y" | "x""x" | "y" | "z"
sliceIndexnumbernumber
paintedImagesIPaintImagesIPaintImages, All painted mask images.

Returns ​

IPaintImage

Inherited from ​

DrawToolCore.filterDrawedImage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:329

findSliceInSharedPlace ​

▸ findSliceInSharedPlace(): ImageData[]

Returns ​

ImageData[]

Inherited from ​

DrawToolCore.findSliceInSharedPlace

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1733

flipDisplayImageByAxis ​

▸ flipDisplayImageByAxis(): void

flip the canvas to a correct position. This is because the slice canvas from threejs is not in a correct 2D postion. Thus, everytime when we redraw the display canvas, we need to flip to draw the origin canvas from threejs. Under different axis(sagittal, Axial, Coronal), the flip orientation is different.

Returns ​

void

Overrides ​

DrawToolCore.flipDisplayImageByAxis

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1092

getContainer ​

▸ getContainer(): HTMLElement

Returns ​

HTMLElement

Defined in ​

src/Utils/segmentation/NrrdTools.ts:672

getCurrentImageDimension ​

▸ getCurrentImageDimension(): number[]

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:333

getCurrentSliceIndex ​

▸ getCurrentSliceIndex(): number

Returns ​

number

Defined in ​

src/Utils/segmentation/NrrdTools.ts:699

getCurrentSlicesNumAndContrastNum ​

▸ getCurrentSlicesNumAndContrastNum(): Object

Returns ​

Object

NameType
contrastIndexnumber
currentIndexnumber

Defined in ​

src/Utils/segmentation/NrrdTools.ts:692

getDrawingCanvas ​

▸ getDrawingCanvas(): HTMLCanvasElement

Returns ​

HTMLCanvasElement

Defined in ​

src/Utils/segmentation/NrrdTools.ts:675

getGuiSettings ​

▸ getGuiSettings(): Object

Returns ​

Object

NameType
guiSettingundefined | IGuiParameterSettings
guiStateIGUIStates

Defined in ​

src/Utils/segmentation/NrrdTools.ts:159

getIsShowContrastState ​

▸ getIsShowContrastState(): boolean

Returns ​

boolean

Defined in ​

src/Utils/segmentation/NrrdTools.ts:705

getMaskData ​

▸ getMaskData(): IMaskData

Returns ​

IMaskData

Defined in ​

src/Utils/segmentation/NrrdTools.ts:343

getMaxSliceNum ​

▸ getMaxSliceNum(): number[]

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:682

getNrrdToolsSettings ​

▸ getNrrdToolsSettings(): INrrdStates

Returns ​

INrrdStates

Defined in ​

src/Utils/segmentation/NrrdTools.ts:678

getRestLabel ​

▸ getRestLabel(): ("label1" | "label2" | "label3")[]

label div controls*************************

Returns ​

("label1" | "label2" | "label3")[]

Inherited from ​

DrawToolCore.getRestLabel

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1209

getSharedPlace ​

▸ Private getSharedPlace(len, ratio): number[]

Parameters ​

NameType
lennumber
rationumber

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:347

getSpaceOrigin ​

▸ getSpaceOrigin(): number[]

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:340

getVoxelSpacing ​

▸ getVoxelSpacing(): number[]

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:337

init ​

▸ Private init(): void

A initialise function for nrrd_tools

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:176

initPaintImages ​

▸ Private initPaintImages(dimensions): void

init all painted images for store images

Parameters ​

NameType
dimensionsnumber[]

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:372

loadDisplaySlicesArray ​

▸ Private loadDisplaySlicesArray(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:738

loadingMaskByLabel ​

▸ Private loadingMaskByLabel(masks, index, imageData): ImageData

Parameters ​

NameType
masksexportPaintImageType[]
indexnumber
imageDataImageData

Returns ​

ImageData

Defined in ​

src/Utils/segmentation/NrrdTools.ts:248

redrawDisplayCanvas ​

▸ redrawDisplayCanvas(): void

Redraw current contrast image to display canvas. It is more related to change the contrast slice image's window width or center.

Returns ​

void

Overrides ​

DrawToolCore.redrawDisplayCanvas

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1149

redrawMianPreOnDisplayCanvas ​

▸ redrawMianPreOnDisplayCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:933

reloadMaskToLabel ​

▸ Private reloadMaskToLabel(paintImages, ctx): void

Used to init the mask on each label and reload

Parameters ​

NameType
paintImagesIPaintImages
ctxCanvasRenderingContext2D

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1031

removeContrastDragMode ​

▸ removeContrastDragMode(): void

Returns ​

void

Inherited from ​

DrawToolCore.removeContrastDragMode

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1852

removeSkip ​

▸ removeSkip(index): void

Parameters ​

NameType
indexnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:602

replaceArray ​

▸ replaceArray(mainArr, replaceArr): void

Parameters ​

NameType
mainArrnumber[] | Uint8ClampedArray
replaceArrnumber[] | Uint8ClampedArray

Returns ​

void

Inherited from ​

DrawToolCore.replaceArray

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1720

replaceHorizontalRowPixels ​

▸ replaceHorizontalRowPixels(paintImageArray, length, ratio, markedArr, targetWidth, convertIndex): void

Parameters ​

NameTypeDescription
paintImageArrayIPaintImage[]: the target view slice's marked images array
lengthnumber: the target view slice's dimention (total slice index num)
rationumber: the target slice image's width/height ratio of its dimention length
markedArrnumber[][] | Uint8ClampedArray[]: current painted image's horizontal 2d Array
targetWidthnumber: the target image width
convertIndexnumber: Mapping current image's index to target slice image's width/height pixel start point

Returns ​

void

Inherited from ​

DrawToolCore.replaceHorizontalRowPixels

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1672

replaceVerticalColPixels ​

▸ replaceVerticalColPixels(paintImageArray, length, ratio, markedArr, targetWidth, convertIndex): void

Parameters ​

NameTypeDescription
paintImageArrayIPaintImage[]: the target view slice's marked images array
lengthnumber: the target view slice's dimention (total slice index num)
rationumber: the target slice image's width/height ratio of its dimention length
markedArrnumber[][] | Uint8ClampedArray[]: current painted image's vertical 2d Array
targetWidthnumber: the target image width
convertIndexnumber: Mapping current image's index to target slice image's width/height pixel start point

Returns ​

void

Inherited from ​

DrawToolCore.replaceVerticalColPixels

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1639

repraintCurrentContrastSlice ​

▸ repraintCurrentContrastSlice(): void

Returns ​

void

Inherited from ​

DrawToolCore.repraintCurrentContrastSlice

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1902

resetDisplaySlicesStatus ​

▸ Private resetDisplaySlicesStatus(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:765

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Clear masks on drawingCanvas layers.

Returns ​

void

Overrides ​

DrawToolCore.resetLayerCanvas

Defined in ​

src/Utils/segmentation/NrrdTools.ts:922

resetPaintAreaUIPosition ​

▸ resetPaintAreaUIPosition(l?, t?): void

Reset the draw and display canvases layout after mouse pan. If no params in, then center the draw and display canvases.

Parameters ​

NameTypeDescription
l?numbernumber, Offset to the left
t?numbernumber, Offset to the top

Returns ​

void

Overrides ​

DrawToolCore.resetPaintAreaUIPosition

Defined in ​

src/Utils/segmentation/NrrdTools.ts:902

resizePaintArea ​

▸ resizePaintArea(factor): void

Resize the draw and display canvas size based on the input size factor number.

Parameters ​

NameTypeDescription
factornumbernumber

Returns ​

void

Overrides ​

DrawToolCore.resizePaintArea

Defined in ​

src/Utils/segmentation/NrrdTools.ts:961

setAllSlices ​

▸ setAllSlices(allSlices): void

entry function

  • { x:slice, y:slice, z:slice }

Parameters ​

NameTypeDescription
allSlicesnrrdSliceType[]all nrrd contrast slices

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:198

setBaseDrawDisplayCanvasesSize ​

▸ setBaseDrawDisplayCanvasesSize(size): void

Set the Draw Display Canvas base size

Parameters ​

NameTypeDescription
sizenumbernumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:83

setDisplaySliceIndexPanel ​

▸ setDisplaySliceIndexPanel(panel): void

Parameters ​

NameType
panelHTMLDivElement

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:93

setDisplaySlicesBaseOnAxis ​

▸ Private setDisplaySlicesBaseOnAxis(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:725

setEmptyCanvasSize ​

▸ setEmptyCanvasSize(axis?): void

Set the empty canvas width and height based on the axis (pixel distance not the mm), to reduce duplicate codes.

Parameters ​

NameType
axis?"z" | "y" | "x"

Returns ​

void

Overrides ​

DrawToolCore.setEmptyCanvasSize

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1120

setEraserUrls ​

▸ setEraserUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Inherited from ​

DrawToolCore.setEraserUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:105

setIsDrawFalse ​

▸ setIsDrawFalse(target): void

Give a delay time to finish the last drawing before upcoming interrupt opreations. Give a delay time number (ms) to disable the draw function, After your interrupt opeartion, you should enable the draw fucntion.

Parameters ​

NameTypeDescription
targetnumbernumber

Returns ​

void

Overrides ​

DrawToolCore.setIsDrawFalse

Defined in ​

src/Utils/segmentation/NrrdTools.ts:715

setMainAreaSize ​

▸ setMainAreaSize(factor): void

Parameters ​

NameType
factornumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:659

setMainPreSlice ​

▸ Private setMainPreSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:789

setMasksData ​

▸ setMasksData(masksData, loadingBar?): void

Parameters ​

NameType
masksDatastoreExportPaintImageType
loadingBar?loadingBarType

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:265

setOriginCanvasAndPre ​

▸ Private setOriginCanvasAndPre(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:796

setPencilIconUrls ​

▸ setPencilIconUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Inherited from ​

DrawToolCore.setPencilIconUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:108

setShowInMainArea ​

▸ Private setShowInMainArea(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:329

setSliceMoving ​

▸ setSliceMoving(step): void

Parameters ​

NameType
stepnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:650

setSliceOrientation ​

▸ setSliceOrientation(axisTo): void

Switch all contrast slices' orientation

Parameters ​

NameType
axisTo"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:436

setSyncsliceNum ​

▸ setSyncsliceNum(): void

Keep all contrast slice index to same. Synchronize the slice indexes of all the contrasts so that they are consistent with the main slice's index.

Returns ​

void

Overrides ​

DrawToolCore.setSyncsliceNum

Defined in ​

src/Utils/segmentation/NrrdTools.ts:868

setupConfigs ​

▸ Private setupConfigs(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:772

setupConrastEvents ​

▸ setupConrastEvents(callback): void

Set up root container events fns for drag function

Parameters ​

NameType
callback(step: number, towards: "horizental" | "vertical") => void

Returns ​

void

Inherited from ​

DrawToolCore.setupConrastEvents

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1785

setupGUI ​

▸ setupGUI(gui): void

Set up GUI for drawing panel

Parameters ​

NameTypeDescription
guiGUIGUI

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:109

sliceArrayH ​

▸ sliceArrayH(arr, row, col): Uint8ClampedArray[]

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

Uint8ClampedArray[]

Inherited from ​

DrawToolCore.sliceArrayH

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1601

sliceArrayV ​

▸ sliceArrayV(arr, row, col): number[][]

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

number[][]

Inherited from ​

DrawToolCore.sliceArrayV

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1612

storeAllImages ​

▸ storeAllImages(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Inherited from ​

DrawToolCore.storeAllImages

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1358

storeEachLayerImage ​

▸ storeEachLayerImage(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Inherited from ​

DrawToolCore.storeEachLayerImage

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1559

storeImageToAxis ​

▸ storeImageToAxis(index, paintedImages, imageData, axis?): void

Store images*************************

Parameters ​

NameType
indexnumber
paintedImagesIPaintImages
imageDataImageData
axis?"z" | "y" | "x"

Returns ​

void

Inherited from ​

DrawToolCore.storeImageToAxis

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1324

storeImageToLabel ​

▸ storeImageToLabel(index, canvas, paintedImages): ImageData

Parameters ​

NameType
indexnumber
canvasHTMLCanvasElement
paintedImagesIPaintImages

Returns ​

ImageData

Inherited from ​

DrawToolCore.storeImageToLabel

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1539

switchAllSlicesArrayData ​

▸ switchAllSlicesArrayData(allSlices): void

Parameters ​

NameType
allSlicesnrrdSliceType[]

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:759

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Inherited from ​

DrawToolCore.undoLastPainting

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1247

updateMaxIndex ​

▸ Private updateMaxIndex(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:840

updateOriginAndChangedWH ​

▸ updateOriginAndChangedWH(): void

Update the original canvas size, allow set to threejs load one (pixel distance not the mm). Then update the changedWidth and changedHeight based on the sizeFoctor.

Returns ​

void

Overrides ​

DrawToolCore.updateOriginAndChangedWH

Defined in ​

src/Utils/segmentation/NrrdTools.ts:850

updateSlicesContrast ​

▸ updateSlicesContrast(value, flag): void

Parameters ​

NameType
valuenumber
flagstring

Returns ​

void

Inherited from ​

DrawToolCore.updateSlicesContrast

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1876

+ \ No newline at end of file diff --git a/apidist/interfaces/Loader_copperNrrdLoader.optsType.html b/apidist/interfaces/Loader_copperNrrdLoader.optsType.html index 7cf0ab3..383d48e 100644 --- a/apidist/interfaces/Loader_copperNrrdLoader.optsType.html +++ b/apidist/interfaces/Loader_copperNrrdLoader.optsType.html @@ -11,13 +11,13 @@ - + -
Copper3d API

Appearance

copper3d / Modules / Loader/copperNrrdLoader / optsType

Interface: optsType ​

Loader/copperNrrdLoader.optsType

Table of contents ​

Properties ​

Properties ​

container ​

• Optional container: HTMLDivElement

Defined in ​

src/Loader/copperNrrdLoader.ts:35

openGui ​

• openGui: boolean

Defined in ​

src/Loader/copperNrrdLoader.ts:34

- +
Copper3d API

Appearance

copper3d / Modules / Loader/copperNrrdLoader / optsType

Interface: optsType ​

Loader/copperNrrdLoader.optsType

Table of contents ​

Properties ​

Properties ​

container ​

• Optional container: HTMLDivElement

Defined in ​

src/Loader/copperNrrdLoader.ts:35

openGui ​

• openGui: boolean

Defined in ​

src/Loader/copperNrrdLoader.ts:34

+ \ No newline at end of file diff --git a/apidist/modules.html b/apidist/modules.html index d4ed1ac..b344d90 100644 --- a/apidist/modules.html +++ b/apidist/modules.html @@ -17,7 +17,7 @@
Copper3d API

Appearance

- + \ No newline at end of file diff --git a/apidist/modules/Controls_Copper3dTrackballControls.html b/apidist/modules/Controls_Copper3dTrackballControls.html index 20cf2ba..f380a90 100644 --- a/apidist/modules/Controls_Copper3dTrackballControls.html +++ b/apidist/modules/Controls_Copper3dTrackballControls.html @@ -17,7 +17,7 @@
Copper3d API

Appearance

copper3d / Modules / Controls/Copper3dTrackballControls

Module: Controls/Copper3dTrackballControls ​

Table of contents ​

Classes ​

- + \ No newline at end of file diff --git a/apidist/modules/Controls_copperControls.html b/apidist/modules/Controls_copperControls.html index 6760e36..d4a2e7f 100644 --- a/apidist/modules/Controls_copperControls.html +++ b/apidist/modules/Controls_copperControls.html @@ -17,7 +17,7 @@
Copper3d API

Appearance

copper3d / Modules / Controls/copperControls

Module: Controls/copperControls ​

Table of contents ​

Classes ​

- + \ No newline at end of file diff --git a/apidist/modules/Loader_copperNrrdLoader.html b/apidist/modules/Loader_copperNrrdLoader.html index 3b28d8d..4288033 100644 --- a/apidist/modules/Loader_copperNrrdLoader.html +++ b/apidist/modules/Loader_copperNrrdLoader.html @@ -11,13 +11,13 @@ - + -
Copper3d API

Appearance

copper3d / Modules / Loader/copperNrrdLoader

Module: Loader/copperNrrdLoader ​

Table of contents ​

Interfaces ​

Functions ​

Functions ​

addBoxHelper ​

▸ addBoxHelper(scene, volume, boxCube?): void

Parameters ​

NameType
scenecopperScene
volumeany
boxCube?Object3D<Event>

Returns ​

void

Defined in ​

src/Loader/copperNrrdLoader.ts:435

copperNrrdLoader ​

▸ copperNrrdLoader(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

Defined in ​

src/Loader/copperNrrdLoader.ts:38

copperNrrdTexture3dLoader ​

▸ copperNrrdTexture3dLoader(url, scene, container, callback?): void

Parameters ​

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

Returns ​

void

Defined in ​

src/Loader/copperNrrdLoader.ts:177

getWholeSlices ​

▸ getWholeSlices(nrrdSlices, scene, gui, controls): void

Parameters ​

NameType
nrrdSlicesnrrdSliceType
sceneScene
guiGUI
controlsCopper3dTrackballControls

Returns ​

void

Defined in ​

src/Loader/copperNrrdLoader.ts:335

- +
Copper3d API

Appearance

copper3d / Modules / Loader/copperNrrdLoader

Module: Loader/copperNrrdLoader ​

Table of contents ​

Interfaces ​

Functions ​

Functions ​

addBoxHelper ​

▸ addBoxHelper(scene, volume, boxCube?): void

Parameters ​

NameType
scenecopperScene
volumeany
boxCube?Object3D<Event>

Returns ​

void

Defined in ​

src/Loader/copperNrrdLoader.ts:435

copperNrrdLoader ​

▸ copperNrrdLoader(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

Defined in ​

src/Loader/copperNrrdLoader.ts:38

copperNrrdTexture3dLoader ​

▸ copperNrrdTexture3dLoader(url, scene, container, callback?): void

Parameters ​

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

Returns ​

void

Defined in ​

src/Loader/copperNrrdLoader.ts:177

getWholeSlices ​

▸ getWholeSlices(nrrdSlices, scene, gui, controls): void

Parameters ​

NameType
nrrdSlicesnrrdSliceType
sceneScene
guiGUI
controlsCopper3dTrackballControls

Returns ​

void

Defined in ​

src/Loader/copperNrrdLoader.ts:335

+ \ No newline at end of file diff --git a/apidist/modules/Renderer_baseRenderer.html b/apidist/modules/Renderer_baseRenderer.html index 8420350..51ad2a0 100644 --- a/apidist/modules/Renderer_baseRenderer.html +++ b/apidist/modules/Renderer_baseRenderer.html @@ -17,7 +17,7 @@
Copper3d API

Appearance

copper3d / Modules / Renderer/baseRenderer

Module: Renderer/baseRenderer ​

Table of contents ​

Classes ​

- + \ No newline at end of file diff --git a/apidist/modules/Renderer_copperMSceneRenderer.html b/apidist/modules/Renderer_copperMSceneRenderer.html index 72aad98..2b3b1aa 100644 --- a/apidist/modules/Renderer_copperMSceneRenderer.html +++ b/apidist/modules/Renderer_copperMSceneRenderer.html @@ -17,7 +17,7 @@
Copper3d API

Appearance

copper3d / Modules / Renderer/copperMSceneRenderer

Module: Renderer/copperMSceneRenderer ​

Table of contents ​

Classes ​

- + \ No newline at end of file diff --git a/apidist/modules/Renderer_copperRenderer-1.html b/apidist/modules/Renderer_copperRenderer-1.html index 99d30c8..c2912db 100644 --- a/apidist/modules/Renderer_copperRenderer-1.html +++ b/apidist/modules/Renderer_copperRenderer-1.html @@ -17,7 +17,7 @@
Copper3d API

Appearance

copper3d / Modules / Renderer/copperRenderer

Module: Renderer/copperRenderer ​

Table of contents ​

References ​

References ​

copperRenderer ​

Re-exports copperRenderer

- + \ No newline at end of file diff --git a/apidist/modules/Renderer_copperRenderer-2.html b/apidist/modules/Renderer_copperRenderer-2.html index ae786c5..9ab9357 100644 --- a/apidist/modules/Renderer_copperRenderer-2.html +++ b/apidist/modules/Renderer_copperRenderer-2.html @@ -17,7 +17,7 @@
Copper3d API

Appearance

copper3d / Modules / Renderer/copperRenderer

Module: Renderer/copperRenderer ​

Table of contents ​

References ​

References ​

copperRenderer ​

Re-exports copperRenderer

- + \ No newline at end of file diff --git a/apidist/modules/Renderer_copperRenderer-3.html b/apidist/modules/Renderer_copperRenderer-3.html index 86b3d52..9a8a1a5 100644 --- a/apidist/modules/Renderer_copperRenderer-3.html +++ b/apidist/modules/Renderer_copperRenderer-3.html @@ -17,7 +17,7 @@
Copper3d API

Appearance

copper3d / Modules / Renderer/copperRenderer

Module: Renderer/copperRenderer ​

Table of contents ​

References ​

References ​

copperRenderer ​

Re-exports copperRenderer

- + \ No newline at end of file diff --git a/apidist/modules/Renderer_copperRenderer.html b/apidist/modules/Renderer_copperRenderer.html index bdc3d83..0ec1305 100644 --- a/apidist/modules/Renderer_copperRenderer.html +++ b/apidist/modules/Renderer_copperRenderer.html @@ -17,7 +17,7 @@
Copper3d API

Appearance

copper3d / Modules / Renderer/copperRenderer

Module: Renderer/copperRenderer ​

Table of contents ​

Classes ​

- + \ No newline at end of file diff --git a/apidist/modules/Scene_baseScene.html b/apidist/modules/Scene_baseScene.html index 788c1f8..089bd87 100644 --- a/apidist/modules/Scene_baseScene.html +++ b/apidist/modules/Scene_baseScene.html @@ -17,7 +17,7 @@
Copper3d API

Appearance

copper3d / Modules / Scene/baseScene

Module: Scene/baseScene ​

Table of contents ​

Classes ​

- + \ No newline at end of file diff --git a/apidist/modules/Scene_commonSceneMethod.html b/apidist/modules/Scene_commonSceneMethod.html index c717ece..9a18ff7 100644 --- a/apidist/modules/Scene_commonSceneMethod.html +++ b/apidist/modules/Scene_commonSceneMethod.html @@ -17,7 +17,7 @@
Copper3d API

Appearance

copper3d / Modules / Scene/commonSceneMethod

Module: Scene/commonSceneMethod ​

Table of contents ​

Classes ​

- + \ No newline at end of file diff --git a/apidist/modules/Scene_copperMScene.html b/apidist/modules/Scene_copperMScene.html index 20956c2..0f1756e 100644 --- a/apidist/modules/Scene_copperMScene.html +++ b/apidist/modules/Scene_copperMScene.html @@ -17,7 +17,7 @@
Copper3d API

Appearance

copper3d / Modules / Scene/copperMScene

Module: Scene/copperMScene ​

Table of contents ​

Classes ​

- + \ No newline at end of file diff --git a/apidist/modules/Scene_copperScene.html b/apidist/modules/Scene_copperScene.html index 4947f7f..3a54e7c 100644 --- a/apidist/modules/Scene_copperScene.html +++ b/apidist/modules/Scene_copperScene.html @@ -17,7 +17,7 @@
Copper3d API

Appearance

copper3d / Modules / Scene/copperScene

Module: Scene/copperScene ​

Table of contents ​

Classes ​

- + \ No newline at end of file diff --git a/apidist/modules/Scene_copperSceneOnDemond.html b/apidist/modules/Scene_copperSceneOnDemond.html index a3f0148..f0e5294 100644 --- a/apidist/modules/Scene_copperSceneOnDemond.html +++ b/apidist/modules/Scene_copperSceneOnDemond.html @@ -17,7 +17,7 @@
Copper3d API

Appearance

copper3d / Modules / Scene/copperSceneOnDemond

Module: Scene/copperSceneOnDemond ​

Table of contents ​

Classes ​

- + \ No newline at end of file diff --git a/apidist/modules/Utils_MeshNodeTool.html b/apidist/modules/Utils_MeshNodeTool.html index 9088e17..c0a145f 100644 --- a/apidist/modules/Utils_MeshNodeTool.html +++ b/apidist/modules/Utils_MeshNodeTool.html @@ -17,7 +17,7 @@
Copper3d API

Appearance

copper3d / Modules / Utils/MeshNodeTool

Module: Utils/MeshNodeTool ​

Table of contents ​

Classes ​

- + \ No newline at end of file diff --git a/apidist/modules/Utils_segmentation_CommToolsData.html b/apidist/modules/Utils_segmentation_CommToolsData.html index 0448998..0740be8 100644 --- a/apidist/modules/Utils_segmentation_CommToolsData.html +++ b/apidist/modules/Utils_segmentation_CommToolsData.html @@ -17,7 +17,7 @@
Copper3d API

Appearance

copper3d / Modules / Utils/segmentation/CommToolsData

Module: Utils/segmentation/CommToolsData ​

Table of contents ​

Classes ​

- + \ No newline at end of file diff --git a/apidist/modules/Utils_segmentation_DragOperator.html b/apidist/modules/Utils_segmentation_DragOperator.html index 61243de..3ca6f05 100644 --- a/apidist/modules/Utils_segmentation_DragOperator.html +++ b/apidist/modules/Utils_segmentation_DragOperator.html @@ -17,7 +17,7 @@
Copper3d API

Appearance

copper3d / Modules / Utils/segmentation/DragOperator

Module: Utils/segmentation/DragOperator ​

Table of contents ​

Classes ​

- + \ No newline at end of file diff --git a/apidist/modules/Utils_segmentation_DrawToolCore.html b/apidist/modules/Utils_segmentation_DrawToolCore.html index 873d2dc..c42a28d 100644 --- a/apidist/modules/Utils_segmentation_DrawToolCore.html +++ b/apidist/modules/Utils_segmentation_DrawToolCore.html @@ -17,7 +17,7 @@
Copper3d API

Appearance

copper3d / Modules / Utils/segmentation/DrawToolCore

Module: Utils/segmentation/DrawToolCore ​

Table of contents ​

Classes ​

- + \ No newline at end of file diff --git a/apidist/modules/Utils_segmentation_NrrdTools.html b/apidist/modules/Utils_segmentation_NrrdTools.html index 87458ed..78c6ad1 100644 --- a/apidist/modules/Utils_segmentation_NrrdTools.html +++ b/apidist/modules/Utils_segmentation_NrrdTools.html @@ -17,7 +17,7 @@
Copper3d API

Appearance

copper3d / Modules / Utils/segmentation/NrrdTools

Module: Utils/segmentation/NrrdTools ​

Table of contents ​

Classes ​

- + \ No newline at end of file diff --git a/apidist/modules/Utils_segmentation_coreTools_gui.html b/apidist/modules/Utils_segmentation_coreTools_gui.html index cc39aac..e6e9246 100644 --- a/apidist/modules/Utils_segmentation_coreTools_gui.html +++ b/apidist/modules/Utils_segmentation_coreTools_gui.html @@ -11,13 +11,13 @@ - + -
Copper3d API

Appearance

copper3d / Modules / Utils/segmentation/coreTools/gui

Module: Utils/segmentation/coreTools/gui ​

Table of contents ​

Functions ​

Functions ​

removeGuiFolderChilden ​

▸ removeGuiFolderChilden(modeFolder): void

Parameters ​

NameType
modeFolderGUI

Returns ​

void

Defined in ​

src/Utils/segmentation/coreTools/gui.ts:473

setupGui ​

▸ setupGui(configs): IGuiParameterSettings

Parameters ​

NameType
configsIConfigGUI

Returns ​

IGuiParameterSettings

Defined in ​

src/Utils/segmentation/coreTools/gui.ts:95

- +
Copper3d API

Appearance

copper3d / Modules / Utils/segmentation/coreTools/gui

Module: Utils/segmentation/coreTools/gui ​

Table of contents ​

Functions ​

Functions ​

removeGuiFolderChilden ​

▸ removeGuiFolderChilden(modeFolder): void

Parameters ​

NameType
modeFolderGUI

Returns ​

void

Defined in ​

src/Utils/segmentation/coreTools/gui.ts:473

setupGui ​

▸ setupGui(configs): IGuiParameterSettings

Parameters ​

NameType
configsIConfigGUI

Returns ​

IGuiParameterSettings

Defined in ​

src/Utils/segmentation/coreTools/gui.ts:95

+ \ No newline at end of file diff --git a/apidist/modules/Utils_utils.html b/apidist/modules/Utils_utils.html index 0b257e4..21d2540 100644 --- a/apidist/modules/Utils_utils.html +++ b/apidist/modules/Utils_utils.html @@ -11,13 +11,13 @@ - + -
Copper3d API

Appearance

copper3d / Modules / Utils/utils

Module: Utils/utils ​

Table of contents ​

Functions ​

Functions ​

H3 ​

▸ H3(x): number[]

Cubic-Hermite basis function.

Parameters ​

NameType
xnumber

Returns ​

number[]

Defined in ​

src/Utils/utils.ts:216

L3 ​

▸ L3(x): number[]

Cubic-Lagrange basis function

Parameters ​

NameType
xnumber

Returns ​

number[]

Defined in ​

src/Utils/utils.ts:198

calcDistance ​

▸ calcDistance(x0, x1): number

Euclidean distance n dimensions

Parameters ​

NameType
x0number[]
x1number[]

Returns ​

number

Defined in ​

src/Utils/utils.ts:288

fullScreenListenner ​

▸ fullScreenListenner(container): void

Parameters ​

NameType
containerHTMLDivElement | HTMLCanvasElement

Returns ​

void

Defined in ​

src/Utils/utils.ts:1

getWightsH3H3H3 ​

▸ getWightsH3H3H3(Xi): number[][]

Parameters ​

NameType
Xinumber[][]

Returns ​

number[][]

Defined in ​

src/Utils/utils.ts:248

getWightsL3L3L3 ​

▸ getWightsL3L3L3(Xi): number[]

To calculate the weights for each element of Xi using the cubic Lagrange basis functions.

Parameters ​

NameType
Xinumber[]

Returns ​

number[]

Defined in ​

src/Utils/utils.ts:232

isIOS ​

▸ isIOS(): boolean

Returns ​

boolean

Defined in ​

src/Utils/utils.ts:21

loading ​

▸ loading(loadingGif?): Object

Parameters ​

NameType
loadingGif?string

Returns ​

Object

NameType
loadingContainerHTMLDivElement
progressHTMLDivElement

Defined in ​

src/Utils/utils.ts:49

perturbRandom ​

▸ perturbRandom(x, dx): number[]

Parameters ​

NameType
xnumber[]
dxnumber

Returns ​

number[]

Defined in ​

src/Utils/utils.ts:297

switchEraserSize ​

▸ switchEraserSize(size, urls?): string

Parameters ​

NameType
sizenumber
urls?string[]

Returns ​

string

Defined in ​

src/Utils/utils.ts:123

switchPencilIcon ​

▸ switchPencilIcon(icon, urls?): string

Parameters ​

NameType
iconstring
urls?string[]

Returns ​

string

Defined in ​

src/Utils/utils.ts:84

throttle ​

▸ throttle(callback, wait): (event: MouseEvent) => void

Parameters ​

NameType
callback(event: MouseEvent) => void
waitnumber

Returns ​

fn

▸ (event): void

Parameters ​
NameType
eventMouseEvent
Returns ​

void

Defined in ​

src/Utils/utils.ts:182

traverseMaterials ​

▸ traverseMaterials(object, callback): void

Parameters ​

NameType
objectGroup
callback(material: any) => void

Returns ​

void

Defined in ​

src/Utils/utils.ts:35

- +
Copper3d API

Appearance

copper3d / Modules / Utils/utils

Module: Utils/utils ​

Table of contents ​

Functions ​

Functions ​

H3 ​

▸ H3(x): number[]

Cubic-Hermite basis function.

Parameters ​

NameType
xnumber

Returns ​

number[]

Defined in ​

src/Utils/utils.ts:216

L3 ​

▸ L3(x): number[]

Cubic-Lagrange basis function

Parameters ​

NameType
xnumber

Returns ​

number[]

Defined in ​

src/Utils/utils.ts:198

calcDistance ​

▸ calcDistance(x0, x1): number

Euclidean distance n dimensions

Parameters ​

NameType
x0number[]
x1number[]

Returns ​

number

Defined in ​

src/Utils/utils.ts:288

fullScreenListenner ​

▸ fullScreenListenner(container): void

Parameters ​

NameType
containerHTMLDivElement | HTMLCanvasElement

Returns ​

void

Defined in ​

src/Utils/utils.ts:1

getWightsH3H3H3 ​

▸ getWightsH3H3H3(Xi): number[][]

Parameters ​

NameType
Xinumber[][]

Returns ​

number[][]

Defined in ​

src/Utils/utils.ts:248

getWightsL3L3L3 ​

▸ getWightsL3L3L3(Xi): number[]

To calculate the weights for each element of Xi using the cubic Lagrange basis functions.

Parameters ​

NameType
Xinumber[]

Returns ​

number[]

Defined in ​

src/Utils/utils.ts:232

isIOS ​

▸ isIOS(): boolean

Returns ​

boolean

Defined in ​

src/Utils/utils.ts:21

loading ​

▸ loading(loadingGif?): Object

Parameters ​

NameType
loadingGif?string

Returns ​

Object

NameType
loadingContainerHTMLDivElement
progressHTMLDivElement

Defined in ​

src/Utils/utils.ts:49

perturbRandom ​

▸ perturbRandom(x, dx): number[]

Parameters ​

NameType
xnumber[]
dxnumber

Returns ​

number[]

Defined in ​

src/Utils/utils.ts:297

switchEraserSize ​

▸ switchEraserSize(size, urls?): string

Parameters ​

NameType
sizenumber
urls?string[]

Returns ​

string

Defined in ​

src/Utils/utils.ts:123

switchPencilIcon ​

▸ switchPencilIcon(icon, urls?): string

Parameters ​

NameType
iconstring
urls?string[]

Returns ​

string

Defined in ​

src/Utils/utils.ts:84

throttle ​

▸ throttle(callback, wait): (event: MouseEvent) => void

Parameters ​

NameType
callback(event: MouseEvent) => void
waitnumber

Returns ​

fn

▸ (event): void

Parameters ​
NameType
eventMouseEvent
Returns ​

void

Defined in ​

src/Utils/utils.ts:182

traverseMaterials ​

▸ traverseMaterials(object, callback): void

Parameters ​

NameType
objectGroup
callback(material: any) => void

Returns ​

void

Defined in ​

src/Utils/utils.ts:35

+ \ No newline at end of file diff --git a/assets/apidist_classes_Controls_Copper3dTrackballControls.Copper3dTrackballControls.md.9b3fefda.js b/assets/apidist_classes_Controls_Copper3dTrackballControls.Copper3dTrackballControls.md.09bf8022.js similarity index 94% rename from assets/apidist_classes_Controls_Copper3dTrackballControls.Copper3dTrackballControls.md.9b3fefda.js rename to assets/apidist_classes_Controls_Copper3dTrackballControls.Copper3dTrackballControls.md.09bf8022.js index b34c677..65407bd 100644 --- a/assets/apidist_classes_Controls_Copper3dTrackballControls.Copper3dTrackballControls.md.9b3fefda.js +++ b/assets/apidist_classes_Controls_Copper3dTrackballControls.Copper3dTrackballControls.md.09bf8022.js @@ -1 +1 @@ -import{_ as e,o as a,c as t,Q as r}from"./chunks/framework.5916b37e.js";const C=JSON.parse('{"title":"Class: Copper3dTrackballControls","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Controls_Copper3dTrackballControls.Copper3dTrackballControls.md","filePath":"apidist/classes/Controls_Copper3dTrackballControls.Copper3dTrackballControls.md"}'),o={name:"apidist/classes/Controls_Copper3dTrackballControls.Copper3dTrackballControls.md"},l=r('

copper3d / Modules / Controls/Copper3dTrackballControls / Copper3dTrackballControls

Class: Copper3dTrackballControls ​

Controls/Copper3dTrackballControls.Copper3dTrackballControls

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new Copper3dTrackballControls(object, domElement)

Parameters ​

NameType
objectPerspectiveCamera | OrthographicCamera
domElementHTMLElement

Overrides ​

EventDispatcher.constructor

Defined in ​

src/Controls/Copper3dTrackballControls.ts:79

Properties ​

checkDistances ​

• checkDistances: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:72

dispose ​

• dispose: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:77

domElement ​

• domElement: HTMLElement

Defined in ​

src/Controls/Copper3dTrackballControls.ts:29

dynamicDampingFactor ​

• dynamicDampingFactor: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:42

enabled ​

• enabled: boolean

Defined in ​

src/Controls/Copper3dTrackballControls.ts:30

handleResize ​

• handleResize: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:66

keys ​

• keys: ["KeyA", "KeyS", "KeyD"]

Defined in ​

src/Controls/Copper3dTrackballControls.ts:50

maxDistance ​

• maxDistance: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:45

maxZoom ​

• maxZoom: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:48

minDistance ​

• minDistance: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:44

minZoom ​

• minZoom: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:47

mouseButtons ​

• mouseButtons: Object

Type declaration ​

NameType
LEFT-1 | LEFT | RIGHT
MIDDLE-1 | LEFT | MIDDLE | RIGHT
RIGHT-1 | LEFT | RIGHT

Defined in ​

src/Controls/Copper3dTrackballControls.ts:52

noPan ​

• noPan: boolean

Defined in ​

src/Controls/Copper3dTrackballControls.ts:39

noRotate ​

• noRotate: boolean

Defined in ​

src/Controls/Copper3dTrackballControls.ts:37

noZoom ​

• noZoom: boolean

Defined in ​

src/Controls/Copper3dTrackballControls.ts:38

object ​

• object: PerspectiveCamera | OrthographicCamera

Defined in ​

src/Controls/Copper3dTrackballControls.ts:28

panCamera ​

• panCamera: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:70

panSpeed ​

• panSpeed: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:35

position0 ​

• position0: Vector3

Defined in ​

src/Controls/Copper3dTrackballControls.ts:61

reset ​

• reset: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:75

rotateCamera ​

• rotateCamera: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:68

rotateSpeed ​

• rotateSpeed: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:33

screen ​

• screen: Object

Type declaration ​

NameType
heightnumber
leftnumber
topnumber
widthnumber

Defined in ​

src/Controls/Copper3dTrackballControls.ts:31

staticMoving ​

• staticMoving: boolean

Defined in ​

src/Controls/Copper3dTrackballControls.ts:41

target ​

• target: Vector3

Defined in ​

src/Controls/Copper3dTrackballControls.ts:58

target0 ​

• target0: Vector3

Defined in ​

src/Controls/Copper3dTrackballControls.ts:60

up0 ​

• up0: Vector3

Defined in ​

src/Controls/Copper3dTrackballControls.ts:62

update ​

• update: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:74

zoom0 ​

• zoom0: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:63

zoomCamera ​

• zoomCamera: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:69

zoomSpeed ​

• zoomSpeed: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:34

Methods ​

addEventListener ​

▸ addEventListener<T>(type, listener): void

Adds a listener to an event type.

Type parameters ​

NameType
Textends string

Parameters ​

NameTypeDescription
typeTThe type of event to listen to.
listenerEventListener<Event, T, Copper3dTrackballControls>The function that gets called when the event is fired.

Returns ​

void

Inherited from ​

EventDispatcher.addEventListener

Defined in ​

node_modules/@types/three/src/core/EventDispatcher.d.ts:46

dispatchEvent ​

▸ dispatchEvent(event): void

Fire an event type.

Parameters ​

NameTypeDescription
eventEventThe event that gets fired.

Returns ​

void

Inherited from ​

EventDispatcher.dispatchEvent

Defined in ​

node_modules/@types/three/src/core/EventDispatcher.d.ts:66

hasEventListener ​

▸ hasEventListener<T>(type, listener): boolean

Checks if listener is added to an event type.

Type parameters ​

NameType
Textends string

Parameters ​

NameTypeDescription
typeTThe type of event to listen to.
listenerEventListener<Event, T, Copper3dTrackballControls>The function that gets called when the event is fired.

Returns ​

boolean

Inherited from ​

EventDispatcher.hasEventListener

Defined in ​

node_modules/@types/three/src/core/EventDispatcher.d.ts:53

removeEventListener ​

▸ removeEventListener<T>(type, listener): void

Removes a listener from an event type.

Type parameters ​

NameType
Textends string

Parameters ​

NameTypeDescription
typeTThe type of the listener that gets removed.
listenerEventListener<Event, T, Copper3dTrackballControls>The listener function that gets removed.

Returns ​

void

Inherited from ​

EventDispatcher.removeEventListener

Defined in ​

node_modules/@types/three/src/core/EventDispatcher.d.ts:60

',266),n=[l];function d(i,s,c,h,p,b){return a(),t("div",null,n)}const u=e(o,[["render",d]]);export{C as __pageData,u as default}; +import{_ as e,o as a,c as t,Q as r}from"./chunks/framework.5916b37e.js";const C=JSON.parse('{"title":"Class: Copper3dTrackballControls","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Controls_Copper3dTrackballControls.Copper3dTrackballControls.md","filePath":"apidist/classes/Controls_Copper3dTrackballControls.Copper3dTrackballControls.md"}'),o={name:"apidist/classes/Controls_Copper3dTrackballControls.Copper3dTrackballControls.md"},l=r('

copper3d / Modules / Controls/Copper3dTrackballControls / Copper3dTrackballControls

Class: Copper3dTrackballControls ​

Controls/Copper3dTrackballControls.Copper3dTrackballControls

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new Copper3dTrackballControls(object, domElement)

Parameters ​

NameType
objectPerspectiveCamera | OrthographicCamera
domElementHTMLElement

Overrides ​

EventDispatcher.constructor

Defined in ​

src/Controls/Copper3dTrackballControls.ts:79

Properties ​

checkDistances ​

• checkDistances: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:72

dispose ​

• dispose: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:77

domElement ​

• domElement: HTMLElement

Defined in ​

src/Controls/Copper3dTrackballControls.ts:29

dynamicDampingFactor ​

• dynamicDampingFactor: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:42

enabled ​

• enabled: boolean

Defined in ​

src/Controls/Copper3dTrackballControls.ts:30

handleResize ​

• handleResize: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:66

keys ​

• keys: ["KeyA", "KeyS", "KeyD"]

Defined in ​

src/Controls/Copper3dTrackballControls.ts:50

maxDistance ​

• maxDistance: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:45

maxZoom ​

• maxZoom: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:48

minDistance ​

• minDistance: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:44

minZoom ​

• minZoom: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:47

mouseButtons ​

• mouseButtons: Object

Type declaration ​

NameType
LEFT-1 | LEFT | RIGHT
MIDDLE-1 | LEFT | MIDDLE | RIGHT
RIGHT-1 | LEFT | RIGHT

Defined in ​

src/Controls/Copper3dTrackballControls.ts:52

noPan ​

• noPan: boolean

Defined in ​

src/Controls/Copper3dTrackballControls.ts:39

noRotate ​

• noRotate: boolean

Defined in ​

src/Controls/Copper3dTrackballControls.ts:37

noZoom ​

• noZoom: boolean

Defined in ​

src/Controls/Copper3dTrackballControls.ts:38

object ​

• object: PerspectiveCamera | OrthographicCamera

Defined in ​

src/Controls/Copper3dTrackballControls.ts:28

panCamera ​

• panCamera: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:70

panSpeed ​

• panSpeed: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:35

position0 ​

• position0: Vector3

Defined in ​

src/Controls/Copper3dTrackballControls.ts:61

reset ​

• reset: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:75

rotateCamera ​

• rotateCamera: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:68

rotateSpeed ​

• rotateSpeed: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:33

screen ​

• screen: Object

Type declaration ​

NameType
heightnumber
leftnumber
topnumber
widthnumber

Defined in ​

src/Controls/Copper3dTrackballControls.ts:31

staticMoving ​

• staticMoving: boolean

Defined in ​

src/Controls/Copper3dTrackballControls.ts:41

target ​

• target: Vector3

Defined in ​

src/Controls/Copper3dTrackballControls.ts:58

target0 ​

• target0: Vector3

Defined in ​

src/Controls/Copper3dTrackballControls.ts:60

up0 ​

• up0: Vector3

Defined in ​

src/Controls/Copper3dTrackballControls.ts:62

update ​

• update: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:74

zoom0 ​

• zoom0: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:63

zoomCamera ​

• zoomCamera: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Controls/Copper3dTrackballControls.ts:69

zoomSpeed ​

• zoomSpeed: number

Defined in ​

src/Controls/Copper3dTrackballControls.ts:34

Methods ​

addEventListener ​

▸ addEventListener<T>(type, listener): void

Adds a listener to an event type.

Type parameters ​

NameType
Textends string

Parameters ​

NameTypeDescription
typeTThe type of event to listen to.
listenerEventListener<Event, T, Copper3dTrackballControls>The function that gets called when the event is fired.

Returns ​

void

Inherited from ​

EventDispatcher.addEventListener

Defined in ​

node_modules/@types/three/src/core/EventDispatcher.d.ts:46

dispatchEvent ​

▸ dispatchEvent(event): void

Fire an event type.

Parameters ​

NameTypeDescription
eventEventThe event that gets fired.

Returns ​

void

Inherited from ​

EventDispatcher.dispatchEvent

Defined in ​

node_modules/@types/three/src/core/EventDispatcher.d.ts:66

hasEventListener ​

▸ hasEventListener<T>(type, listener): boolean

Checks if listener is added to an event type.

Type parameters ​

NameType
Textends string

Parameters ​

NameTypeDescription
typeTThe type of event to listen to.
listenerEventListener<Event, T, Copper3dTrackballControls>The function that gets called when the event is fired.

Returns ​

boolean

Inherited from ​

EventDispatcher.hasEventListener

Defined in ​

node_modules/@types/three/src/core/EventDispatcher.d.ts:53

removeEventListener ​

▸ removeEventListener<T>(type, listener): void

Removes a listener from an event type.

Type parameters ​

NameType
Textends string

Parameters ​

NameTypeDescription
typeTThe type of the listener that gets removed.
listenerEventListener<Event, T, Copper3dTrackballControls>The listener function that gets removed.

Returns ​

void

Inherited from ​

EventDispatcher.removeEventListener

Defined in ​

node_modules/@types/three/src/core/EventDispatcher.d.ts:60

',266),n=[l];function d(i,s,c,h,p,b){return a(),t("div",null,n)}const u=e(o,[["render",d]]);export{C as __pageData,u as default}; diff --git a/assets/apidist_classes_Controls_Copper3dTrackballControls.Copper3dTrackballControls.md.9b3fefda.lean.js b/assets/apidist_classes_Controls_Copper3dTrackballControls.Copper3dTrackballControls.md.09bf8022.lean.js similarity index 100% rename from assets/apidist_classes_Controls_Copper3dTrackballControls.Copper3dTrackballControls.md.9b3fefda.lean.js rename to assets/apidist_classes_Controls_Copper3dTrackballControls.Copper3dTrackballControls.md.09bf8022.lean.js diff --git a/assets/apidist_classes_Controls_copperControls.CameraViewPoint.md.52bb4284.js b/assets/apidist_classes_Controls_copperControls.CameraViewPoint.md.8f5c3d20.js similarity index 91% rename from assets/apidist_classes_Controls_copperControls.CameraViewPoint.md.52bb4284.js rename to assets/apidist_classes_Controls_copperControls.CameraViewPoint.md.8f5c3d20.js index a4ead16..356c6ea 100644 --- a/assets/apidist_classes_Controls_copperControls.CameraViewPoint.md.52bb4284.js +++ b/assets/apidist_classes_Controls_copperControls.CameraViewPoint.md.8f5c3d20.js @@ -1 +1 @@ -import{_ as e,o,c as r,Q as a}from"./chunks/framework.5916b37e.js";const C=JSON.parse('{"title":"Class: CameraViewPoint","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Controls_copperControls.CameraViewPoint.md","filePath":"apidist/classes/Controls_copperControls.CameraViewPoint.md"}'),t={name:"apidist/classes/Controls_copperControls.CameraViewPoint.md"},n=a('

copper3d / Modules / Controls/copperControls / CameraViewPoint

Class: CameraViewPoint ​

Controls/copperControls.CameraViewPoint

Table of contents ​

Constructors ​

Properties ​

Constructors ​

constructor ​

• new CameraViewPoint()

Properties ​

eyePosition ​

• eyePosition: number[]

Defined in ​

src/Controls/copperControls.ts:53

farPlane ​

• farPlane: number = 2000.0

Defined in ​

src/Controls/copperControls.ts:52

nearPlane ​

• nearPlane: number = 0.1

Defined in ​

src/Controls/copperControls.ts:51

targetPosition ​

• targetPosition: number[]

Defined in ​

src/Controls/copperControls.ts:54

upVector ​

• upVector: number[]

Defined in ​

src/Controls/copperControls.ts:55

',36),i=[n];function s(l,c,p,h,d,u){return o(),r("div",null,i)}const b=e(t,[["render",s]]);export{C as __pageData,b as default}; +import{_ as e,o,c as r,Q as a}from"./chunks/framework.5916b37e.js";const C=JSON.parse('{"title":"Class: CameraViewPoint","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Controls_copperControls.CameraViewPoint.md","filePath":"apidist/classes/Controls_copperControls.CameraViewPoint.md"}'),t={name:"apidist/classes/Controls_copperControls.CameraViewPoint.md"},n=a('

copper3d / Modules / Controls/copperControls / CameraViewPoint

Class: CameraViewPoint ​

Controls/copperControls.CameraViewPoint

Table of contents ​

Constructors ​

Properties ​

Constructors ​

constructor ​

• new CameraViewPoint()

Properties ​

eyePosition ​

• eyePosition: number[]

Defined in ​

src/Controls/copperControls.ts:53

farPlane ​

• farPlane: number = 2000.0

Defined in ​

src/Controls/copperControls.ts:52

nearPlane ​

• nearPlane: number = 0.1

Defined in ​

src/Controls/copperControls.ts:51

targetPosition ​

• targetPosition: number[]

Defined in ​

src/Controls/copperControls.ts:54

upVector ​

• upVector: number[]

Defined in ​

src/Controls/copperControls.ts:55

',36),i=[n];function s(l,c,p,h,d,u){return o(),r("div",null,i)}const m=e(t,[["render",s]]);export{C as __pageData,m as default}; diff --git a/assets/apidist_classes_Controls_copperControls.CameraViewPoint.md.52bb4284.lean.js b/assets/apidist_classes_Controls_copperControls.CameraViewPoint.md.8f5c3d20.lean.js similarity index 87% rename from assets/apidist_classes_Controls_copperControls.CameraViewPoint.md.52bb4284.lean.js rename to assets/apidist_classes_Controls_copperControls.CameraViewPoint.md.8f5c3d20.lean.js index f1cad38..cd0a841 100644 --- a/assets/apidist_classes_Controls_copperControls.CameraViewPoint.md.52bb4284.lean.js +++ b/assets/apidist_classes_Controls_copperControls.CameraViewPoint.md.8f5c3d20.lean.js @@ -1 +1 @@ -import{_ as e,o,c as r,Q as a}from"./chunks/framework.5916b37e.js";const C=JSON.parse('{"title":"Class: CameraViewPoint","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Controls_copperControls.CameraViewPoint.md","filePath":"apidist/classes/Controls_copperControls.CameraViewPoint.md"}'),t={name:"apidist/classes/Controls_copperControls.CameraViewPoint.md"},n=a("",36),i=[n];function s(l,c,p,h,d,u){return o(),r("div",null,i)}const b=e(t,[["render",s]]);export{C as __pageData,b as default}; +import{_ as e,o,c as r,Q as a}from"./chunks/framework.5916b37e.js";const C=JSON.parse('{"title":"Class: CameraViewPoint","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Controls_copperControls.CameraViewPoint.md","filePath":"apidist/classes/Controls_copperControls.CameraViewPoint.md"}'),t={name:"apidist/classes/Controls_copperControls.CameraViewPoint.md"},n=a("",36),i=[n];function s(l,c,p,h,d,u){return o(),r("div",null,i)}const m=e(t,[["render",s]]);export{C as __pageData,m as default}; diff --git a/assets/apidist_classes_Controls_copperControls.Controls.md.1186c714.js b/assets/apidist_classes_Controls_copperControls.Controls.md.5559fda2.js similarity index 92% rename from assets/apidist_classes_Controls_copperControls.Controls.md.1186c714.js rename to assets/apidist_classes_Controls_copperControls.Controls.md.5559fda2.js index af2c863..852007a 100644 --- a/assets/apidist_classes_Controls_copperControls.Controls.md.1186c714.js +++ b/assets/apidist_classes_Controls_copperControls.Controls.md.5559fda2.js @@ -1 +1 @@ -import{_ as e,o as t,c as o,Q as a}from"./chunks/framework.5916b37e.js";const b=JSON.parse('{"title":"Class: Controls","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Controls_copperControls.Controls.md","filePath":"apidist/classes/Controls_copperControls.Controls.md"}'),r={name:"apidist/classes/Controls_copperControls.Controls.md"},n=a('

copper3d / Modules / Controls/copperControls / Controls

Class: Controls ​

Controls/copperControls.Controls

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new Controls(camera)

Parameters ​

NameType
cameraPerspectiveCamera

Defined in ​

src/Controls/copperControls.ts:7

Properties ​

currentCamera ​

• Private currentCamera: PerspectiveCamera

Defined in ​

src/Controls/copperControls.ts:3

directionalLight ​

• Private directionalLight: null | DirectionalLight = null

Defined in ​

src/Controls/copperControls.ts:4

viewpoint ​

• Private viewpoint: CameraViewPoint

Defined in ​

src/Controls/copperControls.ts:5

Methods ​

setCameraViewPoint ​

▸ setCameraViewPoint(): void

Returns ​

void

Defined in ​

src/Controls/copperControls.ts:12

updateCameraViewPoint ​

▸ updateCameraViewPoint(viewpoint): void

Parameters ​

NameType
viewpointCameraViewPoint

Returns ​

void

Defined in ​

src/Controls/copperControls.ts:33

updateDirectionalLight ​

▸ updateDirectionalLight(directionalLight?): void

Parameters ​

NameType
directionalLight?DirectionalLight

Returns ​

void

Defined in ​

src/Controls/copperControls.ts:38

',57),i=[n];function l(s,d,c,h,p,u){return t(),o("div",null,i)}const f=e(r,[["render",l]]);export{b as __pageData,f as default}; +import{_ as e,o as t,c as o,Q as a}from"./chunks/framework.5916b37e.js";const f=JSON.parse('{"title":"Class: Controls","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Controls_copperControls.Controls.md","filePath":"apidist/classes/Controls_copperControls.Controls.md"}'),r={name:"apidist/classes/Controls_copperControls.Controls.md"},n=a('

copper3d / Modules / Controls/copperControls / Controls

Class: Controls ​

Controls/copperControls.Controls

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new Controls(camera)

Parameters ​

NameType
cameraPerspectiveCamera

Defined in ​

src/Controls/copperControls.ts:7

Properties ​

currentCamera ​

• Private currentCamera: PerspectiveCamera

Defined in ​

src/Controls/copperControls.ts:3

directionalLight ​

• Private directionalLight: null | DirectionalLight = null

Defined in ​

src/Controls/copperControls.ts:4

viewpoint ​

• Private viewpoint: CameraViewPoint

Defined in ​

src/Controls/copperControls.ts:5

Methods ​

setCameraViewPoint ​

▸ setCameraViewPoint(): void

Returns ​

void

Defined in ​

src/Controls/copperControls.ts:12

updateCameraViewPoint ​

▸ updateCameraViewPoint(viewpoint): void

Parameters ​

NameType
viewpointCameraViewPoint

Returns ​

void

Defined in ​

src/Controls/copperControls.ts:33

updateDirectionalLight ​

▸ updateDirectionalLight(directionalLight?): void

Parameters ​

NameType
directionalLight?DirectionalLight

Returns ​

void

Defined in ​

src/Controls/copperControls.ts:38

',57),i=[n];function l(s,d,c,h,p,u){return t(),o("div",null,i)}const C=e(r,[["render",l]]);export{f as __pageData,C as default}; diff --git a/assets/apidist_classes_Controls_copperControls.Controls.md.1186c714.lean.js b/assets/apidist_classes_Controls_copperControls.Controls.md.5559fda2.lean.js similarity index 64% rename from assets/apidist_classes_Controls_copperControls.Controls.md.1186c714.lean.js rename to assets/apidist_classes_Controls_copperControls.Controls.md.5559fda2.lean.js index b286d06..8b15a73 100644 --- a/assets/apidist_classes_Controls_copperControls.Controls.md.1186c714.lean.js +++ b/assets/apidist_classes_Controls_copperControls.Controls.md.5559fda2.lean.js @@ -1 +1 @@ -import{_ as e,o as t,c as o,Q as a}from"./chunks/framework.5916b37e.js";const b=JSON.parse('{"title":"Class: Controls","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Controls_copperControls.Controls.md","filePath":"apidist/classes/Controls_copperControls.Controls.md"}'),r={name:"apidist/classes/Controls_copperControls.Controls.md"},n=a("",57),i=[n];function l(s,d,c,h,p,u){return t(),o("div",null,i)}const f=e(r,[["render",l]]);export{b as __pageData,f as default}; +import{_ as e,o as t,c as o,Q as a}from"./chunks/framework.5916b37e.js";const f=JSON.parse('{"title":"Class: Controls","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Controls_copperControls.Controls.md","filePath":"apidist/classes/Controls_copperControls.Controls.md"}'),r={name:"apidist/classes/Controls_copperControls.Controls.md"},n=a("",57),i=[n];function l(s,d,c,h,p,u){return t(),o("div",null,i)}const C=e(r,[["render",l]]);export{f as __pageData,C as default}; diff --git a/assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.7eab65d3.js b/assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.7ebced4e.js similarity index 92% rename from assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.7eab65d3.js rename to assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.7ebced4e.js index fbf60f8..984a0ed 100644 --- a/assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.7eab65d3.js +++ b/assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.7ebced4e.js @@ -1 +1 @@ -import{_ as e,o as r,c as a,Q as t}from"./chunks/framework.5916b37e.js";const f=JSON.parse('{"title":"Class: baseRenderer","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Renderer_baseRenderer.baseRenderer.md","filePath":"apidist/classes/Renderer_baseRenderer.baseRenderer.md"}'),n={name:"apidist/classes/Renderer_baseRenderer.baseRenderer.md"},d=t('

copper3d / Modules / Renderer/baseRenderer / baseRenderer

Class: baseRenderer ​

Renderer/baseRenderer.baseRenderer

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new baseRenderer(container, options?)

Parameters ​

NameType
containerHTMLDivElement
options?ICopperRenderOpt

Defined in ​

src/Renderer/baseRenderer.ts:31

Properties ​

cameraFolder ​

• Private cameraFolder: null | GUI

Defined in ​

src/Renderer/baseRenderer.ts:29

container ​

• container: HTMLDivElement

Defined in ​

src/Renderer/baseRenderer.ts:15

currentScene ​

• currentScene: baseScene

Defined in ​

src/Renderer/baseRenderer.ts:20

gui ​

• gui: null | GUI

Defined in ​

src/Renderer/baseRenderer.ts:17

options ​

• options: undefined | ICopperRenderOpt

Defined in ​

src/Renderer/baseRenderer.ts:23

pmremGenerator ​

• pmremGenerator: PMREMGenerator

Defined in ​

src/Renderer/baseRenderer.ts:21

renderer ​

• renderer: WebGLRenderer

Defined in ​

src/Renderer/baseRenderer.ts:16

state ​

• Private state: stateType

Defined in ​

src/Renderer/baseRenderer.ts:24

stats ​

• stats: Stats

Defined in ​

src/Renderer/baseRenderer.ts:18

visualCtrls ​

• Private visualCtrls: GUIController<object>[] = []

Defined in ​

src/Renderer/baseRenderer.ts:28

visualiseFolder ​

• Private visualiseFolder: null | GUI

Defined in ​

src/Renderer/baseRenderer.ts:27

Methods ​

addGui ​

▸ addGui(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:140

closeGui ​

▸ closeGui(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:132

getCubeMapTexture ​

▸ Private getCubeMapTexture(environment): Promise<unknown>

Parameters ​

NameType
environmentenvironmentType

Returns ​

Promise<unknown>

Defined in ​

src/Renderer/baseRenderer.ts:108

getCurrentScene ​

▸ getCurrentScene(): baseScene

Returns ​

baseScene

Defined in ​

src/Renderer/baseRenderer.ts:126

hideGui ​

▸ hideGui(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:129

init ​

▸ init(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:83

setClearColor ​

▸ setClearColor(clearColor?, alpha?): void

Parameters ​

NameTypeDefault value
clearColornumber0x000000
alphanumber0

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:136

updateEnvironment ​

▸ updateEnvironment(vignette?): void

Parameters ​

NameType
vignette?customMeshType

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:95

updateGui ​

▸ updateGui(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:198

',143),i=[d];function o(s,l,h,c,b,u){return r(),a("div",null,i)}const R=e(n,[["render",o]]);export{f as __pageData,R as default}; +import{_ as e,o as r,c as a,Q as t}from"./chunks/framework.5916b37e.js";const f=JSON.parse('{"title":"Class: baseRenderer","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Renderer_baseRenderer.baseRenderer.md","filePath":"apidist/classes/Renderer_baseRenderer.baseRenderer.md"}'),n={name:"apidist/classes/Renderer_baseRenderer.baseRenderer.md"},d=t('

copper3d / Modules / Renderer/baseRenderer / baseRenderer

Class: baseRenderer ​

Renderer/baseRenderer.baseRenderer

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new baseRenderer(container, options?)

Parameters ​

NameType
containerHTMLDivElement
options?ICopperRenderOpt

Defined in ​

src/Renderer/baseRenderer.ts:31

Properties ​

cameraFolder ​

• Private cameraFolder: null | GUI

Defined in ​

src/Renderer/baseRenderer.ts:29

container ​

• container: HTMLDivElement

Defined in ​

src/Renderer/baseRenderer.ts:15

currentScene ​

• currentScene: baseScene

Defined in ​

src/Renderer/baseRenderer.ts:20

gui ​

• gui: null | GUI

Defined in ​

src/Renderer/baseRenderer.ts:17

options ​

• options: undefined | ICopperRenderOpt

Defined in ​

src/Renderer/baseRenderer.ts:23

pmremGenerator ​

• pmremGenerator: PMREMGenerator

Defined in ​

src/Renderer/baseRenderer.ts:21

renderer ​

• renderer: WebGLRenderer

Defined in ​

src/Renderer/baseRenderer.ts:16

state ​

• Private state: stateType

Defined in ​

src/Renderer/baseRenderer.ts:24

stats ​

• stats: Stats

Defined in ​

src/Renderer/baseRenderer.ts:18

visualCtrls ​

• Private visualCtrls: GUIController<object>[] = []

Defined in ​

src/Renderer/baseRenderer.ts:28

visualiseFolder ​

• Private visualiseFolder: null | GUI

Defined in ​

src/Renderer/baseRenderer.ts:27

Methods ​

addGui ​

▸ addGui(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:140

closeGui ​

▸ closeGui(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:132

getCubeMapTexture ​

▸ Private getCubeMapTexture(environment): Promise<unknown>

Parameters ​

NameType
environmentenvironmentType

Returns ​

Promise<unknown>

Defined in ​

src/Renderer/baseRenderer.ts:108

getCurrentScene ​

▸ getCurrentScene(): baseScene

Returns ​

baseScene

Defined in ​

src/Renderer/baseRenderer.ts:126

hideGui ​

▸ hideGui(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:129

init ​

▸ init(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:83

setClearColor ​

▸ setClearColor(clearColor?, alpha?): void

Parameters ​

NameTypeDefault value
clearColornumber0x000000
alphanumber0

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:136

updateEnvironment ​

▸ updateEnvironment(vignette?): void

Parameters ​

NameType
vignette?customMeshType

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:95

updateGui ​

▸ updateGui(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:198

',143),i=[d];function o(s,l,h,c,u,b){return r(),a("div",null,i)}const R=e(n,[["render",o]]);export{f as __pageData,R as default}; diff --git a/assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.7eab65d3.lean.js b/assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.7ebced4e.lean.js similarity index 87% rename from assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.7eab65d3.lean.js rename to assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.7ebced4e.lean.js index 361d35e..561fed2 100644 --- a/assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.7eab65d3.lean.js +++ b/assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.7ebced4e.lean.js @@ -1 +1 @@ -import{_ as e,o as r,c as a,Q as t}from"./chunks/framework.5916b37e.js";const f=JSON.parse('{"title":"Class: baseRenderer","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Renderer_baseRenderer.baseRenderer.md","filePath":"apidist/classes/Renderer_baseRenderer.baseRenderer.md"}'),n={name:"apidist/classes/Renderer_baseRenderer.baseRenderer.md"},d=t("",143),i=[d];function o(s,l,h,c,b,u){return r(),a("div",null,i)}const R=e(n,[["render",o]]);export{f as __pageData,R as default}; +import{_ as e,o as r,c as a,Q as t}from"./chunks/framework.5916b37e.js";const f=JSON.parse('{"title":"Class: baseRenderer","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Renderer_baseRenderer.baseRenderer.md","filePath":"apidist/classes/Renderer_baseRenderer.baseRenderer.md"}'),n={name:"apidist/classes/Renderer_baseRenderer.baseRenderer.md"},d=t("",143),i=[d];function o(s,l,h,c,u,b){return r(),a("div",null,i)}const R=e(n,[["render",o]]);export{f as __pageData,R as default}; diff --git a/assets/apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.9fb389b4.js b/assets/apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.b390fd45.js similarity index 92% rename from assets/apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.9fb389b4.js rename to assets/apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.b390fd45.js index b7db9f2..5ac1491 100644 --- a/assets/apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.9fb389b4.js +++ b/assets/apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.b390fd45.js @@ -1 +1 @@ -import{_ as e,o as r,c as n,Q as a}from"./chunks/framework.5916b37e.js";const b=JSON.parse('{"title":"Class: copperMSceneRenderer","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Renderer_copperMSceneRenderer.copperMSceneRenderer.md","filePath":"apidist/classes/Renderer_copperMSceneRenderer.copperMSceneRenderer.md"}'),t={name:"apidist/classes/Renderer_copperMSceneRenderer.copperMSceneRenderer.md"},o=a('

copper3d / Modules / Renderer/copperMSceneRenderer / copperMSceneRenderer

Class: copperMSceneRenderer ​

Renderer/copperMSceneRenderer.copperMSceneRenderer

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new copperMSceneRenderer(container, numberOfScene, cameraPosition?)

Parameters ​

NameType
containerHTMLDivElement
numberOfScenenumber
cameraPosition?positionType

Defined in ​

src/Renderer/copperMSceneRenderer.ts:21

Properties ​

cameras ​

• cameras: PerspectiveCamera[]

Defined in ​

src/Renderer/copperMSceneRenderer.ts:12

canvas ​

• canvas: HTMLCanvasElement

Defined in ​

src/Renderer/copperMSceneRenderer.ts:17

container ​

• container: HTMLDivElement

Defined in ​

src/Renderer/copperMSceneRenderer.ts:9

elems ​

• elems: HTMLDivElement[]

Defined in ​

src/Renderer/copperMSceneRenderer.ts:10

numberOfScene ​

• numberOfScene: number

Defined in ​

src/Renderer/copperMSceneRenderer.ts:8

pmremGenerator ​

• pmremGenerator: PMREMGenerator

Defined in ​

src/Renderer/copperMSceneRenderer.ts:19

renderer ​

• renderer: WebGLRenderer

Defined in ​

src/Renderer/copperMSceneRenderer.ts:13

sceneInfos ​

• sceneInfos: copperMScene[]

Defined in ​

src/Renderer/copperMSceneRenderer.ts:18

scenes ​

• scenes: Scene[]

Defined in ​

src/Renderer/copperMSceneRenderer.ts:11

Methods ​

animate ​

▸ animate(): void

Returns ​

void

Defined in ​

src/Renderer/copperMSceneRenderer.ts:139

getCubeMapTexture ​

▸ Private getCubeMapTexture(environment): Promise<unknown>

Parameters ​

NameType
environmentenvironmentType

Returns ​

Promise<unknown>

Defined in ​

src/Renderer/copperMSceneRenderer.ts:76

init ​

▸ init(): void

Returns ​

void

Defined in ​

src/Renderer/copperMSceneRenderer.ts:39

renderSceneInfo ​

▸ renderSceneInfo(sceneInfo): void

Parameters ​

NameType
sceneInfocopperMScene

Returns ​

void

Defined in ​

src/Renderer/copperMSceneRenderer.ts:94

resizeRendererToDisplaySize ​

▸ resizeRendererToDisplaySize(): void

Returns ​

void

Defined in ​

src/Renderer/copperMSceneRenderer.ts:117

updateEnvironment ​

▸ updateEnvironment(sceneIn): void

Parameters ​

NameType
sceneIncopperMScene

Returns ​

void

Defined in ​

src/Renderer/copperMSceneRenderer.ts:64

',110),d=[o];function i(c,s,l,h,p,u){return r(),n("div",null,d)}const m=e(t,[["render",i]]);export{b as __pageData,m as default}; +import{_ as e,o as r,c as n,Q as a}from"./chunks/framework.5916b37e.js";const b=JSON.parse('{"title":"Class: copperMSceneRenderer","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Renderer_copperMSceneRenderer.copperMSceneRenderer.md","filePath":"apidist/classes/Renderer_copperMSceneRenderer.copperMSceneRenderer.md"}'),t={name:"apidist/classes/Renderer_copperMSceneRenderer.copperMSceneRenderer.md"},o=a('

copper3d / Modules / Renderer/copperMSceneRenderer / copperMSceneRenderer

Class: copperMSceneRenderer ​

Renderer/copperMSceneRenderer.copperMSceneRenderer

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new copperMSceneRenderer(container, numberOfScene, cameraPosition?)

Parameters ​

NameType
containerHTMLDivElement
numberOfScenenumber
cameraPosition?positionType

Defined in ​

src/Renderer/copperMSceneRenderer.ts:21

Properties ​

cameras ​

• cameras: PerspectiveCamera[]

Defined in ​

src/Renderer/copperMSceneRenderer.ts:12

canvas ​

• canvas: HTMLCanvasElement

Defined in ​

src/Renderer/copperMSceneRenderer.ts:17

container ​

• container: HTMLDivElement

Defined in ​

src/Renderer/copperMSceneRenderer.ts:9

elems ​

• elems: HTMLDivElement[]

Defined in ​

src/Renderer/copperMSceneRenderer.ts:10

numberOfScene ​

• numberOfScene: number

Defined in ​

src/Renderer/copperMSceneRenderer.ts:8

pmremGenerator ​

• pmremGenerator: PMREMGenerator

Defined in ​

src/Renderer/copperMSceneRenderer.ts:19

renderer ​

• renderer: WebGLRenderer

Defined in ​

src/Renderer/copperMSceneRenderer.ts:13

sceneInfos ​

• sceneInfos: copperMScene[]

Defined in ​

src/Renderer/copperMSceneRenderer.ts:18

scenes ​

• scenes: Scene[]

Defined in ​

src/Renderer/copperMSceneRenderer.ts:11

Methods ​

animate ​

▸ animate(): void

Returns ​

void

Defined in ​

src/Renderer/copperMSceneRenderer.ts:139

getCubeMapTexture ​

▸ Private getCubeMapTexture(environment): Promise<unknown>

Parameters ​

NameType
environmentenvironmentType

Returns ​

Promise<unknown>

Defined in ​

src/Renderer/copperMSceneRenderer.ts:76

init ​

▸ init(): void

Returns ​

void

Defined in ​

src/Renderer/copperMSceneRenderer.ts:39

renderSceneInfo ​

▸ renderSceneInfo(sceneInfo): void

Parameters ​

NameType
sceneInfocopperMScene

Returns ​

void

Defined in ​

src/Renderer/copperMSceneRenderer.ts:94

resizeRendererToDisplaySize ​

▸ resizeRendererToDisplaySize(): void

Returns ​

void

Defined in ​

src/Renderer/copperMSceneRenderer.ts:117

updateEnvironment ​

▸ updateEnvironment(sceneIn): void

Parameters ​

NameType
sceneIncopperMScene

Returns ​

void

Defined in ​

src/Renderer/copperMSceneRenderer.ts:64

',110),d=[o];function i(c,s,l,h,p,u){return r(),n("div",null,d)}const m=e(t,[["render",i]]);export{b as __pageData,m as default}; diff --git a/assets/apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.9fb389b4.lean.js b/assets/apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.b390fd45.lean.js similarity index 100% rename from assets/apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.9fb389b4.lean.js rename to assets/apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.b390fd45.lean.js diff --git a/assets/apidist_classes_Renderer_copperRenderer.copperRenderer.md.0387fed3.js b/assets/apidist_classes_Renderer_copperRenderer.copperRenderer.md.93348682.js similarity index 93% rename from assets/apidist_classes_Renderer_copperRenderer.copperRenderer.md.0387fed3.js rename to assets/apidist_classes_Renderer_copperRenderer.copperRenderer.md.93348682.js index 345af74..fbf1ae7 100644 --- a/assets/apidist_classes_Renderer_copperRenderer.copperRenderer.md.0387fed3.js +++ b/assets/apidist_classes_Renderer_copperRenderer.copperRenderer.md.93348682.js @@ -1 +1 @@ -import{_ as e,o as r,c as a,Q as n}from"./chunks/framework.5916b37e.js";const f=JSON.parse('{"title":"Class: copperRenderer","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Renderer_copperRenderer.copperRenderer.md","filePath":"apidist/classes/Renderer_copperRenderer.copperRenderer.md"}'),t={name:"apidist/classes/Renderer_copperRenderer.copperRenderer.md"},d=n('

copper3d / Modules / Renderer/copperRenderer / copperRenderer

Class: copperRenderer ​

Renderer/copperRenderer.copperRenderer

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new copperRenderer(container, options?)

Parameters ​

NameType
containerHTMLDivElement
options?ICopperRenderOpt

Overrides ​

baseRenderer.constructor

Defined in ​

src/Renderer/copperRenderer.ts:19

Properties ​

container ​

• container: HTMLDivElement

Inherited from ​

baseRenderer.container

Defined in ​

src/Renderer/baseRenderer.ts:15

currentScene ​

• currentScene: baseScene

Inherited from ​

baseRenderer.currentScene

Defined in ​

src/Renderer/baseRenderer.ts:20

delta ​

• Private delta: number = 0

Defined in ​

src/Renderer/copperRenderer.ts:14

fps ​

• Private fps: number = 30

Defined in ​

src/Renderer/copperRenderer.ts:12

gui ​

• gui: null | GUI

Inherited from ​

baseRenderer.gui

Defined in ​

src/Renderer/baseRenderer.ts:17

interval ​

• Private interval: number

Defined in ​

src/Renderer/copperRenderer.ts:15

options ​

• options: undefined | ICopperRenderOpt

Inherited from ​

baseRenderer.options

Defined in ​

src/Renderer/baseRenderer.ts:23

pmremGenerator ​

• pmremGenerator: PMREMGenerator

Inherited from ​

baseRenderer.pmremGenerator

Defined in ​

src/Renderer/baseRenderer.ts:21

preRenderCallbackFunctions ​

• preRenderCallbackFunctions: Function[] = []

Defined in ​

src/Renderer/copperRenderer.ts:17

renderClock ​

• Private renderClock: Clock

Defined in ​

src/Renderer/copperRenderer.ts:13

renderer ​

• renderer: WebGLRenderer

Inherited from ​

baseRenderer.renderer

Defined in ​

src/Renderer/baseRenderer.ts:16

sceneMap ​

• Private sceneMap: SceneMapType = {}

Defined in ​

src/Renderer/copperRenderer.ts:11

stats ​

• stats: Stats

Inherited from ​

baseRenderer.stats

Defined in ​

src/Renderer/baseRenderer.ts:18

Methods ​

addGui ​

▸ addGui(): void

Returns ​

void

Inherited from ​

baseRenderer.addGui

Defined in ​

src/Renderer/baseRenderer.ts:140

addPreRenderCallbackFunction ​

▸ addPreRenderCallbackFunction(callbackFunction): void

Parameters ​

NameType
callbackFunctionFunction

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:58

animate ​

▸ animate(time?): void

Parameters ​

NameType
time?number

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:64

closeGui ​

▸ closeGui(): void

Returns ​

void

Inherited from ​

baseRenderer.closeGui

Defined in ​

src/Renderer/baseRenderer.ts:132

createScene ​

▸ createScene(name): undefined | copperScene

Parameters ​

NameType
namestring

Returns ​

undefined | copperScene

Defined in ​

src/Renderer/copperRenderer.ts:41

getCurrentScene ​

▸ getCurrentScene(): baseScene

Returns ​

baseScene

Inherited from ​

baseRenderer.getCurrentScene

Defined in ​

src/Renderer/baseRenderer.ts:126

getSceneByName ​

▸ getSceneByName(name): copperScene | baseScene | copperMScene

Parameters ​

NameType
namestring

Returns ​

copperScene | baseScene | copperMScene

Defined in ​

src/Renderer/copperRenderer.ts:23

hideGui ​

▸ hideGui(): void

Returns ​

void

Inherited from ​

baseRenderer.hideGui

Defined in ​

src/Renderer/baseRenderer.ts:129

init ​

▸ init(): void

Returns ​

void

Inherited from ​

baseRenderer.init

Defined in ​

src/Renderer/baseRenderer.ts:83

onWindowResize ​

▸ onWindowResize(): void

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:62

render ​

▸ render(): void

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:89

setClearColor ​

▸ setClearColor(clearColor?, alpha?): void

Parameters ​

NameTypeDefault value
clearColornumber0x000000
alphanumber0

Returns ​

void

Inherited from ​

baseRenderer.setClearColor

Defined in ​

src/Renderer/baseRenderer.ts:136

setCurrentScene ​

▸ setCurrentScene(sceneIn): void

Parameters ​

NameType
sceneIncopperScene

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:31

setFPS ​

▸ setFPS(fps): void

Parameters ​

NameType
fpsnumber

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:27

updateEnvironment ​

▸ updateEnvironment(vignette?): void

Parameters ​

NameType
vignette?customMeshType

Returns ​

void

Inherited from ​

baseRenderer.updateEnvironment

Defined in ​

src/Renderer/baseRenderer.ts:95

updateGui ​

▸ updateGui(): void

Returns ​

void

Inherited from ​

baseRenderer.updateGui

Defined in ​

src/Renderer/baseRenderer.ts:198

',244),o=[d];function i(s,l,h,c,p,b){return r(),a("div",null,o)}const R=e(t,[["render",i]]);export{f as __pageData,R as default}; +import{_ as e,o as r,c as a,Q as n}from"./chunks/framework.5916b37e.js";const f=JSON.parse('{"title":"Class: copperRenderer","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Renderer_copperRenderer.copperRenderer.md","filePath":"apidist/classes/Renderer_copperRenderer.copperRenderer.md"}'),t={name:"apidist/classes/Renderer_copperRenderer.copperRenderer.md"},d=n('

copper3d / Modules / Renderer/copperRenderer / copperRenderer

Class: copperRenderer ​

Renderer/copperRenderer.copperRenderer

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new copperRenderer(container, options?)

Parameters ​

NameType
containerHTMLDivElement
options?ICopperRenderOpt

Overrides ​

baseRenderer.constructor

Defined in ​

src/Renderer/copperRenderer.ts:19

Properties ​

container ​

• container: HTMLDivElement

Inherited from ​

baseRenderer.container

Defined in ​

src/Renderer/baseRenderer.ts:15

currentScene ​

• currentScene: baseScene

Inherited from ​

baseRenderer.currentScene

Defined in ​

src/Renderer/baseRenderer.ts:20

delta ​

• Private delta: number = 0

Defined in ​

src/Renderer/copperRenderer.ts:14

fps ​

• Private fps: number = 30

Defined in ​

src/Renderer/copperRenderer.ts:12

gui ​

• gui: null | GUI

Inherited from ​

baseRenderer.gui

Defined in ​

src/Renderer/baseRenderer.ts:17

interval ​

• Private interval: number

Defined in ​

src/Renderer/copperRenderer.ts:15

options ​

• options: undefined | ICopperRenderOpt

Inherited from ​

baseRenderer.options

Defined in ​

src/Renderer/baseRenderer.ts:23

pmremGenerator ​

• pmremGenerator: PMREMGenerator

Inherited from ​

baseRenderer.pmremGenerator

Defined in ​

src/Renderer/baseRenderer.ts:21

preRenderCallbackFunctions ​

• preRenderCallbackFunctions: Function[] = []

Defined in ​

src/Renderer/copperRenderer.ts:17

renderClock ​

• Private renderClock: Clock

Defined in ​

src/Renderer/copperRenderer.ts:13

renderer ​

• renderer: WebGLRenderer

Inherited from ​

baseRenderer.renderer

Defined in ​

src/Renderer/baseRenderer.ts:16

sceneMap ​

• Private sceneMap: SceneMapType = {}

Defined in ​

src/Renderer/copperRenderer.ts:11

stats ​

• stats: Stats

Inherited from ​

baseRenderer.stats

Defined in ​

src/Renderer/baseRenderer.ts:18

Methods ​

addGui ​

▸ addGui(): void

Returns ​

void

Inherited from ​

baseRenderer.addGui

Defined in ​

src/Renderer/baseRenderer.ts:140

addPreRenderCallbackFunction ​

▸ addPreRenderCallbackFunction(callbackFunction): void

Parameters ​

NameType
callbackFunctionFunction

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:58

animate ​

▸ animate(time?): void

Parameters ​

NameType
time?number

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:64

closeGui ​

▸ closeGui(): void

Returns ​

void

Inherited from ​

baseRenderer.closeGui

Defined in ​

src/Renderer/baseRenderer.ts:132

createScene ​

▸ createScene(name): undefined | copperScene

Parameters ​

NameType
namestring

Returns ​

undefined | copperScene

Defined in ​

src/Renderer/copperRenderer.ts:41

getCurrentScene ​

▸ getCurrentScene(): baseScene

Returns ​

baseScene

Inherited from ​

baseRenderer.getCurrentScene

Defined in ​

src/Renderer/baseRenderer.ts:126

getSceneByName ​

▸ getSceneByName(name): copperScene | baseScene | copperMScene

Parameters ​

NameType
namestring

Returns ​

copperScene | baseScene | copperMScene

Defined in ​

src/Renderer/copperRenderer.ts:23

hideGui ​

▸ hideGui(): void

Returns ​

void

Inherited from ​

baseRenderer.hideGui

Defined in ​

src/Renderer/baseRenderer.ts:129

init ​

▸ init(): void

Returns ​

void

Inherited from ​

baseRenderer.init

Defined in ​

src/Renderer/baseRenderer.ts:83

onWindowResize ​

▸ onWindowResize(): void

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:62

render ​

▸ render(): void

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:89

setClearColor ​

▸ setClearColor(clearColor?, alpha?): void

Parameters ​

NameTypeDefault value
clearColornumber0x000000
alphanumber0

Returns ​

void

Inherited from ​

baseRenderer.setClearColor

Defined in ​

src/Renderer/baseRenderer.ts:136

setCurrentScene ​

▸ setCurrentScene(sceneIn): void

Parameters ​

NameType
sceneIncopperScene

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:31

setFPS ​

▸ setFPS(fps): void

Parameters ​

NameType
fpsnumber

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:27

updateEnvironment ​

▸ updateEnvironment(vignette?): void

Parameters ​

NameType
vignette?customMeshType

Returns ​

void

Inherited from ​

baseRenderer.updateEnvironment

Defined in ​

src/Renderer/baseRenderer.ts:95

updateGui ​

▸ updateGui(): void

Returns ​

void

Inherited from ​

baseRenderer.updateGui

Defined in ​

src/Renderer/baseRenderer.ts:198

',244),o=[d];function i(s,l,h,c,p,b){return r(),a("div",null,o)}const R=e(t,[["render",i]]);export{f as __pageData,R as default}; diff --git a/assets/apidist_classes_Renderer_copperRenderer.copperRenderer.md.0387fed3.lean.js b/assets/apidist_classes_Renderer_copperRenderer.copperRenderer.md.93348682.lean.js similarity index 100% rename from assets/apidist_classes_Renderer_copperRenderer.copperRenderer.md.0387fed3.lean.js rename to assets/apidist_classes_Renderer_copperRenderer.copperRenderer.md.93348682.lean.js diff --git a/assets/apidist_classes_Scene_baseScene.baseScene.md.ddd0983d.js b/assets/apidist_classes_Scene_baseScene.baseScene.md.0f72be24.js similarity index 93% rename from assets/apidist_classes_Scene_baseScene.baseScene.md.ddd0983d.js rename to assets/apidist_classes_Scene_baseScene.baseScene.md.0f72be24.js index 4a0522f..8f23970 100644 --- a/assets/apidist_classes_Scene_baseScene.baseScene.md.ddd0983d.js +++ b/assets/apidist_classes_Scene_baseScene.baseScene.md.0f72be24.js @@ -1 +1 @@ -import{_ as e,o as a,c as t,Q as r}from"./chunks/framework.5916b37e.js";const u=JSON.parse('{"title":"Class: baseScene","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Scene_baseScene.baseScene.md","filePath":"apidist/classes/Scene_baseScene.baseScene.md"}'),o={name:"apidist/classes/Scene_baseScene.baseScene.md"},n=r('

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

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

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[]>[] = []

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) => 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
callback(selectMesh: undefined | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>) => 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[]> | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]
mousePositionmouseMovePositionType

Returns ​

Object

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

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[]>

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:184

',478),d=[n];function c(i,l,h,s,m,b){return a(),t("div",null,d)}const p=e(o,[["render",c]]);export{u as __pageData,p as default}; +import{_ as e,o as a,c as t,Q as r}from"./chunks/framework.5916b37e.js";const u=JSON.parse('{"title":"Class: baseScene","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Scene_baseScene.baseScene.md","filePath":"apidist/classes/Scene_baseScene.baseScene.md"}'),o={name:"apidist/classes/Scene_baseScene.baseScene.md"},n=r('

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

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

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[]>[] = []

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) => 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
callback(selectMesh: undefined | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>) => 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[]> | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]
mousePositionmouseMovePositionType

Returns ​

Object

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

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[]>

Returns ​

void

Defined in ​

src/Scene/baseScene.ts:184

',478),c=[n];function d(i,l,h,s,m,b){return a(),t("div",null,c)}const p=e(o,[["render",d]]);export{u as __pageData,p as default}; diff --git a/assets/apidist_classes_Scene_baseScene.baseScene.md.ddd0983d.lean.js b/assets/apidist_classes_Scene_baseScene.baseScene.md.0f72be24.lean.js similarity index 73% rename from assets/apidist_classes_Scene_baseScene.baseScene.md.ddd0983d.lean.js rename to assets/apidist_classes_Scene_baseScene.baseScene.md.0f72be24.lean.js index c1a4b0d..3b59666 100644 --- a/assets/apidist_classes_Scene_baseScene.baseScene.md.ddd0983d.lean.js +++ b/assets/apidist_classes_Scene_baseScene.baseScene.md.0f72be24.lean.js @@ -1 +1 @@ -import{_ as e,o as a,c as t,Q as r}from"./chunks/framework.5916b37e.js";const u=JSON.parse('{"title":"Class: baseScene","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Scene_baseScene.baseScene.md","filePath":"apidist/classes/Scene_baseScene.baseScene.md"}'),o={name:"apidist/classes/Scene_baseScene.baseScene.md"},n=r("",478),d=[n];function c(i,l,h,s,m,b){return a(),t("div",null,d)}const p=e(o,[["render",c]]);export{u as __pageData,p as default}; +import{_ as e,o as a,c as t,Q as r}from"./chunks/framework.5916b37e.js";const u=JSON.parse('{"title":"Class: baseScene","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Scene_baseScene.baseScene.md","filePath":"apidist/classes/Scene_baseScene.baseScene.md"}'),o={name:"apidist/classes/Scene_baseScene.baseScene.md"},n=r("",478),c=[n];function d(i,l,h,s,m,b){return a(),t("div",null,c)}const p=e(o,[["render",d]]);export{u as __pageData,p as default}; diff --git a/assets/apidist_classes_Scene_commonSceneMethod.commonScene.md.cd169d18.js b/assets/apidist_classes_Scene_commonSceneMethod.commonScene.md.035104bc.js similarity index 93% rename from assets/apidist_classes_Scene_commonSceneMethod.commonScene.md.cd169d18.js rename to assets/apidist_classes_Scene_commonSceneMethod.commonScene.md.035104bc.js index de433ff..61e67aa 100644 --- a/assets/apidist_classes_Scene_commonSceneMethod.commonScene.md.cd169d18.js +++ b/assets/apidist_classes_Scene_commonSceneMethod.commonScene.md.035104bc.js @@ -1 +1 @@ -import{_ as e,o as t,c as a,Q as o}from"./chunks/framework.5916b37e.js";const p=JSON.parse('{"title":"Class: commonScene","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Scene_commonSceneMethod.commonScene.md","filePath":"apidist/classes/Scene_commonSceneMethod.commonScene.md"}'),r={name:"apidist/classes/Scene_commonSceneMethod.commonScene.md"},n=o('

copper3d / Modules / Scene/commonSceneMethod / commonScene

Class: commonScene ​

Scene/commonSceneMethod.commonScene

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new commonScene(container, opt?)

Parameters ​

NameType
containerHTMLDivElement
opt?ICopperSceneOpts

Defined in ​

src/Scene/commonSceneMethod.ts:48

Properties ​

camera ​

• camera: PerspectiveCamera | OrthographicCamera

Defined in ​

src/Scene/commonSceneMethod.ts:29

container ​

• container: HTMLDivElement

Defined in ​

src/Scene/commonSceneMethod.ts:27

controls ​

• controls: Copper3dTrackballControls | OrbitControls | TrackballControls

Defined in ​

src/Scene/commonSceneMethod.ts:37

copperOrthographicCamera ​

• copperOrthographicCamera: OrthographicCamera

Defined in ​

src/Scene/commonSceneMethod.ts:32

copperPerspectiveCamera ​

• copperPerspectiveCamera: PerspectiveCamera

Defined in ​

src/Scene/commonSceneMethod.ts:31

depthStep ​

• Protected depthStep: number = 0.4

Defined in ​

src/Scene/commonSceneMethod.ts:44

pickableObjects ​

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

Defined in ​

src/Scene/commonSceneMethod.ts:46

preRenderCallbackFunctions ​

• Protected preRenderCallbackFunctions: preRenderCallbackFunctionType

Defined in ​

src/Scene/commonSceneMethod.ts:42

renderNrrdVolume ​

• Protected renderNrrdVolume: boolean = false

Defined in ​

src/Scene/commonSceneMethod.ts:40

scene ​

• scene: Scene

Defined in ​

src/Scene/commonSceneMethod.ts:28

sort ​

• Protected sort: boolean = true

Defined in ​

src/Scene/commonSceneMethod.ts:43

subCamera ​

• subCamera: null | PerspectiveCamera = null

Defined in ​

src/Scene/commonSceneMethod.ts:36

subCopperControl ​

• Protected subCopperControl: null | Controls = null

Defined in ​

src/Scene/commonSceneMethod.ts:39

subDiv ​

• subDiv: null | HTMLDivElement = null

Defined in ​

src/Scene/commonSceneMethod.ts:34

subRender ​

• Protected subRender: null | WebGLRenderer = null

Defined in ​

src/Scene/commonSceneMethod.ts:38

subScene ​

• subScene: Scene

Defined in ​

src/Scene/commonSceneMethod.ts:35

Methods ​

addObject ​

▸ addObject(obj): void

Parameters ​

NameType
objany

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:107

addPreRenderCallbackFunction ​

▸ addPreRenderCallbackFunction(callbackFunction): number

Parameters ​

NameType
callbackFunctionFunction

Returns ​

number

Defined in ​

src/Scene/commonSceneMethod.ts:122

addSubView ​

▸ addSubView(): HTMLDivElement

create a new sub view to display models

Returns ​

HTMLDivElement

Defined in ​

src/Scene/commonSceneMethod.ts:174

createDemoMesh ​

▸ createDemoMesh(): void

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:96

loadDicom ​

▸ loadDicom(urls, opts?): void

Parameters ​

NameType
urlsstring | string[]
opts?dicomLoaderOptsType

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:198

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

Defined in ​

src/Scene/commonSceneMethod.ts:314

loadNrrdTexture3d ​

▸ loadNrrdTexture3d(url, callback?): void

Parameters ​

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

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:338

loadOBJ ​

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

Parameters ​

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

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:350

pickModel ​

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

Parameters ​

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

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:132

pickSpecifiedModel ​

▸ pickSpecifiedModel(content, mousePosition): Object

Parameters ​

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

Returns ​

Object

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

Defined in ​

src/Scene/commonSceneMethod.ts:154

removePreRenderCallbackFunction ​

▸ removePreRenderCallbackFunction(id): void

Parameters ​

NameType
idnumber

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:128

setDepth ​

▸ setDepth(value): void

Parameters ​

NameType
valuenumber

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:111

setDicomFilesOrder ​

▸ setDicomFilesOrder(value): void

Parameters ​

NameType
value"ascending" | "descending"

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:114

updateControls ​

▸ updateControls(camera): void

Parameters ​

NameType
cameraPerspectiveCamera | OrthographicCamera

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:329

',223),d=[n];function c(i,l,s,h,m,b){return t(),a("div",null,d)}const f=e(r,[["render",c]]);export{p as __pageData,f as default}; +import{_ as e,o as t,c as a,Q as o}from"./chunks/framework.5916b37e.js";const p=JSON.parse('{"title":"Class: commonScene","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Scene_commonSceneMethod.commonScene.md","filePath":"apidist/classes/Scene_commonSceneMethod.commonScene.md"}'),r={name:"apidist/classes/Scene_commonSceneMethod.commonScene.md"},n=o('

copper3d / Modules / Scene/commonSceneMethod / commonScene

Class: commonScene ​

Scene/commonSceneMethod.commonScene

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new commonScene(container, opt?)

Parameters ​

NameType
containerHTMLDivElement
opt?ICopperSceneOpts

Defined in ​

src/Scene/commonSceneMethod.ts:48

Properties ​

camera ​

• camera: PerspectiveCamera | OrthographicCamera

Defined in ​

src/Scene/commonSceneMethod.ts:29

container ​

• container: HTMLDivElement

Defined in ​

src/Scene/commonSceneMethod.ts:27

controls ​

• controls: Copper3dTrackballControls | OrbitControls | TrackballControls

Defined in ​

src/Scene/commonSceneMethod.ts:37

copperOrthographicCamera ​

• copperOrthographicCamera: OrthographicCamera

Defined in ​

src/Scene/commonSceneMethod.ts:32

copperPerspectiveCamera ​

• copperPerspectiveCamera: PerspectiveCamera

Defined in ​

src/Scene/commonSceneMethod.ts:31

depthStep ​

• Protected depthStep: number = 0.4

Defined in ​

src/Scene/commonSceneMethod.ts:44

pickableObjects ​

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

Defined in ​

src/Scene/commonSceneMethod.ts:46

preRenderCallbackFunctions ​

• Protected preRenderCallbackFunctions: preRenderCallbackFunctionType

Defined in ​

src/Scene/commonSceneMethod.ts:42

renderNrrdVolume ​

• Protected renderNrrdVolume: boolean = false

Defined in ​

src/Scene/commonSceneMethod.ts:40

scene ​

• scene: Scene

Defined in ​

src/Scene/commonSceneMethod.ts:28

sort ​

• Protected sort: boolean = true

Defined in ​

src/Scene/commonSceneMethod.ts:43

subCamera ​

• subCamera: null | PerspectiveCamera = null

Defined in ​

src/Scene/commonSceneMethod.ts:36

subCopperControl ​

• Protected subCopperControl: null | Controls = null

Defined in ​

src/Scene/commonSceneMethod.ts:39

subDiv ​

• subDiv: null | HTMLDivElement = null

Defined in ​

src/Scene/commonSceneMethod.ts:34

subRender ​

• Protected subRender: null | WebGLRenderer = null

Defined in ​

src/Scene/commonSceneMethod.ts:38

subScene ​

• subScene: Scene

Defined in ​

src/Scene/commonSceneMethod.ts:35

Methods ​

addObject ​

▸ addObject(obj): void

Parameters ​

NameType
objany

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:107

addPreRenderCallbackFunction ​

▸ addPreRenderCallbackFunction(callbackFunction): number

Parameters ​

NameType
callbackFunctionFunction

Returns ​

number

Defined in ​

src/Scene/commonSceneMethod.ts:122

addSubView ​

▸ addSubView(): HTMLDivElement

create a new sub view to display models

Returns ​

HTMLDivElement

Defined in ​

src/Scene/commonSceneMethod.ts:174

createDemoMesh ​

▸ createDemoMesh(): void

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:96

loadDicom ​

▸ loadDicom(urls, opts?): void

Parameters ​

NameType
urlsstring | string[]
opts?dicomLoaderOptsType

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:198

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

Defined in ​

src/Scene/commonSceneMethod.ts:314

loadNrrdTexture3d ​

▸ loadNrrdTexture3d(url, callback?): void

Parameters ​

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

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:338

loadOBJ ​

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

Parameters ​

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

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:350

pickModel ​

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

Parameters ​

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

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:132

pickSpecifiedModel ​

▸ pickSpecifiedModel(content, mousePosition): Object

Parameters ​

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

Returns ​

Object

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

Defined in ​

src/Scene/commonSceneMethod.ts:154

removePreRenderCallbackFunction ​

▸ removePreRenderCallbackFunction(id): void

Parameters ​

NameType
idnumber

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:128

setDepth ​

▸ setDepth(value): void

Parameters ​

NameType
valuenumber

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:111

setDicomFilesOrder ​

▸ setDicomFilesOrder(value): void

Parameters ​

NameType
value"ascending" | "descending"

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:114

updateControls ​

▸ updateControls(camera): void

Parameters ​

NameType
cameraPerspectiveCamera | OrthographicCamera

Returns ​

void

Defined in ​

src/Scene/commonSceneMethod.ts:329

',223),c=[n];function d(i,l,s,h,m,u){return t(),a("div",null,c)}const f=e(r,[["render",d]]);export{p as __pageData,f as default}; diff --git a/assets/apidist_classes_Scene_commonSceneMethod.commonScene.md.cd169d18.lean.js b/assets/apidist_classes_Scene_commonSceneMethod.commonScene.md.035104bc.lean.js similarity index 75% rename from assets/apidist_classes_Scene_commonSceneMethod.commonScene.md.cd169d18.lean.js rename to assets/apidist_classes_Scene_commonSceneMethod.commonScene.md.035104bc.lean.js index 831ab4a..644c927 100644 --- a/assets/apidist_classes_Scene_commonSceneMethod.commonScene.md.cd169d18.lean.js +++ b/assets/apidist_classes_Scene_commonSceneMethod.commonScene.md.035104bc.lean.js @@ -1 +1 @@ -import{_ as e,o as t,c as a,Q as o}from"./chunks/framework.5916b37e.js";const p=JSON.parse('{"title":"Class: commonScene","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Scene_commonSceneMethod.commonScene.md","filePath":"apidist/classes/Scene_commonSceneMethod.commonScene.md"}'),r={name:"apidist/classes/Scene_commonSceneMethod.commonScene.md"},n=o("",223),d=[n];function c(i,l,s,h,m,b){return t(),a("div",null,d)}const f=e(r,[["render",c]]);export{p as __pageData,f as default}; +import{_ as e,o as t,c as a,Q as o}from"./chunks/framework.5916b37e.js";const p=JSON.parse('{"title":"Class: commonScene","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Scene_commonSceneMethod.commonScene.md","filePath":"apidist/classes/Scene_commonSceneMethod.commonScene.md"}'),r={name:"apidist/classes/Scene_commonSceneMethod.commonScene.md"},n=o("",223),c=[n];function d(i,l,s,h,m,u){return t(),a("div",null,c)}const f=e(r,[["render",d]]);export{p as __pageData,f as default}; diff --git a/assets/apidist_classes_Scene_copperMScene.copperMScene.md.7de27c45.js b/assets/apidist_classes_Scene_copperMScene.copperMScene.md.12821a71.js similarity index 93% rename from assets/apidist_classes_Scene_copperMScene.copperMScene.md.7de27c45.js rename to assets/apidist_classes_Scene_copperMScene.copperMScene.md.12821a71.js index 0eb34df..5501de4 100644 --- a/assets/apidist_classes_Scene_copperMScene.copperMScene.md.7de27c45.js +++ b/assets/apidist_classes_Scene_copperMScene.copperMScene.md.12821a71.js @@ -1 +1 @@ -import{_ as e,o as a,c as t,Q as r}from"./chunks/framework.5916b37e.js";const b=JSON.parse('{"title":"Class: copperMScene","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Scene_copperMScene.copperMScene.md","filePath":"apidist/classes/Scene_copperMScene.copperMScene.md"}'),o={name:"apidist/classes/Scene_copperMScene.copperMScene.md"},n=r('

copper3d / Modules / Scene/copperMScene / copperMScene

Class: copperMScene ​

Scene/copperMScene.copperMScene

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new copperMScene(container, renderer)

Parameters ​

NameType
containerHTMLDivElement
rendererWebGLRenderer

Overrides ​

commonScene.constructor

Defined in ​

src/Scene/copperMScene.ts:51

Properties ​

ambientLight ​

• ambientLight: AmbientLight

Defined in ​

src/Scene/copperMScene.ts:39

camera ​

• camera: PerspectiveCamera | OrthographicCamera

Inherited from ​

commonScene.camera

Defined in ​

src/Scene/commonSceneMethod.ts:29

cameraPositionFlag ​

• cameraPositionFlag: boolean = false

Defined in ​

src/Scene/copperMScene.ts:42

color1 ​

• Private color1: string = "#5454ad"

Defined in ​

src/Scene/copperMScene.ts:46

color2 ​

• Private color2: string = "#18e5a7"

Defined in ​

src/Scene/copperMScene.ts:47

container ​

• container: HTMLDivElement

Overrides ​

commonScene.container

Defined in ​

src/Scene/copperMScene.ts:34

content ​

• content: Group

Defined in ​

src/Scene/copperMScene.ts:43

controls ​

• controls: Copper3dTrackballControls | OrbitControls | TrackballControls

Inherited from ​

commonScene.controls

Defined in ​

src/Scene/commonSceneMethod.ts:37

copperControl ​

• copperControl: Controls

Defined in ​

src/Scene/copperMScene.ts:40

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

gui ​

• gui: GUI

Defined in ​

src/Scene/copperMScene.ts:30

guiContainer ​

• Private guiContainer: HTMLDivElement

Defined in ​

src/Scene/copperMScene.ts:49

isHalfed ​

• isHalfed: boolean = false

Defined in ​

src/Scene/copperMScene.ts:44

lights ​

• Private lights: any[] = []

Defined in ​

src/Scene/copperMScene.ts:48

pickableObjects ​

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

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

scene ​

• scene: Scene

Inherited from ​

commonScene.scene

Defined in ​

src/Scene/commonSceneMethod.ts:28

sceneName ​

• sceneName: string = ""

Defined in ​

src/Scene/copperMScene.ts:36

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

vignette ​

• vignette: customMeshType

Defined in ​

src/Scene/copperMScene.ts:37

Methods ​

addLights ​

▸ addLights(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:299

addObject ​

▸ addObject(obj): void

Parameters ​

NameType
objany

Returns ​

void

Inherited from ​

commonScene.addObject

Defined in ​

src/Scene/commonSceneMethod.ts:107

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

drawWholeNrrd ​

▸ drawWholeNrrd(nrrdSlices): void

Parameters ​

NameType
nrrdSlicesnrrdSliceType

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:284

init ​

▸ init(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:94

loadDicom ​

▸ loadDicom(urls, opts?): void

Parameters ​

NameType
urlsstring | string[]
opts?dicomLoaderOptsType

Returns ​

void

Inherited from ​

commonScene.loadDicom

Defined in ​

src/Scene/commonSceneMethod.ts:198

loadGltf ​

▸ loadGltf(url, callback?): void

Parameters ​

NameType
urlstring
callback?(content: Group) => void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:144

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?): void

Parameters ​

NameType
urlstring
callback?(mesh: Group) => void

Returns ​

void

Overrides ​

commonScene.loadOBJ

Defined in ​

src/Scene/copperMScene.ts:237

loadView ​

▸ loadView(viewpointData): void

Parameters ​

NameType
viewpointDataCameraViewPoint

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:331

loadViewUrl ​

▸ loadViewUrl(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:319

onWindowResize ​

▸ onWindowResize(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:366

pickModel ​

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

Parameters ​

NameType
contentGroup
callback(selectMesh: undefined | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>) => 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[]> | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]
mousePositionmouseMovePositionType

Returns ​

Object

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

Inherited from ​

commonScene.pickSpecifiedModel

Defined in ​

src/Scene/commonSceneMethod.ts:154

removeLights ​

▸ removeLights(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:312

removePreRenderCallbackFunction ​

▸ removePreRenderCallbackFunction(id): void

Parameters ​

NameType
idnumber

Returns ​

void

Overrides ​

commonScene.removePreRenderCallbackFunction

Defined in ​

src/Scene/copperMScene.ts:357

render ​

▸ render(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:390

resetView ​

▸ resetView(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:361

setCameraPosition ​

▸ setCameraPosition(position): void

Parameters ​

NameType
positionpositionType

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:350

setControls ​

▸ setControls(type): void

Parameters ​

NameType
typenumber

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:123

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

updateBackground ​

▸ updateBackground(color1, color2): void

Parameters ​

NameType
color1string
color2string

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:293

updateCamera ​

▸ updateCamera(viewpoint): void

Parameters ​

NameType
viewpointCameraViewPoint

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:345

updateControls ​

▸ updateControls(camera): void

Parameters ​

NameType
cameraPerspectiveCamera | OrthographicCamera

Returns ​

void

Inherited from ​

commonScene.updateControls

Defined in ​

src/Scene/commonSceneMethod.ts:329

',483),c=[n];function i(d,l,h,s,p,m){return a(),t("div",null,c)}const u=e(o,[["render",i]]);export{b as __pageData,u as default}; +import{_ as e,o as a,c as t,Q as r}from"./chunks/framework.5916b37e.js";const u=JSON.parse('{"title":"Class: copperMScene","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Scene_copperMScene.copperMScene.md","filePath":"apidist/classes/Scene_copperMScene.copperMScene.md"}'),o={name:"apidist/classes/Scene_copperMScene.copperMScene.md"},n=r('

copper3d / Modules / Scene/copperMScene / copperMScene

Class: copperMScene ​

Scene/copperMScene.copperMScene

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new copperMScene(container, renderer)

Parameters ​

NameType
containerHTMLDivElement
rendererWebGLRenderer

Overrides ​

commonScene.constructor

Defined in ​

src/Scene/copperMScene.ts:51

Properties ​

ambientLight ​

• ambientLight: AmbientLight

Defined in ​

src/Scene/copperMScene.ts:39

camera ​

• camera: PerspectiveCamera | OrthographicCamera

Inherited from ​

commonScene.camera

Defined in ​

src/Scene/commonSceneMethod.ts:29

cameraPositionFlag ​

• cameraPositionFlag: boolean = false

Defined in ​

src/Scene/copperMScene.ts:42

color1 ​

• Private color1: string = "#5454ad"

Defined in ​

src/Scene/copperMScene.ts:46

color2 ​

• Private color2: string = "#18e5a7"

Defined in ​

src/Scene/copperMScene.ts:47

container ​

• container: HTMLDivElement

Overrides ​

commonScene.container

Defined in ​

src/Scene/copperMScene.ts:34

content ​

• content: Group

Defined in ​

src/Scene/copperMScene.ts:43

controls ​

• controls: Copper3dTrackballControls | OrbitControls | TrackballControls

Inherited from ​

commonScene.controls

Defined in ​

src/Scene/commonSceneMethod.ts:37

copperControl ​

• copperControl: Controls

Defined in ​

src/Scene/copperMScene.ts:40

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

gui ​

• gui: GUI

Defined in ​

src/Scene/copperMScene.ts:30

guiContainer ​

• Private guiContainer: HTMLDivElement

Defined in ​

src/Scene/copperMScene.ts:49

isHalfed ​

• isHalfed: boolean = false

Defined in ​

src/Scene/copperMScene.ts:44

lights ​

• Private lights: any[] = []

Defined in ​

src/Scene/copperMScene.ts:48

pickableObjects ​

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

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

scene ​

• scene: Scene

Inherited from ​

commonScene.scene

Defined in ​

src/Scene/commonSceneMethod.ts:28

sceneName ​

• sceneName: string = ""

Defined in ​

src/Scene/copperMScene.ts:36

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

vignette ​

• vignette: customMeshType

Defined in ​

src/Scene/copperMScene.ts:37

Methods ​

addLights ​

▸ addLights(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:299

addObject ​

▸ addObject(obj): void

Parameters ​

NameType
objany

Returns ​

void

Inherited from ​

commonScene.addObject

Defined in ​

src/Scene/commonSceneMethod.ts:107

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

drawWholeNrrd ​

▸ drawWholeNrrd(nrrdSlices): void

Parameters ​

NameType
nrrdSlicesnrrdSliceType

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:284

init ​

▸ init(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:94

loadDicom ​

▸ loadDicom(urls, opts?): void

Parameters ​

NameType
urlsstring | string[]
opts?dicomLoaderOptsType

Returns ​

void

Inherited from ​

commonScene.loadDicom

Defined in ​

src/Scene/commonSceneMethod.ts:198

loadGltf ​

▸ loadGltf(url, callback?): void

Parameters ​

NameType
urlstring
callback?(content: Group) => void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:144

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?): void

Parameters ​

NameType
urlstring
callback?(mesh: Group) => void

Returns ​

void

Overrides ​

commonScene.loadOBJ

Defined in ​

src/Scene/copperMScene.ts:237

loadView ​

▸ loadView(viewpointData): void

Parameters ​

NameType
viewpointDataCameraViewPoint

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:331

loadViewUrl ​

▸ loadViewUrl(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:319

onWindowResize ​

▸ onWindowResize(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:366

pickModel ​

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

Parameters ​

NameType
contentGroup
callback(selectMesh: undefined | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>) => 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[]> | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>[]
mousePositionmouseMovePositionType

Returns ​

Object

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

Inherited from ​

commonScene.pickSpecifiedModel

Defined in ​

src/Scene/commonSceneMethod.ts:154

removeLights ​

▸ removeLights(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:312

removePreRenderCallbackFunction ​

▸ removePreRenderCallbackFunction(id): void

Parameters ​

NameType
idnumber

Returns ​

void

Overrides ​

commonScene.removePreRenderCallbackFunction

Defined in ​

src/Scene/copperMScene.ts:357

render ​

▸ render(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:390

resetView ​

▸ resetView(): void

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:361

setCameraPosition ​

▸ setCameraPosition(position): void

Parameters ​

NameType
positionpositionType

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:350

setControls ​

▸ setControls(type): void

Parameters ​

NameType
typenumber

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:123

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

updateBackground ​

▸ updateBackground(color1, color2): void

Parameters ​

NameType
color1string
color2string

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:293

updateCamera ​

▸ updateCamera(viewpoint): void

Parameters ​

NameType
viewpointCameraViewPoint

Returns ​

void

Defined in ​

src/Scene/copperMScene.ts:345

updateControls ​

▸ updateControls(camera): void

Parameters ​

NameType
cameraPerspectiveCamera | OrthographicCamera

Returns ​

void

Inherited from ​

commonScene.updateControls

Defined in ​

src/Scene/commonSceneMethod.ts:329

',483),c=[n];function i(d,l,h,s,p,m){return a(),t("div",null,c)}const b=e(o,[["render",i]]);export{u as __pageData,b as default}; diff --git a/assets/apidist_classes_Scene_copperMScene.copperMScene.md.7de27c45.lean.js b/assets/apidist_classes_Scene_copperMScene.copperMScene.md.12821a71.lean.js similarity index 63% rename from assets/apidist_classes_Scene_copperMScene.copperMScene.md.7de27c45.lean.js rename to assets/apidist_classes_Scene_copperMScene.copperMScene.md.12821a71.lean.js index dc5a4e1..72e8c5a 100644 --- a/assets/apidist_classes_Scene_copperMScene.copperMScene.md.7de27c45.lean.js +++ b/assets/apidist_classes_Scene_copperMScene.copperMScene.md.12821a71.lean.js @@ -1 +1 @@ -import{_ as e,o as a,c as t,Q as r}from"./chunks/framework.5916b37e.js";const b=JSON.parse('{"title":"Class: copperMScene","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Scene_copperMScene.copperMScene.md","filePath":"apidist/classes/Scene_copperMScene.copperMScene.md"}'),o={name:"apidist/classes/Scene_copperMScene.copperMScene.md"},n=r("",483),c=[n];function i(d,l,h,s,p,m){return a(),t("div",null,c)}const u=e(o,[["render",i]]);export{b as __pageData,u as default}; +import{_ as e,o as a,c as t,Q as r}from"./chunks/framework.5916b37e.js";const u=JSON.parse('{"title":"Class: copperMScene","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Scene_copperMScene.copperMScene.md","filePath":"apidist/classes/Scene_copperMScene.copperMScene.md"}'),o={name:"apidist/classes/Scene_copperMScene.copperMScene.md"},n=r("",483),c=[n];function i(d,l,h,s,p,m){return a(),t("div",null,c)}const b=e(o,[["render",i]]);export{u as __pageData,b as default}; diff --git a/assets/apidist_classes_Scene_copperScene.copperScene.md.33bcfe1a.js b/assets/apidist_classes_Scene_copperScene.copperScene.md.9d90be6c.js similarity index 94% rename from assets/apidist_classes_Scene_copperScene.copperScene.md.33bcfe1a.js rename to assets/apidist_classes_Scene_copperScene.copperScene.md.9d90be6c.js index eb7b821..dcc5c51 100644 --- a/assets/apidist_classes_Scene_copperScene.copperScene.md.33bcfe1a.js +++ b/assets/apidist_classes_Scene_copperScene.copperScene.md.9d90be6c.js @@ -1 +1 @@ -import{_ as e,o as a,c as t,Q as r}from"./chunks/framework.5916b37e.js";const m=JSON.parse('{"title":"Class: copperScene","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Scene_copperScene.copperScene.md","filePath":"apidist/classes/Scene_copperScene.copperScene.md"}'),n={name:"apidist/classes/Scene_copperScene.copperScene.md"},o=r('

copper3d / Modules / Scene/copperScene / copperScene

Class: copperScene ​

Scene/copperScene.copperScene

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new copperScene(container, renderer, opt?)

Parameters ​

NameType
containerHTMLDivElement
rendererWebGLRenderer
opt?ICopperSceneOpts

Overrides ​

baseScene.constructor

Defined in ​

src/Scene/copperScene.ts:30

Properties ​

ambientLight ​

• ambientLight: AmbientLight

Inherited from ​

baseScene.ambientLight

Defined in ​

src/Scene/baseScene.ts:18

camera ​

• camera: PerspectiveCamera | OrthographicCamera

Inherited from ​

baseScene.camera

Defined in ​

src/Scene/commonSceneMethod.ts:29

cameraPositionFlag ​

• cameraPositionFlag: boolean = false

Inherited from ​

baseScene.cameraPositionFlag

Defined in ​

src/Scene/baseScene.ts:20

clipAction ​

• Private clipAction: any

Defined in ​

src/Scene/copperScene.ts:24

clock ​

• clock: Clock

Defined in ​

src/Scene/copperScene.ts:17

container ​

• container: HTMLDivElement

Inherited from ​

baseScene.container

Defined in ​

src/Scene/commonSceneMethod.ts:27

content ​

• content: Group

Inherited from ​

baseScene.content

Defined in ​

src/Scene/baseScene.ts:21

controls ​

• controls: Copper3dTrackballControls | OrbitControls | TrackballControls

Overrides ​

baseScene.controls

Defined in ​

src/Scene/copperScene.ts:18

copperControl ​

• copperControl: Controls

Inherited from ​

baseScene.copperControl

Defined in ​

src/Scene/baseScene.ts:19

copperOrthographicCamera ​

• copperOrthographicCamera: OrthographicCamera

Inherited from ​

baseScene.copperOrthographicCamera

Defined in ​

src/Scene/commonSceneMethod.ts:32

copperPerspectiveCamera ​

• copperPerspectiveCamera: PerspectiveCamera

Inherited from ​

baseScene.copperPerspectiveCamera

Defined in ​

src/Scene/commonSceneMethod.ts:31

depthStep ​

• Protected depthStep: number = 0.4

Inherited from ​

baseScene.depthStep

Defined in ​

src/Scene/commonSceneMethod.ts:44

directionalLight ​

• directionalLight: DirectionalLight

Inherited from ​

baseScene.directionalLight

Defined in ​

src/Scene/baseScene.ts:17

exportContent ​

• exportContent: Group

Inherited from ​

baseScene.exportContent

Defined in ​

src/Scene/baseScene.ts:22

isHalfed ​

• isHalfed: boolean = false

Inherited from ​

baseScene.isHalfed

Defined in ​

src/Scene/baseScene.ts:23

mixer ​

• Private mixer: null | AnimationMixer = null

Defined in ​

src/Scene/copperScene.ts:21

modelReady ​

• Private modelReady: boolean = false

Defined in ​

src/Scene/copperScene.ts:23

pickableObjects ​

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

Inherited from ​

baseScene.pickableObjects

Defined in ​

src/Scene/commonSceneMethod.ts:46

playRate ​

• Private playRate: number = 1.0

Defined in ​

src/Scene/copperScene.ts:22

preRenderCallbackFunctions ​

• Protected preRenderCallbackFunctions: preRenderCallbackFunctionType

Inherited from ​

baseScene.preRenderCallbackFunctions

Defined in ​

src/Scene/commonSceneMethod.ts:42

renderNrrdVolume ​

• Protected renderNrrdVolume: boolean = false

Inherited from ​

baseScene.renderNrrdVolume

Defined in ​

src/Scene/commonSceneMethod.ts:40

renderer ​

• renderer: WebGLRenderer

Inherited from ​

baseScene.renderer

Defined in ​

src/Scene/baseScene.ts:12

scene ​

• scene: Scene

Inherited from ​

baseScene.scene

Defined in ​

src/Scene/commonSceneMethod.ts:28

sceneName ​

• sceneName: string = ""

Inherited from ​

baseScene.sceneName

Defined in ​

src/Scene/baseScene.ts:15

sort ​

• Protected sort: boolean = true

Inherited from ​

baseScene.sort

Defined in ​

src/Scene/commonSceneMethod.ts:43

subCamera ​

• subCamera: null | PerspectiveCamera = null

Inherited from ​

baseScene.subCamera

Defined in ​

src/Scene/commonSceneMethod.ts:36

subCopperControl ​

• Protected subCopperControl: null | Controls = null

Inherited from ​

baseScene.subCopperControl

Defined in ​

src/Scene/commonSceneMethod.ts:39

subDiv ​

• subDiv: null | HTMLDivElement = null

Inherited from ​

baseScene.subDiv

Defined in ​

src/Scene/commonSceneMethod.ts:34

subRender ​

• Protected subRender: null | WebGLRenderer = null

Inherited from ​

baseScene.subRender

Defined in ​

src/Scene/commonSceneMethod.ts:38

subScene ​

• subScene: Scene

Inherited from ​

baseScene.subScene

Defined in ​

src/Scene/commonSceneMethod.ts:35

texture2dMesh ​

• Private texture2dMesh: null | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]> = null

Defined in ​

src/Scene/copperScene.ts:28

viewPoint ​

• viewPoint: CameraViewPoint

Inherited from ​

baseScene.viewPoint

Defined in ​

src/Scene/baseScene.ts:24

vignette ​

• vignette: undefined | customMeshType

Inherited from ​

baseScene.vignette

Defined in ​

src/Scene/baseScene.ts:16

Methods ​

addLights ​

▸ addLights(): void

Returns ​

void

Inherited from ​

baseScene.addLights

Defined in ​

src/Scene/baseScene.ts:138

addObject ​

▸ addObject(obj): void

Parameters ​

NameType
objany

Returns ​

void

Inherited from ​

baseScene.addObject

Defined in ​

src/Scene/baseScene.ts:134

addPreRenderCallbackFunction ​

▸ addPreRenderCallbackFunction(callbackFunction): number

Parameters ​

NameType
callbackFunctionFunction

Returns ​

number

Inherited from ​

baseScene.addPreRenderCallbackFunction

Defined in ​

src/Scene/commonSceneMethod.ts:122

addSubView ​

▸ addSubView(): HTMLDivElement

create a new sub view to display models

Returns ​

HTMLDivElement

Inherited from ​

baseScene.addSubView

Defined in ​

src/Scene/commonSceneMethod.ts:174

createDemoMesh ​

▸ createDemoMesh(): void

Returns ​

void

Inherited from ​

baseScene.createDemoMesh

Defined in ​

src/Scene/commonSceneMethod.ts:96

getCurrentMixer ​

▸ getCurrentMixer(): null | AnimationMixer

Returns ​

null | AnimationMixer

Defined in ​

src/Scene/copperScene.ts:327

getCurrentTime ​

▸ getCurrentTime(): number

Returns ​

number

Defined in ​

src/Scene/copperScene.ts:319

getDefaultViewPoint ​

▸ getDefaultViewPoint(): CameraViewPoint

Returns ​

CameraViewPoint

Inherited from ​

baseScene.getDefaultViewPoint

Defined in ​

src/Scene/baseScene.ts:109

getPlayRate ​

▸ getPlayRate(): number

Returns ​

number

Defined in ​

src/Scene/copperScene.ts:292

init ​

▸ init(): void

Returns ​

void

Inherited from ​

baseScene.init

Defined in ​

src/Scene/baseScene.ts:54

loadDicom ​

▸ loadDicom(urls, opts?): void

Parameters ​

NameType
urlsstring | string[]
opts?dicomLoaderOptsType

Returns ​

void

Inherited from ​

baseScene.loadDicom

Defined in ​

src/Scene/commonSceneMethod.ts:198

loadGltf ​

▸ loadGltf(url, callback?): void

Parameters ​

NameType
urlstring
callback?(content: Group) => void

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:56

loadMetadataUrl ​

▸ loadMetadataUrl(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Inherited from ​

baseScene.loadMetadataUrl

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 ​

baseScene.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 ​

baseScene.loadNrrdTexture3d

Defined in ​

src/Scene/commonSceneMethod.ts:338

loadOBJ ​

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

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.loadOBJ

Defined in ​

src/Scene/commonSceneMethod.ts:350

loadView ​

▸ loadView(viewpointData): void

Parameters ​

NameType
viewpointDataCameraViewPoint

Returns ​

void

Inherited from ​

baseScene.loadView

Defined in ​

src/Scene/baseScene.ts:97

loadViewUrl ​

▸ loadViewUrl(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Inherited from ​

baseScene.loadViewUrl

Defined in ​

src/Scene/baseScene.ts:85

loadVtk ​

▸ loadVtk(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:146

loadVtks ​

▸ loadVtks(models): void

Parameters ​

NameType
modelsvtkModels[]

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:150

onRenderCameraChange ​

▸ onRenderCameraChange(): void

Returns ​

void

Overrides ​

baseScene.onRenderCameraChange

Defined in ​

src/Scene/copperScene.ts:344

onWindowResize ​

▸ onWindowResize(): void

Returns ​

void

Inherited from ​

baseScene.onWindowResize

Defined in ​

src/Scene/baseScene.ts:199

pickModel ​

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

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.pickModel

Defined in ​

src/Scene/commonSceneMethod.ts:132

pickSpecifiedModel ​

▸ pickSpecifiedModel(content, mousePosition): Object

Parameters ​

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

Returns ​

Object

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

Inherited from ​

baseScene.pickSpecifiedModel

Defined in ​

src/Scene/commonSceneMethod.ts:154

removeLights ​

▸ removeLights(): void

Returns ​

void

Inherited from ​

baseScene.removeLights

Defined in ​

src/Scene/baseScene.ts:151

removePreRenderCallbackFunction ​

▸ removePreRenderCallbackFunction(id): void

Parameters ​

NameType
idnumber

Returns ​

void

Inherited from ​

baseScene.removePreRenderCallbackFunction

Defined in ​

src/Scene/commonSceneMethod.ts:128

render ​

▸ render(time?): void

Parameters ​

NameType
time?number

Returns ​

void

Overrides ​

baseScene.render

Defined in ​

src/Scene/copperScene.ts:359

resetView ​

▸ resetView(): void

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:309

setDepth ​

▸ setDepth(value): void

Parameters ​

NameType
valuenumber

Returns ​

void

Inherited from ​

baseScene.setDepth

Defined in ​

src/Scene/commonSceneMethod.ts:111

setDicomFilesOrder ​

▸ setDicomFilesOrder(value): void

Parameters ​

NameType
value"ascending" | "descending"

Returns ​

void

Inherited from ​

baseScene.setDicomFilesOrder

Defined in ​

src/Scene/commonSceneMethod.ts:114

setModelPosition ​

▸ setModelPosition(model, position): void

Parameters ​

NameType
modelGroup | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>
positionObject
position.x?number
position.y?number
position.z?number

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:300

setPlayRate ​

▸ setPlayRate(playRate): void

Parameters ​

NameType
playRatenumber

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:296

setViewPoint ​

▸ setViewPoint(camera, target?): CameraViewPoint

Parameters ​

NameType
cameraPerspectiveCamera
target?number[]

Returns ​

CameraViewPoint

Inherited from ​

baseScene.setViewPoint

Defined in ​

src/Scene/baseScene.ts:113

texture2d ​

▸ texture2d(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:255

updateBackground ​

▸ updateBackground(color1, color2): void

Parameters ​

NameType
color1string
color2string

Returns ​

void

Inherited from ​

baseScene.updateBackground

Defined in ​

src/Scene/baseScene.ts:179

updateCamera ​

▸ updateCamera(viewpoint): void

Parameters ​

NameType
viewpointCameraViewPoint

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:314

updateControls ​

▸ updateControls(camera): void

Parameters ​

NameType
cameraPerspectiveCamera | OrthographicCamera

Returns ​

void

Overrides ​

baseScene.updateControls

Defined in ​

src/Scene/copperScene.ts:331

updateDisplay ​

▸ updateDisplay(state): void

Parameters ​

NameType
statebaseStateType

Returns ​

void

Inherited from ​

baseScene.updateDisplay

Defined in ​

src/Scene/baseScene.ts:174

updateLights ​

▸ updateLights(state): void

Parameters ​

NameType
statebaseStateType

Returns ​

void

Inherited from ​

baseScene.updateLights

Defined in ​

src/Scene/baseScene.ts:157

updateModelChildrenVisualisation ​

▸ updateModelChildrenVisualisation(child): void

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.updateModelChildrenVisualisation

Defined in ​

src/Scene/baseScene.ts:184

',636),i=[o];function d(c,l,h,s,p,b){return a(),t("div",null,i)}const u=e(n,[["render",d]]);export{m as __pageData,u as default}; +import{_ as e,o as a,c as t,Q as r}from"./chunks/framework.5916b37e.js";const m=JSON.parse('{"title":"Class: copperScene","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Scene_copperScene.copperScene.md","filePath":"apidist/classes/Scene_copperScene.copperScene.md"}'),n={name:"apidist/classes/Scene_copperScene.copperScene.md"},o=r('

copper3d / Modules / Scene/copperScene / copperScene

Class: copperScene ​

Scene/copperScene.copperScene

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new copperScene(container, renderer, opt?)

Parameters ​

NameType
containerHTMLDivElement
rendererWebGLRenderer
opt?ICopperSceneOpts

Overrides ​

baseScene.constructor

Defined in ​

src/Scene/copperScene.ts:30

Properties ​

ambientLight ​

• ambientLight: AmbientLight

Inherited from ​

baseScene.ambientLight

Defined in ​

src/Scene/baseScene.ts:18

camera ​

• camera: PerspectiveCamera | OrthographicCamera

Inherited from ​

baseScene.camera

Defined in ​

src/Scene/commonSceneMethod.ts:29

cameraPositionFlag ​

• cameraPositionFlag: boolean = false

Inherited from ​

baseScene.cameraPositionFlag

Defined in ​

src/Scene/baseScene.ts:20

clipAction ​

• Private clipAction: any

Defined in ​

src/Scene/copperScene.ts:24

clock ​

• clock: Clock

Defined in ​

src/Scene/copperScene.ts:17

container ​

• container: HTMLDivElement

Inherited from ​

baseScene.container

Defined in ​

src/Scene/commonSceneMethod.ts:27

content ​

• content: Group

Inherited from ​

baseScene.content

Defined in ​

src/Scene/baseScene.ts:21

controls ​

• controls: Copper3dTrackballControls | OrbitControls | TrackballControls

Overrides ​

baseScene.controls

Defined in ​

src/Scene/copperScene.ts:18

copperControl ​

• copperControl: Controls

Inherited from ​

baseScene.copperControl

Defined in ​

src/Scene/baseScene.ts:19

copperOrthographicCamera ​

• copperOrthographicCamera: OrthographicCamera

Inherited from ​

baseScene.copperOrthographicCamera

Defined in ​

src/Scene/commonSceneMethod.ts:32

copperPerspectiveCamera ​

• copperPerspectiveCamera: PerspectiveCamera

Inherited from ​

baseScene.copperPerspectiveCamera

Defined in ​

src/Scene/commonSceneMethod.ts:31

depthStep ​

• Protected depthStep: number = 0.4

Inherited from ​

baseScene.depthStep

Defined in ​

src/Scene/commonSceneMethod.ts:44

directionalLight ​

• directionalLight: DirectionalLight

Inherited from ​

baseScene.directionalLight

Defined in ​

src/Scene/baseScene.ts:17

exportContent ​

• exportContent: Group

Inherited from ​

baseScene.exportContent

Defined in ​

src/Scene/baseScene.ts:22

isHalfed ​

• isHalfed: boolean = false

Inherited from ​

baseScene.isHalfed

Defined in ​

src/Scene/baseScene.ts:23

mixer ​

• Private mixer: null | AnimationMixer = null

Defined in ​

src/Scene/copperScene.ts:21

modelReady ​

• Private modelReady: boolean = false

Defined in ​

src/Scene/copperScene.ts:23

pickableObjects ​

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

Inherited from ​

baseScene.pickableObjects

Defined in ​

src/Scene/commonSceneMethod.ts:46

playRate ​

• Private playRate: number = 1.0

Defined in ​

src/Scene/copperScene.ts:22

preRenderCallbackFunctions ​

• Protected preRenderCallbackFunctions: preRenderCallbackFunctionType

Inherited from ​

baseScene.preRenderCallbackFunctions

Defined in ​

src/Scene/commonSceneMethod.ts:42

renderNrrdVolume ​

• Protected renderNrrdVolume: boolean = false

Inherited from ​

baseScene.renderNrrdVolume

Defined in ​

src/Scene/commonSceneMethod.ts:40

renderer ​

• renderer: WebGLRenderer

Inherited from ​

baseScene.renderer

Defined in ​

src/Scene/baseScene.ts:12

scene ​

• scene: Scene

Inherited from ​

baseScene.scene

Defined in ​

src/Scene/commonSceneMethod.ts:28

sceneName ​

• sceneName: string = ""

Inherited from ​

baseScene.sceneName

Defined in ​

src/Scene/baseScene.ts:15

sort ​

• Protected sort: boolean = true

Inherited from ​

baseScene.sort

Defined in ​

src/Scene/commonSceneMethod.ts:43

subCamera ​

• subCamera: null | PerspectiveCamera = null

Inherited from ​

baseScene.subCamera

Defined in ​

src/Scene/commonSceneMethod.ts:36

subCopperControl ​

• Protected subCopperControl: null | Controls = null

Inherited from ​

baseScene.subCopperControl

Defined in ​

src/Scene/commonSceneMethod.ts:39

subDiv ​

• subDiv: null | HTMLDivElement = null

Inherited from ​

baseScene.subDiv

Defined in ​

src/Scene/commonSceneMethod.ts:34

subRender ​

• Protected subRender: null | WebGLRenderer = null

Inherited from ​

baseScene.subRender

Defined in ​

src/Scene/commonSceneMethod.ts:38

subScene ​

• subScene: Scene

Inherited from ​

baseScene.subScene

Defined in ​

src/Scene/commonSceneMethod.ts:35

texture2dMesh ​

• Private texture2dMesh: null | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]> = null

Defined in ​

src/Scene/copperScene.ts:28

viewPoint ​

• viewPoint: CameraViewPoint

Inherited from ​

baseScene.viewPoint

Defined in ​

src/Scene/baseScene.ts:24

vignette ​

• vignette: undefined | customMeshType

Inherited from ​

baseScene.vignette

Defined in ​

src/Scene/baseScene.ts:16

Methods ​

addLights ​

▸ addLights(): void

Returns ​

void

Inherited from ​

baseScene.addLights

Defined in ​

src/Scene/baseScene.ts:138

addObject ​

▸ addObject(obj): void

Parameters ​

NameType
objany

Returns ​

void

Inherited from ​

baseScene.addObject

Defined in ​

src/Scene/baseScene.ts:134

addPreRenderCallbackFunction ​

▸ addPreRenderCallbackFunction(callbackFunction): number

Parameters ​

NameType
callbackFunctionFunction

Returns ​

number

Inherited from ​

baseScene.addPreRenderCallbackFunction

Defined in ​

src/Scene/commonSceneMethod.ts:122

addSubView ​

▸ addSubView(): HTMLDivElement

create a new sub view to display models

Returns ​

HTMLDivElement

Inherited from ​

baseScene.addSubView

Defined in ​

src/Scene/commonSceneMethod.ts:174

createDemoMesh ​

▸ createDemoMesh(): void

Returns ​

void

Inherited from ​

baseScene.createDemoMesh

Defined in ​

src/Scene/commonSceneMethod.ts:96

getCurrentMixer ​

▸ getCurrentMixer(): null | AnimationMixer

Returns ​

null | AnimationMixer

Defined in ​

src/Scene/copperScene.ts:327

getCurrentTime ​

▸ getCurrentTime(): number

Returns ​

number

Defined in ​

src/Scene/copperScene.ts:319

getDefaultViewPoint ​

▸ getDefaultViewPoint(): CameraViewPoint

Returns ​

CameraViewPoint

Inherited from ​

baseScene.getDefaultViewPoint

Defined in ​

src/Scene/baseScene.ts:109

getPlayRate ​

▸ getPlayRate(): number

Returns ​

number

Defined in ​

src/Scene/copperScene.ts:292

init ​

▸ init(): void

Returns ​

void

Inherited from ​

baseScene.init

Defined in ​

src/Scene/baseScene.ts:54

loadDicom ​

▸ loadDicom(urls, opts?): void

Parameters ​

NameType
urlsstring | string[]
opts?dicomLoaderOptsType

Returns ​

void

Inherited from ​

baseScene.loadDicom

Defined in ​

src/Scene/commonSceneMethod.ts:198

loadGltf ​

▸ loadGltf(url, callback?): void

Parameters ​

NameType
urlstring
callback?(content: Group) => void

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:56

loadMetadataUrl ​

▸ loadMetadataUrl(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Inherited from ​

baseScene.loadMetadataUrl

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 ​

baseScene.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 ​

baseScene.loadNrrdTexture3d

Defined in ​

src/Scene/commonSceneMethod.ts:338

loadOBJ ​

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

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.loadOBJ

Defined in ​

src/Scene/commonSceneMethod.ts:350

loadView ​

▸ loadView(viewpointData): void

Parameters ​

NameType
viewpointDataCameraViewPoint

Returns ​

void

Inherited from ​

baseScene.loadView

Defined in ​

src/Scene/baseScene.ts:97

loadViewUrl ​

▸ loadViewUrl(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Inherited from ​

baseScene.loadViewUrl

Defined in ​

src/Scene/baseScene.ts:85

loadVtk ​

▸ loadVtk(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:146

loadVtks ​

▸ loadVtks(models): void

Parameters ​

NameType
modelsvtkModels[]

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:150

onRenderCameraChange ​

▸ onRenderCameraChange(): void

Returns ​

void

Overrides ​

baseScene.onRenderCameraChange

Defined in ​

src/Scene/copperScene.ts:344

onWindowResize ​

▸ onWindowResize(): void

Returns ​

void

Inherited from ​

baseScene.onWindowResize

Defined in ​

src/Scene/baseScene.ts:199

pickModel ​

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

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.pickModel

Defined in ​

src/Scene/commonSceneMethod.ts:132

pickSpecifiedModel ​

▸ pickSpecifiedModel(content, mousePosition): Object

Parameters ​

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

Returns ​

Object

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

Inherited from ​

baseScene.pickSpecifiedModel

Defined in ​

src/Scene/commonSceneMethod.ts:154

removeLights ​

▸ removeLights(): void

Returns ​

void

Inherited from ​

baseScene.removeLights

Defined in ​

src/Scene/baseScene.ts:151

removePreRenderCallbackFunction ​

▸ removePreRenderCallbackFunction(id): void

Parameters ​

NameType
idnumber

Returns ​

void

Inherited from ​

baseScene.removePreRenderCallbackFunction

Defined in ​

src/Scene/commonSceneMethod.ts:128

render ​

▸ render(time?): void

Parameters ​

NameType
time?number

Returns ​

void

Overrides ​

baseScene.render

Defined in ​

src/Scene/copperScene.ts:359

resetView ​

▸ resetView(): void

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:309

setDepth ​

▸ setDepth(value): void

Parameters ​

NameType
valuenumber

Returns ​

void

Inherited from ​

baseScene.setDepth

Defined in ​

src/Scene/commonSceneMethod.ts:111

setDicomFilesOrder ​

▸ setDicomFilesOrder(value): void

Parameters ​

NameType
value"ascending" | "descending"

Returns ​

void

Inherited from ​

baseScene.setDicomFilesOrder

Defined in ​

src/Scene/commonSceneMethod.ts:114

setModelPosition ​

▸ setModelPosition(model, position): void

Parameters ​

NameType
modelGroup | Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[]>
positionObject
position.x?number
position.y?number
position.z?number

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:300

setPlayRate ​

▸ setPlayRate(playRate): void

Parameters ​

NameType
playRatenumber

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:296

setViewPoint ​

▸ setViewPoint(camera, target?): CameraViewPoint

Parameters ​

NameType
cameraPerspectiveCamera
target?number[]

Returns ​

CameraViewPoint

Inherited from ​

baseScene.setViewPoint

Defined in ​

src/Scene/baseScene.ts:113

texture2d ​

▸ texture2d(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:255

updateBackground ​

▸ updateBackground(color1, color2): void

Parameters ​

NameType
color1string
color2string

Returns ​

void

Inherited from ​

baseScene.updateBackground

Defined in ​

src/Scene/baseScene.ts:179

updateCamera ​

▸ updateCamera(viewpoint): void

Parameters ​

NameType
viewpointCameraViewPoint

Returns ​

void

Defined in ​

src/Scene/copperScene.ts:314

updateControls ​

▸ updateControls(camera): void

Parameters ​

NameType
cameraPerspectiveCamera | OrthographicCamera

Returns ​

void

Overrides ​

baseScene.updateControls

Defined in ​

src/Scene/copperScene.ts:331

updateDisplay ​

▸ updateDisplay(state): void

Parameters ​

NameType
statebaseStateType

Returns ​

void

Inherited from ​

baseScene.updateDisplay

Defined in ​

src/Scene/baseScene.ts:174

updateLights ​

▸ updateLights(state): void

Parameters ​

NameType
statebaseStateType

Returns ​

void

Inherited from ​

baseScene.updateLights

Defined in ​

src/Scene/baseScene.ts:157

updateModelChildrenVisualisation ​

▸ updateModelChildrenVisualisation(child): void

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.updateModelChildrenVisualisation

Defined in ​

src/Scene/baseScene.ts:184

',636),i=[o];function c(d,l,h,s,p,b){return a(),t("div",null,i)}const u=e(n,[["render",c]]);export{m as __pageData,u as default}; diff --git a/assets/apidist_classes_Scene_copperScene.copperScene.md.33bcfe1a.lean.js b/assets/apidist_classes_Scene_copperScene.copperScene.md.9d90be6c.lean.js similarity index 77% rename from assets/apidist_classes_Scene_copperScene.copperScene.md.33bcfe1a.lean.js rename to assets/apidist_classes_Scene_copperScene.copperScene.md.9d90be6c.lean.js index 594d400..2367d39 100644 --- a/assets/apidist_classes_Scene_copperScene.copperScene.md.33bcfe1a.lean.js +++ b/assets/apidist_classes_Scene_copperScene.copperScene.md.9d90be6c.lean.js @@ -1 +1 @@ -import{_ as e,o as a,c as t,Q as r}from"./chunks/framework.5916b37e.js";const m=JSON.parse('{"title":"Class: copperScene","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Scene_copperScene.copperScene.md","filePath":"apidist/classes/Scene_copperScene.copperScene.md"}'),n={name:"apidist/classes/Scene_copperScene.copperScene.md"},o=r("",636),i=[o];function d(c,l,h,s,p,b){return a(),t("div",null,i)}const u=e(n,[["render",d]]);export{m as __pageData,u as default}; +import{_ as e,o as a,c as t,Q as r}from"./chunks/framework.5916b37e.js";const m=JSON.parse('{"title":"Class: copperScene","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Scene_copperScene.copperScene.md","filePath":"apidist/classes/Scene_copperScene.copperScene.md"}'),n={name:"apidist/classes/Scene_copperScene.copperScene.md"},o=r("",636),i=[o];function c(d,l,h,s,p,b){return a(),t("div",null,i)}const u=e(n,[["render",c]]);export{m as __pageData,u as default}; diff --git a/assets/apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.fe22f3a8.js b/assets/apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.8ce60bcb.js similarity index 94% rename from assets/apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.fe22f3a8.js rename to assets/apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.8ce60bcb.js index 61f5859..3473948 100644 --- a/assets/apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.fe22f3a8.js +++ b/assets/apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.8ce60bcb.js @@ -1 +1 @@ -import{_ as e,o as a,c as r,Q as t}from"./chunks/framework.5916b37e.js";const f=JSON.parse('{"title":"Class: copperSceneOnDemond","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Scene_copperSceneOnDemond.copperSceneOnDemond.md","filePath":"apidist/classes/Scene_copperSceneOnDemond.copperSceneOnDemond.md"}'),n={name:"apidist/classes/Scene_copperSceneOnDemond.copperSceneOnDemond.md"},o=t('

copper3d / Modules / Scene/copperSceneOnDemond / copperSceneOnDemond

Class: copperSceneOnDemond ​

Scene/copperSceneOnDemond.copperSceneOnDemond

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new copperSceneOnDemond(container, renderer)

Parameters ​

NameType
containerHTMLDivElement
rendererWebGLRenderer

Overrides ​

baseScene.constructor

Defined in ​

src/Scene/copperSceneOnDemond.ts:12

Properties ​

ambientLight ​

• ambientLight: AmbientLight

Inherited from ​

baseScene.ambientLight

Defined in ​

src/Scene/baseScene.ts:18

camera ​

• camera: PerspectiveCamera | OrthographicCamera

Inherited from ​

baseScene.camera

Defined in ​

src/Scene/commonSceneMethod.ts:29

cameraPositionFlag ​

• cameraPositionFlag: boolean = false

Inherited from ​

baseScene.cameraPositionFlag

Defined in ​

src/Scene/baseScene.ts:20

container ​

• container: HTMLDivElement

Inherited from ​

baseScene.container

Defined in ​

src/Scene/commonSceneMethod.ts:27

content ​

• content: Group

Inherited from ​

baseScene.content

Defined in ​

src/Scene/baseScene.ts:21

controls ​

• controls: OrbitControls

Overrides ​

baseScene.controls

Defined in ​

src/Scene/copperSceneOnDemond.ts:8

copperControl ​

• copperControl: Controls

Inherited from ​

baseScene.copperControl

Defined in ​

src/Scene/baseScene.ts:19

copperOrthographicCamera ​

• copperOrthographicCamera: OrthographicCamera

Inherited from ​

baseScene.copperOrthographicCamera

Defined in ​

src/Scene/commonSceneMethod.ts:32

copperPerspectiveCamera ​

• copperPerspectiveCamera: PerspectiveCamera

Inherited from ​

baseScene.copperPerspectiveCamera

Defined in ​

src/Scene/commonSceneMethod.ts:31

depthStep ​

• Protected depthStep: number = 0.4

Inherited from ​

baseScene.depthStep

Defined in ​

src/Scene/commonSceneMethod.ts:44

directionalLight ​

• directionalLight: DirectionalLight

Inherited from ​

baseScene.directionalLight

Defined in ​

src/Scene/baseScene.ts:17

exportContent ​

• exportContent: Group

Inherited from ​

baseScene.exportContent

Defined in ​

src/Scene/baseScene.ts:22

isHalfed ​

• isHalfed: boolean = false

Inherited from ​

baseScene.isHalfed

Defined in ​

src/Scene/baseScene.ts:23

isResize ​

• isResize: boolean = false

Defined in ​

src/Scene/copperSceneOnDemond.ts:10

pickableObjects ​

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

Inherited from ​

baseScene.pickableObjects

Defined in ​

src/Scene/commonSceneMethod.ts:46

preRenderCallbackFunctions ​

• Protected preRenderCallbackFunctions: preRenderCallbackFunctionType

Inherited from ​

baseScene.preRenderCallbackFunctions

Defined in ​

src/Scene/commonSceneMethod.ts:42

renderNrrdVolume ​

• Protected renderNrrdVolume: boolean = false

Inherited from ​

baseScene.renderNrrdVolume

Defined in ​

src/Scene/commonSceneMethod.ts:40

renderRequested ​

• renderRequested: undefined | boolean = false

Defined in ​

src/Scene/copperSceneOnDemond.ts:9

renderer ​

• renderer: WebGLRenderer

Inherited from ​

baseScene.renderer

Defined in ​

src/Scene/baseScene.ts:12

scene ​

• scene: Scene

Inherited from ​

baseScene.scene

Defined in ​

src/Scene/commonSceneMethod.ts:28

sceneName ​

• sceneName: string = ""

Inherited from ​

baseScene.sceneName

Defined in ​

src/Scene/baseScene.ts:15

sort ​

• Protected sort: boolean = true

Inherited from ​

baseScene.sort

Defined in ​

src/Scene/commonSceneMethod.ts:43

subCamera ​

• subCamera: null | PerspectiveCamera = null

Inherited from ​

baseScene.subCamera

Defined in ​

src/Scene/commonSceneMethod.ts:36

subCopperControl ​

• Protected subCopperControl: null | Controls = null

Inherited from ​

baseScene.subCopperControl

Defined in ​

src/Scene/commonSceneMethod.ts:39

subDiv ​

• subDiv: null | HTMLDivElement = null

Inherited from ​

baseScene.subDiv

Defined in ​

src/Scene/commonSceneMethod.ts:34

subRender ​

• Protected subRender: null | WebGLRenderer = null

Inherited from ​

baseScene.subRender

Defined in ​

src/Scene/commonSceneMethod.ts:38

subScene ​

• subScene: Scene

Inherited from ​

baseScene.subScene

Defined in ​

src/Scene/commonSceneMethod.ts:35

viewPoint ​

• viewPoint: CameraViewPoint

Inherited from ​

baseScene.viewPoint

Defined in ​

src/Scene/baseScene.ts:24

vignette ​

• vignette: undefined | customMeshType

Inherited from ​

baseScene.vignette

Defined in ​

src/Scene/baseScene.ts:16

Methods ​

addLights ​

▸ addLights(): void

Returns ​

void

Inherited from ​

baseScene.addLights

Defined in ​

src/Scene/baseScene.ts:138

addObject ​

▸ addObject(obj): void

Parameters ​

NameType
objany

Returns ​

void

Inherited from ​

baseScene.addObject

Defined in ​

src/Scene/baseScene.ts:134

addPreRenderCallbackFunction ​

▸ addPreRenderCallbackFunction(callbackFunction): number

Parameters ​

NameType
callbackFunctionFunction

Returns ​

number

Inherited from ​

baseScene.addPreRenderCallbackFunction

Defined in ​

src/Scene/commonSceneMethod.ts:122

addSubView ​

▸ addSubView(): HTMLDivElement

create a new sub view to display models

Returns ​

HTMLDivElement

Inherited from ​

baseScene.addSubView

Defined in ​

src/Scene/commonSceneMethod.ts:174

confirmResize ​

▸ confirmResize(): void

Returns ​

void

Defined in ​

src/Scene/copperSceneOnDemond.ts:58

createDemoMesh ​

▸ createDemoMesh(): void

Returns ​

void

Inherited from ​

baseScene.createDemoMesh

Defined in ​

src/Scene/commonSceneMethod.ts:96

getDefaultViewPoint ​

▸ getDefaultViewPoint(): CameraViewPoint

Returns ​

CameraViewPoint

Inherited from ​

baseScene.getDefaultViewPoint

Defined in ​

src/Scene/baseScene.ts:109

init ​

▸ init(): void

Returns ​

void

Inherited from ​

baseScene.init

Defined in ​

src/Scene/baseScene.ts:54

loadDicom ​

▸ loadDicom(urls, opts?): void

Parameters ​

NameType
urlsstring | string[]
opts?dicomLoaderOptsType

Returns ​

void

Inherited from ​

baseScene.loadDicom

Defined in ​

src/Scene/commonSceneMethod.ts:198

loadGltf ​

▸ loadGltf(url, callback?): void

Parameters ​

NameType
urlstring
callback?(content: Group) => void

Returns ​

void

Defined in ​

src/Scene/copperSceneOnDemond.ts:21

loadMetadataUrl ​

▸ loadMetadataUrl(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Inherited from ​

baseScene.loadMetadataUrl

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 ​

baseScene.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 ​

baseScene.loadNrrdTexture3d

Defined in ​

src/Scene/commonSceneMethod.ts:338

loadOBJ ​

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

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.loadOBJ

Defined in ​

src/Scene/commonSceneMethod.ts:350

loadView ​

▸ loadView(viewpointData): void

Parameters ​

NameType
viewpointDataCameraViewPoint

Returns ​

void

Inherited from ​

baseScene.loadView

Defined in ​

src/Scene/baseScene.ts:97

loadViewUrl ​

▸ loadViewUrl(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Inherited from ​

baseScene.loadViewUrl

Defined in ​

src/Scene/baseScene.ts:85

onRenderCameraChange ​

▸ onRenderCameraChange(): void

Returns ​

void

Inherited from ​

baseScene.onRenderCameraChange

Defined in ​

src/Scene/baseScene.ts:193

onWindowResize ​

▸ onWindowResize(): void

Returns ​

void

Inherited from ​

baseScene.onWindowResize

Defined in ​

src/Scene/baseScene.ts:199

pickModel ​

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

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.pickModel

Defined in ​

src/Scene/commonSceneMethod.ts:132

pickSpecifiedModel ​

▸ pickSpecifiedModel(content, mousePosition): Object

Parameters ​

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

Returns ​

Object

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

Inherited from ​

baseScene.pickSpecifiedModel

Defined in ​

src/Scene/commonSceneMethod.ts:154

removeLights ​

▸ removeLights(): void

Returns ​

void

Inherited from ​

baseScene.removeLights

Defined in ​

src/Scene/baseScene.ts:151

removePreRenderCallbackFunction ​

▸ removePreRenderCallbackFunction(id): void

Parameters ​

NameType
idnumber

Returns ​

void

Inherited from ​

baseScene.removePreRenderCallbackFunction

Defined in ​

src/Scene/commonSceneMethod.ts:128

render ​

▸ render(): void

Returns ​

void

Overrides ​

baseScene.render

Defined in ​

src/Scene/copperSceneOnDemond.ts:63

requestRenderIfNotRequested ​

▸ requestRenderIfNotRequested(): void

Returns ​

void

Defined in ​

src/Scene/copperSceneOnDemond.ts:70

setDepth ​

▸ setDepth(value): void

Parameters ​

NameType
valuenumber

Returns ​

void

Inherited from ​

baseScene.setDepth

Defined in ​

src/Scene/commonSceneMethod.ts:111

setDicomFilesOrder ​

▸ setDicomFilesOrder(value): void

Parameters ​

NameType
value"ascending" | "descending"

Returns ​

void

Inherited from ​

baseScene.setDicomFilesOrder

Defined in ​

src/Scene/commonSceneMethod.ts:114

setViewPoint ​

▸ setViewPoint(camera, target?): CameraViewPoint

Parameters ​

NameType
cameraPerspectiveCamera
target?number[]

Returns ​

CameraViewPoint

Inherited from ​

baseScene.setViewPoint

Defined in ​

src/Scene/baseScene.ts:113

updateBackground ​

▸ updateBackground(color1, color2): void

Parameters ​

NameType
color1string
color2string

Returns ​

void

Inherited from ​

baseScene.updateBackground

Defined in ​

src/Scene/baseScene.ts:179

updateControls ​

▸ updateControls(camera): void

Parameters ​

NameType
cameraPerspectiveCamera | OrthographicCamera

Returns ​

void

Inherited from ​

baseScene.updateControls

Defined in ​

src/Scene/commonSceneMethod.ts:329

updateDisplay ​

▸ updateDisplay(state): void

Parameters ​

NameType
statebaseStateType

Returns ​

void

Inherited from ​

baseScene.updateDisplay

Defined in ​

src/Scene/baseScene.ts:174

updateLights ​

▸ updateLights(state): void

Parameters ​

NameType
statebaseStateType

Returns ​

void

Inherited from ​

baseScene.updateLights

Defined in ​

src/Scene/baseScene.ts:157

updateModelChildrenVisualisation ​

▸ updateModelChildrenVisualisation(child): void

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.updateModelChildrenVisualisation

Defined in ​

src/Scene/baseScene.ts:184

',546),d=[o];function i(c,l,h,s,b,p){return a(),r("div",null,d)}const u=e(n,[["render",i]]);export{f as __pageData,u as default}; +import{_ as e,o as a,c as r,Q as t}from"./chunks/framework.5916b37e.js";const f=JSON.parse('{"title":"Class: copperSceneOnDemond","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Scene_copperSceneOnDemond.copperSceneOnDemond.md","filePath":"apidist/classes/Scene_copperSceneOnDemond.copperSceneOnDemond.md"}'),n={name:"apidist/classes/Scene_copperSceneOnDemond.copperSceneOnDemond.md"},o=t('

copper3d / Modules / Scene/copperSceneOnDemond / copperSceneOnDemond

Class: copperSceneOnDemond ​

Scene/copperSceneOnDemond.copperSceneOnDemond

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new copperSceneOnDemond(container, renderer)

Parameters ​

NameType
containerHTMLDivElement
rendererWebGLRenderer

Overrides ​

baseScene.constructor

Defined in ​

src/Scene/copperSceneOnDemond.ts:12

Properties ​

ambientLight ​

• ambientLight: AmbientLight

Inherited from ​

baseScene.ambientLight

Defined in ​

src/Scene/baseScene.ts:18

camera ​

• camera: PerspectiveCamera | OrthographicCamera

Inherited from ​

baseScene.camera

Defined in ​

src/Scene/commonSceneMethod.ts:29

cameraPositionFlag ​

• cameraPositionFlag: boolean = false

Inherited from ​

baseScene.cameraPositionFlag

Defined in ​

src/Scene/baseScene.ts:20

container ​

• container: HTMLDivElement

Inherited from ​

baseScene.container

Defined in ​

src/Scene/commonSceneMethod.ts:27

content ​

• content: Group

Inherited from ​

baseScene.content

Defined in ​

src/Scene/baseScene.ts:21

controls ​

• controls: OrbitControls

Overrides ​

baseScene.controls

Defined in ​

src/Scene/copperSceneOnDemond.ts:8

copperControl ​

• copperControl: Controls

Inherited from ​

baseScene.copperControl

Defined in ​

src/Scene/baseScene.ts:19

copperOrthographicCamera ​

• copperOrthographicCamera: OrthographicCamera

Inherited from ​

baseScene.copperOrthographicCamera

Defined in ​

src/Scene/commonSceneMethod.ts:32

copperPerspectiveCamera ​

• copperPerspectiveCamera: PerspectiveCamera

Inherited from ​

baseScene.copperPerspectiveCamera

Defined in ​

src/Scene/commonSceneMethod.ts:31

depthStep ​

• Protected depthStep: number = 0.4

Inherited from ​

baseScene.depthStep

Defined in ​

src/Scene/commonSceneMethod.ts:44

directionalLight ​

• directionalLight: DirectionalLight

Inherited from ​

baseScene.directionalLight

Defined in ​

src/Scene/baseScene.ts:17

exportContent ​

• exportContent: Group

Inherited from ​

baseScene.exportContent

Defined in ​

src/Scene/baseScene.ts:22

isHalfed ​

• isHalfed: boolean = false

Inherited from ​

baseScene.isHalfed

Defined in ​

src/Scene/baseScene.ts:23

isResize ​

• isResize: boolean = false

Defined in ​

src/Scene/copperSceneOnDemond.ts:10

pickableObjects ​

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

Inherited from ​

baseScene.pickableObjects

Defined in ​

src/Scene/commonSceneMethod.ts:46

preRenderCallbackFunctions ​

• Protected preRenderCallbackFunctions: preRenderCallbackFunctionType

Inherited from ​

baseScene.preRenderCallbackFunctions

Defined in ​

src/Scene/commonSceneMethod.ts:42

renderNrrdVolume ​

• Protected renderNrrdVolume: boolean = false

Inherited from ​

baseScene.renderNrrdVolume

Defined in ​

src/Scene/commonSceneMethod.ts:40

renderRequested ​

• renderRequested: undefined | boolean = false

Defined in ​

src/Scene/copperSceneOnDemond.ts:9

renderer ​

• renderer: WebGLRenderer

Inherited from ​

baseScene.renderer

Defined in ​

src/Scene/baseScene.ts:12

scene ​

• scene: Scene

Inherited from ​

baseScene.scene

Defined in ​

src/Scene/commonSceneMethod.ts:28

sceneName ​

• sceneName: string = ""

Inherited from ​

baseScene.sceneName

Defined in ​

src/Scene/baseScene.ts:15

sort ​

• Protected sort: boolean = true

Inherited from ​

baseScene.sort

Defined in ​

src/Scene/commonSceneMethod.ts:43

subCamera ​

• subCamera: null | PerspectiveCamera = null

Inherited from ​

baseScene.subCamera

Defined in ​

src/Scene/commonSceneMethod.ts:36

subCopperControl ​

• Protected subCopperControl: null | Controls = null

Inherited from ​

baseScene.subCopperControl

Defined in ​

src/Scene/commonSceneMethod.ts:39

subDiv ​

• subDiv: null | HTMLDivElement = null

Inherited from ​

baseScene.subDiv

Defined in ​

src/Scene/commonSceneMethod.ts:34

subRender ​

• Protected subRender: null | WebGLRenderer = null

Inherited from ​

baseScene.subRender

Defined in ​

src/Scene/commonSceneMethod.ts:38

subScene ​

• subScene: Scene

Inherited from ​

baseScene.subScene

Defined in ​

src/Scene/commonSceneMethod.ts:35

viewPoint ​

• viewPoint: CameraViewPoint

Inherited from ​

baseScene.viewPoint

Defined in ​

src/Scene/baseScene.ts:24

vignette ​

• vignette: undefined | customMeshType

Inherited from ​

baseScene.vignette

Defined in ​

src/Scene/baseScene.ts:16

Methods ​

addLights ​

▸ addLights(): void

Returns ​

void

Inherited from ​

baseScene.addLights

Defined in ​

src/Scene/baseScene.ts:138

addObject ​

▸ addObject(obj): void

Parameters ​

NameType
objany

Returns ​

void

Inherited from ​

baseScene.addObject

Defined in ​

src/Scene/baseScene.ts:134

addPreRenderCallbackFunction ​

▸ addPreRenderCallbackFunction(callbackFunction): number

Parameters ​

NameType
callbackFunctionFunction

Returns ​

number

Inherited from ​

baseScene.addPreRenderCallbackFunction

Defined in ​

src/Scene/commonSceneMethod.ts:122

addSubView ​

▸ addSubView(): HTMLDivElement

create a new sub view to display models

Returns ​

HTMLDivElement

Inherited from ​

baseScene.addSubView

Defined in ​

src/Scene/commonSceneMethod.ts:174

confirmResize ​

▸ confirmResize(): void

Returns ​

void

Defined in ​

src/Scene/copperSceneOnDemond.ts:58

createDemoMesh ​

▸ createDemoMesh(): void

Returns ​

void

Inherited from ​

baseScene.createDemoMesh

Defined in ​

src/Scene/commonSceneMethod.ts:96

getDefaultViewPoint ​

▸ getDefaultViewPoint(): CameraViewPoint

Returns ​

CameraViewPoint

Inherited from ​

baseScene.getDefaultViewPoint

Defined in ​

src/Scene/baseScene.ts:109

init ​

▸ init(): void

Returns ​

void

Inherited from ​

baseScene.init

Defined in ​

src/Scene/baseScene.ts:54

loadDicom ​

▸ loadDicom(urls, opts?): void

Parameters ​

NameType
urlsstring | string[]
opts?dicomLoaderOptsType

Returns ​

void

Inherited from ​

baseScene.loadDicom

Defined in ​

src/Scene/commonSceneMethod.ts:198

loadGltf ​

▸ loadGltf(url, callback?): void

Parameters ​

NameType
urlstring
callback?(content: Group) => void

Returns ​

void

Defined in ​

src/Scene/copperSceneOnDemond.ts:21

loadMetadataUrl ​

▸ loadMetadataUrl(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Inherited from ​

baseScene.loadMetadataUrl

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 ​

baseScene.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 ​

baseScene.loadNrrdTexture3d

Defined in ​

src/Scene/commonSceneMethod.ts:338

loadOBJ ​

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

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.loadOBJ

Defined in ​

src/Scene/commonSceneMethod.ts:350

loadView ​

▸ loadView(viewpointData): void

Parameters ​

NameType
viewpointDataCameraViewPoint

Returns ​

void

Inherited from ​

baseScene.loadView

Defined in ​

src/Scene/baseScene.ts:97

loadViewUrl ​

▸ loadViewUrl(url): void

Parameters ​

NameType
urlstring

Returns ​

void

Inherited from ​

baseScene.loadViewUrl

Defined in ​

src/Scene/baseScene.ts:85

onRenderCameraChange ​

▸ onRenderCameraChange(): void

Returns ​

void

Inherited from ​

baseScene.onRenderCameraChange

Defined in ​

src/Scene/baseScene.ts:193

onWindowResize ​

▸ onWindowResize(): void

Returns ​

void

Inherited from ​

baseScene.onWindowResize

Defined in ​

src/Scene/baseScene.ts:199

pickModel ​

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

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.pickModel

Defined in ​

src/Scene/commonSceneMethod.ts:132

pickSpecifiedModel ​

▸ pickSpecifiedModel(content, mousePosition): Object

Parameters ​

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

Returns ​

Object

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

Inherited from ​

baseScene.pickSpecifiedModel

Defined in ​

src/Scene/commonSceneMethod.ts:154

removeLights ​

▸ removeLights(): void

Returns ​

void

Inherited from ​

baseScene.removeLights

Defined in ​

src/Scene/baseScene.ts:151

removePreRenderCallbackFunction ​

▸ removePreRenderCallbackFunction(id): void

Parameters ​

NameType
idnumber

Returns ​

void

Inherited from ​

baseScene.removePreRenderCallbackFunction

Defined in ​

src/Scene/commonSceneMethod.ts:128

render ​

▸ render(): void

Returns ​

void

Overrides ​

baseScene.render

Defined in ​

src/Scene/copperSceneOnDemond.ts:63

requestRenderIfNotRequested ​

▸ requestRenderIfNotRequested(): void

Returns ​

void

Defined in ​

src/Scene/copperSceneOnDemond.ts:70

setDepth ​

▸ setDepth(value): void

Parameters ​

NameType
valuenumber

Returns ​

void

Inherited from ​

baseScene.setDepth

Defined in ​

src/Scene/commonSceneMethod.ts:111

setDicomFilesOrder ​

▸ setDicomFilesOrder(value): void

Parameters ​

NameType
value"ascending" | "descending"

Returns ​

void

Inherited from ​

baseScene.setDicomFilesOrder

Defined in ​

src/Scene/commonSceneMethod.ts:114

setViewPoint ​

▸ setViewPoint(camera, target?): CameraViewPoint

Parameters ​

NameType
cameraPerspectiveCamera
target?number[]

Returns ​

CameraViewPoint

Inherited from ​

baseScene.setViewPoint

Defined in ​

src/Scene/baseScene.ts:113

updateBackground ​

▸ updateBackground(color1, color2): void

Parameters ​

NameType
color1string
color2string

Returns ​

void

Inherited from ​

baseScene.updateBackground

Defined in ​

src/Scene/baseScene.ts:179

updateControls ​

▸ updateControls(camera): void

Parameters ​

NameType
cameraPerspectiveCamera | OrthographicCamera

Returns ​

void

Inherited from ​

baseScene.updateControls

Defined in ​

src/Scene/commonSceneMethod.ts:329

updateDisplay ​

▸ updateDisplay(state): void

Parameters ​

NameType
statebaseStateType

Returns ​

void

Inherited from ​

baseScene.updateDisplay

Defined in ​

src/Scene/baseScene.ts:174

updateLights ​

▸ updateLights(state): void

Parameters ​

NameType
statebaseStateType

Returns ​

void

Inherited from ​

baseScene.updateLights

Defined in ​

src/Scene/baseScene.ts:157

updateModelChildrenVisualisation ​

▸ updateModelChildrenVisualisation(child): void

Parameters ​

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

Returns ​

void

Inherited from ​

baseScene.updateModelChildrenVisualisation

Defined in ​

src/Scene/baseScene.ts:184

',546),d=[o];function i(c,l,h,s,p,b){return a(),r("div",null,d)}const u=e(n,[["render",i]]);export{f as __pageData,u as default}; diff --git a/assets/apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.fe22f3a8.lean.js b/assets/apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.8ce60bcb.lean.js similarity index 88% rename from assets/apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.fe22f3a8.lean.js rename to assets/apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.8ce60bcb.lean.js index 720a9a4..92d97d0 100644 --- a/assets/apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.fe22f3a8.lean.js +++ b/assets/apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.8ce60bcb.lean.js @@ -1 +1 @@ -import{_ as e,o as a,c as r,Q as t}from"./chunks/framework.5916b37e.js";const f=JSON.parse('{"title":"Class: copperSceneOnDemond","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Scene_copperSceneOnDemond.copperSceneOnDemond.md","filePath":"apidist/classes/Scene_copperSceneOnDemond.copperSceneOnDemond.md"}'),n={name:"apidist/classes/Scene_copperSceneOnDemond.copperSceneOnDemond.md"},o=t("",546),d=[o];function i(c,l,h,s,b,p){return a(),r("div",null,d)}const u=e(n,[["render",i]]);export{f as __pageData,u as default}; +import{_ as e,o as a,c as r,Q as t}from"./chunks/framework.5916b37e.js";const f=JSON.parse('{"title":"Class: copperSceneOnDemond","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Scene_copperSceneOnDemond.copperSceneOnDemond.md","filePath":"apidist/classes/Scene_copperSceneOnDemond.copperSceneOnDemond.md"}'),n={name:"apidist/classes/Scene_copperSceneOnDemond.copperSceneOnDemond.md"},o=t("",546),d=[o];function i(c,l,h,s,p,b){return a(),r("div",null,d)}const u=e(n,[["render",i]]);export{f as __pageData,u as default}; diff --git a/assets/apidist_classes_Utils_MeshNodeTool.Element.md.2c6ac78a.js b/assets/apidist_classes_Utils_MeshNodeTool.Element.md.d8aaa661.js similarity index 94% rename from assets/apidist_classes_Utils_MeshNodeTool.Element.md.2c6ac78a.js rename to assets/apidist_classes_Utils_MeshNodeTool.Element.md.d8aaa661.js index b019418..daff2ab 100644 --- a/assets/apidist_classes_Utils_MeshNodeTool.Element.md.2c6ac78a.js +++ b/assets/apidist_classes_Utils_MeshNodeTool.Element.md.d8aaa661.js @@ -1 +1 @@ -import{_ as e,o as t,c as o,Q as a}from"./chunks/framework.5916b37e.js";const p=JSON.parse('{"title":"Class: Element","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Utils_MeshNodeTool.Element.md","filePath":"apidist/classes/Utils_MeshNodeTool.Element.md"}'),s={name:"apidist/classes/Utils_MeshNodeTool.Element.md"},r=a('

copper3d / Modules / Utils/MeshNodeTool / Element

Class: Element ​

Utils/MeshNodeTool.Element

Table of contents ​

Constructors ​

Properties ​

Constructors ​

constructor ​

• new Element(id, basis, nodes)

Parameters ​

NameType
idstring
basisstring[]
nodesNode[]

Defined in ​

src/Utils/MeshNodeTool.ts:19

Properties ​

basis ​

• basis: string[]

Defined in ​

src/Utils/MeshNodeTool.ts:17

id ​

• id: string

Defined in ​

src/Utils/MeshNodeTool.ts:16

nodes ​

• nodes: Node[]

Defined in ​

src/Utils/MeshNodeTool.ts:18

',30),l=[r];function i(n,d,h,c,f,u){return t(),o("div",null,l)}const m=e(s,[["render",i]]);export{p as __pageData,m as default}; +import{_ as e,o as t,c as o,Q as a}from"./chunks/framework.5916b37e.js";const p=JSON.parse('{"title":"Class: Element","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Utils_MeshNodeTool.Element.md","filePath":"apidist/classes/Utils_MeshNodeTool.Element.md"}'),s={name:"apidist/classes/Utils_MeshNodeTool.Element.md"},r=a('

copper3d / Modules / Utils/MeshNodeTool / Element

Class: Element ​

Utils/MeshNodeTool.Element

Table of contents ​

Constructors ​

Properties ​

Constructors ​

constructor ​

• new Element(id, basis, nodes)

Parameters ​

NameType
idstring
basisstring[]
nodesNode[]

Defined in ​

src/Utils/MeshNodeTool.ts:19

Properties ​

basis ​

• basis: string[]

Defined in ​

src/Utils/MeshNodeTool.ts:17

id ​

• id: string

Defined in ​

src/Utils/MeshNodeTool.ts:16

nodes ​

• nodes: Node[]

Defined in ​

src/Utils/MeshNodeTool.ts:18

',30),l=[r];function i(n,d,h,c,f,u){return t(),o("div",null,l)}const m=e(s,[["render",i]]);export{p as __pageData,m as default}; diff --git a/assets/apidist_classes_Utils_MeshNodeTool.Element.md.2c6ac78a.lean.js b/assets/apidist_classes_Utils_MeshNodeTool.Element.md.d8aaa661.lean.js similarity index 100% rename from assets/apidist_classes_Utils_MeshNodeTool.Element.md.2c6ac78a.lean.js rename to assets/apidist_classes_Utils_MeshNodeTool.Element.md.d8aaa661.lean.js diff --git a/assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.c675b41f.js b/assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.c2904675.js similarity index 95% rename from assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.c675b41f.js rename to assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.c2904675.js index 3d0b757..20930aa 100644 --- a/assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.c675b41f.js +++ b/assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.c2904675.js @@ -1 +1 @@ -import{_ as e,o as t,c as a,Q as o}from"./chunks/framework.5916b37e.js";const m=JSON.parse('{"title":"Class: MeshNodeTool","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Utils_MeshNodeTool.MeshNodeTool.md","filePath":"apidist/classes/Utils_MeshNodeTool.MeshNodeTool.md"}'),d={name:"apidist/classes/Utils_MeshNodeTool.MeshNodeTool.md"},r=o('

copper3d / Modules / Utils/MeshNodeTool / MeshNodeTool

Class: MeshNodeTool ​

Utils/MeshNodeTool.MeshNodeTool

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new MeshNodeTool()

Properties ​

elements ​

• elements: Object = {}

Index signature ​

▪ [key: string]: Element

Defined in ​

src/Utils/MeshNodeTool.ts:28

nodes ​

• nodes: Object = {}

Index signature ​

▪ [key: string]: Node

Defined in ​

src/Utils/MeshNodeTool.ts:27

Methods ​

addElement ​

▸ addElement(id, basis, nodeIds): void

Parameters ​

NameType
idstring
basisstring[]
nodeIdsstring[]

Returns ​

void

Defined in ​

src/Utils/MeshNodeTool.ts:33

addNode ​

▸ addNode(id, p): void

Parameters ​

NameType
idstring
pnumber[]

Returns ​

void

Defined in ​

src/Utils/MeshNodeTool.ts:30

evaluate ​

▸ evaluate(elementId, xi): number[]

Parameters ​

NameType
elementIdstring
xinumber[]

Returns ​

number[]

Defined in ​

src/Utils/MeshNodeTool.ts:56

find ​

▸ find(point, startingNodeId): Object

Parameters ​

NameType
pointVector3
startingNodeIdstring

Returns ​

Object

NameType
elementIdstring
xinumber[]

Defined in ​

src/Utils/MeshNodeTool.ts:61

getNodeMaterialPoints ​

▸ getNodeMaterialPoints(nodeId): { [key: string]: any; elementId: string ; xi: number[] }[]

Parameters ​

NameType
nodeIdstring

Returns ​

{ [key: string]: any; elementId: string ; xi: number[] }[]

Defined in ​

src/Utils/MeshNodeTool.ts:215

loadMesh ​

▸ loadMesh(json): void

Parameters ​

NameType
jsonIMeshNodes

Returns ​

void

Defined in ​

src/Utils/MeshNodeTool.ts:46

▸ search(point, startingNodeId, tol): Object

Parameters ​

NameType
pointVector3
startingNodeIdstring
tolnumber

Returns ​

Object

NameType
elementIdstring
xinumber[]

Defined in ​

src/Utils/MeshNodeTool.ts:118

',92),l=[r];function s(i,n,h,c,u,b){return t(),a("div",null,l)}const p=e(d,[["render",s]]);export{m as __pageData,p as default}; +import{_ as e,o as t,c as a,Q as o}from"./chunks/framework.5916b37e.js";const m=JSON.parse('{"title":"Class: MeshNodeTool","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Utils_MeshNodeTool.MeshNodeTool.md","filePath":"apidist/classes/Utils_MeshNodeTool.MeshNodeTool.md"}'),d={name:"apidist/classes/Utils_MeshNodeTool.MeshNodeTool.md"},r=o('

copper3d / Modules / Utils/MeshNodeTool / MeshNodeTool

Class: MeshNodeTool ​

Utils/MeshNodeTool.MeshNodeTool

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new MeshNodeTool()

Properties ​

elements ​

• elements: Object = {}

Index signature ​

▪ [key: string]: Element

Defined in ​

src/Utils/MeshNodeTool.ts:28

nodes ​

• nodes: Object = {}

Index signature ​

▪ [key: string]: Node

Defined in ​

src/Utils/MeshNodeTool.ts:27

Methods ​

addElement ​

▸ addElement(id, basis, nodeIds): void

Parameters ​

NameType
idstring
basisstring[]
nodeIdsstring[]

Returns ​

void

Defined in ​

src/Utils/MeshNodeTool.ts:33

addNode ​

▸ addNode(id, p): void

Parameters ​

NameType
idstring
pnumber[]

Returns ​

void

Defined in ​

src/Utils/MeshNodeTool.ts:30

evaluate ​

▸ evaluate(elementId, xi): number[]

Parameters ​

NameType
elementIdstring
xinumber[]

Returns ​

number[]

Defined in ​

src/Utils/MeshNodeTool.ts:56

find ​

▸ find(point, startingNodeId): Object

Parameters ​

NameType
pointVector3
startingNodeIdstring

Returns ​

Object

NameType
elementIdstring
xinumber[]

Defined in ​

src/Utils/MeshNodeTool.ts:61

getNodeMaterialPoints ​

▸ getNodeMaterialPoints(nodeId): { [key: string]: any; elementId: string ; xi: number[] }[]

Parameters ​

NameType
nodeIdstring

Returns ​

{ [key: string]: any; elementId: string ; xi: number[] }[]

Defined in ​

src/Utils/MeshNodeTool.ts:215

loadMesh ​

▸ loadMesh(json): void

Parameters ​

NameType
jsonIMeshNodes

Returns ​

void

Defined in ​

src/Utils/MeshNodeTool.ts:46

▸ search(point, startingNodeId, tol): Object

Parameters ​

NameType
pointVector3
startingNodeIdstring
tolnumber

Returns ​

Object

NameType
elementIdstring
xinumber[]

Defined in ​

src/Utils/MeshNodeTool.ts:118

',92),l=[r];function s(i,n,h,c,u,f){return t(),a("div",null,l)}const p=e(d,[["render",s]]);export{m as __pageData,p as default}; diff --git a/assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.c675b41f.lean.js b/assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.c2904675.lean.js similarity index 87% rename from assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.c675b41f.lean.js rename to assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.c2904675.lean.js index c1dede5..997f9e2 100644 --- a/assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.c675b41f.lean.js +++ b/assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.c2904675.lean.js @@ -1 +1 @@ -import{_ as e,o as t,c as a,Q as o}from"./chunks/framework.5916b37e.js";const m=JSON.parse('{"title":"Class: MeshNodeTool","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Utils_MeshNodeTool.MeshNodeTool.md","filePath":"apidist/classes/Utils_MeshNodeTool.MeshNodeTool.md"}'),d={name:"apidist/classes/Utils_MeshNodeTool.MeshNodeTool.md"},r=o("",92),l=[r];function s(i,n,h,c,u,b){return t(),a("div",null,l)}const p=e(d,[["render",s]]);export{m as __pageData,p as default}; +import{_ as e,o as t,c as a,Q as o}from"./chunks/framework.5916b37e.js";const m=JSON.parse('{"title":"Class: MeshNodeTool","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Utils_MeshNodeTool.MeshNodeTool.md","filePath":"apidist/classes/Utils_MeshNodeTool.MeshNodeTool.md"}'),d={name:"apidist/classes/Utils_MeshNodeTool.MeshNodeTool.md"},r=o("",92),l=[r];function s(i,n,h,c,u,f){return t(),a("div",null,l)}const p=e(d,[["render",s]]);export{m as __pageData,p as default}; diff --git a/assets/apidist_classes_Utils_MeshNodeTool.Node.md.7a14ecbd.js b/assets/apidist_classes_Utils_MeshNodeTool.Node.md.d31c6b1b.js similarity index 94% rename from assets/apidist_classes_Utils_MeshNodeTool.Node.md.7a14ecbd.js rename to assets/apidist_classes_Utils_MeshNodeTool.Node.md.d31c6b1b.js index 7b1d031..ffa64a7 100644 --- a/assets/apidist_classes_Utils_MeshNodeTool.Node.md.7a14ecbd.js +++ b/assets/apidist_classes_Utils_MeshNodeTool.Node.md.d31c6b1b.js @@ -1 +1 @@ -import{_ as e,o as t,c as o,Q as a}from"./chunks/framework.5916b37e.js";const b=JSON.parse('{"title":"Class: Node","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Utils_MeshNodeTool.Node.md","filePath":"apidist/classes/Utils_MeshNodeTool.Node.md"}'),r={name:"apidist/classes/Utils_MeshNodeTool.Node.md"},s=a('

copper3d / Modules / Utils/MeshNodeTool / Node

Class: Node ​

Utils/MeshNodeTool.Node

Table of contents ​

Constructors ​

Properties ​

Constructors ​

constructor ​

• new Node(id, p)

Parameters ​

NameType
idstring
pnumber[]

Defined in ​

src/Utils/MeshNodeTool.ts:9

Properties ​

elements ​

• elements: Element[] = []

Defined in ​

src/Utils/MeshNodeTool.ts:8

id ​

• id: string

Defined in ​

src/Utils/MeshNodeTool.ts:6

p ​

• p: number[]

Defined in ​

src/Utils/MeshNodeTool.ts:7

',30),l=[s];function i(d,n,h,c,p,u){return t(),o("div",null,l)}const m=e(r,[["render",i]]);export{b as __pageData,m as default}; +import{_ as e,o as t,c as o,Q as a}from"./chunks/framework.5916b37e.js";const b=JSON.parse('{"title":"Class: Node","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Utils_MeshNodeTool.Node.md","filePath":"apidist/classes/Utils_MeshNodeTool.Node.md"}'),r={name:"apidist/classes/Utils_MeshNodeTool.Node.md"},s=a('

copper3d / Modules / Utils/MeshNodeTool / Node

Class: Node ​

Utils/MeshNodeTool.Node

Table of contents ​

Constructors ​

Properties ​

Constructors ​

constructor ​

• new Node(id, p)

Parameters ​

NameType
idstring
pnumber[]

Defined in ​

src/Utils/MeshNodeTool.ts:9

Properties ​

elements ​

• elements: Element[] = []

Defined in ​

src/Utils/MeshNodeTool.ts:8

id ​

• id: string

Defined in ​

src/Utils/MeshNodeTool.ts:6

p ​

• p: number[]

Defined in ​

src/Utils/MeshNodeTool.ts:7

',30),l=[s];function i(d,n,h,c,p,u){return t(),o("div",null,l)}const m=e(r,[["render",i]]);export{b as __pageData,m as default}; diff --git a/assets/apidist_classes_Utils_MeshNodeTool.Node.md.7a14ecbd.lean.js b/assets/apidist_classes_Utils_MeshNodeTool.Node.md.d31c6b1b.lean.js similarity index 100% rename from assets/apidist_classes_Utils_MeshNodeTool.Node.md.7a14ecbd.lean.js rename to assets/apidist_classes_Utils_MeshNodeTool.Node.md.d31c6b1b.lean.js diff --git a/assets/apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.2b9f1fbe.js b/assets/apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.c1747d40.js similarity index 93% rename from assets/apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.2b9f1fbe.js rename to assets/apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.c1747d40.js index 8d56201..a48d873 100644 --- a/assets/apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.2b9f1fbe.js +++ b/assets/apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.c1747d40.js @@ -1 +1 @@ -import{_ as e,o as a,c as t,Q as o}from"./chunks/framework.5916b37e.js";const f=JSON.parse('{"title":"Class: CommToolsData","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Utils_segmentation_CommToolsData.CommToolsData.md","filePath":"apidist/classes/Utils_segmentation_CommToolsData.CommToolsData.md"}'),r={name:"apidist/classes/Utils_segmentation_CommToolsData.CommToolsData.md"},i=o('

copper3d / Modules / Utils/segmentation/CommToolsData / CommToolsData

Class: CommToolsData ​

Utils/segmentation/CommToolsData.CommToolsData

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new CommToolsData(container, mainAreaContainer)

Parameters ​

NameType
containerHTMLElement
mainAreaContainerHTMLElement

Defined in ​

src/Utils/segmentation/CommToolsData.ts:142

Properties ​

baseCanvasesSize ​

• baseCanvasesSize: number = 1

Defined in ​

src/Utils/segmentation/CommToolsData.ts:14

cursorPage ​

• cursorPage: ICursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:70

gui_states ​

• gui_states: IGUIStates

Defined in ​

src/Utils/segmentation/CommToolsData.ts:91

nrrd_states ​

• nrrd_states: INrrdStates

Defined in ​

src/Utils/segmentation/CommToolsData.ts:15

protectedData ​

• protectedData: IProtected

Defined in ​

src/Utils/segmentation/CommToolsData.ts:141

Methods ​

clearPaint ​

▸ clearPaint(): void

Rewrite this {clearPaint} function under DrawToolCore

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:213

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:229

convertCursorPoint ​

▸ convertCursorPoint(from, to, cursorNumX, cursorNumY, currentSliceIndex): undefined | IConvertObjType

Rewrite this {convertCursorPoint} function under NrrdTools

Parameters ​

NameType
from"z" | "y" | "x"
to"z" | "y" | "x"
cursorNumXnumber
cursorNumYnumber
currentSliceIndexnumber

Returns ​

undefined | IConvertObjType

Defined in ​

src/Utils/segmentation/CommToolsData.ts:285

filterDrawedImage ​

▸ filterDrawedImage(axis, sliceIndex, paintedImages): IPaintImage

Get a painted mask image (IPaintImage) based on current axis and input slice index.

Parameters ​

NameTypeDescription
axis"z" | "y" | "x""x" | "y" | "z"
sliceIndexnumbernumber
paintedImagesIPaintImagesIPaintImages, All painted mask images.

Returns ​

IPaintImage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:329

flipDisplayImageByAxis ​

▸ flipDisplayImageByAxis(): void

Rewrite this {flipDisplayImageByAxis} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:261

generateCanvases ​

▸ Private generateCanvases(): HTMLCanvasElement[]

Returns ​

HTMLCanvasElement[]

Defined in ​

src/Utils/segmentation/CommToolsData.ts:201

redrawDisplayCanvas ​

▸ redrawDisplayCanvas(): void

Rewrite this {redrawDisplayCanvas} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:315

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Rewrite this {resetLayerCanvas} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:299

resetPaintAreaUIPosition ​

▸ resetPaintAreaUIPosition(l?, t?): void

Rewrite this {resetPaintAreaUIPosition} function under NrrdTools

Parameters ​

NameType
l?number
t?number

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:269

resizePaintArea ​

▸ resizePaintArea(factor): void

Rewrite this {resizePaintArea} function under NrrdTools

Parameters ​

NameType
factornumber

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:237

setEmptyCanvasSize ​

▸ setEmptyCanvasSize(axis?): void

Rewrite this {resetPaintAreaUIPosition} function under NrrdTools

Parameters ​

NameType
axis?"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:277

setIsDrawFalse ​

▸ setIsDrawFalse(target): void

Rewrite this {setIsDrawFalse} function under NrrdTools

Parameters ​

NameType
targetnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:245

setSyncsliceNum ​

▸ setSyncsliceNum(): void

Rewrite this {setSyncsliceNum} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:307

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:221

updateOriginAndChangedWH ​

▸ updateOriginAndChangedWH(): void

Rewrite this {updateOriginAndChangedWH} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:253

',175),s=[i];function n(l,d,h,c,m,u){return a(),t("div",null,s)}const b=e(r,[["render",n]]);export{f as __pageData,b as default}; +import{_ as e,o as a,c as t,Q as o}from"./chunks/framework.5916b37e.js";const f=JSON.parse('{"title":"Class: CommToolsData","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Utils_segmentation_CommToolsData.CommToolsData.md","filePath":"apidist/classes/Utils_segmentation_CommToolsData.CommToolsData.md"}'),r={name:"apidist/classes/Utils_segmentation_CommToolsData.CommToolsData.md"},i=o('

copper3d / Modules / Utils/segmentation/CommToolsData / CommToolsData

Class: CommToolsData ​

Utils/segmentation/CommToolsData.CommToolsData

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new CommToolsData(container, mainAreaContainer)

Parameters ​

NameType
containerHTMLElement
mainAreaContainerHTMLElement

Defined in ​

src/Utils/segmentation/CommToolsData.ts:142

Properties ​

baseCanvasesSize ​

• baseCanvasesSize: number = 1

Defined in ​

src/Utils/segmentation/CommToolsData.ts:14

cursorPage ​

• cursorPage: ICursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:70

gui_states ​

• gui_states: IGUIStates

Defined in ​

src/Utils/segmentation/CommToolsData.ts:91

nrrd_states ​

• nrrd_states: INrrdStates

Defined in ​

src/Utils/segmentation/CommToolsData.ts:15

protectedData ​

• protectedData: IProtected

Defined in ​

src/Utils/segmentation/CommToolsData.ts:141

Methods ​

clearPaint ​

▸ clearPaint(): void

Rewrite this {clearPaint} function under DrawToolCore

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:213

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:229

convertCursorPoint ​

▸ convertCursorPoint(from, to, cursorNumX, cursorNumY, currentSliceIndex): undefined | IConvertObjType

Rewrite this {convertCursorPoint} function under NrrdTools

Parameters ​

NameType
from"z" | "y" | "x"
to"z" | "y" | "x"
cursorNumXnumber
cursorNumYnumber
currentSliceIndexnumber

Returns ​

undefined | IConvertObjType

Defined in ​

src/Utils/segmentation/CommToolsData.ts:285

filterDrawedImage ​

▸ filterDrawedImage(axis, sliceIndex, paintedImages): IPaintImage

Get a painted mask image (IPaintImage) based on current axis and input slice index.

Parameters ​

NameTypeDescription
axis"z" | "y" | "x""x" | "y" | "z"
sliceIndexnumbernumber
paintedImagesIPaintImagesIPaintImages, All painted mask images.

Returns ​

IPaintImage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:329

flipDisplayImageByAxis ​

▸ flipDisplayImageByAxis(): void

Rewrite this {flipDisplayImageByAxis} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:261

generateCanvases ​

▸ Private generateCanvases(): HTMLCanvasElement[]

Returns ​

HTMLCanvasElement[]

Defined in ​

src/Utils/segmentation/CommToolsData.ts:201

redrawDisplayCanvas ​

▸ redrawDisplayCanvas(): void

Rewrite this {redrawDisplayCanvas} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:315

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Rewrite this {resetLayerCanvas} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:299

resetPaintAreaUIPosition ​

▸ resetPaintAreaUIPosition(l?, t?): void

Rewrite this {resetPaintAreaUIPosition} function under NrrdTools

Parameters ​

NameType
l?number
t?number

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:269

resizePaintArea ​

▸ resizePaintArea(factor): void

Rewrite this {resizePaintArea} function under NrrdTools

Parameters ​

NameType
factornumber

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:237

setEmptyCanvasSize ​

▸ setEmptyCanvasSize(axis?): void

Rewrite this {resetPaintAreaUIPosition} function under NrrdTools

Parameters ​

NameType
axis?"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:277

setIsDrawFalse ​

▸ setIsDrawFalse(target): void

Rewrite this {setIsDrawFalse} function under NrrdTools

Parameters ​

NameType
targetnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:245

setSyncsliceNum ​

▸ setSyncsliceNum(): void

Rewrite this {setSyncsliceNum} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:307

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:221

updateOriginAndChangedWH ​

▸ updateOriginAndChangedWH(): void

Rewrite this {updateOriginAndChangedWH} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:253

',175),s=[i];function n(l,d,c,h,m,u){return a(),t("div",null,s)}const g=e(r,[["render",n]]);export{f as __pageData,g as default}; diff --git a/assets/apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.2b9f1fbe.lean.js b/assets/apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.c1747d40.lean.js similarity index 70% rename from assets/apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.2b9f1fbe.lean.js rename to assets/apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.c1747d40.lean.js index 005c55b..07217b7 100644 --- a/assets/apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.2b9f1fbe.lean.js +++ b/assets/apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.c1747d40.lean.js @@ -1 +1 @@ -import{_ as e,o as a,c as t,Q as o}from"./chunks/framework.5916b37e.js";const f=JSON.parse('{"title":"Class: CommToolsData","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Utils_segmentation_CommToolsData.CommToolsData.md","filePath":"apidist/classes/Utils_segmentation_CommToolsData.CommToolsData.md"}'),r={name:"apidist/classes/Utils_segmentation_CommToolsData.CommToolsData.md"},i=o("",175),s=[i];function n(l,d,h,c,m,u){return a(),t("div",null,s)}const b=e(r,[["render",n]]);export{f as __pageData,b as default}; +import{_ as e,o as a,c as t,Q as o}from"./chunks/framework.5916b37e.js";const f=JSON.parse('{"title":"Class: CommToolsData","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Utils_segmentation_CommToolsData.CommToolsData.md","filePath":"apidist/classes/Utils_segmentation_CommToolsData.CommToolsData.md"}'),r={name:"apidist/classes/Utils_segmentation_CommToolsData.CommToolsData.md"},i=o("",175),s=[i];function n(l,d,c,h,m,u){return a(),t("div",null,s)}const g=e(r,[["render",n]]);export{f as __pageData,g as default}; diff --git a/assets/apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.836da7c3.js b/assets/apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.dc3dec67.js similarity index 91% rename from assets/apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.836da7c3.js rename to assets/apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.dc3dec67.js index f9baf2e..9f10560 100644 --- a/assets/apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.836da7c3.js +++ b/assets/apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.dc3dec67.js @@ -1 +1 @@ -import{_ as e,o as a,c as t,Q as r}from"./chunks/framework.5916b37e.js";const m=JSON.parse('{"title":"Class: DragOperator","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Utils_segmentation_DragOperator.DragOperator.md","filePath":"apidist/classes/Utils_segmentation_DragOperator.DragOperator.md"}'),o={name:"apidist/classes/Utils_segmentation_DragOperator.DragOperator.md"},i=r('

copper3d / Modules / Utils/segmentation/DragOperator / DragOperator

Class: DragOperator ​

Utils/segmentation/DragOperator.DragOperator

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new DragOperator(container, nrrd_sates, gui_states, protectedData, drawingPrameters, setSyncsliceNum, setIsDrawFalse, flipDisplayImageByAxis, setEmptyCanvasSize, filterDrawedImage)

Parameters ​

NameType
containerHTMLElement
nrrd_satesINrrdStates
gui_statesIGUIStates
protectedDataIProtected
drawingPrametersIDrawingEvents
setSyncsliceNum() => void
setIsDrawFalse(target: number) => void
flipDisplayImageByAxis() => void
setEmptyCanvasSize(axis?: "z" | "y" | "x") => void
filterDrawedImage(axis: "z" | "y" | "x", sliceIndex: number, paintedImages: IPaintImages) => IPaintImage

Defined in ​

src/Utils/segmentation/DragOperator.ts:53

Properties ​

container ​

• container: HTMLElement

Defined in ​

src/Utils/segmentation/DragOperator.ts:24

dragEffectCanvases ​

• Private dragEffectCanvases: undefined | IDragEffectCanvases

Defined in ​

src/Utils/segmentation/DragOperator.ts:41

dragPrameters ​

• Private dragPrameters: IDragPrameters

Defined in ​

src/Utils/segmentation/DragOperator.ts:26

drawingPrameters ​

• Private drawingPrameters: IDrawingEvents

Defined in ​

src/Utils/segmentation/DragOperator.ts:35

filterDrawedImage ​

• Private filterDrawedImage: (axis: "z" | "y" | "x", sliceIndex: number, paintedImages: IPaintImages) => IPaintImage

Type declaration ​

▸ (axis, sliceIndex, paintedImages): IPaintImage

Parameters ​
NameType
axis"z" | "y" | "x"
sliceIndexnumber
paintedImagesIPaintImages
Returns ​

IPaintImage

Defined in ​

src/Utils/segmentation/DragOperator.ts:47

flipDisplayImageByAxis ​

• Private flipDisplayImageByAxis: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:45

gui_states ​

• Private gui_states: IGUIStates

Defined in ​

src/Utils/segmentation/DragOperator.ts:39

nrrd_states ​

• Private nrrd_states: INrrdStates

Defined in ​

src/Utils/segmentation/DragOperator.ts:38

protectedData ​

• Private protectedData: IProtected

Defined in ​

src/Utils/segmentation/DragOperator.ts:40

sensitiveArray ​

• Private sensitiveArray: number[] = []

Defined in ​

src/Utils/segmentation/DragOperator.ts:36

setEmptyCanvasSize ​

• Private setEmptyCanvasSize: (axis?: "z" | "y" | "x") => void

Type declaration ​

▸ (axis?): void

Parameters ​
NameType
axis?"z" | "y" | "x"
Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:46

setIsDrawFalse ​

• Private setIsDrawFalse: (target: number) => void

Type declaration ​

▸ (target): void

Parameters ​
NameType
targetnumber
Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:44

setSyncsliceNum ​

• Private setSyncsliceNum: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:43

showDragNumberDiv ​

• Private showDragNumberDiv: HTMLDivElement

Defined in ​

src/Utils/segmentation/DragOperator.ts:37

Methods ​

cleanCanvases ​

▸ Private cleanCanvases(flag): void

Parameters ​

NameType
flagboolean

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:347

configDragMode ​

▸ configDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:388

drag ​

▸ drag(opts?): void

Parameters ​

NameType
opts?IDragOpts

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:104

drawDragSlice ​

▸ Private drawDragSlice(canvas): void

Parameters ​

NameType
canvasany

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:275

drawMaskToLabelCtx ​

▸ Private drawMaskToLabelCtx(paintedImages, ctx): void

Parameters ​

NameType
paintedImagesIPaintImages
ctxCanvasRenderingContext2D

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:322

init ​

▸ Private init(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:85

removeDragMode ​

▸ removeDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:401

setShowDragNumberDiv ​

▸ setShowDragNumberDiv(sliceIndexContainer): void

Parameters ​

NameType
sliceIndexContainerHTMLDivElement

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:100

updateCurrentContrastSlice ​

▸ updateCurrentContrastSlice(): any

Returns ​

any

Defined in ​

src/Utils/segmentation/DragOperator.ts:382

updateIndex ​

▸ updateIndex(move): void

Parameters ​

NameType
movenumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:190

updateMainSlice ​

▸ updateMainSlice(mainPreSlices): void

Parameters ​

NameType
mainPreSlicesany

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:416

updateShowNumDiv ​

▸ updateShowNumDiv(contrastNum): void

Parameters ​

NameType
contrastNumnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:361

',213),n=[i];function d(s,l,c,h,g,p){return a(),t("div",null,n)}const f=e(o,[["render",d]]);export{m as __pageData,f as default}; +import{_ as e,o as a,c as t,Q as r}from"./chunks/framework.5916b37e.js";const m=JSON.parse('{"title":"Class: DragOperator","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Utils_segmentation_DragOperator.DragOperator.md","filePath":"apidist/classes/Utils_segmentation_DragOperator.DragOperator.md"}'),o={name:"apidist/classes/Utils_segmentation_DragOperator.DragOperator.md"},i=r('

copper3d / Modules / Utils/segmentation/DragOperator / DragOperator

Class: DragOperator ​

Utils/segmentation/DragOperator.DragOperator

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new DragOperator(container, nrrd_sates, gui_states, protectedData, drawingPrameters, setSyncsliceNum, setIsDrawFalse, flipDisplayImageByAxis, setEmptyCanvasSize, filterDrawedImage)

Parameters ​

NameType
containerHTMLElement
nrrd_satesINrrdStates
gui_statesIGUIStates
protectedDataIProtected
drawingPrametersIDrawingEvents
setSyncsliceNum() => void
setIsDrawFalse(target: number) => void
flipDisplayImageByAxis() => void
setEmptyCanvasSize(axis?: "z" | "y" | "x") => void
filterDrawedImage(axis: "z" | "y" | "x", sliceIndex: number, paintedImages: IPaintImages) => IPaintImage

Defined in ​

src/Utils/segmentation/DragOperator.ts:53

Properties ​

container ​

• container: HTMLElement

Defined in ​

src/Utils/segmentation/DragOperator.ts:24

dragEffectCanvases ​

• Private dragEffectCanvases: undefined | IDragEffectCanvases

Defined in ​

src/Utils/segmentation/DragOperator.ts:41

dragPrameters ​

• Private dragPrameters: IDragPrameters

Defined in ​

src/Utils/segmentation/DragOperator.ts:26

drawingPrameters ​

• Private drawingPrameters: IDrawingEvents

Defined in ​

src/Utils/segmentation/DragOperator.ts:35

filterDrawedImage ​

• Private filterDrawedImage: (axis: "z" | "y" | "x", sliceIndex: number, paintedImages: IPaintImages) => IPaintImage

Type declaration ​

▸ (axis, sliceIndex, paintedImages): IPaintImage

Parameters ​
NameType
axis"z" | "y" | "x"
sliceIndexnumber
paintedImagesIPaintImages
Returns ​

IPaintImage

Defined in ​

src/Utils/segmentation/DragOperator.ts:47

flipDisplayImageByAxis ​

• Private flipDisplayImageByAxis: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:45

gui_states ​

• Private gui_states: IGUIStates

Defined in ​

src/Utils/segmentation/DragOperator.ts:39

nrrd_states ​

• Private nrrd_states: INrrdStates

Defined in ​

src/Utils/segmentation/DragOperator.ts:38

protectedData ​

• Private protectedData: IProtected

Defined in ​

src/Utils/segmentation/DragOperator.ts:40

sensitiveArray ​

• Private sensitiveArray: number[] = []

Defined in ​

src/Utils/segmentation/DragOperator.ts:36

setEmptyCanvasSize ​

• Private setEmptyCanvasSize: (axis?: "z" | "y" | "x") => void

Type declaration ​

▸ (axis?): void

Parameters ​
NameType
axis?"z" | "y" | "x"
Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:46

setIsDrawFalse ​

• Private setIsDrawFalse: (target: number) => void

Type declaration ​

▸ (target): void

Parameters ​
NameType
targetnumber
Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:44

setSyncsliceNum ​

• Private setSyncsliceNum: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:43

showDragNumberDiv ​

• Private showDragNumberDiv: HTMLDivElement

Defined in ​

src/Utils/segmentation/DragOperator.ts:37

Methods ​

cleanCanvases ​

▸ Private cleanCanvases(flag): void

Parameters ​

NameType
flagboolean

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:352

configDragMode ​

▸ configDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:393

drag ​

▸ drag(opts?): void

Parameters ​

NameType
opts?IDragOpts

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:104

drawDragSlice ​

▸ Private drawDragSlice(canvas): void

Parameters ​

NameType
canvasany

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:280

drawMaskToLabelCtx ​

▸ Private drawMaskToLabelCtx(paintedImages, ctx): void

Parameters ​

NameType
paintedImagesIPaintImages
ctxCanvasRenderingContext2D

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:327

init ​

▸ Private init(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:85

removeDragMode ​

▸ removeDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:406

setShowDragNumberDiv ​

▸ setShowDragNumberDiv(sliceIndexContainer): void

Parameters ​

NameType
sliceIndexContainerHTMLDivElement

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:100

updateCurrentContrastSlice ​

▸ updateCurrentContrastSlice(): any

Returns ​

any

Defined in ​

src/Utils/segmentation/DragOperator.ts:387

updateIndex ​

▸ updateIndex(move): void

Parameters ​

NameType
movenumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:195

updateMainSlice ​

▸ updateMainSlice(mainPreSlices): void

Parameters ​

NameType
mainPreSlicesany

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:421

updateShowNumDiv ​

▸ updateShowNumDiv(contrastNum): void

Parameters ​

NameType
contrastNumnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DragOperator.ts:366

',213),n=[i];function d(s,l,c,h,g,p){return a(),t("div",null,n)}const f=e(o,[["render",d]]);export{m as __pageData,f as default}; diff --git a/assets/apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.836da7c3.lean.js b/assets/apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.dc3dec67.lean.js similarity index 100% rename from assets/apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.836da7c3.lean.js rename to assets/apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.dc3dec67.lean.js diff --git a/assets/apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.0c9f9fa4.js b/assets/apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.0c9f9fa4.js deleted file mode 100644 index 0b5d736..0000000 --- a/assets/apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.0c9f9fa4.js +++ /dev/null @@ -1 +0,0 @@ -import{_ as e,o as t,c as a,Q as r}from"./chunks/framework.5916b37e.js";const g=JSON.parse('{"title":"Class: DrawToolCore","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Utils_segmentation_DrawToolCore.DrawToolCore.md","filePath":"apidist/classes/Utils_segmentation_DrawToolCore.DrawToolCore.md"}'),o={name:"apidist/classes/Utils_segmentation_DrawToolCore.DrawToolCore.md"},i=r('

copper3d / Modules / Utils/segmentation/DrawToolCore / DrawToolCore

Class: DrawToolCore ​

Utils/segmentation/DrawToolCore.DrawToolCore

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new DrawToolCore(container)

Parameters ​

NameType
containerHTMLElement

Overrides ​

CommToolsData.constructor

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:48

Properties ​

baseCanvasesSize ​

• baseCanvasesSize: number = 1

Inherited from ​

CommToolsData.baseCanvasesSize

Defined in ​

src/Utils/segmentation/CommToolsData.ts:14

container ​

• container: HTMLElement

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:15

contrastEventPrameters ​

• contrastEventPrameters: IContrastEvents

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:28

cursorPage ​

• cursorPage: ICursorPage

Inherited from ​

CommToolsData.cursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:70

drawingPrameters ​

• drawingPrameters: IDrawingEvents

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:17

eraserUrls ​

• eraserUrls: string[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:41

gui_states ​

• gui_states: IGUIStates

Inherited from ​

CommToolsData.gui_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:91

mainAreaContainer ​

• mainAreaContainer: HTMLDivElement

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:16

nrrd_states ​

• nrrd_states: INrrdStates

Inherited from ​

CommToolsData.nrrd_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:15

pencilUrls ​

• pencilUrls: string[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:42

protectedData ​

• protectedData: IProtected

Inherited from ​

CommToolsData.protectedData

Defined in ​

src/Utils/segmentation/CommToolsData.ts:141

start ​

• start: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:46

undoArray ​

• undoArray: IUndoType[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:43

Methods ​

checkSharedPlaceSlice ​

▸ checkSharedPlaceSlice(width, height, imageData): Uint8ClampedArray

**************************** Utils for store image and itksnap core *************************************

Parameters ​

NameType
widthnumber
heightnumber
imageDataImageData

Returns ​

Uint8ClampedArray

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1682

clearPaint ​

▸ clearPaint(): void

Clear mask on current slice canvas

Returns ​

void

Overrides ​

CommToolsData.clearPaint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1217

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.clearStoreImages

Defined in ​

src/Utils/segmentation/CommToolsData.ts:229

configContrastDragMode ​

▸ configContrastDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1827

configMouseSphereWheel ​

▸ Private configMouseSphereWheel(): (e: WheelEvent) => void

Returns ​

fn

▸ (e): void

Parameters ​
NameType
eWheelEvent
Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:999

configMouseZoomWheel ​

▸ Private configMouseZoomWheel(): (e: WheelEvent) => void

Returns ​

fn

▸ (e): void

Parameters ​
NameType
eWheelEvent
Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:828

convertCursorPoint ​

▸ convertCursorPoint(from, to, cursorNumX, cursorNumY, currentSliceIndex): undefined | { convertCursorNumX: number ; convertCursorNumY: number ; currentIndex: number ; oldIndex: number }

We generate the MRI slice from threejs based on mm, but when we display it is based on pixel size/distance. So, the index munber on each axis (sagittal, axial, coronal) is the slice's depth in mm distance. And the width and height displayed on screen is the slice's width and height in pixel distance.

When we switch into different axis' views, we need to convert current view's the depth to the pixel distance in other views width or height, and convert the current view's width or height from pixel distance to mm distance as other views' depth (slice index) in general.

Then as for the crosshair (Cursor Inspector), we also need to convert the cursor point (x, y, z) to other views' (x, y, z).

Parameters ​

NameTypeDescription
from"z" | "y" | "x""x" | "y" | "z", current view axis, "x: sagittle, y: coronal, z: axial".
to"z" | "y" | "x""x" | "y" | "z", target view axis (where you want jump to), "x: sagittle, y: coronal, z: axial".
cursorNumXnumbernumber, cursor point x on current axis's slice. (pixel distance)
cursorNumYnumbernumber, cursor point y on current axis's slice. (pixel distance)
currentSliceIndexnumbernumber, current axis's slice's index/depth. (mm distance)

Returns ​

undefined | { convertCursorNumX: number ; convertCursorNumY: number ; currentIndex: number ; oldIndex: number }

Overrides ​

CommToolsData.convertCursorPoint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1060

draw ​

▸ draw(opts?): void

Parameters ​

NameType
opts?IDrawOpts

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:127

drawImageOnEmptyImage ​

▸ drawImageOnEmptyImage(canvas): void

Parameters ​

NameType
canvasHTMLCanvasElement

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:903

drawLine ​

▸ Private drawLine(x1, y1, x2, y2): void

***********************************May consider to move outside ******************************************

Parameters ​

NameType
x1number
y1number
x2number
y2number

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:686

drawLinesOnLayer ​

▸ Private drawLinesOnLayer(ctx, x, y): void

Parameters ​

NameType
ctxCanvasRenderingContext2D
xnumber
ynumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:694

drawSphere ​

▸ drawSphere(mouseX, mouseY, radius): void

Parameters ​

NameType
mouseXnumber
mouseYnumber
radiusnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1021

drawSphereCore ​

▸ Private drawSphereCore(ctx, x, y, radius): void

Parameters ​

NameType
ctxCanvasRenderingContext2D
xnumber
ynumber
radiusnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:963

drawSphereOnEachViews ​

▸ Private drawSphereOnEachViews(decay, axis): void

Parameters ​

NameType
decaynumber
axis"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:933

enableCrosshair ​

▸ Private enableCrosshair(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:882

filterDrawedImage ​

▸ filterDrawedImage(axis, sliceIndex, paintedImages): IPaintImage

Get a painted mask image (IPaintImage) based on current axis and input slice index.

Parameters ​

NameTypeDescription
axis"z" | "y" | "x""x" | "y" | "z"
sliceIndexnumbernumber
paintedImagesIPaintImagesIPaintImages, All painted mask images.

Returns ​

IPaintImage

Inherited from ​

CommToolsData.filterDrawedImage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:329

findSliceInSharedPlace ​

▸ findSliceInSharedPlace(): ImageData[]

Returns ​

ImageData[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1722

flipDisplayImageByAxis ​

▸ flipDisplayImageByAxis(): void

Rewrite this {flipDisplayImageByAxis} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.flipDisplayImageByAxis

Defined in ​

src/Utils/segmentation/CommToolsData.ts:261

getCurrentUndo ​

▸ Private getCurrentUndo(): IUndoType[]

************************** Undo clear functions***************************************************

Returns ​

IUndoType[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1208

getRestLabel ​

▸ getRestLabel(): ("label1" | "label2" | "label3")[]

label div controls*************************

Returns ​

("label1" | "label2" | "label3")[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1198

initAllCanvas ​

▸ Private initAllCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:729

initDrawToolCore ​

▸ Private initDrawToolCore(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:57

paintOnCanvas ​

▸ Private paintOnCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:135

paintOnCanvasLayer ​

▸ Private paintOnCanvasLayer(x, y): void

Parameters ​

NameType
xnumber
ynumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:717

redrawDisplayCanvas ​

▸ redrawDisplayCanvas(): void

Rewrite this {redrawDisplayCanvas} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.redrawDisplayCanvas

Defined in ​

src/Utils/segmentation/CommToolsData.ts:315

removeContrastDragMode ​

▸ removeContrastDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1841

replaceArray ​

▸ replaceArray(mainArr, replaceArr): void

Parameters ​

NameType
mainArrnumber[] | Uint8ClampedArray
replaceArrnumber[] | Uint8ClampedArray

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1709

replaceHorizontalRowPixels ​

▸ replaceHorizontalRowPixels(paintImageArray, length, ratio, markedArr, targetWidth, convertIndex): void

Parameters ​

NameTypeDescription
paintImageArrayIPaintImage[]: the target view slice's marked images array
lengthnumber: the target view slice's dimention (total slice index num)
rationumber: the target slice image's width/height ratio of its dimention length
markedArrnumber[][] | Uint8ClampedArray[]: current painted image's horizontal 2d Array
targetWidthnumber: the target image width
convertIndexnumber: Mapping current image's index to target slice image's width/height pixel start point

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1661

replaceVerticalColPixels ​

▸ replaceVerticalColPixels(paintImageArray, length, ratio, markedArr, targetWidth, convertIndex): void

Parameters ​

NameTypeDescription
paintImageArrayIPaintImage[]: the target view slice's marked images array
lengthnumber: the target view slice's dimention (total slice index num)
rationumber: the target slice image's width/height ratio of its dimention length
markedArrnumber[][] | Uint8ClampedArray[]: current painted image's vertical 2d Array
targetWidthnumber: the target image width
convertIndexnumber: Mapping current image's index to target slice image's width/height pixel start point

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1628

repraintCurrentContrastSlice ​

▸ repraintCurrentContrastSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1891

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Rewrite this {resetLayerCanvas} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.resetLayerCanvas

Defined in ​

src/Utils/segmentation/CommToolsData.ts:299

resetPaintAreaUIPosition ​

▸ resetPaintAreaUIPosition(l?, t?): void

Rewrite this {resetPaintAreaUIPosition} function under NrrdTools

Parameters ​

NameType
l?number
t?number

Returns ​

void

Inherited from ​

CommToolsData.resetPaintAreaUIPosition

Defined in ​

src/Utils/segmentation/CommToolsData.ts:269

resizePaintArea ​

▸ resizePaintArea(factor): void

Rewrite this {resizePaintArea} function under NrrdTools

Parameters ​

NameType
factornumber

Returns ​

void

Inherited from ​

CommToolsData.resizePaintArea

Defined in ​

src/Utils/segmentation/CommToolsData.ts:237

setCurrentLayer ​

▸ Private setCurrentLayer(): Object

Returns ​

Object

NameType
canvasHTMLCanvasElement
ctxCanvasRenderingContext2D

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:103

setEmptyCanvasSize ​

▸ setEmptyCanvasSize(axis?): void

Rewrite this {resetPaintAreaUIPosition} function under NrrdTools

Parameters ​

NameType
axis?"z" | "y" | "x"

Returns ​

void

Inherited from ​

CommToolsData.setEmptyCanvasSize

Defined in ​

src/Utils/segmentation/CommToolsData.ts:277

setEraserUrls ​

▸ setEraserUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:90

setIsDrawFalse ​

▸ setIsDrawFalse(target): void

Rewrite this {setIsDrawFalse} function under NrrdTools

Parameters ​

NameType
targetnumber

Returns ​

void

Inherited from ​

CommToolsData.setIsDrawFalse

Defined in ​

src/Utils/segmentation/CommToolsData.ts:245

setPencilIconUrls ​

▸ setPencilIconUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:93

setSphereCanvasSize ​

▸ Private setSphereCanvasSize(axis?): void

Parameters ​

NameType
axis?"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:976

setSyncsliceNum ​

▸ setSyncsliceNum(): void

Rewrite this {setSyncsliceNum} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.setSyncsliceNum

Defined in ​

src/Utils/segmentation/CommToolsData.ts:307

setUpSphereOrigins ​

▸ Private setUpSphereOrigins(mouseX, mouseY): void

Parameters ​

NameType
mouseXnumber
mouseYnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1155

setupConrastEvents ​

▸ setupConrastEvents(callback): void

Set up root container events fns for drag function

Parameters ​

NameType
callback(step: number, towards: "horizental" | "vertical") => void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1774

sliceArrayH ​

▸ sliceArrayH(arr, row, col): Uint8ClampedArray[]

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

Uint8ClampedArray[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1590

sliceArrayV ​

▸ sliceArrayV(arr, row, col): number[][]

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

number[][]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1601

storeAllImages ​

▸ storeAllImages(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1347

storeEachLayerImage ​

▸ storeEachLayerImage(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1548

storeImageToAxis ​

▸ storeImageToAxis(index, paintedImages, imageData, axis?): void

Store images*************************

Parameters ​

NameType
indexnumber
paintedImagesIPaintImages
imageDataImageData
axis?"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1313

storeImageToLabel ​

▸ storeImageToLabel(index, canvas, paintedImages): ImageData

Parameters ​

NameType
indexnumber
canvasHTMLCanvasElement
paintedImagesIPaintImages

Returns ​

ImageData

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1528

storeSphereImages ​

▸ Private storeSphereImages(index, axis): void

Sphere functions*************************

Parameters ​

NameType
indexnumber
axis"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:916

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Overrides ​

CommToolsData.undoLastPainting

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1236

updateOriginAndChangedWH ​

▸ updateOriginAndChangedWH(): void

Rewrite this {updateOriginAndChangedWH} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.updateOriginAndChangedWH

Defined in ​

src/Utils/segmentation/CommToolsData.ts:253

updateSlicesContrast ​

▸ updateSlicesContrast(value, flag): void

Parameters ​

NameType
valuenumber
flagstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1865

useEraser ​

▸ Private useEraser(): (x: number, y: number, radius: number) => void

Returns ​

fn

▸ (x, y, radius): void

Parameters ​
NameType
xnumber
ynumber
radiusnumber
Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:787

',600),n=[i];function l(s,d,h,c,m,u){return t(),a("div",null,n)}const p=e(o,[["render",l]]);export{g as __pageData,p as default}; diff --git a/assets/apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.c2280199.js b/assets/apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.c2280199.js new file mode 100644 index 0000000..cfdb0cb --- /dev/null +++ b/assets/apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.c2280199.js @@ -0,0 +1 @@ +import{_ as e,o as t,c as a,Q as r}from"./chunks/framework.5916b37e.js";const g=JSON.parse('{"title":"Class: DrawToolCore","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Utils_segmentation_DrawToolCore.DrawToolCore.md","filePath":"apidist/classes/Utils_segmentation_DrawToolCore.DrawToolCore.md"}'),o={name:"apidist/classes/Utils_segmentation_DrawToolCore.DrawToolCore.md"},i=r('

copper3d / Modules / Utils/segmentation/DrawToolCore / DrawToolCore

Class: DrawToolCore ​

Utils/segmentation/DrawToolCore.DrawToolCore

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new DrawToolCore(container)

Parameters ​

NameType
containerHTMLElement

Overrides ​

CommToolsData.constructor

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:48

Properties ​

baseCanvasesSize ​

• baseCanvasesSize: number = 1

Inherited from ​

CommToolsData.baseCanvasesSize

Defined in ​

src/Utils/segmentation/CommToolsData.ts:14

container ​

• container: HTMLElement

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:15

contrastEventPrameters ​

• contrastEventPrameters: IContrastEvents

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:28

cursorPage ​

• cursorPage: ICursorPage

Inherited from ​

CommToolsData.cursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:70

drawingPrameters ​

• drawingPrameters: IDrawingEvents

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:17

eraserUrls ​

• eraserUrls: string[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:41

gui_states ​

• gui_states: IGUIStates

Inherited from ​

CommToolsData.gui_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:91

mainAreaContainer ​

• mainAreaContainer: HTMLDivElement

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:16

nrrd_states ​

• nrrd_states: INrrdStates

Inherited from ​

CommToolsData.nrrd_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:15

pencilUrls ​

• pencilUrls: string[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:42

protectedData ​

• protectedData: IProtected

Inherited from ​

CommToolsData.protectedData

Defined in ​

src/Utils/segmentation/CommToolsData.ts:141

start ​

• start: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:46

undoArray ​

• undoArray: IUndoType[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:43

Methods ​

checkSharedPlaceSlice ​

▸ checkSharedPlaceSlice(width, height, imageData): Uint8ClampedArray

**************************** Utils for store image and itksnap core *************************************

Parameters ​

NameType
widthnumber
heightnumber
imageDataImageData

Returns ​

Uint8ClampedArray

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1693

clearPaint ​

▸ clearPaint(): void

Clear mask on current slice canvas

Returns ​

void

Overrides ​

CommToolsData.clearPaint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1228

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.clearStoreImages

Defined in ​

src/Utils/segmentation/CommToolsData.ts:229

configContrastDragMode ​

▸ configContrastDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1838

configMouseSphereWheel ​

▸ Private configMouseSphereWheel(): (e: WheelEvent) => void

Returns ​

fn

▸ (e): void

Parameters ​
NameType
eWheelEvent
Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1010

configMouseZoomWheel ​

▸ Private configMouseZoomWheel(): (e: WheelEvent) => void

Returns ​

fn

▸ (e): void

Parameters ​
NameType
eWheelEvent
Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:839

convertCursorPoint ​

▸ convertCursorPoint(from, to, cursorNumX, cursorNumY, currentSliceIndex): undefined | { convertCursorNumX: number ; convertCursorNumY: number ; currentIndex: number ; oldIndex: number }

We generate the MRI slice from threejs based on mm, but when we display it is based on pixel size/distance. So, the index munber on each axis (sagittal, axial, coronal) is the slice's depth in mm distance. And the width and height displayed on screen is the slice's width and height in pixel distance.

When we switch into different axis' views, we need to convert current view's the depth to the pixel distance in other views width or height, and convert the current view's width or height from pixel distance to mm distance as other views' depth (slice index) in general.

Then as for the crosshair (Cursor Inspector), we also need to convert the cursor point (x, y, z) to other views' (x, y, z).

Parameters ​

NameTypeDescription
from"z" | "y" | "x""x" | "y" | "z", current view axis, "x: sagittle, y: coronal, z: axial".
to"z" | "y" | "x""x" | "y" | "z", target view axis (where you want jump to), "x: sagittle, y: coronal, z: axial".
cursorNumXnumbernumber, cursor point x on current axis's slice. (pixel distance)
cursorNumYnumbernumber, cursor point y on current axis's slice. (pixel distance)
currentSliceIndexnumbernumber, current axis's slice's index/depth. (mm distance)

Returns ​

undefined | { convertCursorNumX: number ; convertCursorNumY: number ; currentIndex: number ; oldIndex: number }

Overrides ​

CommToolsData.convertCursorPoint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1071

draw ​

▸ draw(opts?): void

Parameters ​

NameType
opts?IDrawOpts

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:142

drawImageOnEmptyImage ​

▸ drawImageOnEmptyImage(canvas): void

Parameters ​

NameType
canvasHTMLCanvasElement

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:914

drawLine ​

▸ Private drawLine(x1, y1, x2, y2): void

***********************************May consider to move outside ******************************************

Parameters ​

NameType
x1number
y1number
x2number
y2number

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:697

drawLinesOnLayer ​

▸ Private drawLinesOnLayer(ctx, x, y): void

Parameters ​

NameType
ctxCanvasRenderingContext2D
xnumber
ynumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:705

drawSphere ​

▸ drawSphere(mouseX, mouseY, radius): void

Parameters ​

NameType
mouseXnumber
mouseYnumber
radiusnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1032

drawSphereCore ​

▸ Private drawSphereCore(ctx, x, y, radius): void

Parameters ​

NameType
ctxCanvasRenderingContext2D
xnumber
ynumber
radiusnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:974

drawSphereOnEachViews ​

▸ Private drawSphereOnEachViews(decay, axis): void

Parameters ​

NameType
decaynumber
axis"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:944

enableCrosshair ​

▸ Private enableCrosshair(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:893

filterDrawedImage ​

▸ filterDrawedImage(axis, sliceIndex, paintedImages): IPaintImage

Get a painted mask image (IPaintImage) based on current axis and input slice index.

Parameters ​

NameTypeDescription
axis"z" | "y" | "x""x" | "y" | "z"
sliceIndexnumbernumber
paintedImagesIPaintImagesIPaintImages, All painted mask images.

Returns ​

IPaintImage

Inherited from ​

CommToolsData.filterDrawedImage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:329

findSliceInSharedPlace ​

▸ findSliceInSharedPlace(): ImageData[]

Returns ​

ImageData[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1733

flipDisplayImageByAxis ​

▸ flipDisplayImageByAxis(): void

Rewrite this {flipDisplayImageByAxis} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.flipDisplayImageByAxis

Defined in ​

src/Utils/segmentation/CommToolsData.ts:261

getCurrentUndo ​

▸ Private getCurrentUndo(): IUndoType[]

************************** Undo clear functions***************************************************

Returns ​

IUndoType[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1219

getRestLabel ​

▸ getRestLabel(): ("label1" | "label2" | "label3")[]

label div controls*************************

Returns ​

("label1" | "label2" | "label3")[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1209

initAllCanvas ​

▸ Private initAllCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:740

initDrawToolCore ​

▸ Private initDrawToolCore(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:57

paintOnCanvas ​

▸ Private paintOnCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:150

paintOnCanvasLayer ​

▸ Private paintOnCanvasLayer(x, y): void

Parameters ​

NameType
xnumber
ynumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:728

redrawDisplayCanvas ​

▸ redrawDisplayCanvas(): void

Rewrite this {redrawDisplayCanvas} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.redrawDisplayCanvas

Defined in ​

src/Utils/segmentation/CommToolsData.ts:315

removeContrastDragMode ​

▸ removeContrastDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1852

replaceArray ​

▸ replaceArray(mainArr, replaceArr): void

Parameters ​

NameType
mainArrnumber[] | Uint8ClampedArray
replaceArrnumber[] | Uint8ClampedArray

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1720

replaceHorizontalRowPixels ​

▸ replaceHorizontalRowPixels(paintImageArray, length, ratio, markedArr, targetWidth, convertIndex): void

Parameters ​

NameTypeDescription
paintImageArrayIPaintImage[]: the target view slice's marked images array
lengthnumber: the target view slice's dimention (total slice index num)
rationumber: the target slice image's width/height ratio of its dimention length
markedArrnumber[][] | Uint8ClampedArray[]: current painted image's horizontal 2d Array
targetWidthnumber: the target image width
convertIndexnumber: Mapping current image's index to target slice image's width/height pixel start point

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1672

replaceVerticalColPixels ​

▸ replaceVerticalColPixels(paintImageArray, length, ratio, markedArr, targetWidth, convertIndex): void

Parameters ​

NameTypeDescription
paintImageArrayIPaintImage[]: the target view slice's marked images array
lengthnumber: the target view slice's dimention (total slice index num)
rationumber: the target slice image's width/height ratio of its dimention length
markedArrnumber[][] | Uint8ClampedArray[]: current painted image's vertical 2d Array
targetWidthnumber: the target image width
convertIndexnumber: Mapping current image's index to target slice image's width/height pixel start point

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1639

repraintCurrentContrastSlice ​

▸ repraintCurrentContrastSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1902

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Rewrite this {resetLayerCanvas} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.resetLayerCanvas

Defined in ​

src/Utils/segmentation/CommToolsData.ts:299

resetPaintAreaUIPosition ​

▸ resetPaintAreaUIPosition(l?, t?): void

Rewrite this {resetPaintAreaUIPosition} function under NrrdTools

Parameters ​

NameType
l?number
t?number

Returns ​

void

Inherited from ​

CommToolsData.resetPaintAreaUIPosition

Defined in ​

src/Utils/segmentation/CommToolsData.ts:269

resizePaintArea ​

▸ resizePaintArea(factor): void

Rewrite this {resizePaintArea} function under NrrdTools

Parameters ​

NameType
factornumber

Returns ​

void

Inherited from ​

CommToolsData.resizePaintArea

Defined in ​

src/Utils/segmentation/CommToolsData.ts:237

setCurrentLayer ​

▸ Private setCurrentLayer(): Object

Returns ​

Object

NameType
canvasHTMLCanvasElement
ctxCanvasRenderingContext2D

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:118

setEmptyCanvasSize ​

▸ setEmptyCanvasSize(axis?): void

Rewrite this {resetPaintAreaUIPosition} function under NrrdTools

Parameters ​

NameType
axis?"z" | "y" | "x"

Returns ​

void

Inherited from ​

CommToolsData.setEmptyCanvasSize

Defined in ​

src/Utils/segmentation/CommToolsData.ts:277

setEraserUrls ​

▸ setEraserUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:105

setIsDrawFalse ​

▸ setIsDrawFalse(target): void

Rewrite this {setIsDrawFalse} function under NrrdTools

Parameters ​

NameType
targetnumber

Returns ​

void

Inherited from ​

CommToolsData.setIsDrawFalse

Defined in ​

src/Utils/segmentation/CommToolsData.ts:245

setPencilIconUrls ​

▸ setPencilIconUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:108

setSphereCanvasSize ​

▸ Private setSphereCanvasSize(axis?): void

Parameters ​

NameType
axis?"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:987

setSyncsliceNum ​

▸ setSyncsliceNum(): void

Rewrite this {setSyncsliceNum} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.setSyncsliceNum

Defined in ​

src/Utils/segmentation/CommToolsData.ts:307

setUpSphereOrigins ​

▸ Private setUpSphereOrigins(mouseX, mouseY): void

Parameters ​

NameType
mouseXnumber
mouseYnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1166

setupConrastEvents ​

▸ setupConrastEvents(callback): void

Set up root container events fns for drag function

Parameters ​

NameType
callback(step: number, towards: "horizental" | "vertical") => void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1785

sliceArrayH ​

▸ sliceArrayH(arr, row, col): Uint8ClampedArray[]

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

Uint8ClampedArray[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1601

sliceArrayV ​

▸ sliceArrayV(arr, row, col): number[][]

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

number[][]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1612

storeAllImages ​

▸ storeAllImages(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1358

storeEachLayerImage ​

▸ storeEachLayerImage(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1559

storeImageToAxis ​

▸ storeImageToAxis(index, paintedImages, imageData, axis?): void

Store images*************************

Parameters ​

NameType
indexnumber
paintedImagesIPaintImages
imageDataImageData
axis?"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1324

storeImageToLabel ​

▸ storeImageToLabel(index, canvas, paintedImages): ImageData

Parameters ​

NameType
indexnumber
canvasHTMLCanvasElement
paintedImagesIPaintImages

Returns ​

ImageData

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1539

storeSphereImages ​

▸ Private storeSphereImages(index, axis): void

Sphere functions*************************

Parameters ​

NameType
indexnumber
axis"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:927

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Overrides ​

CommToolsData.undoLastPainting

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1247

updateOriginAndChangedWH ​

▸ updateOriginAndChangedWH(): void

Rewrite this {updateOriginAndChangedWH} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.updateOriginAndChangedWH

Defined in ​

src/Utils/segmentation/CommToolsData.ts:253

updateSlicesContrast ​

▸ updateSlicesContrast(value, flag): void

Parameters ​

NameType
valuenumber
flagstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1876

useEraser ​

▸ Private useEraser(): (x: number, y: number, radius: number) => void

Returns ​

fn

▸ (x, y, radius): void

Parameters ​
NameType
xnumber
ynumber
radiusnumber
Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:798

',600),n=[i];function l(s,d,h,c,m,u){return t(),a("div",null,n)}const p=e(o,[["render",l]]);export{g as __pageData,p as default}; diff --git a/assets/apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.0c9f9fa4.lean.js b/assets/apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.c2280199.lean.js similarity index 100% rename from assets/apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.0c9f9fa4.lean.js rename to assets/apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.c2280199.lean.js diff --git a/assets/apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.878782ef.js b/assets/apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.4817471e.js similarity index 71% rename from assets/apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.878782ef.js rename to assets/apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.4817471e.js index 56ed99b..bd2f89c 100644 --- a/assets/apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.878782ef.js +++ b/assets/apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.4817471e.js @@ -1 +1 @@ -import{_ as e,o as t,c as a,Q as r}from"./chunks/framework.5916b37e.js";const g=JSON.parse('{"title":"Class: NrrdTools","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Utils_segmentation_NrrdTools.NrrdTools.md","filePath":"apidist/classes/Utils_segmentation_NrrdTools.NrrdTools.md"}'),o={name:"apidist/classes/Utils_segmentation_NrrdTools.NrrdTools.md"},i=r('

copper3d / Modules / Utils/segmentation/NrrdTools / NrrdTools

Class: NrrdTools ​

Utils/segmentation/NrrdTools.NrrdTools

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new NrrdTools(container)

Parameters ​

NameType
containerHTMLDivElement

Overrides ​

DrawToolCore.constructor

Defined in ​

src/Utils/segmentation/NrrdTools.ts:36

Properties ​

baseCanvasesSize ​

• baseCanvasesSize: number = 1

Inherited from ​

DrawToolCore.baseCanvasesSize

Defined in ​

src/Utils/segmentation/CommToolsData.ts:14

container ​

• container: HTMLDivElement

Overrides ​

DrawToolCore.container

Defined in ​

src/Utils/segmentation/NrrdTools.ts:24

contrastEventPrameters ​

• contrastEventPrameters: IContrastEvents

Inherited from ​

DrawToolCore.contrastEventPrameters

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:28

cursorPage ​

• cursorPage: ICursorPage

Inherited from ​

DrawToolCore.cursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:70

dragOperator ​

• dragOperator: DragOperator

Defined in ​

src/Utils/segmentation/NrrdTools.ts:27

drawingPrameters ​

• drawingPrameters: IDrawingEvents

Inherited from ​

DrawToolCore.drawingPrameters

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:17

eraserUrls ​

• eraserUrls: string[] = []

Inherited from ​

DrawToolCore.eraserUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:41

guiParameterSettings ​

• Private guiParameterSettings: undefined | IGuiParameterSettings

Defined in ​

src/Utils/segmentation/NrrdTools.ts:34

gui_states ​

• gui_states: IGUIStates

Inherited from ​

DrawToolCore.gui_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:91

initState ​

• Private initState: boolean = true

Defined in ​

src/Utils/segmentation/NrrdTools.ts:32

mainAreaContainer ​

• mainAreaContainer: HTMLDivElement

Inherited from ​

DrawToolCore.mainAreaContainer

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:16

nrrd_states ​

• nrrd_states: INrrdStates

Inherited from ​

DrawToolCore.nrrd_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:15

paintedImage ​

• Private paintedImage: undefined | IPaintImage

Defined in ​

src/Utils/segmentation/NrrdTools.ts:30

pencilUrls ​

• pencilUrls: string[] = []

Inherited from ​

DrawToolCore.pencilUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:42

preTimer ​

• Private preTimer: any

Defined in ​

src/Utils/segmentation/NrrdTools.ts:33

protectedData ​

• protectedData: IProtected

Inherited from ​

DrawToolCore.protectedData

Defined in ​

src/Utils/segmentation/CommToolsData.ts:141

start ​

• start: () => void

Type declaration ​

▸ (): void

Returns ​

void

Inherited from ​

DrawToolCore.start

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:46

storedPaintImages ​

• storedPaintImages: undefined | IStoredPaintImages

Defined in ​

src/Utils/segmentation/NrrdTools.ts:28

undoArray ​

• undoArray: IUndoType[] = []

Inherited from ​

DrawToolCore.undoArray

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:43

Methods ​

addSkip ​

▸ addSkip(index): void

Parameters ​

NameType
indexnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:590

afterLoadSlice ​

▸ Private afterLoadSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:820

appendLoadingbar ​

▸ appendLoadingbar(loadingbar): void

Parameters ​

NameType
loadingbarHTMLDivElement

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:876

checkSharedPlaceSlice ​

▸ checkSharedPlaceSlice(width, height, imageData): Uint8ClampedArray

**************************** Utils for store image and itksnap core *************************************

Parameters ​

NameType
widthnumber
heightnumber
imageDataImageData

Returns ​

Uint8ClampedArray

Inherited from ​

DrawToolCore.checkSharedPlaceSlice

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1682

clear ​

▸ clear(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:608

clearDictionary ​

▸ Private clearDictionary(dic): void

Parameters ​

NameType
dicISkipSlicesDictType

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1109

clearPaint ​

▸ clearPaint(): void

Clear mask on current slice canvas

Returns ​

void

Inherited from ​

DrawToolCore.clearPaint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1217

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Overrides ​

DrawToolCore.clearStoreImages

Defined in ​

src/Utils/segmentation/NrrdTools.ts:880

configContrastDragMode ​

▸ configContrastDragMode(): void

Returns ​

void

Inherited from ​

DrawToolCore.configContrastDragMode

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1827

convertCursorPoint ​

▸ convertCursorPoint(from, to, cursorNumX, cursorNumY, currentSliceIndex): undefined | { convertCursorNumX: number ; convertCursorNumY: number ; currentIndex: number ; oldIndex: number }

We generate the MRI slice from threejs based on mm, but when we display it is based on pixel size/distance. So, the index munber on each axis (sagittal, axial, coronal) is the slice's depth in mm distance. And the width and height displayed on screen is the slice's width and height in pixel distance.

When we switch into different axis' views, we need to convert current view's the depth to the pixel distance in other views width or height, and convert the current view's width or height from pixel distance to mm distance as other views' depth (slice index) in general.

Then as for the crosshair (Cursor Inspector), we also need to convert the cursor point (x, y, z) to other views' (x, y, z).

Parameters ​

NameTypeDescription
from"z" | "y" | "x""x" | "y" | "z", current view axis, "x: sagittle, y: coronal, z: axial".
to"z" | "y" | "x""x" | "y" | "z", target view axis (where you want jump to), "x: sagittle, y: coronal, z: axial".
cursorNumXnumbernumber, cursor point x on current axis's slice. (pixel distance)
cursorNumYnumbernumber, cursor point y on current axis's slice. (pixel distance)
currentSliceIndexnumbernumber, current axis's slice's index/depth. (mm distance)

Returns ​

undefined | { convertCursorNumX: number ; convertCursorNumY: number ; currentIndex: number ; oldIndex: number }

Inherited from ​

DrawToolCore.convertCursorPoint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1060

createEmptyPaintImage ​

▸ Private createEmptyPaintImage(dimensions, paintImages): void

Parameters ​

NameType
dimensionsnumber[]
paintImagesIPaintImages

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:391

drag ​

▸ drag(opts?): void

core function for drag slices

Parameters ​

NameType
opts?IDragOpts

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:67

draw ​

▸ draw(opts?): void

Parameters ​

NameType
opts?IDrawOpts

Returns ​

void

Inherited from ​

DrawToolCore.draw

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:127

drawImageOnEmptyImage ​

▸ drawImageOnEmptyImage(canvas): void

Parameters ​

NameType
canvasHTMLCanvasElement

Returns ​

void

Inherited from ​

DrawToolCore.drawImageOnEmptyImage

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:903

drawSphere ​

▸ drawSphere(mouseX, mouseY, radius): void

Parameters ​

NameType
mouseXnumber
mouseYnumber
radiusnumber

Returns ​

void

Inherited from ​

DrawToolCore.drawSphere

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1021

enableContrastDragEvents ​

▸ enableContrastDragEvents(callback): void

Enable the drag function for contrast images window center and window high.

Parameters ​

NameType
callback(step: number, towards: "horizental" | "vertical") => void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:101

filterDrawedImage ​

▸ filterDrawedImage(axis, sliceIndex, paintedImages): IPaintImage

Get a painted mask image (IPaintImage) based on current axis and input slice index.

Parameters ​

NameTypeDescription
axis"z" | "y" | "x""x" | "y" | "z"
sliceIndexnumbernumber
paintedImagesIPaintImagesIPaintImages, All painted mask images.

Returns ​

IPaintImage

Inherited from ​

DrawToolCore.filterDrawedImage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:329

findSliceInSharedPlace ​

▸ findSliceInSharedPlace(): ImageData[]

Returns ​

ImageData[]

Inherited from ​

DrawToolCore.findSliceInSharedPlace

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1722

flipDisplayImageByAxis ​

▸ flipDisplayImageByAxis(): void

flip the canvas to a correct position. This is because the slice canvas from threejs is not in a correct 2D postion. Thus, everytime when we redraw the display canvas, we need to flip to draw the origin canvas from threejs. Under different axis(sagittal, Axial, Coronal), the flip orientation is different.

Returns ​

void

Overrides ​

DrawToolCore.flipDisplayImageByAxis

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1092

getContainer ​

▸ getContainer(): HTMLElement

Returns ​

HTMLElement

Defined in ​

src/Utils/segmentation/NrrdTools.ts:672

getCurrentImageDimension ​

▸ getCurrentImageDimension(): number[]

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:333

getCurrentSliceIndex ​

▸ getCurrentSliceIndex(): number

Returns ​

number

Defined in ​

src/Utils/segmentation/NrrdTools.ts:699

getCurrentSlicesNumAndContrastNum ​

▸ getCurrentSlicesNumAndContrastNum(): Object

Returns ​

Object

NameType
contrastIndexnumber
currentIndexnumber

Defined in ​

src/Utils/segmentation/NrrdTools.ts:692

getDrawingCanvas ​

▸ getDrawingCanvas(): HTMLCanvasElement

Returns ​

HTMLCanvasElement

Defined in ​

src/Utils/segmentation/NrrdTools.ts:675

getGuiSettings ​

▸ getGuiSettings(): Object

Returns ​

Object

NameType
guiSettingundefined | IGuiParameterSettings
guiStateIGUIStates

Defined in ​

src/Utils/segmentation/NrrdTools.ts:159

getIsShowContrastState ​

▸ getIsShowContrastState(): boolean

Returns ​

boolean

Defined in ​

src/Utils/segmentation/NrrdTools.ts:705

getMaskData ​

▸ getMaskData(): IMaskData

Returns ​

IMaskData

Defined in ​

src/Utils/segmentation/NrrdTools.ts:343

getMaxSliceNum ​

▸ getMaxSliceNum(): number[]

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:682

getNrrdToolsSettings ​

▸ getNrrdToolsSettings(): INrrdStates

Returns ​

INrrdStates

Defined in ​

src/Utils/segmentation/NrrdTools.ts:678

getRestLabel ​

▸ getRestLabel(): ("label1" | "label2" | "label3")[]

label div controls*************************

Returns ​

("label1" | "label2" | "label3")[]

Inherited from ​

DrawToolCore.getRestLabel

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1198

getSharedPlace ​

▸ Private getSharedPlace(len, ratio): number[]

Parameters ​

NameType
lennumber
rationumber

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:347

getSpaceOrigin ​

▸ getSpaceOrigin(): number[]

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:340

getVoxelSpacing ​

▸ getVoxelSpacing(): number[]

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:337

init ​

▸ Private init(): void

A initialise function for nrrd_tools

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:176

initPaintImages ​

▸ Private initPaintImages(dimensions): void

init all painted images for store images

Parameters ​

NameType
dimensionsnumber[]

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:372

loadDisplaySlicesArray ​

▸ Private loadDisplaySlicesArray(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:738

loadingMaskByLabel ​

▸ Private loadingMaskByLabel(masks, index, imageData): ImageData

Parameters ​

NameType
masksexportPaintImageType[]
indexnumber
imageDataImageData

Returns ​

ImageData

Defined in ​

src/Utils/segmentation/NrrdTools.ts:248

redrawDisplayCanvas ​

▸ redrawDisplayCanvas(): void

Redraw current contrast image to display canvas. It is more related to change the contrast slice image's window width or center.

Returns ​

void

Overrides ​

DrawToolCore.redrawDisplayCanvas

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1149

redrawMianPreOnDisplayCanvas ​

▸ redrawMianPreOnDisplayCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:933

reloadMaskToLabel ​

▸ Private reloadMaskToLabel(paintImages, ctx): void

Used to init the mask on each label and reload

Parameters ​

NameType
paintImagesIPaintImages
ctxCanvasRenderingContext2D

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1031

removeContrastDragMode ​

▸ removeContrastDragMode(): void

Returns ​

void

Inherited from ​

DrawToolCore.removeContrastDragMode

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1841

removeSkip ​

▸ removeSkip(index): void

Parameters ​

NameType
indexnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:602

replaceArray ​

▸ replaceArray(mainArr, replaceArr): void

Parameters ​

NameType
mainArrnumber[] | Uint8ClampedArray
replaceArrnumber[] | Uint8ClampedArray

Returns ​

void

Inherited from ​

DrawToolCore.replaceArray

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1709

replaceHorizontalRowPixels ​

▸ replaceHorizontalRowPixels(paintImageArray, length, ratio, markedArr, targetWidth, convertIndex): void

Parameters ​

NameTypeDescription
paintImageArrayIPaintImage[]: the target view slice's marked images array
lengthnumber: the target view slice's dimention (total slice index num)
rationumber: the target slice image's width/height ratio of its dimention length
markedArrnumber[][] | Uint8ClampedArray[]: current painted image's horizontal 2d Array
targetWidthnumber: the target image width
convertIndexnumber: Mapping current image's index to target slice image's width/height pixel start point

Returns ​

void

Inherited from ​

DrawToolCore.replaceHorizontalRowPixels

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1661

replaceVerticalColPixels ​

▸ replaceVerticalColPixels(paintImageArray, length, ratio, markedArr, targetWidth, convertIndex): void

Parameters ​

NameTypeDescription
paintImageArrayIPaintImage[]: the target view slice's marked images array
lengthnumber: the target view slice's dimention (total slice index num)
rationumber: the target slice image's width/height ratio of its dimention length
markedArrnumber[][] | Uint8ClampedArray[]: current painted image's vertical 2d Array
targetWidthnumber: the target image width
convertIndexnumber: Mapping current image's index to target slice image's width/height pixel start point

Returns ​

void

Inherited from ​

DrawToolCore.replaceVerticalColPixels

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1628

repraintCurrentContrastSlice ​

▸ repraintCurrentContrastSlice(): void

Returns ​

void

Inherited from ​

DrawToolCore.repraintCurrentContrastSlice

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1891

resetDisplaySlicesStatus ​

▸ Private resetDisplaySlicesStatus(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:765

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Clear masks on drawingCanvas layers.

Returns ​

void

Overrides ​

DrawToolCore.resetLayerCanvas

Defined in ​

src/Utils/segmentation/NrrdTools.ts:922

resetPaintAreaUIPosition ​

▸ resetPaintAreaUIPosition(l?, t?): void

Reset the draw and display canvases layout after mouse pan. If no params in, then center the draw and display canvases.

Parameters ​

NameTypeDescription
l?numbernumber, Offset to the left
t?numbernumber, Offset to the top

Returns ​

void

Overrides ​

DrawToolCore.resetPaintAreaUIPosition

Defined in ​

src/Utils/segmentation/NrrdTools.ts:902

resizePaintArea ​

▸ resizePaintArea(factor): void

Resize the draw and display canvas size based on the input size factor number.

Parameters ​

NameTypeDescription
factornumbernumber

Returns ​

void

Overrides ​

DrawToolCore.resizePaintArea

Defined in ​

src/Utils/segmentation/NrrdTools.ts:961

setAllSlices ​

▸ setAllSlices(allSlices): void

entry function

Parameters ​

NameTypeDescription
allSlicesnrrdSliceType[]all nrrd contrast slices

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:198

setBaseDrawDisplayCanvasesSize ​

▸ setBaseDrawDisplayCanvasesSize(size): void

Set the Draw Display Canvas base size

Parameters ​

NameTypeDescription
sizenumbernumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:83

setDisplaySliceIndexPanel ​

▸ setDisplaySliceIndexPanel(panel): void

Parameters ​

NameType
panelHTMLDivElement

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:93

setDisplaySlicesBaseOnAxis ​

▸ Private setDisplaySlicesBaseOnAxis(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:725

setEmptyCanvasSize ​

▸ setEmptyCanvasSize(axis?): void

Set the empty canvas width and height based on the axis (pixel distance not the mm), to reduce duplicate codes.

Parameters ​

NameType
axis?"z" | "y" | "x"

Returns ​

void

Overrides ​

DrawToolCore.setEmptyCanvasSize

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1120

setEraserUrls ​

▸ setEraserUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Inherited from ​

DrawToolCore.setEraserUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:90

setIsDrawFalse ​

▸ setIsDrawFalse(target): void

Give a delay time to finish the last drawing before upcoming interrupt opreations. Give a delay time number (ms) to disable the draw function, After your interrupt opeartion, you should enable the draw fucntion.

Parameters ​

NameTypeDescription
targetnumbernumber

Returns ​

void

Overrides ​

DrawToolCore.setIsDrawFalse

Defined in ​

src/Utils/segmentation/NrrdTools.ts:715

setMainAreaSize ​

▸ setMainAreaSize(factor): void

Parameters ​

NameType
factornumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:659

setMainPreSlice ​

▸ Private setMainPreSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:789

setMasksData ​

▸ setMasksData(masksData, loadingBar?): void

Parameters ​

NameType
masksDatastoreExportPaintImageType
loadingBar?loadingBarType

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:265

setOriginCanvasAndPre ​

▸ Private setOriginCanvasAndPre(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:796

setPencilIconUrls ​

▸ setPencilIconUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Inherited from ​

DrawToolCore.setPencilIconUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:93

setShowInMainArea ​

▸ Private setShowInMainArea(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:329

setSliceMoving ​

▸ setSliceMoving(step): void

Parameters ​

NameType
stepnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:650

setSliceOrientation ​

▸ setSliceOrientation(axisTo): void

Switch all contrast slices' orientation

Parameters ​

NameType
axisTo"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:436

setSyncsliceNum ​

▸ setSyncsliceNum(): void

Keep all contrast slice index to same. Synchronize the slice indexes of all the contrasts so that they are consistent with the main slice's index.

Returns ​

void

Overrides ​

DrawToolCore.setSyncsliceNum

Defined in ​

src/Utils/segmentation/NrrdTools.ts:868

setupConfigs ​

▸ Private setupConfigs(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:772

setupConrastEvents ​

▸ setupConrastEvents(callback): void

Set up root container events fns for drag function

Parameters ​

NameType
callback(step: number, towards: "horizental" | "vertical") => void

Returns ​

void

Inherited from ​

DrawToolCore.setupConrastEvents

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1774

setupGUI ​

▸ setupGUI(gui): void

Set up GUI for drawing panel

Parameters ​

NameTypeDescription
guiGUIGUI

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:109

sliceArrayH ​

▸ sliceArrayH(arr, row, col): Uint8ClampedArray[]

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

Uint8ClampedArray[]

Inherited from ​

DrawToolCore.sliceArrayH

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1590

sliceArrayV ​

▸ sliceArrayV(arr, row, col): number[][]

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

number[][]

Inherited from ​

DrawToolCore.sliceArrayV

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1601

storeAllImages ​

▸ storeAllImages(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Inherited from ​

DrawToolCore.storeAllImages

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1347

storeEachLayerImage ​

▸ storeEachLayerImage(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Inherited from ​

DrawToolCore.storeEachLayerImage

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1548

storeImageToAxis ​

▸ storeImageToAxis(index, paintedImages, imageData, axis?): void

Store images*************************

Parameters ​

NameType
indexnumber
paintedImagesIPaintImages
imageDataImageData
axis?"z" | "y" | "x"

Returns ​

void

Inherited from ​

DrawToolCore.storeImageToAxis

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1313

storeImageToLabel ​

▸ storeImageToLabel(index, canvas, paintedImages): ImageData

Parameters ​

NameType
indexnumber
canvasHTMLCanvasElement
paintedImagesIPaintImages

Returns ​

ImageData

Inherited from ​

DrawToolCore.storeImageToLabel

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1528

switchAllSlicesArrayData ​

▸ switchAllSlicesArrayData(allSlices): void

Parameters ​

NameType
allSlicesnrrdSliceType[]

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:759

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Inherited from ​

DrawToolCore.undoLastPainting

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1236

updateMaxIndex ​

▸ Private updateMaxIndex(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:840

updateOriginAndChangedWH ​

▸ updateOriginAndChangedWH(): void

Update the original canvas size, allow set to threejs load one (pixel distance not the mm). Then update the changedWidth and changedHeight based on the sizeFoctor.

Returns ​

void

Overrides ​

DrawToolCore.updateOriginAndChangedWH

Defined in ​

src/Utils/segmentation/NrrdTools.ts:850

updateSlicesContrast ​

▸ updateSlicesContrast(value, flag): void

Parameters ​

NameType
valuenumber
flagstring

Returns ​

void

Inherited from ​

DrawToolCore.updateSlicesContrast

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1865

',896),n=[i];function l(s,d,h,c,m,u){return t(),a("div",null,n)}const p=e(o,[["render",l]]);export{g as __pageData,p as default}; +import{_ as e,o as t,c as a,Q as r}from"./chunks/framework.5916b37e.js";const g=JSON.parse('{"title":"Class: NrrdTools","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/classes/Utils_segmentation_NrrdTools.NrrdTools.md","filePath":"apidist/classes/Utils_segmentation_NrrdTools.NrrdTools.md"}'),o={name:"apidist/classes/Utils_segmentation_NrrdTools.NrrdTools.md"},i=r('

copper3d / Modules / Utils/segmentation/NrrdTools / NrrdTools

Class: NrrdTools ​

Utils/segmentation/NrrdTools.NrrdTools

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new NrrdTools(container)

Parameters ​

NameType
containerHTMLDivElement

Overrides ​

DrawToolCore.constructor

Defined in ​

src/Utils/segmentation/NrrdTools.ts:36

Properties ​

baseCanvasesSize ​

• baseCanvasesSize: number = 1

Inherited from ​

DrawToolCore.baseCanvasesSize

Defined in ​

src/Utils/segmentation/CommToolsData.ts:14

container ​

• container: HTMLDivElement

Overrides ​

DrawToolCore.container

Defined in ​

src/Utils/segmentation/NrrdTools.ts:24

contrastEventPrameters ​

• contrastEventPrameters: IContrastEvents

Inherited from ​

DrawToolCore.contrastEventPrameters

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:28

cursorPage ​

• cursorPage: ICursorPage

Inherited from ​

DrawToolCore.cursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:70

dragOperator ​

• dragOperator: DragOperator

Defined in ​

src/Utils/segmentation/NrrdTools.ts:27

drawingPrameters ​

• drawingPrameters: IDrawingEvents

Inherited from ​

DrawToolCore.drawingPrameters

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:17

eraserUrls ​

• eraserUrls: string[] = []

Inherited from ​

DrawToolCore.eraserUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:41

guiParameterSettings ​

• Private guiParameterSettings: undefined | IGuiParameterSettings

Defined in ​

src/Utils/segmentation/NrrdTools.ts:34

gui_states ​

• gui_states: IGUIStates

Inherited from ​

DrawToolCore.gui_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:91

initState ​

• Private initState: boolean = true

Defined in ​

src/Utils/segmentation/NrrdTools.ts:32

mainAreaContainer ​

• mainAreaContainer: HTMLDivElement

Inherited from ​

DrawToolCore.mainAreaContainer

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:16

nrrd_states ​

• nrrd_states: INrrdStates

Inherited from ​

DrawToolCore.nrrd_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:15

paintedImage ​

• Private paintedImage: undefined | IPaintImage

Defined in ​

src/Utils/segmentation/NrrdTools.ts:30

pencilUrls ​

• pencilUrls: string[] = []

Inherited from ​

DrawToolCore.pencilUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:42

preTimer ​

• Private preTimer: any

Defined in ​

src/Utils/segmentation/NrrdTools.ts:33

protectedData ​

• protectedData: IProtected

Inherited from ​

DrawToolCore.protectedData

Defined in ​

src/Utils/segmentation/CommToolsData.ts:141

start ​

• start: () => void

Type declaration ​

▸ (): void

Returns ​

void

Inherited from ​

DrawToolCore.start

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:46

storedPaintImages ​

• storedPaintImages: undefined | IStoredPaintImages

Defined in ​

src/Utils/segmentation/NrrdTools.ts:28

undoArray ​

• undoArray: IUndoType[] = []

Inherited from ​

DrawToolCore.undoArray

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:43

Methods ​

addSkip ​

▸ addSkip(index): void

Parameters ​

NameType
indexnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:590

afterLoadSlice ​

▸ Private afterLoadSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:820

appendLoadingbar ​

▸ appendLoadingbar(loadingbar): void

Parameters ​

NameType
loadingbarHTMLDivElement

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:876

checkSharedPlaceSlice ​

▸ checkSharedPlaceSlice(width, height, imageData): Uint8ClampedArray

**************************** Utils for store image and itksnap core *************************************

Parameters ​

NameType
widthnumber
heightnumber
imageDataImageData

Returns ​

Uint8ClampedArray

Inherited from ​

DrawToolCore.checkSharedPlaceSlice

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1693

clear ​

▸ clear(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:608

clearDictionary ​

▸ Private clearDictionary(dic): void

Parameters ​

NameType
dicISkipSlicesDictType

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1109

clearPaint ​

▸ clearPaint(): void

Clear mask on current slice canvas

Returns ​

void

Inherited from ​

DrawToolCore.clearPaint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1228

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Overrides ​

DrawToolCore.clearStoreImages

Defined in ​

src/Utils/segmentation/NrrdTools.ts:880

configContrastDragMode ​

▸ configContrastDragMode(): void

Returns ​

void

Inherited from ​

DrawToolCore.configContrastDragMode

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1838

convertCursorPoint ​

▸ convertCursorPoint(from, to, cursorNumX, cursorNumY, currentSliceIndex): undefined | { convertCursorNumX: number ; convertCursorNumY: number ; currentIndex: number ; oldIndex: number }

We generate the MRI slice from threejs based on mm, but when we display it is based on pixel size/distance. So, the index munber on each axis (sagittal, axial, coronal) is the slice's depth in mm distance. And the width and height displayed on screen is the slice's width and height in pixel distance.

When we switch into different axis' views, we need to convert current view's the depth to the pixel distance in other views width or height, and convert the current view's width or height from pixel distance to mm distance as other views' depth (slice index) in general.

Then as for the crosshair (Cursor Inspector), we also need to convert the cursor point (x, y, z) to other views' (x, y, z).

Parameters ​

NameTypeDescription
from"z" | "y" | "x""x" | "y" | "z", current view axis, "x: sagittle, y: coronal, z: axial".
to"z" | "y" | "x""x" | "y" | "z", target view axis (where you want jump to), "x: sagittle, y: coronal, z: axial".
cursorNumXnumbernumber, cursor point x on current axis's slice. (pixel distance)
cursorNumYnumbernumber, cursor point y on current axis's slice. (pixel distance)
currentSliceIndexnumbernumber, current axis's slice's index/depth. (mm distance)

Returns ​

undefined | { convertCursorNumX: number ; convertCursorNumY: number ; currentIndex: number ; oldIndex: number }

Inherited from ​

DrawToolCore.convertCursorPoint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1071

createEmptyPaintImage ​

▸ Private createEmptyPaintImage(dimensions, paintImages): void

Parameters ​

NameType
dimensionsnumber[]
paintImagesIPaintImages

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:391

drag ​

▸ drag(opts?): void

core function for drag slices

Parameters ​

NameType
opts?IDragOpts

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:67

draw ​

▸ draw(opts?): void

Parameters ​

NameType
opts?IDrawOpts

Returns ​

void

Inherited from ​

DrawToolCore.draw

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:142

drawImageOnEmptyImage ​

▸ drawImageOnEmptyImage(canvas): void

Parameters ​

NameType
canvasHTMLCanvasElement

Returns ​

void

Inherited from ​

DrawToolCore.drawImageOnEmptyImage

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:914

drawSphere ​

▸ drawSphere(mouseX, mouseY, radius): void

Parameters ​

NameType
mouseXnumber
mouseYnumber
radiusnumber

Returns ​

void

Inherited from ​

DrawToolCore.drawSphere

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1032

enableContrastDragEvents ​

▸ enableContrastDragEvents(callback): void

Enable the drag function for contrast images window center and window high.

Parameters ​

NameType
callback(step: number, towards: "horizental" | "vertical") => void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:101

filterDrawedImage ​

▸ filterDrawedImage(axis, sliceIndex, paintedImages): IPaintImage

Get a painted mask image (IPaintImage) based on current axis and input slice index.

Parameters ​

NameTypeDescription
axis"z" | "y" | "x""x" | "y" | "z"
sliceIndexnumbernumber
paintedImagesIPaintImagesIPaintImages, All painted mask images.

Returns ​

IPaintImage

Inherited from ​

DrawToolCore.filterDrawedImage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:329

findSliceInSharedPlace ​

▸ findSliceInSharedPlace(): ImageData[]

Returns ​

ImageData[]

Inherited from ​

DrawToolCore.findSliceInSharedPlace

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1733

flipDisplayImageByAxis ​

▸ flipDisplayImageByAxis(): void

flip the canvas to a correct position. This is because the slice canvas from threejs is not in a correct 2D postion. Thus, everytime when we redraw the display canvas, we need to flip to draw the origin canvas from threejs. Under different axis(sagittal, Axial, Coronal), the flip orientation is different.

Returns ​

void

Overrides ​

DrawToolCore.flipDisplayImageByAxis

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1092

getContainer ​

▸ getContainer(): HTMLElement

Returns ​

HTMLElement

Defined in ​

src/Utils/segmentation/NrrdTools.ts:672

getCurrentImageDimension ​

▸ getCurrentImageDimension(): number[]

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:333

getCurrentSliceIndex ​

▸ getCurrentSliceIndex(): number

Returns ​

number

Defined in ​

src/Utils/segmentation/NrrdTools.ts:699

getCurrentSlicesNumAndContrastNum ​

▸ getCurrentSlicesNumAndContrastNum(): Object

Returns ​

Object

NameType
contrastIndexnumber
currentIndexnumber

Defined in ​

src/Utils/segmentation/NrrdTools.ts:692

getDrawingCanvas ​

▸ getDrawingCanvas(): HTMLCanvasElement

Returns ​

HTMLCanvasElement

Defined in ​

src/Utils/segmentation/NrrdTools.ts:675

getGuiSettings ​

▸ getGuiSettings(): Object

Returns ​

Object

NameType
guiSettingundefined | IGuiParameterSettings
guiStateIGUIStates

Defined in ​

src/Utils/segmentation/NrrdTools.ts:159

getIsShowContrastState ​

▸ getIsShowContrastState(): boolean

Returns ​

boolean

Defined in ​

src/Utils/segmentation/NrrdTools.ts:705

getMaskData ​

▸ getMaskData(): IMaskData

Returns ​

IMaskData

Defined in ​

src/Utils/segmentation/NrrdTools.ts:343

getMaxSliceNum ​

▸ getMaxSliceNum(): number[]

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:682

getNrrdToolsSettings ​

▸ getNrrdToolsSettings(): INrrdStates

Returns ​

INrrdStates

Defined in ​

src/Utils/segmentation/NrrdTools.ts:678

getRestLabel ​

▸ getRestLabel(): ("label1" | "label2" | "label3")[]

label div controls*************************

Returns ​

("label1" | "label2" | "label3")[]

Inherited from ​

DrawToolCore.getRestLabel

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1209

getSharedPlace ​

▸ Private getSharedPlace(len, ratio): number[]

Parameters ​

NameType
lennumber
rationumber

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:347

getSpaceOrigin ​

▸ getSpaceOrigin(): number[]

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:340

getVoxelSpacing ​

▸ getVoxelSpacing(): number[]

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:337

init ​

▸ Private init(): void

A initialise function for nrrd_tools

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:176

initPaintImages ​

▸ Private initPaintImages(dimensions): void

init all painted images for store images

Parameters ​

NameType
dimensionsnumber[]

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:372

loadDisplaySlicesArray ​

▸ Private loadDisplaySlicesArray(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:738

loadingMaskByLabel ​

▸ Private loadingMaskByLabel(masks, index, imageData): ImageData

Parameters ​

NameType
masksexportPaintImageType[]
indexnumber
imageDataImageData

Returns ​

ImageData

Defined in ​

src/Utils/segmentation/NrrdTools.ts:248

redrawDisplayCanvas ​

▸ redrawDisplayCanvas(): void

Redraw current contrast image to display canvas. It is more related to change the contrast slice image's window width or center.

Returns ​

void

Overrides ​

DrawToolCore.redrawDisplayCanvas

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1149

redrawMianPreOnDisplayCanvas ​

▸ redrawMianPreOnDisplayCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:933

reloadMaskToLabel ​

▸ Private reloadMaskToLabel(paintImages, ctx): void

Used to init the mask on each label and reload

Parameters ​

NameType
paintImagesIPaintImages
ctxCanvasRenderingContext2D

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1031

removeContrastDragMode ​

▸ removeContrastDragMode(): void

Returns ​

void

Inherited from ​

DrawToolCore.removeContrastDragMode

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1852

removeSkip ​

▸ removeSkip(index): void

Parameters ​

NameType
indexnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:602

replaceArray ​

▸ replaceArray(mainArr, replaceArr): void

Parameters ​

NameType
mainArrnumber[] | Uint8ClampedArray
replaceArrnumber[] | Uint8ClampedArray

Returns ​

void

Inherited from ​

DrawToolCore.replaceArray

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1720

replaceHorizontalRowPixels ​

▸ replaceHorizontalRowPixels(paintImageArray, length, ratio, markedArr, targetWidth, convertIndex): void

Parameters ​

NameTypeDescription
paintImageArrayIPaintImage[]: the target view slice's marked images array
lengthnumber: the target view slice's dimention (total slice index num)
rationumber: the target slice image's width/height ratio of its dimention length
markedArrnumber[][] | Uint8ClampedArray[]: current painted image's horizontal 2d Array
targetWidthnumber: the target image width
convertIndexnumber: Mapping current image's index to target slice image's width/height pixel start point

Returns ​

void

Inherited from ​

DrawToolCore.replaceHorizontalRowPixels

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1672

replaceVerticalColPixels ​

▸ replaceVerticalColPixels(paintImageArray, length, ratio, markedArr, targetWidth, convertIndex): void

Parameters ​

NameTypeDescription
paintImageArrayIPaintImage[]: the target view slice's marked images array
lengthnumber: the target view slice's dimention (total slice index num)
rationumber: the target slice image's width/height ratio of its dimention length
markedArrnumber[][] | Uint8ClampedArray[]: current painted image's vertical 2d Array
targetWidthnumber: the target image width
convertIndexnumber: Mapping current image's index to target slice image's width/height pixel start point

Returns ​

void

Inherited from ​

DrawToolCore.replaceVerticalColPixels

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1639

repraintCurrentContrastSlice ​

▸ repraintCurrentContrastSlice(): void

Returns ​

void

Inherited from ​

DrawToolCore.repraintCurrentContrastSlice

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1902

resetDisplaySlicesStatus ​

▸ Private resetDisplaySlicesStatus(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:765

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Clear masks on drawingCanvas layers.

Returns ​

void

Overrides ​

DrawToolCore.resetLayerCanvas

Defined in ​

src/Utils/segmentation/NrrdTools.ts:922

resetPaintAreaUIPosition ​

▸ resetPaintAreaUIPosition(l?, t?): void

Reset the draw and display canvases layout after mouse pan. If no params in, then center the draw and display canvases.

Parameters ​

NameTypeDescription
l?numbernumber, Offset to the left
t?numbernumber, Offset to the top

Returns ​

void

Overrides ​

DrawToolCore.resetPaintAreaUIPosition

Defined in ​

src/Utils/segmentation/NrrdTools.ts:902

resizePaintArea ​

▸ resizePaintArea(factor): void

Resize the draw and display canvas size based on the input size factor number.

Parameters ​

NameTypeDescription
factornumbernumber

Returns ​

void

Overrides ​

DrawToolCore.resizePaintArea

Defined in ​

src/Utils/segmentation/NrrdTools.ts:961

setAllSlices ​

▸ setAllSlices(allSlices): void

entry function

Parameters ​

NameTypeDescription
allSlicesnrrdSliceType[]all nrrd contrast slices

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:198

setBaseDrawDisplayCanvasesSize ​

▸ setBaseDrawDisplayCanvasesSize(size): void

Set the Draw Display Canvas base size

Parameters ​

NameTypeDescription
sizenumbernumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:83

setDisplaySliceIndexPanel ​

▸ setDisplaySliceIndexPanel(panel): void

Parameters ​

NameType
panelHTMLDivElement

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:93

setDisplaySlicesBaseOnAxis ​

▸ Private setDisplaySlicesBaseOnAxis(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:725

setEmptyCanvasSize ​

▸ setEmptyCanvasSize(axis?): void

Set the empty canvas width and height based on the axis (pixel distance not the mm), to reduce duplicate codes.

Parameters ​

NameType
axis?"z" | "y" | "x"

Returns ​

void

Overrides ​

DrawToolCore.setEmptyCanvasSize

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1120

setEraserUrls ​

▸ setEraserUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Inherited from ​

DrawToolCore.setEraserUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:105

setIsDrawFalse ​

▸ setIsDrawFalse(target): void

Give a delay time to finish the last drawing before upcoming interrupt opreations. Give a delay time number (ms) to disable the draw function, After your interrupt opeartion, you should enable the draw fucntion.

Parameters ​

NameTypeDescription
targetnumbernumber

Returns ​

void

Overrides ​

DrawToolCore.setIsDrawFalse

Defined in ​

src/Utils/segmentation/NrrdTools.ts:715

setMainAreaSize ​

▸ setMainAreaSize(factor): void

Parameters ​

NameType
factornumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:659

setMainPreSlice ​

▸ Private setMainPreSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:789

setMasksData ​

▸ setMasksData(masksData, loadingBar?): void

Parameters ​

NameType
masksDatastoreExportPaintImageType
loadingBar?loadingBarType

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:265

setOriginCanvasAndPre ​

▸ Private setOriginCanvasAndPre(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:796

setPencilIconUrls ​

▸ setPencilIconUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Inherited from ​

DrawToolCore.setPencilIconUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:108

setShowInMainArea ​

▸ Private setShowInMainArea(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:329

setSliceMoving ​

▸ setSliceMoving(step): void

Parameters ​

NameType
stepnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:650

setSliceOrientation ​

▸ setSliceOrientation(axisTo): void

Switch all contrast slices' orientation

Parameters ​

NameType
axisTo"z" | "y" | "x"

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:436

setSyncsliceNum ​

▸ setSyncsliceNum(): void

Keep all contrast slice index to same. Synchronize the slice indexes of all the contrasts so that they are consistent with the main slice's index.

Returns ​

void

Overrides ​

DrawToolCore.setSyncsliceNum

Defined in ​

src/Utils/segmentation/NrrdTools.ts:868

setupConfigs ​

▸ Private setupConfigs(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:772

setupConrastEvents ​

▸ setupConrastEvents(callback): void

Set up root container events fns for drag function

Parameters ​

NameType
callback(step: number, towards: "horizental" | "vertical") => void

Returns ​

void

Inherited from ​

DrawToolCore.setupConrastEvents

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1785

setupGUI ​

▸ setupGUI(gui): void

Set up GUI for drawing panel

Parameters ​

NameTypeDescription
guiGUIGUI

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:109

sliceArrayH ​

▸ sliceArrayH(arr, row, col): Uint8ClampedArray[]

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

Uint8ClampedArray[]

Inherited from ​

DrawToolCore.sliceArrayH

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1601

sliceArrayV ​

▸ sliceArrayV(arr, row, col): number[][]

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

number[][]

Inherited from ​

DrawToolCore.sliceArrayV

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1612

storeAllImages ​

▸ storeAllImages(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Inherited from ​

DrawToolCore.storeAllImages

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1358

storeEachLayerImage ​

▸ storeEachLayerImage(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Inherited from ​

DrawToolCore.storeEachLayerImage

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1559

storeImageToAxis ​

▸ storeImageToAxis(index, paintedImages, imageData, axis?): void

Store images*************************

Parameters ​

NameType
indexnumber
paintedImagesIPaintImages
imageDataImageData
axis?"z" | "y" | "x"

Returns ​

void

Inherited from ​

DrawToolCore.storeImageToAxis

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1324

storeImageToLabel ​

▸ storeImageToLabel(index, canvas, paintedImages): ImageData

Parameters ​

NameType
indexnumber
canvasHTMLCanvasElement
paintedImagesIPaintImages

Returns ​

ImageData

Inherited from ​

DrawToolCore.storeImageToLabel

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1539

switchAllSlicesArrayData ​

▸ switchAllSlicesArrayData(allSlices): void

Parameters ​

NameType
allSlicesnrrdSliceType[]

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:759

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Inherited from ​

DrawToolCore.undoLastPainting

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1247

updateMaxIndex ​

▸ Private updateMaxIndex(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:840

updateOriginAndChangedWH ​

▸ updateOriginAndChangedWH(): void

Update the original canvas size, allow set to threejs load one (pixel distance not the mm). Then update the changedWidth and changedHeight based on the sizeFoctor.

Returns ​

void

Overrides ​

DrawToolCore.updateOriginAndChangedWH

Defined in ​

src/Utils/segmentation/NrrdTools.ts:850

updateSlicesContrast ​

▸ updateSlicesContrast(value, flag): void

Parameters ​

NameType
valuenumber
flagstring

Returns ​

void

Inherited from ​

DrawToolCore.updateSlicesContrast

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1876

',896),n=[i];function l(s,d,h,c,m,u){return t(),a("div",null,n)}const p=e(o,[["render",l]]);export{g as __pageData,p as default}; diff --git a/assets/apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.878782ef.lean.js b/assets/apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.4817471e.lean.js similarity index 100% rename from assets/apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.878782ef.lean.js rename to assets/apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.4817471e.lean.js diff --git a/assets/apidist_interfaces_Loader_copperNrrdLoader.optsType.md.a1f0c75c.js b/assets/apidist_interfaces_Loader_copperNrrdLoader.optsType.md.63197113.js similarity index 95% rename from assets/apidist_interfaces_Loader_copperNrrdLoader.optsType.md.a1f0c75c.js rename to assets/apidist_interfaces_Loader_copperNrrdLoader.optsType.md.63197113.js index 2ed146d..4884bfb 100644 --- a/assets/apidist_interfaces_Loader_copperNrrdLoader.optsType.md.a1f0c75c.js +++ b/assets/apidist_interfaces_Loader_copperNrrdLoader.optsType.md.63197113.js @@ -1 +1 @@ -import{_ as e,o as r,c as a,Q as o}from"./chunks/framework.5916b37e.js";const _=JSON.parse('{"title":"Interface: optsType","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/interfaces/Loader_copperNrrdLoader.optsType.md","filePath":"apidist/interfaces/Loader_copperNrrdLoader.optsType.md"}'),t={name:"apidist/interfaces/Loader_copperNrrdLoader.optsType.md"},n=o('

copper3d / Modules / Loader/copperNrrdLoader / optsType

Interface: optsType ​

Loader/copperNrrdLoader.optsType

Table of contents ​

Properties ​

Properties ​

container ​

• Optional container: HTMLDivElement

Defined in ​

src/Loader/copperNrrdLoader.ts:35

openGui ​

• openGui: boolean

Defined in ​

src/Loader/copperNrrdLoader.ts:34

',16),i=[n];function p(d,s,c,l,h,f){return r(),a("div",null,i)}const L=e(t,[["render",p]]);export{_ as __pageData,L as default}; +import{_ as e,o as r,c as a,Q as o}from"./chunks/framework.5916b37e.js";const _=JSON.parse('{"title":"Interface: optsType","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/interfaces/Loader_copperNrrdLoader.optsType.md","filePath":"apidist/interfaces/Loader_copperNrrdLoader.optsType.md"}'),t={name:"apidist/interfaces/Loader_copperNrrdLoader.optsType.md"},n=o('

copper3d / Modules / Loader/copperNrrdLoader / optsType

Interface: optsType ​

Loader/copperNrrdLoader.optsType

Table of contents ​

Properties ​

Properties ​

container ​

• Optional container: HTMLDivElement

Defined in ​

src/Loader/copperNrrdLoader.ts:35

openGui ​

• openGui: boolean

Defined in ​

src/Loader/copperNrrdLoader.ts:34

',16),i=[n];function p(d,s,c,l,h,f){return r(),a("div",null,i)}const L=e(t,[["render",p]]);export{_ as __pageData,L as default}; diff --git a/assets/apidist_interfaces_Loader_copperNrrdLoader.optsType.md.a1f0c75c.lean.js b/assets/apidist_interfaces_Loader_copperNrrdLoader.optsType.md.63197113.lean.js similarity index 100% rename from assets/apidist_interfaces_Loader_copperNrrdLoader.optsType.md.a1f0c75c.lean.js rename to assets/apidist_interfaces_Loader_copperNrrdLoader.optsType.md.63197113.lean.js diff --git a/assets/apidist_modules_Loader_copperNrrdLoader.md.640862f7.js b/assets/apidist_modules_Loader_copperNrrdLoader.md.1041d102.js similarity index 97% rename from assets/apidist_modules_Loader_copperNrrdLoader.md.640862f7.js rename to assets/apidist_modules_Loader_copperNrrdLoader.md.1041d102.js index 3199a50..6ae38c8 100644 --- a/assets/apidist_modules_Loader_copperNrrdLoader.md.640862f7.js +++ b/assets/apidist_modules_Loader_copperNrrdLoader.md.1041d102.js @@ -1 +1 @@ -import{_ as e,o as t,c as r,Q as a}from"./chunks/framework.5916b37e.js";const b=JSON.parse('{"title":"Module: Loader/copperNrrdLoader","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/modules/Loader_copperNrrdLoader.md","filePath":"apidist/modules/Loader_copperNrrdLoader.md"}'),d={name:"apidist/modules/Loader_copperNrrdLoader.md"},o=a('

copper3d / Modules / Loader/copperNrrdLoader

Module: Loader/copperNrrdLoader ​

Table of contents ​

Interfaces ​

Functions ​

Functions ​

addBoxHelper ​

▸ addBoxHelper(scene, volume, boxCube?): void

Parameters ​

NameType
scenecopperScene
volumeany
boxCube?Object3D<Event>

Returns ​

void

Defined in ​

src/Loader/copperNrrdLoader.ts:435

copperNrrdLoader ​

▸ copperNrrdLoader(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

Defined in ​

src/Loader/copperNrrdLoader.ts:38

copperNrrdTexture3dLoader ​

▸ copperNrrdTexture3dLoader(url, scene, container, callback?): void

Parameters ​

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

Returns ​

void

Defined in ​

src/Loader/copperNrrdLoader.ts:177

getWholeSlices ​

▸ getWholeSlices(nrrdSlices, scene, gui, controls): void

Parameters ​

NameType
nrrdSlicesnrrdSliceType
sceneScene
guiGUI
controlsCopper3dTrackballControls

Returns ​

void

Defined in ​

src/Loader/copperNrrdLoader.ts:335

',43),l=[o];function c(n,i,s,h,p,u){return t(),r("div",null,l)}const x=e(d,[["render",c]]);export{b as __pageData,x as default}; +import{_ as e,o as t,c as r,Q as a}from"./chunks/framework.5916b37e.js";const b=JSON.parse('{"title":"Module: Loader/copperNrrdLoader","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/modules/Loader_copperNrrdLoader.md","filePath":"apidist/modules/Loader_copperNrrdLoader.md"}'),d={name:"apidist/modules/Loader_copperNrrdLoader.md"},o=a('

copper3d / Modules / Loader/copperNrrdLoader

Module: Loader/copperNrrdLoader ​

Table of contents ​

Interfaces ​

Functions ​

Functions ​

addBoxHelper ​

▸ addBoxHelper(scene, volume, boxCube?): void

Parameters ​

NameType
scenecopperScene
volumeany
boxCube?Object3D<Event>

Returns ​

void

Defined in ​

src/Loader/copperNrrdLoader.ts:435

copperNrrdLoader ​

▸ copperNrrdLoader(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

Defined in ​

src/Loader/copperNrrdLoader.ts:38

copperNrrdTexture3dLoader ​

▸ copperNrrdTexture3dLoader(url, scene, container, callback?): void

Parameters ​

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

Returns ​

void

Defined in ​

src/Loader/copperNrrdLoader.ts:177

getWholeSlices ​

▸ getWholeSlices(nrrdSlices, scene, gui, controls): void

Parameters ​

NameType
nrrdSlicesnrrdSliceType
sceneScene
guiGUI
controlsCopper3dTrackballControls

Returns ​

void

Defined in ​

src/Loader/copperNrrdLoader.ts:335

',43),l=[o];function c(n,i,s,h,p,u){return t(),r("div",null,l)}const x=e(d,[["render",c]]);export{b as __pageData,x as default}; diff --git a/assets/apidist_modules_Loader_copperNrrdLoader.md.640862f7.lean.js b/assets/apidist_modules_Loader_copperNrrdLoader.md.1041d102.lean.js similarity index 100% rename from assets/apidist_modules_Loader_copperNrrdLoader.md.640862f7.lean.js rename to assets/apidist_modules_Loader_copperNrrdLoader.md.1041d102.lean.js diff --git a/assets/apidist_modules_Utils_segmentation_coreTools_gui.md.04587535.js b/assets/apidist_modules_Utils_segmentation_coreTools_gui.md.74dce587.js similarity index 96% rename from assets/apidist_modules_Utils_segmentation_coreTools_gui.md.04587535.js rename to assets/apidist_modules_Utils_segmentation_coreTools_gui.md.74dce587.js index 9b9c938..2091000 100644 --- a/assets/apidist_modules_Utils_segmentation_coreTools_gui.md.04587535.js +++ b/assets/apidist_modules_Utils_segmentation_coreTools_gui.md.74dce587.js @@ -1 +1 @@ -import{_ as e,o as t,c as a,Q as o}from"./chunks/framework.5916b37e.js";const f=JSON.parse('{"title":"Module: Utils/segmentation/coreTools/gui","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/modules/Utils_segmentation_coreTools_gui.md","filePath":"apidist/modules/Utils_segmentation_coreTools_gui.md"}'),i={name:"apidist/modules/Utils_segmentation_coreTools_gui.md"},r=o('

copper3d / Modules / Utils/segmentation/coreTools/gui

Module: Utils/segmentation/coreTools/gui ​

Table of contents ​

Functions ​

Functions ​

removeGuiFolderChilden ​

▸ removeGuiFolderChilden(modeFolder): void

Parameters ​

NameType
modeFolderGUI

Returns ​

void

Defined in ​

src/Utils/segmentation/coreTools/gui.ts:473

setupGui ​

▸ setupGui(configs): IGuiParameterSettings

Parameters ​

NameType
configsIConfigGUI

Returns ​

IGuiParameterSettings

Defined in ​

src/Utils/segmentation/coreTools/gui.ts:95

',23),n=[r];function s(l,d,c,u,h,m){return t(),a("div",null,n)}const p=e(i,[["render",s]]);export{f as __pageData,p as default}; +import{_ as e,o as t,c as a,Q as o}from"./chunks/framework.5916b37e.js";const f=JSON.parse('{"title":"Module: Utils/segmentation/coreTools/gui","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/modules/Utils_segmentation_coreTools_gui.md","filePath":"apidist/modules/Utils_segmentation_coreTools_gui.md"}'),i={name:"apidist/modules/Utils_segmentation_coreTools_gui.md"},r=o('

copper3d / Modules / Utils/segmentation/coreTools/gui

Module: Utils/segmentation/coreTools/gui ​

Table of contents ​

Functions ​

Functions ​

removeGuiFolderChilden ​

▸ removeGuiFolderChilden(modeFolder): void

Parameters ​

NameType
modeFolderGUI

Returns ​

void

Defined in ​

src/Utils/segmentation/coreTools/gui.ts:473

setupGui ​

▸ setupGui(configs): IGuiParameterSettings

Parameters ​

NameType
configsIConfigGUI

Returns ​

IGuiParameterSettings

Defined in ​

src/Utils/segmentation/coreTools/gui.ts:95

',23),n=[r];function s(l,d,c,u,h,m){return t(),a("div",null,n)}const p=e(i,[["render",s]]);export{f as __pageData,p as default}; diff --git a/assets/apidist_modules_Utils_segmentation_coreTools_gui.md.04587535.lean.js b/assets/apidist_modules_Utils_segmentation_coreTools_gui.md.74dce587.lean.js similarity index 100% rename from assets/apidist_modules_Utils_segmentation_coreTools_gui.md.04587535.lean.js rename to assets/apidist_modules_Utils_segmentation_coreTools_gui.md.74dce587.lean.js diff --git a/assets/apidist_modules_Utils_utils.md.0dbd468f.js b/assets/apidist_modules_Utils_utils.md.32f611ca.js similarity index 95% rename from assets/apidist_modules_Utils_utils.md.0dbd468f.js rename to assets/apidist_modules_Utils_utils.md.32f611ca.js index 74caae8..32db825 100644 --- a/assets/apidist_modules_Utils_utils.md.0dbd468f.js +++ b/assets/apidist_modules_Utils_utils.md.32f611ca.js @@ -1 +1 @@ -import{_ as e,o as t,c as a,Q as r}from"./chunks/framework.5916b37e.js";const m=JSON.parse('{"title":"Module: Utils/utils","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/modules/Utils_utils.md","filePath":"apidist/modules/Utils_utils.md"}'),l={name:"apidist/modules/Utils_utils.md"},i=r('

copper3d / Modules / Utils/utils

Module: Utils/utils ​

Table of contents ​

Functions ​

Functions ​

H3 ​

▸ H3(x): number[]

Cubic-Hermite basis function.

Parameters ​

NameType
xnumber

Returns ​

number[]

Defined in ​

src/Utils/utils.ts:216

L3 ​

▸ L3(x): number[]

Cubic-Lagrange basis function

Parameters ​

NameType
xnumber

Returns ​

number[]

Defined in ​

src/Utils/utils.ts:198

calcDistance ​

▸ calcDistance(x0, x1): number

Euclidean distance n dimensions

Parameters ​

NameType
x0number[]
x1number[]

Returns ​

number

Defined in ​

src/Utils/utils.ts:288

fullScreenListenner ​

▸ fullScreenListenner(container): void

Parameters ​

NameType
containerHTMLDivElement | HTMLCanvasElement

Returns ​

void

Defined in ​

src/Utils/utils.ts:1

getWightsH3H3H3 ​

▸ getWightsH3H3H3(Xi): number[][]

Parameters ​

NameType
Xinumber[][]

Returns ​

number[][]

Defined in ​

src/Utils/utils.ts:248

getWightsL3L3L3 ​

▸ getWightsL3L3L3(Xi): number[]

To calculate the weights for each element of Xi using the cubic Lagrange basis functions.

Parameters ​

NameType
Xinumber[]

Returns ​

number[]

Defined in ​

src/Utils/utils.ts:232

isIOS ​

▸ isIOS(): boolean

Returns ​

boolean

Defined in ​

src/Utils/utils.ts:21

loading ​

▸ loading(loadingGif?): Object

Parameters ​

NameType
loadingGif?string

Returns ​

Object

NameType
loadingContainerHTMLDivElement
progressHTMLDivElement

Defined in ​

src/Utils/utils.ts:49

perturbRandom ​

▸ perturbRandom(x, dx): number[]

Parameters ​

NameType
xnumber[]
dxnumber

Returns ​

number[]

Defined in ​

src/Utils/utils.ts:297

switchEraserSize ​

▸ switchEraserSize(size, urls?): string

Parameters ​

NameType
sizenumber
urls?string[]

Returns ​

string

Defined in ​

src/Utils/utils.ts:123

switchPencilIcon ​

▸ switchPencilIcon(icon, urls?): string

Parameters ​

NameType
iconstring
urls?string[]

Returns ​

string

Defined in ​

src/Utils/utils.ts:84

throttle ​

▸ throttle(callback, wait): (event: MouseEvent) => void

Parameters ​

NameType
callback(event: MouseEvent) => void
waitnumber

Returns ​

fn

▸ (event): void

Parameters ​
NameType
eventMouseEvent
Returns ​

void

Defined in ​

src/Utils/utils.ts:182

traverseMaterials ​

▸ traverseMaterials(object, callback): void

Parameters ​

NameType
objectGroup
callback(material: any) => void

Returns ​

void

Defined in ​

src/Utils/utils.ts:35

',130),o=[i];function n(s,d,h,c,u,b){return t(),a("div",null,o)}const p=e(l,[["render",n]]);export{m as __pageData,p as default}; +import{_ as e,o as t,c as a,Q as r}from"./chunks/framework.5916b37e.js";const m=JSON.parse('{"title":"Module: Utils/utils","description":"","frontmatter":{},"headers":[],"relativePath":"apidist/modules/Utils_utils.md","filePath":"apidist/modules/Utils_utils.md"}'),l={name:"apidist/modules/Utils_utils.md"},i=r('

copper3d / Modules / Utils/utils

Module: Utils/utils ​

Table of contents ​

Functions ​

Functions ​

H3 ​

▸ H3(x): number[]

Cubic-Hermite basis function.

Parameters ​

NameType
xnumber

Returns ​

number[]

Defined in ​

src/Utils/utils.ts:216

L3 ​

▸ L3(x): number[]

Cubic-Lagrange basis function

Parameters ​

NameType
xnumber

Returns ​

number[]

Defined in ​

src/Utils/utils.ts:198

calcDistance ​

▸ calcDistance(x0, x1): number

Euclidean distance n dimensions

Parameters ​

NameType
x0number[]
x1number[]

Returns ​

number

Defined in ​

src/Utils/utils.ts:288

fullScreenListenner ​

▸ fullScreenListenner(container): void

Parameters ​

NameType
containerHTMLDivElement | HTMLCanvasElement

Returns ​

void

Defined in ​

src/Utils/utils.ts:1

getWightsH3H3H3 ​

▸ getWightsH3H3H3(Xi): number[][]

Parameters ​

NameType
Xinumber[][]

Returns ​

number[][]

Defined in ​

src/Utils/utils.ts:248

getWightsL3L3L3 ​

▸ getWightsL3L3L3(Xi): number[]

To calculate the weights for each element of Xi using the cubic Lagrange basis functions.

Parameters ​

NameType
Xinumber[]

Returns ​

number[]

Defined in ​

src/Utils/utils.ts:232

isIOS ​

▸ isIOS(): boolean

Returns ​

boolean

Defined in ​

src/Utils/utils.ts:21

loading ​

▸ loading(loadingGif?): Object

Parameters ​

NameType
loadingGif?string

Returns ​

Object

NameType
loadingContainerHTMLDivElement
progressHTMLDivElement

Defined in ​

src/Utils/utils.ts:49

perturbRandom ​

▸ perturbRandom(x, dx): number[]

Parameters ​

NameType
xnumber[]
dxnumber

Returns ​

number[]

Defined in ​

src/Utils/utils.ts:297

switchEraserSize ​

▸ switchEraserSize(size, urls?): string

Parameters ​

NameType
sizenumber
urls?string[]

Returns ​

string

Defined in ​

src/Utils/utils.ts:123

switchPencilIcon ​

▸ switchPencilIcon(icon, urls?): string

Parameters ​

NameType
iconstring
urls?string[]

Returns ​

string

Defined in ​

src/Utils/utils.ts:84

throttle ​

▸ throttle(callback, wait): (event: MouseEvent) => void

Parameters ​

NameType
callback(event: MouseEvent) => void
waitnumber

Returns ​

fn

▸ (event): void

Parameters ​
NameType
eventMouseEvent
Returns ​

void

Defined in ​

src/Utils/utils.ts:182

traverseMaterials ​

▸ traverseMaterials(object, callback): void

Parameters ​

NameType
objectGroup
callback(material: any) => void

Returns ​

void

Defined in ​

src/Utils/utils.ts:35

',130),o=[i];function n(s,d,h,c,u,b){return t(),a("div",null,o)}const p=e(l,[["render",n]]);export{m as __pageData,p as default}; diff --git a/assets/apidist_modules_Utils_utils.md.0dbd468f.lean.js b/assets/apidist_modules_Utils_utils.md.32f611ca.lean.js similarity index 100% rename from assets/apidist_modules_Utils_utils.md.0dbd468f.lean.js rename to assets/apidist_modules_Utils_utils.md.32f611ca.lean.js diff --git a/hashmap.json b/hashmap.json index 543efdd..cdd3ea2 100644 --- a/hashmap.json +++ b/hashmap.json @@ -1 +1 @@ -{"apidist_readme.md":"e26a5690","apidist_classes_utils_meshnodetool.element.md":"2c6ac78a","apidist_classes_utils_meshnodetool.meshnodetool.md":"c675b41f","apidist_classes_scene_coppersceneondemond.coppersceneondemond.md":"fe22f3a8","apidist_classes_utils_meshnodetool.node.md":"7a14ecbd","apidist_interfaces_loader_coppernrrdloader.optstype.md":"a1f0c75c","apidist_modules_controls_coppercontrols.md":"90df69a1","apidist_classes_utils_segmentation_dragoperator.dragoperator.md":"836da7c3","apidist_modules.md":"71341fd9","apidist_modules_controls_copper3dtrackballcontrols.md":"0dc9210f","apidist_classes_utils_segmentation_drawtoolcore.drawtoolcore.md":"0c9f9fa4","apidist_modules_scene_basescene.md":"6842adae","apidist_modules_scene_commonscenemethod.md":"03a638f1","apidist_modules_renderer_copperrenderer.md":"21951b1a","apidist_modules_scene_coppermscene.md":"9050160c","apidist_modules_scene_copperscene.md":"1a21b247","apidist_modules_scene_coppersceneondemond.md":"67889485","apidist_modules_utils_meshnodetool.md":"b50ec67d","apidist_modules_utils_segmentation_commtoolsdata.md":"e338e0a5","apidist_modules_utils_segmentation_drawtoolcore.md":"754ecf1b","apidist_modules_utils_segmentation_dragoperator.md":"ee72e1de","apidist_modules_utils_segmentation_nrrdtools.md":"98dc8640","index.md":"31081171","apidist_modules_renderer_copperrenderer-3.md":"4b216dba","apidist_classes_controls_coppercontrols.controls.md":"1186c714","apidist_classes_renderer_baserenderer.baserenderer.md":"7eab65d3","apidist_classes_controls_coppercontrols.cameraviewpoint.md":"52bb4284","apidist_classes_scene_coppermscene.coppermscene.md":"7de27c45","apidist_classes_controls_copper3dtrackballcontrols.copper3dtrackballcontrols.md":"9b3fefda","apidist_classes_renderer_copperrenderer.copperrenderer.md":"0387fed3","apidist_classes_renderer_coppermscenerenderer.coppermscenerenderer.md":"9fb389b4","apidist_classes_scene_commonscenemethod.commonscene.md":"cd169d18","apidist_classes_scene_copperscene.copperscene.md":"33bcfe1a","apidist_modules_renderer_baserenderer.md":"b28c03bf","apidist_modules_renderer_coppermscenerenderer.md":"49827154","apidist_classes_utils_segmentation_nrrdtools.nrrdtools.md":"878782ef","apidist_modules_utils_segmentation_coretools_gui.md":"04587535","apidist_modules_renderer_copperrenderer-1.md":"19044635","apidist_modules_utils_utils.md":"0dbd468f","apidist_classes_utils_segmentation_commtoolsdata.commtoolsdata.md":"2b9f1fbe","apidist_modules_loader_coppernrrdloader.md":"640862f7","apidist_classes_scene_basescene.basescene.md":"ddd0983d","apidist_modules_renderer_copperrenderer-2.md":"e2ff7d05"} +{"apidist_classes_controls_coppercontrols.cameraviewpoint.md":"8f5c3d20","apidist_classes_renderer_copperrenderer.copperrenderer.md":"93348682","apidist_classes_renderer_coppermscenerenderer.coppermscenerenderer.md":"b390fd45","apidist_classes_renderer_baserenderer.baserenderer.md":"7ebced4e","apidist_classes_controls_coppercontrols.controls.md":"5559fda2","apidist_readme.md":"e26a5690","apidist_classes_scene_coppersceneondemond.coppersceneondemond.md":"8ce60bcb","apidist_modules_controls_coppercontrols.md":"90df69a1","apidist_classes_utils_meshnodetool.node.md":"d31c6b1b","apidist_classes_scene_basescene.basescene.md":"0f72be24","apidist_classes_utils_meshnodetool.meshnodetool.md":"c2904675","apidist_classes_utils_segmentation_commtoolsdata.commtoolsdata.md":"c1747d40","apidist_classes_scene_coppermscene.coppermscene.md":"12821a71","apidist_classes_utils_segmentation_dragoperator.dragoperator.md":"dc3dec67","apidist_classes_utils_meshnodetool.element.md":"d8aaa661","apidist_modules_scene_basescene.md":"6842adae","apidist_modules_renderer_coppermscenerenderer.md":"49827154","apidist_modules_controls_copper3dtrackballcontrols.md":"0dc9210f","apidist_modules_utils_utils.md":"32f611ca","apidist_classes_scene_commonscenemethod.commonscene.md":"035104bc","apidist_modules_loader_coppernrrdloader.md":"1041d102","apidist_modules.md":"71341fd9","apidist_interfaces_loader_coppernrrdloader.optstype.md":"63197113","apidist_modules_renderer_copperrenderer-1.md":"19044635","apidist_modules_renderer_copperrenderer-2.md":"e2ff7d05","apidist_modules_renderer_copperrenderer-3.md":"4b216dba","apidist_modules_renderer_copperrenderer.md":"21951b1a","apidist_modules_scene_commonscenemethod.md":"03a638f1","apidist_modules_scene_copperscene.md":"1a21b247","apidist_modules_scene_coppersceneondemond.md":"67889485","apidist_modules_utils_meshnodetool.md":"b50ec67d","apidist_modules_utils_segmentation_commtoolsdata.md":"e338e0a5","apidist_modules_utils_segmentation_dragoperator.md":"ee72e1de","apidist_modules_utils_segmentation_drawtoolcore.md":"754ecf1b","apidist_modules_utils_segmentation_nrrdtools.md":"98dc8640","apidist_modules_utils_segmentation_coretools_gui.md":"74dce587","apidist_modules_renderer_baserenderer.md":"b28c03bf","index.md":"31081171","apidist_classes_scene_copperscene.copperscene.md":"9d90be6c","apidist_classes_controls_copper3dtrackballcontrols.copper3dtrackballcontrols.md":"09bf8022","apidist_modules_scene_coppermscene.md":"9050160c","apidist_classes_utils_segmentation_nrrdtools.nrrdtools.md":"4817471e","apidist_classes_utils_segmentation_drawtoolcore.drawtoolcore.md":"c2280199"} diff --git a/index.html b/index.html index a307a47..c4c2dee 100644 --- a/index.html +++ b/index.html @@ -17,7 +17,7 @@
Copper3d API

Appearance

Copper3d

A visualisation tool base on threejs. It provides Dicom loader, Nrrd Segmentation Tools, Create vtk animation functions.

Copper3d core API
- + \ No newline at end of file