Class PixelVolume

Represents a 3D region of pixels used for referencing pixel data.

Index

Constructors

Properties

_back _bottom _front _left _right _top

Accessors

back bottom front left right top

Methods

assign clone isEqual isEqual

Constructors

constructor

new PixelVolume(
    left?: number,
    top?: number,
    right?: number,
    bottom?: number,
    front?: number,
    back?: number,
): PixelVolume
Parameters
- Optionalleft: number
- Optionaltop: number
- Optionalright: number
- Optionalbottom: number
- Optionalfront: number
- Optionalback: number
Returns PixelVolume

Properties

`Protected`_back

_back: number

`Protected`_bottom

_bottom: number

`Protected`_front

_front: number

`Protected`_left

_left: number

`Protected`_right

_right: number

`Protected`_top

_top: number

Accessors

back

get back(): number

Returns number
set back(value: number): void
Parameters
- value: number
Returns void

bottom

get bottom(): number

Returns number
set bottom(value: number): void
Parameters
- value: number
Returns void

front

get front(): number

Returns number
set front(value: number): void
Parameters
- value: number
Returns void

left

get left(): number

Returns number
set left(value: number): void
Parameters
- value: number
Returns void

right

get right(): number

Returns number
set right(value: number): void
Parameters
- value: number
Returns void

top

get top(): number

Returns number
set top(value: number): void
Parameters
- value: number
Returns void

Methods

assign

assign(other: Immutable<PixelVolume>): PixelVolume
Copies all properties defined by the prototype of PixelVolume from other to this instance.
Parameters
- other: Immutable<PixelVolume>
Returns PixelVolume

clone

clone(): PixelVolume

Clones this instance and returns a new PixelVolume with identical values.

Returns PixelVolume

isEqual

isEqual(this: Immutable<PixelVolume>, other: Immutable<PixelVolume>): boolean
Determines if this PixelVolume instance is equal to the other instance.
Parameters
- this: Immutable<PixelVolume>
- other: Immutable<PixelVolume>
Returns boolean

`Static`isEqual

isEqual(lhs: Immutable<PixelVolume>, rhs: Immutable<PixelVolume>): boolean
Determines if both PixelVolume instances are equal.
Parameters
- lhs: Immutable<PixelVolume>
- rhs: Immutable<PixelVolume>
Returns boolean