From a635bf626195486629687f9706370d8077cf46cf Mon Sep 17 00:00:00 2001 From: LinkunGao Date: Thu, 3 Oct 2024 09:33:57 +0000 Subject: [PATCH] deploy: e4149f74e582484cfeb42c8444e8aa8a09df65aa --- 404.html | 2 +- apidist/README.html | 2 +- ...Copper3dTrackballControls.Copper3dTrackballControls.html | 6 +++--- .../classes/Controls_copperControls.CameraViewPoint.html | 6 +++--- apidist/classes/Controls_copperControls.Controls.html | 6 +++--- apidist/classes/Renderer_baseRenderer.baseRenderer.html | 6 +++--- .../Renderer_copperMSceneRenderer.copperMSceneRenderer.html | 6 +++--- apidist/classes/Renderer_copperRenderer.copperRenderer.html | 6 +++--- apidist/classes/Scene_baseScene.baseScene.html | 6 +++--- apidist/classes/Scene_commonSceneMethod.commonScene.html | 6 +++--- apidist/classes/Scene_copperMScene.copperMScene.html | 6 +++--- apidist/classes/Scene_copperScene.copperScene.html | 6 +++--- .../Scene_copperSceneOnDemond.copperSceneOnDemond.html | 6 +++--- apidist/classes/Utils_MeshNodeTool.Element.html | 6 +++--- apidist/classes/Utils_MeshNodeTool.MeshNodeTool.html | 6 +++--- apidist/classes/Utils_MeshNodeTool.Node.html | 6 +++--- .../Utils_segmentation_CommToolsData.CommToolsData.html | 6 +++--- .../Utils_segmentation_DragOperator.DragOperator.html | 6 +++--- .../Utils_segmentation_DrawToolCore.DrawToolCore.html | 6 +++--- apidist/classes/Utils_segmentation_NrrdTools.NrrdTools.html | 6 +++--- apidist/interfaces/Loader_copperNrrdLoader.optsType.html | 6 +++--- apidist/modules.html | 2 +- apidist/modules/Controls_Copper3dTrackballControls.html | 2 +- apidist/modules/Controls_copperControls.html | 2 +- apidist/modules/Loader_copperNrrdLoader.html | 6 +++--- apidist/modules/Renderer_baseRenderer.html | 2 +- apidist/modules/Renderer_copperMSceneRenderer.html | 2 +- apidist/modules/Renderer_copperRenderer-1.html | 2 +- apidist/modules/Renderer_copperRenderer-2.html | 2 +- apidist/modules/Renderer_copperRenderer-3.html | 2 +- apidist/modules/Renderer_copperRenderer.html | 2 +- apidist/modules/Scene_baseScene.html | 2 +- apidist/modules/Scene_commonSceneMethod.html | 2 +- apidist/modules/Scene_copperMScene.html | 2 +- apidist/modules/Scene_copperScene.html | 2 +- apidist/modules/Scene_copperSceneOnDemond.html | 2 +- apidist/modules/Utils_MeshNodeTool.html | 2 +- apidist/modules/Utils_segmentation_CommToolsData.html | 2 +- apidist/modules/Utils_segmentation_DragOperator.html | 2 +- apidist/modules/Utils_segmentation_DrawToolCore.html | 2 +- apidist/modules/Utils_segmentation_NrrdTools.html | 2 +- apidist/modules/Utils_segmentation_coreTools_gui.html | 6 +++--- apidist/modules/Utils_utils.html | 6 +++--- ...ckballControls.Copper3dTrackballControls.md.78f59b32.js} | 2 +- ...lControls.Copper3dTrackballControls.md.78f59b32.lean.js} | 0 ..._Controls_copperControls.CameraViewPoint.md.65077997.js} | 2 +- ...rols_copperControls.CameraViewPoint.md.65077997.lean.js} | 0 ...classes_Controls_copperControls.Controls.md.69a0f16d.js} | 2 +- ...es_Controls_copperControls.Controls.md.69a0f16d.lean.js} | 2 +- ...asses_Renderer_baseRenderer.baseRenderer.md.486455e2.js} | 2 +- ..._Renderer_baseRenderer.baseRenderer.md.486455e2.lean.js} | 2 +- ...opperMSceneRenderer.copperMSceneRenderer.md.57a3bf1b.js} | 2 +- ...MSceneRenderer.copperMSceneRenderer.md.57a3bf1b.lean.js} | 2 +- ...s_Renderer_copperRenderer.copperRenderer.md.6d1ea50b.js} | 2 +- ...derer_copperRenderer.copperRenderer.md.6d1ea50b.lean.js} | 2 +- ...pidist_classes_Scene_baseScene.baseScene.md.61f061b6.js} | 2 +- ...t_classes_Scene_baseScene.baseScene.md.61f061b6.lean.js} | 0 ...sses_Scene_commonSceneMethod.commonScene.md.e77c1bce.js} | 2 +- ...Scene_commonSceneMethod.commonScene.md.e77c1bce.lean.js} | 0 ..._classes_Scene_copperMScene.copperMScene.md.8b080c61.js} | 2 +- ...ses_Scene_copperMScene.copperMScene.md.8b080c61.lean.js} | 0 ...st_classes_Scene_copperScene.copperScene.md.826727ff.js} | 2 +- ...asses_Scene_copperScene.copperScene.md.826727ff.lean.js} | 0 ..._copperSceneOnDemond.copperSceneOnDemond.md.159ccf85.js} | 2 +- ...erSceneOnDemond.copperSceneOnDemond.md.159ccf85.lean.js} | 0 ...idist_classes_Utils_MeshNodeTool.Element.md.90a8b6f8.js} | 2 +- ..._classes_Utils_MeshNodeTool.Element.md.90a8b6f8.lean.js} | 0 ..._classes_Utils_MeshNodeTool.MeshNodeTool.md.2cefc028.js} | 2 +- ...ses_Utils_MeshNodeTool.MeshNodeTool.md.2cefc028.lean.js} | 2 +- ... apidist_classes_Utils_MeshNodeTool.Node.md.cbca78ea.js} | 2 +- ...ist_classes_Utils_MeshNodeTool.Node.md.cbca78ea.lean.js} | 0 ...segmentation_CommToolsData.CommToolsData.md.8a335248.js} | 2 +- ...ntation_CommToolsData.CommToolsData.md.8a335248.lean.js} | 0 ...s_segmentation_DragOperator.DragOperator.md.eb6181d8.js} | 2 +- ...mentation_DragOperator.DragOperator.md.eb6181d8.lean.js} | 2 +- ...s_segmentation_DrawToolCore.DrawToolCore.md.69cb94c5.js} | 2 +- ...mentation_DrawToolCore.DrawToolCore.md.69cb94c5.lean.js} | 0 ...s_Utils_segmentation_NrrdTools.NrrdTools.md.fc10885a.js} | 2 +- ...ls_segmentation_NrrdTools.NrrdTools.md.fc10885a.lean.js} | 0 ...erfaces_Loader_copperNrrdLoader.optsType.md.0c190027.js} | 2 +- ...es_Loader_copperNrrdLoader.optsType.md.0c190027.lean.js} | 0 ... apidist_modules_Loader_copperNrrdLoader.md.8ad3704c.js} | 2 +- ...ist_modules_Loader_copperNrrdLoader.md.8ad3704c.lean.js} | 2 +- ...modules_Utils_segmentation_coreTools_gui.md.5a72133e.js} | 2 +- ...es_Utils_segmentation_coreTools_gui.md.5a72133e.lean.js} | 2 +- ...292504.js => apidist_modules_Utils_utils.md.e5eb399b.js} | 2 +- ...n.js => apidist_modules_Utils_utils.md.e5eb399b.lean.js} | 0 hashmap.json | 2 +- index.html | 2 +- 89 files changed, 119 insertions(+), 119 deletions(-) rename assets/{apidist_classes_Controls_Copper3dTrackballControls.Copper3dTrackballControls.md.797ee5d2.js => apidist_classes_Controls_Copper3dTrackballControls.Copper3dTrackballControls.md.78f59b32.js} (94%) rename assets/{apidist_classes_Controls_Copper3dTrackballControls.Copper3dTrackballControls.md.797ee5d2.lean.js => apidist_classes_Controls_Copper3dTrackballControls.Copper3dTrackballControls.md.78f59b32.lean.js} (100%) rename assets/{apidist_classes_Controls_copperControls.CameraViewPoint.md.715e5ff1.js => apidist_classes_Controls_copperControls.CameraViewPoint.md.65077997.js} (92%) rename assets/{apidist_classes_Controls_copperControls.CameraViewPoint.md.715e5ff1.lean.js => apidist_classes_Controls_copperControls.CameraViewPoint.md.65077997.lean.js} (100%) rename assets/{apidist_classes_Controls_copperControls.Controls.md.78bd2acf.js => apidist_classes_Controls_copperControls.Controls.md.69a0f16d.js} (92%) rename assets/{apidist_classes_Controls_copperControls.Controls.md.78bd2acf.lean.js => apidist_classes_Controls_copperControls.Controls.md.69a0f16d.lean.js} (76%) rename assets/{apidist_classes_Renderer_baseRenderer.baseRenderer.md.949cee0a.js => apidist_classes_Renderer_baseRenderer.baseRenderer.md.486455e2.js} (89%) rename assets/{apidist_classes_Renderer_baseRenderer.baseRenderer.md.949cee0a.lean.js => apidist_classes_Renderer_baseRenderer.baseRenderer.md.486455e2.lean.js} (75%) rename assets/{apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.08ed100c.js => apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.57a3bf1b.js} (92%) rename assets/{apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.08ed100c.lean.js => apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.57a3bf1b.lean.js} (88%) rename assets/{apidist_classes_Renderer_copperRenderer.copperRenderer.md.02b16073.js => apidist_classes_Renderer_copperRenderer.copperRenderer.md.6d1ea50b.js} (90%) rename assets/{apidist_classes_Renderer_copperRenderer.copperRenderer.md.02b16073.lean.js => apidist_classes_Renderer_copperRenderer.copperRenderer.md.6d1ea50b.lean.js} (63%) rename assets/{apidist_classes_Scene_baseScene.baseScene.md.5530f63c.js => apidist_classes_Scene_baseScene.baseScene.md.61f061b6.js} (94%) rename assets/{apidist_classes_Scene_baseScene.baseScene.md.5530f63c.lean.js => apidist_classes_Scene_baseScene.baseScene.md.61f061b6.lean.js} (100%) rename assets/{apidist_classes_Scene_commonSceneMethod.commonScene.md.0b70d19e.js => apidist_classes_Scene_commonSceneMethod.commonScene.md.e77c1bce.js} (93%) rename assets/{apidist_classes_Scene_commonSceneMethod.commonScene.md.0b70d19e.lean.js => apidist_classes_Scene_commonSceneMethod.commonScene.md.e77c1bce.lean.js} (100%) rename assets/{apidist_classes_Scene_copperMScene.copperMScene.md.9ac994ac.js => apidist_classes_Scene_copperMScene.copperMScene.md.8b080c61.js} (94%) rename assets/{apidist_classes_Scene_copperMScene.copperMScene.md.9ac994ac.lean.js => apidist_classes_Scene_copperMScene.copperMScene.md.8b080c61.lean.js} (100%) rename assets/{apidist_classes_Scene_copperScene.copperScene.md.8805daed.js => apidist_classes_Scene_copperScene.copperScene.md.826727ff.js} (94%) rename assets/{apidist_classes_Scene_copperScene.copperScene.md.8805daed.lean.js => apidist_classes_Scene_copperScene.copperScene.md.826727ff.lean.js} (100%) rename assets/{apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.a1a8f30f.js => apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.159ccf85.js} (94%) rename assets/{apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.a1a8f30f.lean.js => apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.159ccf85.lean.js} (100%) rename assets/{apidist_classes_Utils_MeshNodeTool.Element.md.8b274bdc.js => apidist_classes_Utils_MeshNodeTool.Element.md.90a8b6f8.js} (94%) rename assets/{apidist_classes_Utils_MeshNodeTool.Element.md.8b274bdc.lean.js => apidist_classes_Utils_MeshNodeTool.Element.md.90a8b6f8.lean.js} (100%) rename assets/{apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.b472aed6.js => apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.2cefc028.js} (95%) rename assets/{apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.b472aed6.lean.js => apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.2cefc028.lean.js} (87%) rename assets/{apidist_classes_Utils_MeshNodeTool.Node.md.ae44cd20.js => apidist_classes_Utils_MeshNodeTool.Node.md.cbca78ea.js} (94%) rename assets/{apidist_classes_Utils_MeshNodeTool.Node.md.ae44cd20.lean.js => apidist_classes_Utils_MeshNodeTool.Node.md.cbca78ea.lean.js} (100%) rename assets/{apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.423cb4fb.js => apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.8a335248.js} (94%) rename assets/{apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.423cb4fb.lean.js => apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.8a335248.lean.js} (100%) rename assets/{apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.e73cba27.js => apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.eb6181d8.js} (93%) rename assets/{apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.e73cba27.lean.js => apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.eb6181d8.lean.js} (70%) rename assets/{apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.5c09077d.js => apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.69cb94c5.js} (95%) rename assets/{apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.5c09077d.lean.js => apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.69cb94c5.lean.js} (100%) rename assets/{apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.02b66863.js => apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.fc10885a.js} (94%) rename assets/{apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.02b66863.lean.js => apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.fc10885a.lean.js} (100%) rename assets/{apidist_interfaces_Loader_copperNrrdLoader.optsType.md.7ab6b681.js => apidist_interfaces_Loader_copperNrrdLoader.optsType.md.0c190027.js} (95%) rename assets/{apidist_interfaces_Loader_copperNrrdLoader.optsType.md.7ab6b681.lean.js => apidist_interfaces_Loader_copperNrrdLoader.optsType.md.0c190027.lean.js} (100%) rename assets/{apidist_modules_Loader_copperNrrdLoader.md.efb47231.js => apidist_modules_Loader_copperNrrdLoader.md.8ad3704c.js} (96%) rename assets/{apidist_modules_Loader_copperNrrdLoader.md.efb47231.lean.js => apidist_modules_Loader_copperNrrdLoader.md.8ad3704c.lean.js} (86%) rename assets/{apidist_modules_Utils_segmentation_coreTools_gui.md.ced0118d.js => apidist_modules_Utils_segmentation_coreTools_gui.md.5a72133e.js} (93%) rename assets/{apidist_modules_Utils_segmentation_coreTools_gui.md.ced0118d.lean.js => apidist_modules_Utils_segmentation_coreTools_gui.md.5a72133e.lean.js} (75%) rename assets/{apidist_modules_Utils_utils.md.39292504.js => apidist_modules_Utils_utils.md.e5eb399b.js} (95%) rename assets/{apidist_modules_Utils_utils.md.39292504.lean.js => apidist_modules_Utils_utils.md.e5eb399b.lean.js} (100%) diff --git a/404.html b/404.html index b34f170..235b983 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 fa6e015..42b4f0c 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 b0d7131..cbd24ad 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 3e5fbb3..e6bdd5e 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 7bee7f1..5cf9139 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 e9ebf04..9d65f7e 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:141

closeGui ​

