Skip to content

copper3d / Modules / Loader/volumeBoundingBox

Module: Loader/volumeBoundingBox

Table of contents

Interfaces

Variables

Functions

Variables

VOLUME_BOUNDS_NAME

Const VOLUME_BOUNDS_NAME: "volume-bounds"

Defined in

src/Loader/volumeBoundingBox.ts:39

Functions

addVolumeBoundingBox

addVolumeBoundingBox(scene, rasDimensions, opts?): THREE.BoxHelper | undefined

Adds the box and returns it, so the caller can hide, move or dispose it. Returns undefined for a degenerate volume -- a zero extent on any axis would produce a flat or empty helper rather than a box.

Parameters

NameTypeDescription
sceneBoundingBoxHost-
rasDimensionsArrayLike<number>the volume's RASDimensions, i.e. its extent in world units along x, y and z
opts?VolumeBoundingBoxOpts-

Returns

THREE.BoxHelper | undefined

Defined in

src/Loader/volumeBoundingBox.ts:49