import VolumeComponent from 'ngl/src/component/volume-component.js'

public class | source

VolumeComponent

Extends:

Component → VolumeComponent

Component wrapping a Volume object

Example:

// get a volume component by loading a volume file into the stage
stage.loadFile( "url/for/volume" ).then( function( volumeComponent ){
    volumeComponent.addRepresentation( "surface" );
    volumeComponent.autoView();
} );

Constructor Summary

Public Constructor
public	constructor(stage: Stage, volume: Volume, params: ComponentParameters)

Member Summary

Public Members
public get	type: String Component type
public	volume

Method Summary

Public Methods
public	addRepresentation(type: String, params: VolumeRepresentationParameters): RepresentationComponent Add a new volume representation to the component
public	dispose()
public	getBoxUntransformed()
public	getCenterUntransformed()

Inherited Summary

From class Component
public get	type
public	annotationList
public	controls
public	matrix
public	name
public	position
public	quaternion
public	reprList
public	scale
public	signals: ComponentSignals Events emitted by the component
public	stage
public	status
public	transform
public	uuid
public	viewer
public	visible
public	addAnnotation(position: Vector3, content: String \| Element, params: Object): Annotation Add an anotation object
public	addBufferRepresentation()
public	addRepresentation(type: String, object: Object, params: RepresentationParameters): RepresentationComponent Add a new representation to the component
public	autoView(duration: Integer): undefined Automatically center and zoom the component
public	dispose()
public	eachAnnotation(callback: Function): undefined Iterator over each annotation and executing the callback
public	eachRepresentation(callback: Function): undefined Iterator over each representation and executing the callback
public	getBox(): Box3
public abstract	getBoxUntransformed(): Box3
public	getCenter(): Vector3
public	getCenterUntransformed()
public	getZoom()
public	hasRepresentation()
public	removeAllAnnotations(): undefined Remove all annotations from the component
public	removeAllRepresentations(): undefined Removes all representation components
public	removeAnnotation(annotation: Annotation): undefined Remove the give annotation from the component
public	removeRepresentation(repr: RepresentationComponent): undefined Removes a representation component
public	setName()
public	setPosition(p: Vector3 \| Array): Component Set position transform
public	setRotation(r: Quaternion \| Euler \| Array): Component Set rotation transform
public	setScale(s: Number): Component Set scale transform
public	setStatus()
public	setTransform(m: Matrix4): Component Set general transform.
public	setVisibility(value: Boolean): Component Set the visibility of the component, including added representations
public	updateMatrix()
public	updateRepresentations()

Public Constructors

public constructor(stage: Stage, volume: Volume, params: ComponentParameters) source

Override:

Component#constructor

Params:

Name	Type	Attribute	Description
stage	Stage		stage object the component belongs to
volume	Volume		volume object to wrap
params	ComponentParameters		component parameters

Public Members

public get type: String source

Component type

Override:

Component#type

public volume source

Public Methods

public addRepresentation(type: String, params: VolumeRepresentationParameters): RepresentationComponent source

Add a new volume representation to the component

Override:

Component#addRepresentation

Params:

Name	Type	Attribute	Description
type	String		the name of the representation, one of: surface, dot.
params	VolumeRepresentationParameters		representation parameters

Return:

RepresentationComponent

the created representation wrapped into a representation component object

public dispose() source

Override:

Component#dispose

public getBoxUntransformed() source

Override:

Component#getBoxUntransformed

public getCenterUntransformed() source

Override:

Component#getCenterUntransformed