▸ closeGui(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:133

getCubeMapTexture ​

▸ Private getCubeMapTexture(environment): Promise<unknown>

Parameters ​

NameType
environmentenvironmentType

Returns ​

Promise<unknown>

Defined in ​

src/Renderer/baseRenderer.ts:109

getCurrentScene ​

▸ getCurrentScene(): baseScene

Returns ​

baseScene

Defined in ​

src/Renderer/baseRenderer.ts:127

hideGui ​

▸ hideGui(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:130

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

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

+ \ No newline at end of file diff --git a/apidist/classes/Renderer_copperMSceneRenderer.copperMSceneRenderer.html b/apidist/classes/Renderer_copperMSceneRenderer.copperMSceneRenderer.html index f35a624..ca16cf3 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 afdac39..4451f99 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:141

addPreRenderCallbackFunction ​

▸ addPreRenderCallbackFunction(callbackFunction): void

Parameters ​

NameType
callbackFunctionFunction

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:60

animate ​

▸ animate(time?): void

Parameters ​

NameType
time?number

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:66

closeGui ​

▸ closeGui(): void

Returns ​

void

Inherited from ​

baseRenderer.closeGui

Defined in ​

src/Renderer/baseRenderer.ts:133

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

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

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

render ​

▸ render(): void

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:91

setClearColor ​

▸ setClearColor(clearColor?, alpha?): void

Parameters ​

NameTypeDefault value
clearColornumber0x000000
alphanumber0

Returns ​

void

Inherited from ​

baseRenderer.setClearColor

Defined in ​

src/Renderer/baseRenderer.ts:137

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

+ \ No newline at end of file diff --git a/apidist/classes/Scene_baseScene.baseScene.html b/apidist/classes/Scene_baseScene.baseScene.html index 3bab5b2..a83984c 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 a13c0e5..9d3efd7 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 26708cf..c23b704 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 ddb0b6f..77ed05a 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 2d0ca9b..88b24a7 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 b1874fc..8560a3c 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 0e17649..28cbc4a 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 10de8ee..cddd269 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 b07996d..b42e377 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:155

Properties ​

baseCanvasesSize ​

• baseCanvasesSize: number = 1

Defined in ​

src/Utils/segmentation/CommToolsData.ts:15

cursorPage ​

• cursorPage: ICursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:81

gui_states ​

• gui_states: IGUIStates

Defined in ​

src/Utils/segmentation/CommToolsData.ts:102

nrrd_states ​

• nrrd_states: INrrdStates

Defined in ​

src/Utils/segmentation/CommToolsData.ts:16

protectedData ​

• protectedData: IProtected

Defined in ​

src/Utils/segmentation/CommToolsData.ts:154

Methods ​

clearPaint ​

▸ clearPaint(): void

Rewrite this {clearPaint} function under DrawToolCore

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:226

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:242

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

createEmptyPaintImage ​

▸ createEmptyPaintImage(dimensions, paintImages): void

Rewrite this {createEmptyPaintImage} function under NrrdTools

Parameters ​

NameType
dimensionsnumber[]
paintImagesIPaintImages

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:250

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

flipDisplayImageByAxis ​

▸ flipDisplayImageByAxis(): void

Rewrite this {flipDisplayImageByAxis} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:285

generateCanvases ​

▸ Private generateCanvases(): HTMLCanvasElement[]

Returns ​

HTMLCanvasElement[]

Defined in ​

src/Utils/segmentation/CommToolsData.ts:214

redrawDisplayCanvas ​

▸ redrawDisplayCanvas(): void

Rewrite this {redrawDisplayCanvas} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:339

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Rewrite this {resetLayerCanvas} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:323

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

resizePaintArea ​

▸ resizePaintArea(factor): void

Rewrite this {resizePaintArea} function under NrrdTools

Parameters ​

NameType
factornumber

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:261

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

setIsDrawFalse ​

▸ setIsDrawFalse(target): void

Rewrite this {setIsDrawFalse} function under NrrdTools

Parameters ​

NameType
targetnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:269

setSyncsliceNum ​

▸ setSyncsliceNum(): void

Rewrite this {setSyncsliceNum} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:331

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:234

updateOriginAndChangedWH ​

▸ updateOriginAndChangedWH(): void

Rewrite this {updateOriginAndChangedWH} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:277

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

Properties ​

baseCanvasesSize ​

• baseCanvasesSize: number = 1

Defined in ​

src/Utils/segmentation/CommToolsData.ts:15

cursorPage ​

• cursorPage: ICursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:81

gui_states ​

• gui_states: IGUIStates

Defined in ​

src/Utils/segmentation/CommToolsData.ts:102

nrrd_states ​

• nrrd_states: INrrdStates

Defined in ​

src/Utils/segmentation/CommToolsData.ts:16

protectedData ​

• protectedData: IProtected

Defined in ​

src/Utils/segmentation/CommToolsData.ts:154

Methods ​

clearPaint ​

▸ clearPaint(): void

Rewrite this {clearPaint} function under DrawToolCore

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:226

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:242

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

createEmptyPaintImage ​

▸ createEmptyPaintImage(dimensions, paintImages): void

Rewrite this {createEmptyPaintImage} function under NrrdTools

Parameters ​

NameType
dimensionsnumber[]
paintImagesIPaintImages

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:250

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

flipDisplayImageByAxis ​

▸ flipDisplayImageByAxis(): void

Rewrite this {flipDisplayImageByAxis} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:285

generateCanvases ​

▸ Private generateCanvases(): HTMLCanvasElement[]

Returns ​

HTMLCanvasElement[]

Defined in ​

src/Utils/segmentation/CommToolsData.ts:214

redrawDisplayCanvas ​

▸ redrawDisplayCanvas(): void

Rewrite this {redrawDisplayCanvas} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:339

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Rewrite this {resetLayerCanvas} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:323

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

resizePaintArea ​

▸ resizePaintArea(factor): void

Rewrite this {resizePaintArea} function under NrrdTools

Parameters ​

NameType
factornumber

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:261

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

setIsDrawFalse ​

▸ setIsDrawFalse(target): void

Rewrite this {setIsDrawFalse} function under NrrdTools

Parameters ​

NameType
targetnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:269

setSyncsliceNum ​

▸ setSyncsliceNum(): void

Rewrite this {setSyncsliceNum} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:331

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:234

updateOriginAndChangedWH ​

▸ updateOriginAndChangedWH(): void

Rewrite this {updateOriginAndChangedWH} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:277

+ \ 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 23f32bf..9753ca0 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: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

- +
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 b2965f7..b4bda50 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:49

Properties ​

baseCanvasesSize ​

• baseCanvasesSize: number = 1

Inherited from ​

CommToolsData.baseCanvasesSize

Defined in ​

src/Utils/segmentation/CommToolsData.ts:15

container ​

• container: HTMLElement

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:16

contrastEventPrameters ​

• contrastEventPrameters: IContrastEvents

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:29

cursorPage ​

• cursorPage: ICursorPage

Inherited from ​

CommToolsData.cursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:81

drawingPrameters ​

• drawingPrameters: IDrawingEvents

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:18

eraserUrls ​

• eraserUrls: string[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:42

gui_states ​

• gui_states: IGUIStates

Inherited from ​

CommToolsData.gui_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:102

mainAreaContainer ​

• mainAreaContainer: HTMLDivElement

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:17

nrrd_states ​

• nrrd_states: INrrdStates

Inherited from ​

CommToolsData.nrrd_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:16

pencilUrls ​

• pencilUrls: string[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:43

protectedData ​

• protectedData: IProtected

Inherited from ​

CommToolsData.protectedData

Defined in ​

src/Utils/segmentation/CommToolsData.ts:154

start ​

• start: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:47

undoArray ​

• undoArray: IUndoType[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:44

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

clearPaint ​

▸ clearPaint(): void

Clear mask on current slice canvas

Returns ​

void

Overrides ​

CommToolsData.clearPaint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1466

clearSphereCanvas ​

▸ Private clearSphereCanvas(): (HTMLCanvasElement | CanvasRenderingContext2D)[]

Returns ​

(HTMLCanvasElement | CanvasRenderingContext2D)[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1278

clearSpherePrintStoreImages ​

▸ Private clearSpherePrintStoreImages(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:225

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.clearStoreImages

Defined in ​

src/Utils/segmentation/CommToolsData.ts:242

configContrastDragMode ​

▸ configContrastDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2076

configMouseSphereWheel ​

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

Returns ​

fn

▸ (e): void

Parameters ​
NameType
eWheelEvent
Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1203

configMouseZoomWheel ​

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

Returns ​

fn

▸ (e): void

Parameters ​
NameType
eWheelEvent
Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:963

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

createEmptyPaintImage ​

▸ createEmptyPaintImage(dimensions, paintImages): void

Rewrite this {createEmptyPaintImage} function under NrrdTools

Parameters ​

NameType
dimensionsnumber[]
paintImagesIPaintImages

Returns ​

void

Inherited from ​

CommToolsData.createEmptyPaintImage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:250

draw ​

▸ draw(opts?): void

Parameters ​

NameType
opts?IDrawOpts

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:143

drawCalSphereDown ​

▸ drawCalSphereDown(x, y, sliceIndex, cal_position): void

Parameters ​

NameType
xnumber
ynumber
sliceIndexnumber
cal_position"tumour" | "skin" | "nipple" | "ribcage"

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:152

drawCalSphereUp ​

▸ drawCalSphereUp(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:196

drawCalculatorSphere ​

▸ drawCalculatorSphere(radius): void

Parameters ​

NameType
radiusnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1225

drawCalculatorSphereOnEachViews ​

▸ drawCalculatorSphereOnEachViews(axis): void

Parameters ​

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

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1059

drawImageOnEmptyImage ​

▸ drawImageOnEmptyImage(canvas): void

Parameters ​

NameType
canvasHTMLCanvasElement

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1040

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

drawLinesOnLayer ​

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

Parameters ​

NameType
ctxCanvasRenderingContext2D
xnumber
ynumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:829

drawSphere ​

▸ drawSphere(mouseX, mouseY, radius): void

Parameters ​

NameType
mouseXnumber
mouseYnumber
radiusnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1256

drawSphereCore ​

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

Parameters ​

NameTypeDescription
ctxCanvasRenderingContext2Ddraw sphere canvas ctx
xnumberwidth must be match the origin size, size factor 1, ignore the size factor
ynumberheight must be match the origin size, size factor 1, ignore the size factor
radiusnumberradius must be match the origin size, size factor 1, ignore the size factor
colorstringsphere color

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1166

drawSphereOnEachViews ​

▸ Private drawSphereOnEachViews(decay, axis): void

Parameters ​

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

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1128

enableCrosshair ​

▸ Private enableCrosshair(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1019

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

findSliceInSharedPlace ​

▸ findSliceInSharedPlace(): ImageData[]

Returns ​

ImageData[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1971

flipDisplayImageByAxis ​

▸ flipDisplayImageByAxis(): void

Rewrite this {flipDisplayImageByAxis} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.flipDisplayImageByAxis

Defined in ​

src/Utils/segmentation/CommToolsData.ts:285

getCurrentUndo ​

▸ Private getCurrentUndo(): IUndoType[]

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

Returns ​

IUndoType[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1457

getRestLabel ​

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

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

Returns ​

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

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1447

getSpherePosition ​

▸ Private getSpherePosition(position, axis): Object

Sphere calculate distance functions*************************

Parameters ​

NameType
positionICommXYZ
axis"z" | "y" | "x"

Returns ​

Object

NameType
xany
yany
zany

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1052

initAllCanvas ​

▸ Private initAllCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:864

initDrawToolCore ​

▸ Private initDrawToolCore(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:58

paintOnCanvas ​

▸ Private paintOnCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:235

paintOnCanvasLayer ​

▸ Private paintOnCanvasLayer(x, y): void

Parameters ​

NameType
xnumber
ynumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:852

redrawDisplayCanvas ​

▸ redrawDisplayCanvas(): void

Rewrite this {redrawDisplayCanvas} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.redrawDisplayCanvas

Defined in ​

src/Utils/segmentation/CommToolsData.ts:339

removeContrastDragMode ​

▸ removeContrastDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2090

replaceArray ​

▸ replaceArray(mainArr, replaceArr): void

Parameters ​

NameType
mainArrnumber[] | Uint8ClampedArray
replaceArrnumber[] | Uint8ClampedArray

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1958

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

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

repraintCurrentContrastSlice ​

▸ repraintCurrentContrastSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2140

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Rewrite this {resetLayerCanvas} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.resetLayerCanvas

Defined in ​

src/Utils/segmentation/CommToolsData.ts:323

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

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

setCurrentLayer ​

▸ Private setCurrentLayer(): Object

Returns ​

Object

NameType
canvasHTMLCanvasElement
ctxCanvasRenderingContext2D

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:119

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

setEraserUrls ​

▸ setEraserUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:106

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

setPencilIconUrls ​

▸ setPencilIconUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:109

setSphereCanvasSize ​

▸ Private setSphereCanvasSize(axis?): void

Parameters ​

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

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1180

setSyncsliceNum ​

▸ setSyncsliceNum(): void

Rewrite this {setSyncsliceNum} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.setSyncsliceNum

Defined in ​

src/Utils/segmentation/CommToolsData.ts:331

setUpSphereOrigins ​

▸ Private setUpSphereOrigins(mouseX, mouseY, sliceIndex): void

Parameters ​

NameType
mouseXnumber
mouseYnumber
sliceIndexnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1404

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

sliceArrayH ​

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

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

Uint8ClampedArray[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1839

sliceArrayV ​

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

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

number[][]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1850

storeAllImages ​

▸ storeAllImages(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1596

storeEachLayerImage ​

▸ storeEachLayerImage(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1797

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

storeImageToLabel ​

▸ storeImageToLabel(index, canvas, paintedImages): ImageData

Parameters ​

NameType
indexnumber
canvasHTMLCanvasElement
paintedImagesIPaintImages

Returns ​

ImageData

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1777

storeSphereImages ​

▸ Private storeSphereImages(index, axis): void

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

Parameters ​

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

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1111

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Overrides ​

CommToolsData.undoLastPainting

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1485

updateOriginAndChangedWH ​

▸ updateOriginAndChangedWH(): void

Rewrite this {updateOriginAndChangedWH} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.updateOriginAndChangedWH

Defined in ​

src/Utils/segmentation/CommToolsData.ts:277

updateSlicesContrast ​

▸ updateSlicesContrast(value, flag): void

Parameters ​

NameType
valuenumber
flagstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2114

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

zoomActionAfterDrawSphere ​

▸ Private zoomActionAfterDrawSphere(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:218

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

Properties ​

baseCanvasesSize ​

• baseCanvasesSize: number = 1

Inherited from ​

CommToolsData.baseCanvasesSize

Defined in ​

src/Utils/segmentation/CommToolsData.ts:15

container ​

• container: HTMLElement

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:16

contrastEventPrameters ​

• contrastEventPrameters: IContrastEvents

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:29

cursorPage ​

• cursorPage: ICursorPage

Inherited from ​

CommToolsData.cursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:81

drawingPrameters ​

• drawingPrameters: IDrawingEvents

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:18

eraserUrls ​

• eraserUrls: string[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:42

gui_states ​

• gui_states: IGUIStates

Inherited from ​

CommToolsData.gui_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:102

mainAreaContainer ​

• mainAreaContainer: HTMLDivElement

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:17

nrrd_states ​

• nrrd_states: INrrdStates

Inherited from ​

CommToolsData.nrrd_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:16

pencilUrls ​

• pencilUrls: string[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:43

protectedData ​

• protectedData: IProtected

Inherited from ​

CommToolsData.protectedData

Defined in ​

src/Utils/segmentation/CommToolsData.ts:154

start ​

• start: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:47

undoArray ​

• undoArray: IUndoType[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:44

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

clearPaint ​

▸ clearPaint(): void

Clear mask on current slice canvas

Returns ​

void

Overrides ​

CommToolsData.clearPaint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1466

clearSphereCanvas ​

▸ Private clearSphereCanvas(): (HTMLCanvasElement | CanvasRenderingContext2D)[]

Returns ​

(HTMLCanvasElement | CanvasRenderingContext2D)[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1278

clearSpherePrintStoreImages ​

▸ Private clearSpherePrintStoreImages(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:225

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.clearStoreImages

Defined in ​

src/Utils/segmentation/CommToolsData.ts:242

configContrastDragMode ​

▸ configContrastDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2076

configMouseSphereWheel ​

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

Returns ​

fn

▸ (e): void

Parameters ​
NameType
eWheelEvent
Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1203

configMouseZoomWheel ​

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

Returns ​

fn

▸ (e): void

Parameters ​
NameType
eWheelEvent
Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:963

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

createEmptyPaintImage ​

▸ createEmptyPaintImage(dimensions, paintImages): void

Rewrite this {createEmptyPaintImage} function under NrrdTools

Parameters ​

NameType
dimensionsnumber[]
paintImagesIPaintImages

Returns ​

void

Inherited from ​

CommToolsData.createEmptyPaintImage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:250

draw ​

▸ draw(opts?): void

Parameters ​

NameType
opts?IDrawOpts

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:143

drawCalSphereDown ​

▸ drawCalSphereDown(x, y, sliceIndex, cal_position): void

Parameters ​

NameType
xnumber
ynumber
sliceIndexnumber
cal_position"tumour" | "skin" | "nipple" | "ribcage"

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:152

drawCalSphereUp ​

▸ drawCalSphereUp(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:196

drawCalculatorSphere ​

▸ drawCalculatorSphere(radius): void

Parameters ​

NameType
radiusnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1225

drawCalculatorSphereOnEachViews ​

▸ drawCalculatorSphereOnEachViews(axis): void

Parameters ​

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

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1059

drawImageOnEmptyImage ​

▸ drawImageOnEmptyImage(canvas): void

Parameters ​

NameType
canvasHTMLCanvasElement

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1040

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

drawLinesOnLayer ​

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

Parameters ​

NameType
ctxCanvasRenderingContext2D
xnumber
ynumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:829

drawSphere ​

▸ drawSphere(mouseX, mouseY, radius): void

Parameters ​

NameType
mouseXnumber
mouseYnumber
radiusnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1256

drawSphereCore ​

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

Parameters ​

NameTypeDescription
ctxCanvasRenderingContext2Ddraw sphere canvas ctx
xnumberwidth must be match the origin size, size factor 1, ignore the size factor
ynumberheight must be match the origin size, size factor 1, ignore the size factor
radiusnumberradius must be match the origin size, size factor 1, ignore the size factor
colorstringsphere color

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1166

drawSphereOnEachViews ​

▸ Private drawSphereOnEachViews(decay, axis): void

Parameters ​

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

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1128

enableCrosshair ​

▸ Private enableCrosshair(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1019

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

findSliceInSharedPlace ​

▸ findSliceInSharedPlace(): ImageData[]

Returns ​

ImageData[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1971

flipDisplayImageByAxis ​

▸ flipDisplayImageByAxis(): void

Rewrite this {flipDisplayImageByAxis} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.flipDisplayImageByAxis

Defined in ​

src/Utils/segmentation/CommToolsData.ts:285

getCurrentUndo ​

▸ Private getCurrentUndo(): IUndoType[]

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

Returns ​

IUndoType[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1457

getRestLabel ​

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

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

Returns ​

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

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1447

getSpherePosition ​

▸ Private getSpherePosition(position, axis): Object

Sphere calculate distance functions*************************

Parameters ​

NameType
positionICommXYZ
axis"z" | "y" | "x"

Returns ​

Object

NameType
xany
yany
zany

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1052

initAllCanvas ​

▸ Private initAllCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:864

initDrawToolCore ​

▸ Private initDrawToolCore(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:58

paintOnCanvas ​

▸ Private paintOnCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:235

paintOnCanvasLayer ​

▸ Private paintOnCanvasLayer(x, y): void

Parameters ​

NameType
xnumber
ynumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:852

redrawDisplayCanvas ​

▸ redrawDisplayCanvas(): void

Rewrite this {redrawDisplayCanvas} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.redrawDisplayCanvas

Defined in ​

src/Utils/segmentation/CommToolsData.ts:339

removeContrastDragMode ​

▸ removeContrastDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2090

replaceArray ​

▸ replaceArray(mainArr, replaceArr): void

Parameters ​

NameType
mainArrnumber[] | Uint8ClampedArray
replaceArrnumber[] | Uint8ClampedArray

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1958

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

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

repraintCurrentContrastSlice ​

▸ repraintCurrentContrastSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2140

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Rewrite this {resetLayerCanvas} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.resetLayerCanvas

Defined in ​

src/Utils/segmentation/CommToolsData.ts:323

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

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

setCurrentLayer ​

▸ Private setCurrentLayer(): Object

Returns ​

Object

NameType
canvasHTMLCanvasElement
ctxCanvasRenderingContext2D

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:119

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

setEraserUrls ​

▸ setEraserUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:106

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

setPencilIconUrls ​

▸ setPencilIconUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:109

setSphereCanvasSize ​

▸ Private setSphereCanvasSize(axis?): void

Parameters ​

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

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1180

setSyncsliceNum ​

▸ setSyncsliceNum(): void

Rewrite this {setSyncsliceNum} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.setSyncsliceNum

Defined in ​

src/Utils/segmentation/CommToolsData.ts:331

setUpSphereOrigins ​

▸ Private setUpSphereOrigins(mouseX, mouseY, sliceIndex): void

Parameters ​

NameType
mouseXnumber
mouseYnumber
sliceIndexnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1404

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

sliceArrayH ​

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

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

Uint8ClampedArray[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1839

sliceArrayV ​

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

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

number[][]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1850

storeAllImages ​

▸ storeAllImages(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1596

storeEachLayerImage ​

▸ storeEachLayerImage(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1797

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

storeImageToLabel ​

▸ storeImageToLabel(index, canvas, paintedImages): ImageData

Parameters ​

NameType
indexnumber
canvasHTMLCanvasElement
paintedImagesIPaintImages

Returns ​

ImageData

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1777

storeSphereImages ​

▸ Private storeSphereImages(index, axis): void

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

Parameters ​

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

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1111

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Overrides ​

CommToolsData.undoLastPainting

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1485

updateOriginAndChangedWH ​

▸ updateOriginAndChangedWH(): void

Rewrite this {updateOriginAndChangedWH} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.updateOriginAndChangedWH

Defined in ​

src/Utils/segmentation/CommToolsData.ts:277

updateSlicesContrast ​

▸ updateSlicesContrast(value, flag): void

Parameters ​

NameType
valuenumber
flagstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2114

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

zoomActionAfterDrawSphere ​

▸ Private zoomActionAfterDrawSphere(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:218

+ \ 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 4d6c0b1..9138aa4 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:15

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

cursorPage ​

• cursorPage: ICursorPage

Inherited from ​

DrawToolCore.cursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:81

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

eraserUrls ​

• eraserUrls: string[] = []

Inherited from ​

DrawToolCore.eraserUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:42

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

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

nrrd_states ​

• nrrd_states: INrrdStates

Inherited from ​

DrawToolCore.nrrd_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:16

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

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

start ​

• start: () => void

Type declaration ​

▸ (): void

Returns ​

void

Inherited from ​

DrawToolCore.start

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:47

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

Methods ​

addSkip ​

▸ addSkip(index): void

Parameters ​

NameType
indexnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:606

afterLoadSlice ​

▸ Private afterLoadSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:841

appendLoadingbar ​

▸ appendLoadingbar(loadingbar): void

Parameters ​

NameType
loadingbarHTMLDivElement

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:900

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

clear ​

▸ clear(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:624

clearDictionary ​

▸ Private clearDictionary(dic): void

Parameters ​

NameType
dicISkipSlicesDictType

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1133

clearPaint ​

▸ clearPaint(): void

Clear mask on current slice canvas

Returns ​

void

Inherited from ​

DrawToolCore.clearPaint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1466

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Overrides ​

DrawToolCore.clearStoreImages

Defined in ​

src/Utils/segmentation/NrrdTools.ts:904

configContrastDragMode ​

▸ configContrastDragMode(): void

Returns ​

void

Inherited from ​

DrawToolCore.configContrastDragMode

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2076

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

createEmptyPaintImage ​

▸ createEmptyPaintImage(dimensions, paintImages): void

Rewrite this {createEmptyPaintImage} function under NrrdTools

Parameters ​

NameType
dimensionsnumber[]
paintImagesIPaintImages

Returns ​

void

Overrides ​

DrawToolCore.createEmptyPaintImage

Defined in ​

src/Utils/segmentation/NrrdTools.ts:407

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

drawCalSphereDown ​

▸ drawCalSphereDown(x, y, sliceIndex, cal_position): void

Parameters ​

NameType
xnumber
ynumber
sliceIndexnumber
cal_position"tumour" | "skin" | "nipple" | "ribcage"

Returns ​

void

Inherited from ​

DrawToolCore.drawCalSphereDown

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:152

drawCalSphereUp ​

▸ drawCalSphereUp(): void

Returns ​

void

Inherited from ​

DrawToolCore.drawCalSphereUp

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:196

drawCalculatorSphere ​

▸ drawCalculatorSphere(radius): void

Parameters ​

NameType
radiusnumber

Returns ​

void

Inherited from ​

DrawToolCore.drawCalculatorSphere

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1225

drawCalculatorSphereOnEachViews ​

▸ drawCalculatorSphereOnEachViews(axis): void

Parameters ​

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

Returns ​

void

Inherited from ​

DrawToolCore.drawCalculatorSphereOnEachViews

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1059

drawImageOnEmptyImage ​

▸ drawImageOnEmptyImage(canvas): void

Parameters ​

NameType
canvasHTMLCanvasElement

Returns ​

void

Inherited from ​

DrawToolCore.drawImageOnEmptyImage

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1040

drawSphere ​

▸ drawSphere(mouseX, mouseY, radius): void

Parameters ​

NameType
mouseXnumber
mouseYnumber
radiusnumber

Returns ​

void

Inherited from ​

DrawToolCore.drawSphere

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1256

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

findSliceInSharedPlace ​

▸ findSliceInSharedPlace(): ImageData[]

Returns ​

ImageData[]

Inherited from ​

DrawToolCore.findSliceInSharedPlace

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1971

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

getContainer ​

▸ getContainer(): HTMLElement

Returns ​

HTMLElement

Defined in ​

src/Utils/segmentation/NrrdTools.ts:693

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

getCurrentSlicesNumAndContrastNum ​

▸ getCurrentSlicesNumAndContrastNum(): Object

Returns ​

Object

NameType
contrastIndexnumber
currentIndexnumber

Defined in ​

src/Utils/segmentation/NrrdTools.ts:713

getDrawingCanvas ​

▸ getDrawingCanvas(): HTMLCanvasElement

Returns ​

HTMLCanvasElement

Defined in ​

src/Utils/segmentation/NrrdTools.ts:696

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

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

getNrrdToolsSettings ​

▸ getNrrdToolsSettings(): INrrdStates

Returns ​

INrrdStates

Defined in ​

src/Utils/segmentation/NrrdTools.ts:699

getRestLabel ​

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

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

Returns ​

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

Inherited from ​

DrawToolCore.getRestLabel

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1447

getSharedPlace ​

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

Parameters ​

NameType
lennumber
rationumber

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:363

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

loadDisplaySlicesArray ​

▸ Private loadDisplaySlicesArray(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:759

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

redrawMianPreOnDisplayCanvas ​

▸ redrawMianPreOnDisplayCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:957

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

removeContrastDragMode ​

▸ removeContrastDragMode(): void

Returns ​

void

Inherited from ​

DrawToolCore.removeContrastDragMode

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2090

removeSkip ​

▸ removeSkip(index): void

Parameters ​

NameType
indexnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:618

replaceArray ​

▸ replaceArray(mainArr, replaceArr): void

Parameters ​

NameType
mainArrnumber[] | Uint8ClampedArray
replaceArrnumber[] | Uint8ClampedArray

Returns ​

void

Inherited from ​

DrawToolCore.replaceArray

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1958

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

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

repraintCurrentContrastSlice ​

▸ repraintCurrentContrastSlice(): void

Returns ​

void

Inherited from ​

DrawToolCore.repraintCurrentContrastSlice

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2140

resetDisplaySlicesStatus ​

▸ Private resetDisplaySlicesStatus(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:786

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Clear masks on drawingCanvas layers.

Returns ​

void

Overrides ​

DrawToolCore.resetLayerCanvas

Defined in ​

src/Utils/segmentation/NrrdTools.ts:946

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

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

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

setCalculateDistanceSphere ​

▸ setCalculateDistanceSphere(x, y, sliceIndex, cal_position): void

Parameters ​

NameType
xnumber
ynumber
sliceIndexnumber
cal_position"tumour" | "skin" | "nipple" | "ribcage"

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:348

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

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

setEraserUrls ​

▸ setEraserUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Inherited from ​

DrawToolCore.setEraserUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:106

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

setMainAreaSize ​

▸ setMainAreaSize(factor): void

Parameters ​

NameType
factornumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:680

setMainPreSlice ​

▸ Private setMainPreSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:810

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

setPencilIconUrls ​

▸ setPencilIconUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Inherited from ​

DrawToolCore.setPencilIconUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:109

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

setSliceOrientation ​

▸ setSliceOrientation(axisTo): void

Switch all contrast slices' orientation

Parameters ​

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

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:452

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

setupConfigs ​

▸ Private setupConfigs(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:793

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

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

sliceArrayV ​

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

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

number[][]

Inherited from ​

DrawToolCore.sliceArrayV

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1850

storeAllImages ​

▸ storeAllImages(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Inherited from ​

DrawToolCore.storeAllImages

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1596

storeEachLayerImage ​

▸ storeEachLayerImage(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Inherited from ​

DrawToolCore.storeEachLayerImage

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1797

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

storeImageToLabel ​

▸ storeImageToLabel(index, canvas, paintedImages): ImageData

Parameters ​

NameType
indexnumber
canvasHTMLCanvasElement
paintedImagesIPaintImages

Returns ​

ImageData

Inherited from ​

DrawToolCore.storeImageToLabel

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1777

switchAllSlicesArrayData ​

▸ switchAllSlicesArrayData(allSlices): void

Parameters ​

NameType
allSlicesnrrdSliceType[]

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:780

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Inherited from ​

DrawToolCore.undoLastPainting

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1485

updateMaxIndex ​

▸ Private updateMaxIndex(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:861

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

updateSlicesContrast ​

▸ updateSlicesContrast(value, flag): void

Parameters ​

NameType
valuenumber
flagstring

Returns ​

void

Inherited from ​

DrawToolCore.updateSlicesContrast

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2114

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

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

cursorPage ​

• cursorPage: ICursorPage

Inherited from ​

DrawToolCore.cursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:81

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

eraserUrls ​

• eraserUrls: string[] = []

Inherited from ​

DrawToolCore.eraserUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:42

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

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

nrrd_states ​

• nrrd_states: INrrdStates

Inherited from ​

DrawToolCore.nrrd_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:16

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

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

start ​

• start: () => void

Type declaration ​

▸ (): void

Returns ​

void

Inherited from ​

DrawToolCore.start

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:47

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

Methods ​

addSkip ​

▸ addSkip(index): void

Parameters ​

NameType
indexnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:606

afterLoadSlice ​

▸ Private afterLoadSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:841

appendLoadingbar ​

▸ appendLoadingbar(loadingbar): void

Parameters ​

NameType
loadingbarHTMLDivElement

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:900

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

clear ​

▸ clear(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:624

clearDictionary ​

▸ Private clearDictionary(dic): void

Parameters ​

NameType
dicISkipSlicesDictType

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1133

clearPaint ​

▸ clearPaint(): void

Clear mask on current slice canvas

Returns ​

void

Inherited from ​

DrawToolCore.clearPaint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1466

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Overrides ​

DrawToolCore.clearStoreImages

Defined in ​

src/Utils/segmentation/NrrdTools.ts:904

configContrastDragMode ​

▸ configContrastDragMode(): void

Returns ​

void

Inherited from ​

DrawToolCore.configContrastDragMode

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2076

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

createEmptyPaintImage ​

▸ createEmptyPaintImage(dimensions, paintImages): void

Rewrite this {createEmptyPaintImage} function under NrrdTools

Parameters ​

NameType
dimensionsnumber[]
paintImagesIPaintImages

Returns ​

void

Overrides ​

DrawToolCore.createEmptyPaintImage

Defined in ​

src/Utils/segmentation/NrrdTools.ts:407

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

drawCalSphereDown ​

▸ drawCalSphereDown(x, y, sliceIndex, cal_position): void

Parameters ​

NameType
xnumber
ynumber
sliceIndexnumber
cal_position"tumour" | "skin" | "nipple" | "ribcage"

Returns ​

void

Inherited from ​

DrawToolCore.drawCalSphereDown

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:152

drawCalSphereUp ​

▸ drawCalSphereUp(): void

Returns ​

void

Inherited from ​

DrawToolCore.drawCalSphereUp

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:196

drawCalculatorSphere ​

▸ drawCalculatorSphere(radius): void

Parameters ​

NameType
radiusnumber

Returns ​

void

Inherited from ​

DrawToolCore.drawCalculatorSphere

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1225

drawCalculatorSphereOnEachViews ​

▸ drawCalculatorSphereOnEachViews(axis): void

Parameters ​

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

Returns ​

void

Inherited from ​

DrawToolCore.drawCalculatorSphereOnEachViews

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1059

drawImageOnEmptyImage ​

▸ drawImageOnEmptyImage(canvas): void

Parameters ​

NameType
canvasHTMLCanvasElement

Returns ​

void

Inherited from ​

DrawToolCore.drawImageOnEmptyImage

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1040

drawSphere ​

▸ drawSphere(mouseX, mouseY, radius): void

Parameters ​

NameType
mouseXnumber
mouseYnumber
radiusnumber

Returns ​

void

Inherited from ​

DrawToolCore.drawSphere

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1256

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

findSliceInSharedPlace ​

▸ findSliceInSharedPlace(): ImageData[]

Returns ​

ImageData[]

Inherited from ​

DrawToolCore.findSliceInSharedPlace

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1971

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

getContainer ​

▸ getContainer(): HTMLElement

Returns ​

HTMLElement

Defined in ​

src/Utils/segmentation/NrrdTools.ts:693

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

getCurrentSlicesNumAndContrastNum ​

▸ getCurrentSlicesNumAndContrastNum(): Object

Returns ​

Object

NameType
contrastIndexnumber
currentIndexnumber

Defined in ​

src/Utils/segmentation/NrrdTools.ts:713

getDrawingCanvas ​

▸ getDrawingCanvas(): HTMLCanvasElement

Returns ​

HTMLCanvasElement

Defined in ​

src/Utils/segmentation/NrrdTools.ts:696

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

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

getNrrdToolsSettings ​

▸ getNrrdToolsSettings(): INrrdStates

Returns ​

INrrdStates

Defined in ​

src/Utils/segmentation/NrrdTools.ts:699

getRestLabel ​

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

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

Returns ​

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

Inherited from ​

DrawToolCore.getRestLabel

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1447

getSharedPlace ​

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

Parameters ​

NameType
lennumber
rationumber

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:363

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

loadDisplaySlicesArray ​

▸ Private loadDisplaySlicesArray(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:759

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

redrawMianPreOnDisplayCanvas ​

▸ redrawMianPreOnDisplayCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:957

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

removeContrastDragMode ​

▸ removeContrastDragMode(): void

Returns ​

void

Inherited from ​

DrawToolCore.removeContrastDragMode

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2090

removeSkip ​

▸ removeSkip(index): void

Parameters ​

NameType
indexnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:618

replaceArray ​

▸ replaceArray(mainArr, replaceArr): void

Parameters ​

NameType
mainArrnumber[] | Uint8ClampedArray
replaceArrnumber[] | Uint8ClampedArray

Returns ​

void

Inherited from ​

DrawToolCore.replaceArray

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1958

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

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

repraintCurrentContrastSlice ​

▸ repraintCurrentContrastSlice(): void

Returns ​

void

Inherited from ​

DrawToolCore.repraintCurrentContrastSlice

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2140

resetDisplaySlicesStatus ​

▸ Private resetDisplaySlicesStatus(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:786

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Clear masks on drawingCanvas layers.

Returns ​

void

Overrides ​

DrawToolCore.resetLayerCanvas

Defined in ​

src/Utils/segmentation/NrrdTools.ts:946

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

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

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

setCalculateDistanceSphere ​

▸ setCalculateDistanceSphere(x, y, sliceIndex, cal_position): void

Parameters ​

NameType
xnumber
ynumber
sliceIndexnumber
cal_position"tumour" | "skin" | "nipple" | "ribcage"

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:348

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

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

setEraserUrls ​

▸ setEraserUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Inherited from ​

DrawToolCore.setEraserUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:106

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

setMainAreaSize ​

▸ setMainAreaSize(factor): void

Parameters ​

NameType
factornumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:680

setMainPreSlice ​

▸ Private setMainPreSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:810

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

setPencilIconUrls ​

▸ setPencilIconUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Inherited from ​

DrawToolCore.setPencilIconUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:109

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

setSliceOrientation ​

▸ setSliceOrientation(axisTo): void

Switch all contrast slices' orientation

Parameters ​

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

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:452

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

setupConfigs ​

▸ Private setupConfigs(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:793

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

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

sliceArrayV ​

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

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

number[][]

Inherited from ​

DrawToolCore.sliceArrayV

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1850

storeAllImages ​

▸ storeAllImages(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Inherited from ​

DrawToolCore.storeAllImages

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1596

storeEachLayerImage ​

▸ storeEachLayerImage(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Inherited from ​

DrawToolCore.storeEachLayerImage

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1797

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

storeImageToLabel ​

▸ storeImageToLabel(index, canvas, paintedImages): ImageData

Parameters ​

NameType
indexnumber
canvasHTMLCanvasElement
paintedImagesIPaintImages

Returns ​

ImageData

Inherited from ​

DrawToolCore.storeImageToLabel

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1777

switchAllSlicesArrayData ​

▸ switchAllSlicesArrayData(allSlices): void

Parameters ​

NameType
allSlicesnrrdSliceType[]

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:780

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Inherited from ​

DrawToolCore.undoLastPainting

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1485

updateMaxIndex ​

▸ Private updateMaxIndex(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:861

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

updateSlicesContrast ​

▸ updateSlicesContrast(value, flag): void

Parameters ​

NameType
valuenumber
flagstring

Returns ​

void

Inherited from ​

DrawToolCore.updateSlicesContrast

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2114

+ \ No newline at end of file diff --git a/apidist/interfaces/Loader_copperNrrdLoader.optsType.html b/apidist/interfaces/Loader_copperNrrdLoader.optsType.html index b26676e..5e4bcc3 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 779ab75..d3f6832 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 73f216a..b74e067 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 276d8ae..d2fdcee 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 c391603..2da40d5 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 0cd4fb3..bc191c7 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 4d038b7..51d311e 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 990d93d..d95d546 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 9329793..2c24b23 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 19adcf0..6a41a8a 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 8b97754..9734a46 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 3c37ee6..a6b34dc 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 a89147a..2c04f82 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 ca750b8..d25c150 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 bf79c98..ea85919 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 3be6ba0..d29428b 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 0a799ae..954c2a9 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 0ba124e..60f71f8 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 e305041..44d55a0 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 a6ed963..b2315ca 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 bc4012f..e2ad9bd 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 e2dd248..f2db0d9 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:532

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

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 447f8b3..f485ba0 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.797ee5d2.js b/assets/apidist_classes_Controls_Copper3dTrackballControls.Copper3dTrackballControls.md.78f59b32.js similarity index 94% rename from assets/apidist_classes_Controls_Copper3dTrackballControls.Copper3dTrackballControls.md.797ee5d2.js rename to assets/apidist_classes_Controls_Copper3dTrackballControls.Copper3dTrackballControls.md.78f59b32.js index ffe1b00..9d6d76c 100644 --- a/assets/apidist_classes_Controls_Copper3dTrackballControls.Copper3dTrackballControls.md.797ee5d2.js +++ b/assets/apidist_classes_Controls_Copper3dTrackballControls.Copper3dTrackballControls.md.78f59b32.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.797ee5d2.lean.js b/assets/apidist_classes_Controls_Copper3dTrackballControls.Copper3dTrackballControls.md.78f59b32.lean.js similarity index 100% rename from assets/apidist_classes_Controls_Copper3dTrackballControls.Copper3dTrackballControls.md.797ee5d2.lean.js rename to assets/apidist_classes_Controls_Copper3dTrackballControls.Copper3dTrackballControls.md.78f59b32.lean.js diff --git a/assets/apidist_classes_Controls_copperControls.CameraViewPoint.md.715e5ff1.js b/assets/apidist_classes_Controls_copperControls.CameraViewPoint.md.65077997.js similarity index 92% rename from assets/apidist_classes_Controls_copperControls.CameraViewPoint.md.715e5ff1.js rename to assets/apidist_classes_Controls_copperControls.CameraViewPoint.md.65077997.js index 3c1f2d4..bf2e81b 100644 --- a/assets/apidist_classes_Controls_copperControls.CameraViewPoint.md.715e5ff1.js +++ b/assets/apidist_classes_Controls_copperControls.CameraViewPoint.md.65077997.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 m=e(t,[["render",s]]);export{C as __pageData,m 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.715e5ff1.lean.js b/assets/apidist_classes_Controls_copperControls.CameraViewPoint.md.65077997.lean.js similarity index 100% rename from assets/apidist_classes_Controls_copperControls.CameraViewPoint.md.715e5ff1.lean.js rename to assets/apidist_classes_Controls_copperControls.CameraViewPoint.md.65077997.lean.js diff --git a/assets/apidist_classes_Controls_copperControls.Controls.md.78bd2acf.js b/assets/apidist_classes_Controls_copperControls.Controls.md.69a0f16d.js similarity index 92% rename from assets/apidist_classes_Controls_copperControls.Controls.md.78bd2acf.js rename to assets/apidist_classes_Controls_copperControls.Controls.md.69a0f16d.js index f07e988..8490ce8 100644 --- a/assets/apidist_classes_Controls_copperControls.Controls.md.78bd2acf.js +++ b/assets/apidist_classes_Controls_copperControls.Controls.md.69a0f16d.js @@ -1 +1 @@ -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}; +import{_ as e,o as t,c as o,Q as a}from"./chunks/framework.5916b37e.js";const m=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{m as __pageData,C as default}; diff --git a/assets/apidist_classes_Controls_copperControls.Controls.md.78bd2acf.lean.js b/assets/apidist_classes_Controls_copperControls.Controls.md.69a0f16d.lean.js similarity index 76% rename from assets/apidist_classes_Controls_copperControls.Controls.md.78bd2acf.lean.js rename to assets/apidist_classes_Controls_copperControls.Controls.md.69a0f16d.lean.js index 8b15a73..9a3189b 100644 --- a/assets/apidist_classes_Controls_copperControls.Controls.md.78bd2acf.lean.js +++ b/assets/apidist_classes_Controls_copperControls.Controls.md.69a0f16d.lean.js @@ -1 +1 @@ -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}; +import{_ as e,o as t,c as o,Q as a}from"./chunks/framework.5916b37e.js";const m=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{m as __pageData,C as default}; diff --git a/assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.949cee0a.js b/assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.486455e2.js similarity index 89% rename from assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.949cee0a.js rename to assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.486455e2.js index 62d46c1..d045bd8 100644 --- a/assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.949cee0a.js +++ b/assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.486455e2.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,u,b){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 p=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:141

closeGui ​

▸ closeGui(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:133

getCubeMapTexture ​

▸ Private getCubeMapTexture(environment): Promise<unknown>

Parameters ​

NameType
environmentenvironmentType

Returns ​

Promise<unknown>

Defined in ​

src/Renderer/baseRenderer.ts:109

getCurrentScene ​

▸ getCurrentScene(): baseScene

Returns ​

baseScene

Defined in ​

src/Renderer/baseRenderer.ts:127

hideGui ​

▸ hideGui(): void

Returns ​

void

Defined in ​

src/Renderer/baseRenderer.ts:130

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

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

',143),i=[d];function o(s,l,h,c,u,b){return r(),a("div",null,i)}const R=e(n,[["render",o]]);export{p as __pageData,R as default}; diff --git a/assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.949cee0a.lean.js b/assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.486455e2.lean.js similarity index 75% rename from assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.949cee0a.lean.js rename to assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.486455e2.lean.js index 561fed2..ed593b7 100644 --- a/assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.949cee0a.lean.js +++ b/assets/apidist_classes_Renderer_baseRenderer.baseRenderer.md.486455e2.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,u,b){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 p=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{p as __pageData,R as default}; diff --git a/assets/apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.08ed100c.js b/assets/apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.57a3bf1b.js similarity index 92% rename from assets/apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.08ed100c.js rename to assets/apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.57a3bf1b.js index e63741a..05cedcc 100644 --- a/assets/apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.08ed100c.js +++ b/assets/apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.57a3bf1b.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,f){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.08ed100c.lean.js b/assets/apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.57a3bf1b.lean.js similarity index 88% rename from assets/apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.08ed100c.lean.js rename to assets/apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.57a3bf1b.lean.js index d545fae..0f02bbc 100644 --- a/assets/apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.08ed100c.lean.js +++ b/assets/apidist_classes_Renderer_copperMSceneRenderer.copperMSceneRenderer.md.57a3bf1b.lean.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("",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("",110),d=[o];function i(c,s,l,h,p,f){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_copperRenderer.copperRenderer.md.02b16073.js b/assets/apidist_classes_Renderer_copperRenderer.copperRenderer.md.6d1ea50b.js similarity index 90% rename from assets/apidist_classes_Renderer_copperRenderer.copperRenderer.md.02b16073.js rename to assets/apidist_classes_Renderer_copperRenderer.copperRenderer.md.6d1ea50b.js index 7d3216c..2de298b 100644 --- a/assets/apidist_classes_Renderer_copperRenderer.copperRenderer.md.02b16073.js +++ b/assets/apidist_classes_Renderer_copperRenderer.copperRenderer.md.6d1ea50b.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 u=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:141

addPreRenderCallbackFunction ​

▸ addPreRenderCallbackFunction(callbackFunction): void

Parameters ​

NameType
callbackFunctionFunction

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:60

animate ​

▸ animate(time?): void

Parameters ​

NameType
time?number

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:66

closeGui ​

▸ closeGui(): void

Returns ​

void

Inherited from ​

baseRenderer.closeGui

Defined in ​

src/Renderer/baseRenderer.ts:133

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

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

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

render ​

▸ render(): void

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:91

setClearColor ​

▸ setClearColor(clearColor?, alpha?): void

Parameters ​

NameTypeDefault value
clearColornumber0x000000
alphanumber0

Returns ​

void

Inherited from ​

baseRenderer.setClearColor

Defined in ​

src/Renderer/baseRenderer.ts:137

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

',244),o=[d];function i(s,l,h,c,p,f){return r(),a("div",null,o)}const R=e(t,[["render",i]]);export{u as __pageData,R as default}; diff --git a/assets/apidist_classes_Renderer_copperRenderer.copperRenderer.md.02b16073.lean.js b/assets/apidist_classes_Renderer_copperRenderer.copperRenderer.md.6d1ea50b.lean.js similarity index 63% rename from assets/apidist_classes_Renderer_copperRenderer.copperRenderer.md.02b16073.lean.js rename to assets/apidist_classes_Renderer_copperRenderer.copperRenderer.md.6d1ea50b.lean.js index a3027bc..dd59a9e 100644 --- a/assets/apidist_classes_Renderer_copperRenderer.copperRenderer.md.02b16073.lean.js +++ b/assets/apidist_classes_Renderer_copperRenderer.copperRenderer.md.6d1ea50b.lean.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("",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 u=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("",244),o=[d];function i(s,l,h,c,p,f){return r(),a("div",null,o)}const R=e(t,[["render",i]]);export{u as __pageData,R as default}; diff --git a/assets/apidist_classes_Scene_baseScene.baseScene.md.5530f63c.js b/assets/apidist_classes_Scene_baseScene.baseScene.md.61f061b6.js similarity index 94% rename from assets/apidist_classes_Scene_baseScene.baseScene.md.5530f63c.js rename to assets/apidist_classes_Scene_baseScene.baseScene.md.61f061b6.js index b1586c8..a050e87 100644 --- a/assets/apidist_classes_Scene_baseScene.baseScene.md.5530f63c.js +++ b/assets/apidist_classes_Scene_baseScene.baseScene.md.61f061b6.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),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}; diff --git a/assets/apidist_classes_Scene_baseScene.baseScene.md.5530f63c.lean.js b/assets/apidist_classes_Scene_baseScene.baseScene.md.61f061b6.lean.js similarity index 100% rename from assets/apidist_classes_Scene_baseScene.baseScene.md.5530f63c.lean.js rename to assets/apidist_classes_Scene_baseScene.baseScene.md.61f061b6.lean.js diff --git a/assets/apidist_classes_Scene_commonSceneMethod.commonScene.md.0b70d19e.js b/assets/apidist_classes_Scene_commonSceneMethod.commonScene.md.e77c1bce.js similarity index 93% rename from assets/apidist_classes_Scene_commonSceneMethod.commonScene.md.0b70d19e.js rename to assets/apidist_classes_Scene_commonSceneMethod.commonScene.md.e77c1bce.js index f2517f2..151ec2d 100644 --- a/assets/apidist_classes_Scene_commonSceneMethod.commonScene.md.0b70d19e.js +++ b/assets/apidist_classes_Scene_commonSceneMethod.commonScene.md.e77c1bce.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,u){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),d=[n];function c(i,l,s,h,m,u){return t(),a("div",null,d)}const f=e(r,[["render",c]]);export{p as __pageData,f as default}; diff --git a/assets/apidist_classes_Scene_commonSceneMethod.commonScene.md.0b70d19e.lean.js b/assets/apidist_classes_Scene_commonSceneMethod.commonScene.md.e77c1bce.lean.js similarity index 100% rename from assets/apidist_classes_Scene_commonSceneMethod.commonScene.md.0b70d19e.lean.js rename to assets/apidist_classes_Scene_commonSceneMethod.commonScene.md.e77c1bce.lean.js diff --git a/assets/apidist_classes_Scene_copperMScene.copperMScene.md.9ac994ac.js b/assets/apidist_classes_Scene_copperMScene.copperMScene.md.8b080c61.js similarity index 94% rename from assets/apidist_classes_Scene_copperMScene.copperMScene.md.9ac994ac.js rename to assets/apidist_classes_Scene_copperMScene.copperMScene.md.8b080c61.js index a4c91dd..e647a1c 100644 --- a/assets/apidist_classes_Scene_copperMScene.copperMScene.md.9ac994ac.js +++ b/assets/apidist_classes_Scene_copperMScene.copperMScene.md.8b080c61.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: 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}; +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.9ac994ac.lean.js b/assets/apidist_classes_Scene_copperMScene.copperMScene.md.8b080c61.lean.js similarity index 100% rename from assets/apidist_classes_Scene_copperMScene.copperMScene.md.9ac994ac.lean.js rename to assets/apidist_classes_Scene_copperMScene.copperMScene.md.8b080c61.lean.js diff --git a/assets/apidist_classes_Scene_copperScene.copperScene.md.8805daed.js b/assets/apidist_classes_Scene_copperScene.copperScene.md.826727ff.js similarity index 94% rename from assets/apidist_classes_Scene_copperScene.copperScene.md.8805daed.js rename to assets/apidist_classes_Scene_copperScene.copperScene.md.826727ff.js index 1b6464e..aaedba9 100644 --- a/assets/apidist_classes_Scene_copperScene.copperScene.md.8805daed.js +++ b/assets/apidist_classes_Scene_copperScene.copperScene.md.826727ff.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 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}; diff --git a/assets/apidist_classes_Scene_copperScene.copperScene.md.8805daed.lean.js b/assets/apidist_classes_Scene_copperScene.copperScene.md.826727ff.lean.js similarity index 100% rename from assets/apidist_classes_Scene_copperScene.copperScene.md.8805daed.lean.js rename to assets/apidist_classes_Scene_copperScene.copperScene.md.826727ff.lean.js diff --git a/assets/apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.a1a8f30f.js b/assets/apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.159ccf85.js similarity index 94% rename from assets/apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.a1a8f30f.js rename to assets/apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.159ccf85.js index 492f654..9d0b0e1 100644 --- a/assets/apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.a1a8f30f.js +++ b/assets/apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.159ccf85.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,p,b){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.a1a8f30f.lean.js b/assets/apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.159ccf85.lean.js similarity index 100% rename from assets/apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.a1a8f30f.lean.js rename to assets/apidist_classes_Scene_copperSceneOnDemond.copperSceneOnDemond.md.159ccf85.lean.js diff --git a/assets/apidist_classes_Utils_MeshNodeTool.Element.md.8b274bdc.js b/assets/apidist_classes_Utils_MeshNodeTool.Element.md.90a8b6f8.js similarity index 94% rename from assets/apidist_classes_Utils_MeshNodeTool.Element.md.8b274bdc.js rename to assets/apidist_classes_Utils_MeshNodeTool.Element.md.90a8b6f8.js index 8490001..6e25f23 100644 --- a/assets/apidist_classes_Utils_MeshNodeTool.Element.md.8b274bdc.js +++ b/assets/apidist_classes_Utils_MeshNodeTool.Element.md.90a8b6f8.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.8b274bdc.lean.js b/assets/apidist_classes_Utils_MeshNodeTool.Element.md.90a8b6f8.lean.js similarity index 100% rename from assets/apidist_classes_Utils_MeshNodeTool.Element.md.8b274bdc.lean.js rename to assets/apidist_classes_Utils_MeshNodeTool.Element.md.90a8b6f8.lean.js diff --git a/assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.b472aed6.js b/assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.2cefc028.js similarity index 95% rename from assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.b472aed6.js rename to assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.2cefc028.js index a18c523..c365e7e 100644 --- a/assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.b472aed6.js +++ b/assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.2cefc028.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,f){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,f,u){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.b472aed6.lean.js b/assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.2cefc028.lean.js similarity index 87% rename from assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.b472aed6.lean.js rename to assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.2cefc028.lean.js index 997f9e2..12db4e0 100644 --- a/assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.b472aed6.lean.js +++ b/assets/apidist_classes_Utils_MeshNodeTool.MeshNodeTool.md.2cefc028.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,f){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,f,u){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.ae44cd20.js b/assets/apidist_classes_Utils_MeshNodeTool.Node.md.cbca78ea.js similarity index 94% rename from assets/apidist_classes_Utils_MeshNodeTool.Node.md.ae44cd20.js rename to assets/apidist_classes_Utils_MeshNodeTool.Node.md.cbca78ea.js index 5cfd082..55c3e4b 100644 --- a/assets/apidist_classes_Utils_MeshNodeTool.Node.md.ae44cd20.js +++ b/assets/apidist_classes_Utils_MeshNodeTool.Node.md.cbca78ea.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.ae44cd20.lean.js b/assets/apidist_classes_Utils_MeshNodeTool.Node.md.cbca78ea.lean.js similarity index 100% rename from assets/apidist_classes_Utils_MeshNodeTool.Node.md.ae44cd20.lean.js rename to assets/apidist_classes_Utils_MeshNodeTool.Node.md.cbca78ea.lean.js diff --git a/assets/apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.423cb4fb.js b/assets/apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.8a335248.js similarity index 94% rename from assets/apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.423cb4fb.js rename to assets/apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.8a335248.js index 3aafd1e..1274bad 100644 --- a/assets/apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.423cb4fb.js +++ b/assets/apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.8a335248.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:155

Properties ​

baseCanvasesSize ​

• baseCanvasesSize: number = 1

Defined in ​

src/Utils/segmentation/CommToolsData.ts:15

cursorPage ​

• cursorPage: ICursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:81

gui_states ​

• gui_states: IGUIStates

Defined in ​

src/Utils/segmentation/CommToolsData.ts:102

nrrd_states ​

• nrrd_states: INrrdStates

Defined in ​

src/Utils/segmentation/CommToolsData.ts:16

protectedData ​

• protectedData: IProtected

Defined in ​

src/Utils/segmentation/CommToolsData.ts:154

Methods ​

clearPaint ​

▸ clearPaint(): void

Rewrite this {clearPaint} function under DrawToolCore

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:226

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:242

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

createEmptyPaintImage ​

▸ createEmptyPaintImage(dimensions, paintImages): void

Rewrite this {createEmptyPaintImage} function under NrrdTools

Parameters ​

NameType
dimensionsnumber[]
paintImagesIPaintImages

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:250

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

flipDisplayImageByAxis ​

▸ flipDisplayImageByAxis(): void

Rewrite this {flipDisplayImageByAxis} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:285

generateCanvases ​

▸ Private generateCanvases(): HTMLCanvasElement[]

Returns ​

HTMLCanvasElement[]

Defined in ​

src/Utils/segmentation/CommToolsData.ts:214

redrawDisplayCanvas ​

▸ redrawDisplayCanvas(): void

Rewrite this {redrawDisplayCanvas} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:339

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Rewrite this {resetLayerCanvas} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:323

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

resizePaintArea ​

▸ resizePaintArea(factor): void

Rewrite this {resizePaintArea} function under NrrdTools

Parameters ​

NameType
factornumber

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:261

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

setIsDrawFalse ​

▸ setIsDrawFalse(target): void

Rewrite this {setIsDrawFalse} function under NrrdTools

Parameters ​

NameType
targetnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:269

setSyncsliceNum ​

▸ setSyncsliceNum(): void

Rewrite this {setSyncsliceNum} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:331

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:234

updateOriginAndChangedWH ​

▸ updateOriginAndChangedWH(): void

Rewrite this {updateOriginAndChangedWH} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:277

',185),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}; +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:155

Properties ​

baseCanvasesSize ​

• baseCanvasesSize: number = 1

Defined in ​

src/Utils/segmentation/CommToolsData.ts:15

cursorPage ​

• cursorPage: ICursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:81

gui_states ​

• gui_states: IGUIStates

Defined in ​

src/Utils/segmentation/CommToolsData.ts:102

nrrd_states ​

• nrrd_states: INrrdStates

Defined in ​

src/Utils/segmentation/CommToolsData.ts:16

protectedData ​

• protectedData: IProtected

Defined in ​

src/Utils/segmentation/CommToolsData.ts:154

Methods ​

clearPaint ​

▸ clearPaint(): void

Rewrite this {clearPaint} function under DrawToolCore

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:226

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:242

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

createEmptyPaintImage ​

▸ createEmptyPaintImage(dimensions, paintImages): void

Rewrite this {createEmptyPaintImage} function under NrrdTools

Parameters ​

NameType
dimensionsnumber[]
paintImagesIPaintImages

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:250

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

flipDisplayImageByAxis ​

▸ flipDisplayImageByAxis(): void

Rewrite this {flipDisplayImageByAxis} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:285

generateCanvases ​

▸ Private generateCanvases(): HTMLCanvasElement[]

Returns ​

HTMLCanvasElement[]

Defined in ​

src/Utils/segmentation/CommToolsData.ts:214

redrawDisplayCanvas ​

▸ redrawDisplayCanvas(): void

Rewrite this {redrawDisplayCanvas} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:339

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Rewrite this {resetLayerCanvas} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:323

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

resizePaintArea ​

▸ resizePaintArea(factor): void

Rewrite this {resizePaintArea} function under NrrdTools

Parameters ​

NameType
factornumber

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:261

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

setIsDrawFalse ​

▸ setIsDrawFalse(target): void

Rewrite this {setIsDrawFalse} function under NrrdTools

Parameters ​

NameType
targetnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:269

setSyncsliceNum ​

▸ setSyncsliceNum(): void

Rewrite this {setSyncsliceNum} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:331

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:234

updateOriginAndChangedWH ​

▸ updateOriginAndChangedWH(): void

Rewrite this {updateOriginAndChangedWH} function under NrrdTools

Returns ​

void

Defined in ​

src/Utils/segmentation/CommToolsData.ts:277

',185),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.423cb4fb.lean.js b/assets/apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.8a335248.lean.js similarity index 100% rename from assets/apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.423cb4fb.lean.js rename to assets/apidist_classes_Utils_segmentation_CommToolsData.CommToolsData.md.8a335248.lean.js diff --git a/assets/apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.e73cba27.js b/assets/apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.eb6181d8.js similarity index 93% rename from assets/apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.e73cba27.js rename to assets/apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.eb6181d8.js index d3ea9a6..572786e 100644 --- a/assets/apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.e73cba27.js +++ b/assets/apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.eb6181d8.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: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}; +import{_ as e,o as a,c as t,Q as r}from"./chunks/framework.5916b37e.js";const f=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 m=e(o,[["render",d]]);export{f as __pageData,m as default}; diff --git a/assets/apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.e73cba27.lean.js b/assets/apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.eb6181d8.lean.js similarity index 70% rename from assets/apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.e73cba27.lean.js rename to assets/apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.eb6181d8.lean.js index 0149f7e..e9ef7da 100644 --- a/assets/apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.e73cba27.lean.js +++ b/assets/apidist_classes_Utils_segmentation_DragOperator.DragOperator.md.eb6181d8.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: 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("",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 f=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("",213),n=[i];function d(s,l,c,h,g,p){return a(),t("div",null,n)}const m=e(o,[["render",d]]);export{f as __pageData,m as default}; diff --git a/assets/apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.5c09077d.js b/assets/apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.69cb94c5.js similarity index 95% rename from assets/apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.5c09077d.js rename to assets/apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.69cb94c5.js index b54518c..b41fa52 100644 --- a/assets/apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.5c09077d.js +++ b/assets/apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.69cb94c5.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: 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:49

Properties ​

baseCanvasesSize ​

• baseCanvasesSize: number = 1

Inherited from ​

CommToolsData.baseCanvasesSize

Defined in ​

src/Utils/segmentation/CommToolsData.ts:15

container ​

• container: HTMLElement

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:16

contrastEventPrameters ​

• contrastEventPrameters: IContrastEvents

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:29

cursorPage ​

• cursorPage: ICursorPage

Inherited from ​

CommToolsData.cursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:81

drawingPrameters ​

• drawingPrameters: IDrawingEvents

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:18

eraserUrls ​

• eraserUrls: string[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:42

gui_states ​

• gui_states: IGUIStates

Inherited from ​

CommToolsData.gui_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:102

mainAreaContainer ​

• mainAreaContainer: HTMLDivElement

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:17

nrrd_states ​

• nrrd_states: INrrdStates

Inherited from ​

CommToolsData.nrrd_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:16

pencilUrls ​

• pencilUrls: string[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:43

protectedData ​

• protectedData: IProtected

Inherited from ​

CommToolsData.protectedData

Defined in ​

src/Utils/segmentation/CommToolsData.ts:154

start ​

• start: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:47

undoArray ​

• undoArray: IUndoType[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:44

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

clearPaint ​

▸ clearPaint(): void

Clear mask on current slice canvas

Returns ​

void

Overrides ​

CommToolsData.clearPaint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1466

clearSphereCanvas ​

▸ Private clearSphereCanvas(): (HTMLCanvasElement | CanvasRenderingContext2D)[]

Returns ​

(HTMLCanvasElement | CanvasRenderingContext2D)[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1278

clearSpherePrintStoreImages ​

▸ Private clearSpherePrintStoreImages(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:225

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.clearStoreImages

Defined in ​

src/Utils/segmentation/CommToolsData.ts:242

configContrastDragMode ​

▸ configContrastDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2076

configMouseSphereWheel ​

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

Returns ​

fn

▸ (e): void

Parameters ​
NameType
eWheelEvent
Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1203

configMouseZoomWheel ​

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

Returns ​

fn

▸ (e): void

Parameters ​
NameType
eWheelEvent
Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:963

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

createEmptyPaintImage ​

▸ createEmptyPaintImage(dimensions, paintImages): void

Rewrite this {createEmptyPaintImage} function under NrrdTools

Parameters ​

NameType
dimensionsnumber[]
paintImagesIPaintImages

Returns ​

void

Inherited from ​

CommToolsData.createEmptyPaintImage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:250

draw ​

▸ draw(opts?): void

Parameters ​

NameType
opts?IDrawOpts

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:143

drawCalSphereDown ​

▸ drawCalSphereDown(x, y, sliceIndex, cal_position): void

Parameters ​

NameType
xnumber
ynumber
sliceIndexnumber
cal_position"tumour" | "skin" | "nipple" | "ribcage"

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:152

drawCalSphereUp ​

▸ drawCalSphereUp(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:196

drawCalculatorSphere ​

▸ drawCalculatorSphere(radius): void

Parameters ​

NameType
radiusnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1225

drawCalculatorSphereOnEachViews ​

▸ drawCalculatorSphereOnEachViews(axis): void

Parameters ​

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

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1059

drawImageOnEmptyImage ​

▸ drawImageOnEmptyImage(canvas): void

Parameters ​

NameType
canvasHTMLCanvasElement

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1040

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

drawLinesOnLayer ​

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

Parameters ​

NameType
ctxCanvasRenderingContext2D
xnumber
ynumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:829

drawSphere ​

▸ drawSphere(mouseX, mouseY, radius): void

Parameters ​

NameType
mouseXnumber
mouseYnumber
radiusnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1256

drawSphereCore ​

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

Parameters ​

NameTypeDescription
ctxCanvasRenderingContext2Ddraw sphere canvas ctx
xnumberwidth must be match the origin size, size factor 1, ignore the size factor
ynumberheight must be match the origin size, size factor 1, ignore the size factor
radiusnumberradius must be match the origin size, size factor 1, ignore the size factor
colorstringsphere color

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1166

drawSphereOnEachViews ​

▸ Private drawSphereOnEachViews(decay, axis): void

Parameters ​

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

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1128

enableCrosshair ​

▸ Private enableCrosshair(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1019

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

findSliceInSharedPlace ​

▸ findSliceInSharedPlace(): ImageData[]

Returns ​

ImageData[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1971

flipDisplayImageByAxis ​

▸ flipDisplayImageByAxis(): void

Rewrite this {flipDisplayImageByAxis} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.flipDisplayImageByAxis

Defined in ​

src/Utils/segmentation/CommToolsData.ts:285

getCurrentUndo ​

▸ Private getCurrentUndo(): IUndoType[]

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

Returns ​

IUndoType[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1457

getRestLabel ​

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

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

Returns ​

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

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1447

getSpherePosition ​

▸ Private getSpherePosition(position, axis): Object

Sphere calculate distance functions*************************

Parameters ​

NameType
positionICommXYZ
axis"z" | "y" | "x"

Returns ​

Object

NameType
xany
yany
zany

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1052

initAllCanvas ​

▸ Private initAllCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:864

initDrawToolCore ​

▸ Private initDrawToolCore(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:58

paintOnCanvas ​

▸ Private paintOnCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:235

paintOnCanvasLayer ​

▸ Private paintOnCanvasLayer(x, y): void

Parameters ​

NameType
xnumber
ynumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:852

redrawDisplayCanvas ​

▸ redrawDisplayCanvas(): void

Rewrite this {redrawDisplayCanvas} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.redrawDisplayCanvas

Defined in ​

src/Utils/segmentation/CommToolsData.ts:339

removeContrastDragMode ​

▸ removeContrastDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2090

replaceArray ​

▸ replaceArray(mainArr, replaceArr): void

Parameters ​

NameType
mainArrnumber[] | Uint8ClampedArray
replaceArrnumber[] | Uint8ClampedArray

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1958

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

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

repraintCurrentContrastSlice ​

▸ repraintCurrentContrastSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2140

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Rewrite this {resetLayerCanvas} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.resetLayerCanvas

Defined in ​

src/Utils/segmentation/CommToolsData.ts:323

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

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

setCurrentLayer ​

▸ Private setCurrentLayer(): Object

Returns ​

Object

NameType
canvasHTMLCanvasElement
ctxCanvasRenderingContext2D

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:119

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

setEraserUrls ​

▸ setEraserUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:106

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

setPencilIconUrls ​

▸ setPencilIconUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:109

setSphereCanvasSize ​

▸ Private setSphereCanvasSize(axis?): void

Parameters ​

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

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1180

setSyncsliceNum ​

▸ setSyncsliceNum(): void

Rewrite this {setSyncsliceNum} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.setSyncsliceNum

Defined in ​

src/Utils/segmentation/CommToolsData.ts:331

setUpSphereOrigins ​

▸ Private setUpSphereOrigins(mouseX, mouseY, sliceIndex): void

Parameters ​

NameType
mouseXnumber
mouseYnumber
sliceIndexnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1404

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

sliceArrayH ​

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

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

Uint8ClampedArray[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1839

sliceArrayV ​

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

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

number[][]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1850

storeAllImages ​

▸ storeAllImages(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1596

storeEachLayerImage ​

▸ storeEachLayerImage(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1797

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

storeImageToLabel ​

▸ storeImageToLabel(index, canvas, paintedImages): ImageData

Parameters ​

NameType
indexnumber
canvasHTMLCanvasElement
paintedImagesIPaintImages

Returns ​

ImageData

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1777

storeSphereImages ​

▸ Private storeSphereImages(index, axis): void

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

Parameters ​

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

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1111

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Overrides ​

CommToolsData.undoLastPainting

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1485

updateOriginAndChangedWH ​

▸ updateOriginAndChangedWH(): void

Rewrite this {updateOriginAndChangedWH} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.updateOriginAndChangedWH

Defined in ​

src/Utils/segmentation/CommToolsData.ts:277

updateSlicesContrast ​

▸ updateSlicesContrast(value, flag): void

Parameters ​

NameType
valuenumber
flagstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2114

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

zoomActionAfterDrawSphere ​

▸ Private zoomActionAfterDrawSphere(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:218

',678),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: 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:49

Properties ​

baseCanvasesSize ​

• baseCanvasesSize: number = 1

Inherited from ​

CommToolsData.baseCanvasesSize

Defined in ​

src/Utils/segmentation/CommToolsData.ts:15

container ​

• container: HTMLElement

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:16

contrastEventPrameters ​

• contrastEventPrameters: IContrastEvents

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:29

cursorPage ​

• cursorPage: ICursorPage

Inherited from ​

CommToolsData.cursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:81

drawingPrameters ​

• drawingPrameters: IDrawingEvents

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:18

eraserUrls ​

• eraserUrls: string[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:42

gui_states ​

• gui_states: IGUIStates

Inherited from ​

CommToolsData.gui_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:102

mainAreaContainer ​

• mainAreaContainer: HTMLDivElement

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:17

nrrd_states ​

• nrrd_states: INrrdStates

Inherited from ​

CommToolsData.nrrd_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:16

pencilUrls ​

• pencilUrls: string[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:43

protectedData ​

• protectedData: IProtected

Inherited from ​

CommToolsData.protectedData

Defined in ​

src/Utils/segmentation/CommToolsData.ts:154

start ​

• start: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:47

undoArray ​

• undoArray: IUndoType[] = []

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:44

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

clearPaint ​

▸ clearPaint(): void

Clear mask on current slice canvas

Returns ​

void

Overrides ​

CommToolsData.clearPaint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1466

clearSphereCanvas ​

▸ Private clearSphereCanvas(): (HTMLCanvasElement | CanvasRenderingContext2D)[]

Returns ​

(HTMLCanvasElement | CanvasRenderingContext2D)[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1278

clearSpherePrintStoreImages ​

▸ Private clearSpherePrintStoreImages(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:225

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.clearStoreImages

Defined in ​

src/Utils/segmentation/CommToolsData.ts:242

configContrastDragMode ​

▸ configContrastDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2076

configMouseSphereWheel ​

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

Returns ​

fn

▸ (e): void

Parameters ​
NameType
eWheelEvent
Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1203

configMouseZoomWheel ​

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

Returns ​

fn

▸ (e): void

Parameters ​
NameType
eWheelEvent
Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:963

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

createEmptyPaintImage ​

▸ createEmptyPaintImage(dimensions, paintImages): void

Rewrite this {createEmptyPaintImage} function under NrrdTools

Parameters ​

NameType
dimensionsnumber[]
paintImagesIPaintImages

Returns ​

void

Inherited from ​

CommToolsData.createEmptyPaintImage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:250

draw ​

▸ draw(opts?): void

Parameters ​

NameType
opts?IDrawOpts

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:143

drawCalSphereDown ​

▸ drawCalSphereDown(x, y, sliceIndex, cal_position): void

Parameters ​

NameType
xnumber
ynumber
sliceIndexnumber
cal_position"tumour" | "skin" | "nipple" | "ribcage"

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:152

drawCalSphereUp ​

▸ drawCalSphereUp(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:196

drawCalculatorSphere ​

▸ drawCalculatorSphere(radius): void

Parameters ​

NameType
radiusnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1225

drawCalculatorSphereOnEachViews ​

▸ drawCalculatorSphereOnEachViews(axis): void

Parameters ​

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

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1059

drawImageOnEmptyImage ​

▸ drawImageOnEmptyImage(canvas): void

Parameters ​

NameType
canvasHTMLCanvasElement

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1040

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

drawLinesOnLayer ​

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

Parameters ​

NameType
ctxCanvasRenderingContext2D
xnumber
ynumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:829

drawSphere ​

▸ drawSphere(mouseX, mouseY, radius): void

Parameters ​

NameType
mouseXnumber
mouseYnumber
radiusnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1256

drawSphereCore ​

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

Parameters ​

NameTypeDescription
ctxCanvasRenderingContext2Ddraw sphere canvas ctx
xnumberwidth must be match the origin size, size factor 1, ignore the size factor
ynumberheight must be match the origin size, size factor 1, ignore the size factor
radiusnumberradius must be match the origin size, size factor 1, ignore the size factor
colorstringsphere color

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1166

drawSphereOnEachViews ​

▸ Private drawSphereOnEachViews(decay, axis): void

Parameters ​

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

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1128

enableCrosshair ​

▸ Private enableCrosshair(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1019

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

findSliceInSharedPlace ​

▸ findSliceInSharedPlace(): ImageData[]

Returns ​

ImageData[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1971

flipDisplayImageByAxis ​

▸ flipDisplayImageByAxis(): void

Rewrite this {flipDisplayImageByAxis} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.flipDisplayImageByAxis

Defined in ​

src/Utils/segmentation/CommToolsData.ts:285

getCurrentUndo ​

▸ Private getCurrentUndo(): IUndoType[]

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

Returns ​

IUndoType[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1457

getRestLabel ​

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

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

Returns ​

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

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1447

getSpherePosition ​

▸ Private getSpherePosition(position, axis): Object

Sphere calculate distance functions*************************

Parameters ​

NameType
positionICommXYZ
axis"z" | "y" | "x"

Returns ​

Object

NameType
xany
yany
zany

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1052

initAllCanvas ​

▸ Private initAllCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:864

initDrawToolCore ​

▸ Private initDrawToolCore(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:58

paintOnCanvas ​

▸ Private paintOnCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:235

paintOnCanvasLayer ​

▸ Private paintOnCanvasLayer(x, y): void

Parameters ​

NameType
xnumber
ynumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:852

redrawDisplayCanvas ​

▸ redrawDisplayCanvas(): void

Rewrite this {redrawDisplayCanvas} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.redrawDisplayCanvas

Defined in ​

src/Utils/segmentation/CommToolsData.ts:339

removeContrastDragMode ​

▸ removeContrastDragMode(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2090

replaceArray ​

▸ replaceArray(mainArr, replaceArr): void

Parameters ​

NameType
mainArrnumber[] | Uint8ClampedArray
replaceArrnumber[] | Uint8ClampedArray

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1958

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

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

repraintCurrentContrastSlice ​

▸ repraintCurrentContrastSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2140

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Rewrite this {resetLayerCanvas} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.resetLayerCanvas

Defined in ​

src/Utils/segmentation/CommToolsData.ts:323

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

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

setCurrentLayer ​

▸ Private setCurrentLayer(): Object

Returns ​

Object

NameType
canvasHTMLCanvasElement
ctxCanvasRenderingContext2D

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:119

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

setEraserUrls ​

▸ setEraserUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:106

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

setPencilIconUrls ​

▸ setPencilIconUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:109

setSphereCanvasSize ​

▸ Private setSphereCanvasSize(axis?): void

Parameters ​

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

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1180

setSyncsliceNum ​

▸ setSyncsliceNum(): void

Rewrite this {setSyncsliceNum} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.setSyncsliceNum

Defined in ​

src/Utils/segmentation/CommToolsData.ts:331

setUpSphereOrigins ​

▸ Private setUpSphereOrigins(mouseX, mouseY, sliceIndex): void

Parameters ​

NameType
mouseXnumber
mouseYnumber
sliceIndexnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1404

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

sliceArrayH ​

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

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

Uint8ClampedArray[]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1839

sliceArrayV ​

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

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

number[][]

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1850

storeAllImages ​

▸ storeAllImages(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1596

storeEachLayerImage ​

▸ storeEachLayerImage(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1797

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

storeImageToLabel ​

▸ storeImageToLabel(index, canvas, paintedImages): ImageData

Parameters ​

NameType
indexnumber
canvasHTMLCanvasElement
paintedImagesIPaintImages

Returns ​

ImageData

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1777

storeSphereImages ​

▸ Private storeSphereImages(index, axis): void

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

Parameters ​

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

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1111

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Overrides ​

CommToolsData.undoLastPainting

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1485

updateOriginAndChangedWH ​

▸ updateOriginAndChangedWH(): void

Rewrite this {updateOriginAndChangedWH} function under NrrdTools

Returns ​

void

Inherited from ​

CommToolsData.updateOriginAndChangedWH

Defined in ​

src/Utils/segmentation/CommToolsData.ts:277

updateSlicesContrast ​

▸ updateSlicesContrast(value, flag): void

Parameters ​

NameType
valuenumber
flagstring

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2114

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

zoomActionAfterDrawSphere ​

▸ Private zoomActionAfterDrawSphere(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:218

',678),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.5c09077d.lean.js b/assets/apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.69cb94c5.lean.js similarity index 100% rename from assets/apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.5c09077d.lean.js rename to assets/apidist_classes_Utils_segmentation_DrawToolCore.DrawToolCore.md.69cb94c5.lean.js diff --git a/assets/apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.02b66863.js b/assets/apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.fc10885a.js similarity index 94% rename from assets/apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.02b66863.js rename to assets/apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.fc10885a.js index 253d0a0..024d667 100644 --- a/assets/apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.02b66863.js +++ b/assets/apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.fc10885a.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:15

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

cursorPage ​

• cursorPage: ICursorPage

Inherited from ​

DrawToolCore.cursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:81

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

eraserUrls ​

• eraserUrls: string[] = []

Inherited from ​

DrawToolCore.eraserUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:42

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

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

nrrd_states ​

• nrrd_states: INrrdStates

Inherited from ​

DrawToolCore.nrrd_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:16

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

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

start ​

• start: () => void

Type declaration ​

▸ (): void

Returns ​

void

Inherited from ​

DrawToolCore.start

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:47

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

Methods ​

addSkip ​

▸ addSkip(index): void

Parameters ​

NameType
indexnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:606

afterLoadSlice ​

▸ Private afterLoadSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:841

appendLoadingbar ​

▸ appendLoadingbar(loadingbar): void

Parameters ​

NameType
loadingbarHTMLDivElement

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:900

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

clear ​

▸ clear(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:624

clearDictionary ​

▸ Private clearDictionary(dic): void

Parameters ​

NameType
dicISkipSlicesDictType

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1133

clearPaint ​

▸ clearPaint(): void

Clear mask on current slice canvas

Returns ​

void

Inherited from ​

DrawToolCore.clearPaint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1466

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Overrides ​

DrawToolCore.clearStoreImages

Defined in ​

src/Utils/segmentation/NrrdTools.ts:904

configContrastDragMode ​

▸ configContrastDragMode(): void

Returns ​

void

Inherited from ​

DrawToolCore.configContrastDragMode

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2076

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

createEmptyPaintImage ​

▸ createEmptyPaintImage(dimensions, paintImages): void

Rewrite this {createEmptyPaintImage} function under NrrdTools

Parameters ​

NameType
dimensionsnumber[]
paintImagesIPaintImages

Returns ​

void

Overrides ​

DrawToolCore.createEmptyPaintImage

Defined in ​

src/Utils/segmentation/NrrdTools.ts:407

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

drawCalSphereDown ​

▸ drawCalSphereDown(x, y, sliceIndex, cal_position): void

Parameters ​

NameType
xnumber
ynumber
sliceIndexnumber
cal_position"tumour" | "skin" | "nipple" | "ribcage"

Returns ​

void

Inherited from ​

DrawToolCore.drawCalSphereDown

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:152

drawCalSphereUp ​

▸ drawCalSphereUp(): void

Returns ​

void

Inherited from ​

DrawToolCore.drawCalSphereUp

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:196

drawCalculatorSphere ​

▸ drawCalculatorSphere(radius): void

Parameters ​

NameType
radiusnumber

Returns ​

void

Inherited from ​

DrawToolCore.drawCalculatorSphere

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1225

drawCalculatorSphereOnEachViews ​

▸ drawCalculatorSphereOnEachViews(axis): void

Parameters ​

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

Returns ​

void

Inherited from ​

DrawToolCore.drawCalculatorSphereOnEachViews

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1059

drawImageOnEmptyImage ​

▸ drawImageOnEmptyImage(canvas): void

Parameters ​

NameType
canvasHTMLCanvasElement

Returns ​

void

Inherited from ​

DrawToolCore.drawImageOnEmptyImage

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1040

drawSphere ​

▸ drawSphere(mouseX, mouseY, radius): void

Parameters ​

NameType
mouseXnumber
mouseYnumber
radiusnumber

Returns ​

void

Inherited from ​

DrawToolCore.drawSphere

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1256

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

findSliceInSharedPlace ​

▸ findSliceInSharedPlace(): ImageData[]

Returns ​

ImageData[]

Inherited from ​

DrawToolCore.findSliceInSharedPlace

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1971

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

getContainer ​

▸ getContainer(): HTMLElement

Returns ​

HTMLElement

Defined in ​

src/Utils/segmentation/NrrdTools.ts:693

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

getCurrentSlicesNumAndContrastNum ​

▸ getCurrentSlicesNumAndContrastNum(): Object

Returns ​

Object

NameType
contrastIndexnumber
currentIndexnumber

Defined in ​

src/Utils/segmentation/NrrdTools.ts:713

getDrawingCanvas ​

▸ getDrawingCanvas(): HTMLCanvasElement

Returns ​

HTMLCanvasElement

Defined in ​

src/Utils/segmentation/NrrdTools.ts:696

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

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

getNrrdToolsSettings ​

▸ getNrrdToolsSettings(): INrrdStates

Returns ​

INrrdStates

Defined in ​

src/Utils/segmentation/NrrdTools.ts:699

getRestLabel ​

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

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

Returns ​

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

Inherited from ​

DrawToolCore.getRestLabel

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1447

getSharedPlace ​

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

Parameters ​

NameType
lennumber
rationumber

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:363

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

loadDisplaySlicesArray ​

▸ Private loadDisplaySlicesArray(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:759

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

redrawMianPreOnDisplayCanvas ​

▸ redrawMianPreOnDisplayCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:957

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

removeContrastDragMode ​

▸ removeContrastDragMode(): void

Returns ​

void

Inherited from ​

DrawToolCore.removeContrastDragMode

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2090

removeSkip ​

▸ removeSkip(index): void

Parameters ​

NameType
indexnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:618

replaceArray ​

▸ replaceArray(mainArr, replaceArr): void

Parameters ​

NameType
mainArrnumber[] | Uint8ClampedArray
replaceArrnumber[] | Uint8ClampedArray

Returns ​

void

Inherited from ​

DrawToolCore.replaceArray

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1958

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

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

repraintCurrentContrastSlice ​

▸ repraintCurrentContrastSlice(): void

Returns ​

void

Inherited from ​

DrawToolCore.repraintCurrentContrastSlice

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2140

resetDisplaySlicesStatus ​

▸ Private resetDisplaySlicesStatus(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:786

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Clear masks on drawingCanvas layers.

Returns ​

void

Overrides ​

DrawToolCore.resetLayerCanvas

Defined in ​

src/Utils/segmentation/NrrdTools.ts:946

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

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

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

setCalculateDistanceSphere ​

▸ setCalculateDistanceSphere(x, y, sliceIndex, cal_position): void

Parameters ​

NameType
xnumber
ynumber
sliceIndexnumber
cal_position"tumour" | "skin" | "nipple" | "ribcage"

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:348

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

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

setEraserUrls ​

▸ setEraserUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Inherited from ​

DrawToolCore.setEraserUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:106

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

setMainAreaSize ​

▸ setMainAreaSize(factor): void

Parameters ​

NameType
factornumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:680

setMainPreSlice ​

▸ Private setMainPreSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:810

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

setPencilIconUrls ​

▸ setPencilIconUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Inherited from ​

DrawToolCore.setPencilIconUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:109

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

setSliceOrientation ​

▸ setSliceOrientation(axisTo): void

Switch all contrast slices' orientation

Parameters ​

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

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:452

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

setupConfigs ​

▸ Private setupConfigs(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:793

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

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

sliceArrayV ​

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

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

number[][]

Inherited from ​

DrawToolCore.sliceArrayV

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1850

storeAllImages ​

▸ storeAllImages(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Inherited from ​

DrawToolCore.storeAllImages

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1596

storeEachLayerImage ​

▸ storeEachLayerImage(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Inherited from ​

DrawToolCore.storeEachLayerImage

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1797

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

storeImageToLabel ​

▸ storeImageToLabel(index, canvas, paintedImages): ImageData

Parameters ​

NameType
indexnumber
canvasHTMLCanvasElement
paintedImagesIPaintImages

Returns ​

ImageData

Inherited from ​

DrawToolCore.storeImageToLabel

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1777

switchAllSlicesArrayData ​

▸ switchAllSlicesArrayData(allSlices): void

Parameters ​

NameType
allSlicesnrrdSliceType[]

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:780

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Inherited from ​

DrawToolCore.undoLastPainting

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1485

updateMaxIndex ​

▸ Private updateMaxIndex(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:861

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

updateSlicesContrast ​

▸ updateSlicesContrast(value, flag): void

Parameters ​

NameType
valuenumber
flagstring

Returns ​

void

Inherited from ​

DrawToolCore.updateSlicesContrast

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2114

',950),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:15

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

cursorPage ​

• cursorPage: ICursorPage

Inherited from ​

DrawToolCore.cursorPage

Defined in ​

src/Utils/segmentation/CommToolsData.ts:81

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

eraserUrls ​

• eraserUrls: string[] = []

Inherited from ​

DrawToolCore.eraserUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:42

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

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

nrrd_states ​

• nrrd_states: INrrdStates

Inherited from ​

DrawToolCore.nrrd_states

Defined in ​

src/Utils/segmentation/CommToolsData.ts:16

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

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

start ​

• start: () => void

Type declaration ​

▸ (): void

Returns ​

void

Inherited from ​

DrawToolCore.start

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:47

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

Methods ​

addSkip ​

▸ addSkip(index): void

Parameters ​

NameType
indexnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:606

afterLoadSlice ​

▸ Private afterLoadSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:841

appendLoadingbar ​

▸ appendLoadingbar(loadingbar): void

Parameters ​

NameType
loadingbarHTMLDivElement

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:900

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

clear ​

▸ clear(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:624

clearDictionary ​

▸ Private clearDictionary(dic): void

Parameters ​

NameType
dicISkipSlicesDictType

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:1133

clearPaint ​

▸ clearPaint(): void

Clear mask on current slice canvas

Returns ​

void

Inherited from ​

DrawToolCore.clearPaint

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1466

clearStoreImages ​

▸ clearStoreImages(): void

Rewrite this {clearStoreImages} function under NrrdTools

Returns ​

void

Overrides ​

DrawToolCore.clearStoreImages

Defined in ​

src/Utils/segmentation/NrrdTools.ts:904

configContrastDragMode ​

▸ configContrastDragMode(): void

Returns ​

void

Inherited from ​

DrawToolCore.configContrastDragMode

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2076

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

createEmptyPaintImage ​

▸ createEmptyPaintImage(dimensions, paintImages): void

Rewrite this {createEmptyPaintImage} function under NrrdTools

Parameters ​

NameType
dimensionsnumber[]
paintImagesIPaintImages

Returns ​

void

Overrides ​

DrawToolCore.createEmptyPaintImage

Defined in ​

src/Utils/segmentation/NrrdTools.ts:407

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

drawCalSphereDown ​

▸ drawCalSphereDown(x, y, sliceIndex, cal_position): void

Parameters ​

NameType
xnumber
ynumber
sliceIndexnumber
cal_position"tumour" | "skin" | "nipple" | "ribcage"

Returns ​

void

Inherited from ​

DrawToolCore.drawCalSphereDown

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:152

drawCalSphereUp ​

▸ drawCalSphereUp(): void

Returns ​

void

Inherited from ​

DrawToolCore.drawCalSphereUp

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:196

drawCalculatorSphere ​

▸ drawCalculatorSphere(radius): void

Parameters ​

NameType
radiusnumber

Returns ​

void

Inherited from ​

DrawToolCore.drawCalculatorSphere

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1225

drawCalculatorSphereOnEachViews ​

▸ drawCalculatorSphereOnEachViews(axis): void

Parameters ​

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

Returns ​

void

Inherited from ​

DrawToolCore.drawCalculatorSphereOnEachViews

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1059

drawImageOnEmptyImage ​

▸ drawImageOnEmptyImage(canvas): void

Parameters ​

NameType
canvasHTMLCanvasElement

Returns ​

void

Inherited from ​

DrawToolCore.drawImageOnEmptyImage

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1040

drawSphere ​

▸ drawSphere(mouseX, mouseY, radius): void

Parameters ​

NameType
mouseXnumber
mouseYnumber
radiusnumber

Returns ​

void

Inherited from ​

DrawToolCore.drawSphere

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1256

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

findSliceInSharedPlace ​

▸ findSliceInSharedPlace(): ImageData[]

Returns ​

ImageData[]

Inherited from ​

DrawToolCore.findSliceInSharedPlace

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1971

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

getContainer ​

▸ getContainer(): HTMLElement

Returns ​

HTMLElement

Defined in ​

src/Utils/segmentation/NrrdTools.ts:693

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

getCurrentSlicesNumAndContrastNum ​

▸ getCurrentSlicesNumAndContrastNum(): Object

Returns ​

Object

NameType
contrastIndexnumber
currentIndexnumber

Defined in ​

src/Utils/segmentation/NrrdTools.ts:713

getDrawingCanvas ​

▸ getDrawingCanvas(): HTMLCanvasElement

Returns ​

HTMLCanvasElement

Defined in ​

src/Utils/segmentation/NrrdTools.ts:696

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

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

getNrrdToolsSettings ​

▸ getNrrdToolsSettings(): INrrdStates

Returns ​

INrrdStates

Defined in ​

src/Utils/segmentation/NrrdTools.ts:699

getRestLabel ​

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

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

Returns ​

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

Inherited from ​

DrawToolCore.getRestLabel

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1447

getSharedPlace ​

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

Parameters ​

NameType
lennumber
rationumber

Returns ​

number[]

Defined in ​

src/Utils/segmentation/NrrdTools.ts:363

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

loadDisplaySlicesArray ​

▸ Private loadDisplaySlicesArray(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:759

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

redrawMianPreOnDisplayCanvas ​

▸ redrawMianPreOnDisplayCanvas(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:957

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

removeContrastDragMode ​

▸ removeContrastDragMode(): void

Returns ​

void

Inherited from ​

DrawToolCore.removeContrastDragMode

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2090

removeSkip ​

▸ removeSkip(index): void

Parameters ​

NameType
indexnumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:618

replaceArray ​

▸ replaceArray(mainArr, replaceArr): void

Parameters ​

NameType
mainArrnumber[] | Uint8ClampedArray
replaceArrnumber[] | Uint8ClampedArray

Returns ​

void

Inherited from ​

DrawToolCore.replaceArray

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1958

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

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

repraintCurrentContrastSlice ​

▸ repraintCurrentContrastSlice(): void

Returns ​

void

Inherited from ​

DrawToolCore.repraintCurrentContrastSlice

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2140

resetDisplaySlicesStatus ​

▸ Private resetDisplaySlicesStatus(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:786

resetLayerCanvas ​

▸ resetLayerCanvas(): void

Clear masks on drawingCanvas layers.

Returns ​

void

Overrides ​

DrawToolCore.resetLayerCanvas

Defined in ​

src/Utils/segmentation/NrrdTools.ts:946

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

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

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

setCalculateDistanceSphere ​

▸ setCalculateDistanceSphere(x, y, sliceIndex, cal_position): void

Parameters ​

NameType
xnumber
ynumber
sliceIndexnumber
cal_position"tumour" | "skin" | "nipple" | "ribcage"

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:348

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

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

setEraserUrls ​

▸ setEraserUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Inherited from ​

DrawToolCore.setEraserUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:106

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

setMainAreaSize ​

▸ setMainAreaSize(factor): void

Parameters ​

NameType
factornumber

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:680

setMainPreSlice ​

▸ Private setMainPreSlice(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:810

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

setPencilIconUrls ​

▸ setPencilIconUrls(urls): void

Parameters ​

NameType
urlsstring[]

Returns ​

void

Inherited from ​

DrawToolCore.setPencilIconUrls

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:109

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

setSliceOrientation ​

▸ setSliceOrientation(axisTo): void

Switch all contrast slices' orientation

Parameters ​

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

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:452

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

setupConfigs ​

▸ Private setupConfigs(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:793

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

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

sliceArrayV ​

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

Parameters ​

NameType
arrUint8ClampedArray
rownumber
colnumber

Returns ​

number[][]

Inherited from ​

DrawToolCore.sliceArrayV

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1850

storeAllImages ​

▸ storeAllImages(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Inherited from ​

DrawToolCore.storeAllImages

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1596

storeEachLayerImage ​

▸ storeEachLayerImage(index, label): void

Parameters ​

NameType
indexnumber
labelstring

Returns ​

void

Inherited from ​

DrawToolCore.storeEachLayerImage

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1797

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

storeImageToLabel ​

▸ storeImageToLabel(index, canvas, paintedImages): ImageData

Parameters ​

NameType
indexnumber
canvasHTMLCanvasElement
paintedImagesIPaintImages

Returns ​

ImageData

Inherited from ​

DrawToolCore.storeImageToLabel

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1777

switchAllSlicesArrayData ​

▸ switchAllSlicesArrayData(allSlices): void

Parameters ​

NameType
allSlicesnrrdSliceType[]

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:780

undoLastPainting ​

▸ undoLastPainting(): void

Rewrite this {undoLastPainting} function under DrawToolCore

Returns ​

void

Inherited from ​

DrawToolCore.undoLastPainting

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:1485

updateMaxIndex ​

▸ Private updateMaxIndex(): void

Returns ​

void

Defined in ​

src/Utils/segmentation/NrrdTools.ts:861

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

updateSlicesContrast ​

▸ updateSlicesContrast(value, flag): void

Parameters ​

NameType
valuenumber
flagstring

Returns ​

void

Inherited from ​

DrawToolCore.updateSlicesContrast

Defined in ​

src/Utils/segmentation/DrawToolCore.ts:2114

',950),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.02b66863.lean.js b/assets/apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.fc10885a.lean.js similarity index 100% rename from assets/apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.02b66863.lean.js rename to assets/apidist_classes_Utils_segmentation_NrrdTools.NrrdTools.md.fc10885a.lean.js diff --git a/assets/apidist_interfaces_Loader_copperNrrdLoader.optsType.md.7ab6b681.js b/assets/apidist_interfaces_Loader_copperNrrdLoader.optsType.md.0c190027.js similarity index 95% rename from assets/apidist_interfaces_Loader_copperNrrdLoader.optsType.md.7ab6b681.js rename to assets/apidist_interfaces_Loader_copperNrrdLoader.optsType.md.0c190027.js index 476879e..947fabb 100644 --- a/assets/apidist_interfaces_Loader_copperNrrdLoader.optsType.md.7ab6b681.js +++ b/assets/apidist_interfaces_Loader_copperNrrdLoader.optsType.md.0c190027.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.7ab6b681.lean.js b/assets/apidist_interfaces_Loader_copperNrrdLoader.optsType.md.0c190027.lean.js similarity index 100% rename from assets/apidist_interfaces_Loader_copperNrrdLoader.optsType.md.7ab6b681.lean.js rename to assets/apidist_interfaces_Loader_copperNrrdLoader.optsType.md.0c190027.lean.js diff --git a/assets/apidist_modules_Loader_copperNrrdLoader.md.efb47231.js b/assets/apidist_modules_Loader_copperNrrdLoader.md.8ad3704c.js similarity index 96% rename from assets/apidist_modules_Loader_copperNrrdLoader.md.efb47231.js rename to assets/apidist_modules_Loader_copperNrrdLoader.md.8ad3704c.js index 38a4c39..4854576 100644 --- a/assets/apidist_modules_Loader_copperNrrdLoader.md.efb47231.js +++ b/assets/apidist_modules_Loader_copperNrrdLoader.md.8ad3704c.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,f){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.efb47231.lean.js b/assets/apidist_modules_Loader_copperNrrdLoader.md.8ad3704c.lean.js similarity index 86% rename from assets/apidist_modules_Loader_copperNrrdLoader.md.efb47231.lean.js rename to assets/apidist_modules_Loader_copperNrrdLoader.md.8ad3704c.lean.js index 2f2a659..8573980 100644 --- a/assets/apidist_modules_Loader_copperNrrdLoader.md.efb47231.lean.js +++ b/assets/apidist_modules_Loader_copperNrrdLoader.md.8ad3704c.lean.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("",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("",43),l=[o];function c(n,i,s,h,p,f){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_Utils_segmentation_coreTools_gui.md.ced0118d.js b/assets/apidist_modules_Utils_segmentation_coreTools_gui.md.5a72133e.js similarity index 93% rename from assets/apidist_modules_Utils_segmentation_coreTools_gui.md.ced0118d.js rename to assets/apidist_modules_Utils_segmentation_coreTools_gui.md.5a72133e.js index 0c405dd..6539fc1 100644 --- a/assets/apidist_modules_Utils_segmentation_coreTools_gui.md.ced0118d.js +++ b/assets/apidist_modules_Utils_segmentation_coreTools_gui.md.5a72133e.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:532

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 g=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:532

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{g as __pageData,p as default}; diff --git a/assets/apidist_modules_Utils_segmentation_coreTools_gui.md.ced0118d.lean.js b/assets/apidist_modules_Utils_segmentation_coreTools_gui.md.5a72133e.lean.js similarity index 75% rename from assets/apidist_modules_Utils_segmentation_coreTools_gui.md.ced0118d.lean.js rename to assets/apidist_modules_Utils_segmentation_coreTools_gui.md.5a72133e.lean.js index c8c8069..beb7000 100644 --- a/assets/apidist_modules_Utils_segmentation_coreTools_gui.md.ced0118d.lean.js +++ b/assets/apidist_modules_Utils_segmentation_coreTools_gui.md.5a72133e.lean.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("",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 g=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("",23),n=[r];function s(l,d,c,u,h,m){return t(),a("div",null,n)}const p=e(i,[["render",s]]);export{g as __pageData,p as default}; diff --git a/assets/apidist_modules_Utils_utils.md.39292504.js b/assets/apidist_modules_Utils_utils.md.e5eb399b.js similarity index 95% rename from assets/apidist_modules_Utils_utils.md.39292504.js rename to assets/apidist_modules_Utils_utils.md.e5eb399b.js index 2dfa6de..8f3ea82 100644 --- a/assets/apidist_modules_Utils_utils.md.39292504.js +++ b/assets/apidist_modules_Utils_utils.md.e5eb399b.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.39292504.lean.js b/assets/apidist_modules_Utils_utils.md.e5eb399b.lean.js similarity index 100% rename from assets/apidist_modules_Utils_utils.md.39292504.lean.js rename to assets/apidist_modules_Utils_utils.md.e5eb399b.lean.js diff --git a/hashmap.json b/hashmap.json index 004c8df..7321d8d 100644 --- a/hashmap.json +++ b/hashmap.json @@ -1 +1 @@ -{"apidist_classes_controls_copper3dtrackballcontrols.copper3dtrackballcontrols.md":"797ee5d2","apidist_classes_controls_coppercontrols.cameraviewpoint.md":"715e5ff1","apidist_modules_controls_coppercontrols.md":"90df69a1","apidist_modules_renderer_baserenderer.md":"b28c03bf","apidist_modules_renderer_coppermscenerenderer.md":"49827154","apidist_modules_loader_coppernrrdloader.md":"efb47231","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_basescene.md":"6842adae","apidist_modules_scene_copperscene.md":"1a21b247","apidist_modules_scene_coppermscene.md":"9050160c","apidist_classes_scene_commonscenemethod.commonscene.md":"0b70d19e","apidist_modules_utils_meshnodetool.md":"b50ec67d","apidist_modules_scene_coppersceneondemond.md":"67889485","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":"ced0118d","apidist_modules_utils_segmentation_commtoolsdata.md":"e338e0a5","apidist_classes_scene_copperscene.copperscene.md":"8805daed","apidist_classes_renderer_baserenderer.baserenderer.md":"949cee0a","apidist_classes_utils_meshnodetool.element.md":"8b274bdc","apidist_classes_scene_coppersceneondemond.coppersceneondemond.md":"a1a8f30f","apidist_classes_controls_coppercontrols.controls.md":"78bd2acf","apidist_classes_utils_segmentation_dragoperator.dragoperator.md":"e73cba27","apidist_modules_controls_copper3dtrackballcontrols.md":"0dc9210f","apidist_classes_utils_meshnodetool.meshnodetool.md":"b472aed6","apidist_modules.md":"71341fd9","apidist_classes_renderer_coppermscenerenderer.coppermscenerenderer.md":"08ed100c","apidist_classes_renderer_copperrenderer.copperrenderer.md":"02b16073","apidist_modules_utils_utils.md":"39292504","apidist_interfaces_loader_coppernrrdloader.optstype.md":"7ab6b681","apidist_classes_utils_segmentation_commtoolsdata.commtoolsdata.md":"423cb4fb","apidist_classes_utils_segmentation_drawtoolcore.drawtoolcore.md":"5c09077d","index.md":"31081171","apidist_classes_scene_coppermscene.coppermscene.md":"9ac994ac","apidist_readme.md":"e26a5690","apidist_classes_utils_segmentation_nrrdtools.nrrdtools.md":"02b66863","apidist_classes_utils_meshnodetool.node.md":"ae44cd20","apidist_classes_scene_basescene.basescene.md":"5530f63c"} +{"apidist_classes_controls_coppercontrols.controls.md":"69a0f16d","apidist_classes_renderer_copperrenderer.copperrenderer.md":"6d1ea50b","apidist_classes_renderer_baserenderer.baserenderer.md":"486455e2","apidist_classes_utils_meshnodetool.meshnodetool.md":"2cefc028","apidist_classes_controls_copper3dtrackballcontrols.copper3dtrackballcontrols.md":"78f59b32","apidist_interfaces_loader_coppernrrdloader.optstype.md":"0c190027","apidist_modules.md":"71341fd9","apidist_modules_controls_copper3dtrackballcontrols.md":"0dc9210f","apidist_classes_scene_coppermscene.coppermscene.md":"8b080c61","apidist_modules_controls_coppercontrols.md":"90df69a1","apidist_modules_renderer_baserenderer.md":"b28c03bf","apidist_modules_renderer_coppermscenerenderer.md":"49827154","apidist_modules_loader_coppernrrdloader.md":"8ad3704c","apidist_modules_renderer_copperrenderer-2.md":"e2ff7d05","apidist_modules_scene_commonscenemethod.md":"03a638f1","apidist_modules_renderer_copperrenderer.md":"21951b1a","apidist_modules_scene_basescene.md":"6842adae","apidist_modules_scene_coppermscene.md":"9050160c","apidist_modules_utils_meshnodetool.md":"b50ec67d","apidist_modules_scene_copperscene.md":"1a21b247","apidist_modules_scene_coppersceneondemond.md":"67889485","apidist_modules_utils_segmentation_commtoolsdata.md":"e338e0a5","apidist_classes_scene_commonscenemethod.commonscene.md":"e77c1bce","apidist_classes_controls_coppercontrols.cameraviewpoint.md":"65077997","apidist_readme.md":"e26a5690","apidist_classes_scene_basescene.basescene.md":"61f061b6","index.md":"31081171","apidist_classes_utils_segmentation_dragoperator.dragoperator.md":"eb6181d8","apidist_modules_renderer_copperrenderer-1.md":"19044635","apidist_classes_utils_segmentation_commtoolsdata.commtoolsdata.md":"8a335248","apidist_modules_utils_segmentation_dragoperator.md":"ee72e1de","apidist_modules_utils_segmentation_drawtoolcore.md":"754ecf1b","apidist_modules_utils_segmentation_nrrdtools.md":"98dc8640","apidist_classes_utils_meshnodetool.element.md":"90a8b6f8","apidist_classes_renderer_coppermscenerenderer.coppermscenerenderer.md":"57a3bf1b","apidist_modules_renderer_copperrenderer-3.md":"4b216dba","apidist_classes_scene_copperscene.copperscene.md":"826727ff","apidist_modules_utils_utils.md":"e5eb399b","apidist_modules_utils_segmentation_coretools_gui.md":"5a72133e","apidist_classes_scene_coppersceneondemond.coppersceneondemond.md":"159ccf85","apidist_classes_utils_meshnodetool.node.md":"cbca78ea","apidist_classes_utils_segmentation_nrrdtools.nrrdtools.md":"fc10885a","apidist_classes_utils_segmentation_drawtoolcore.drawtoolcore.md":"69cb94c5"} diff --git a/index.html b/index.html index bb6b967..6ffbde0 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