import RepresentationComponent from 'ngl/src/component/representation-component.js'

public class | source

RepresentationComponent

Extends:

Component → RepresentationComponent

Component wrapping a Representation object

Constructor Summary

Public Constructor
public	constructor(stage: Stage, repr: Representation, params: RepresentationParameters, parent: Component) Create representation component

Member Summary

Public Members
public	parent
public	repr
public	signals: RepresentationComponentSignals Events emitted by the component
public get	type: String Component type
public	visible

Method Summary

Public Methods
public	build()
public	dispose()
public	disposeRepresentation()
public	getParameters(): RepresentationParameters Get representation parameters
public	getType()
public	getVisibility()
public	setColor(value: String \| Color \| Hex): RepresentationComponent Set color
public	setParameters(params: RepresentationParameters): RepresentationComponent Set representation parameters
public	setRepresentation()
public	setSelection(string: String): RepresentationComponent Set selection
public	setVisibility(value: Boolean): RepresentationComponent Set the visibility of the component, takes parent visibility into account
public	toggleVisibility(): RepresentationComponent Toggle visibility of the component, takes parent visibility into account
public	update(what: Object): RepresentationComponent Set selection
public	updateVisibility()

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, repr: Representation, params: RepresentationParameters, parent: Component) source

Create representation component

Override:

Component#constructor

Params:

Name	Type	Attribute	Description
stage	Stage		stage object the component belongs to
repr	Representation		representation object to wrap
params	RepresentationParameters	optional	component parameters
parent	Component	optional	parent component

Public Members

public parent source

public repr source

public signals: RepresentationComponentSignals source

Events emitted by the component

Override:

Component#signals

public get type: String source

Component type

Override:

Component#type

public visible source

Override:

Component#visible

Public Methods

public build() source

public dispose() source

Override:

Component#dispose

public disposeRepresentation() source

public getParameters(): RepresentationParameters source

Get representation parameters

Return:

RepresentationParameters

parameter object

public getType() source

public getVisibility() source

public setColor(value: String | Color | Hex): RepresentationComponent source

Set color

Params:

Name	Type	Attribute	Description
value	String \| Color \| Hex		color value

Return:

RepresentationComponent

this object

public setParameters(params: RepresentationParameters): RepresentationComponent source

Set representation parameters

Params:

Name	Type	Attribute	Description
params	RepresentationParameters		parameter object

Return:

RepresentationComponent

this object

public setRepresentation() source

public setSelection(string: String): RepresentationComponent source

Set selection

Params:

Name	Type	Attribute	Description
string	String		selection string

Return:

RepresentationComponent

this object

public setVisibility(value: Boolean): RepresentationComponent source

Set the visibility of the component, takes parent visibility into account

Override:

Component#setVisibility

Params:

Name	Type	Attribute	Description
value	Boolean		visibility flag

Return:

RepresentationComponent

this object

public toggleVisibility(): RepresentationComponent source

Toggle visibility of the component, takes parent visibility into account

Return:

RepresentationComponent

this object

public update(what: Object): RepresentationComponent source

Set selection

Params:

Name	Type	Attribute	Description
what	Object		flags indicating what attributes to update
what.position	Boolean		update position attribute
what.color	Boolean		update color attribute
what.radius	Boolean		update radius attribute

Return:

RepresentationComponent

this object

RepresentationComponent

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(stage: Stage, repr: Representation, params: RepresentationParameters, parent: Component) source

Override:

Params:

Public Members

public parent source

public repr source

public signals: RepresentationComponentSignals source

Override:

public get type: String source

Override:

public visible source

Override:

Public Methods

public build() source

public dispose() source

Override:

public disposeRepresentation() source

public getParameters(): RepresentationParameters source

Return:

public getType() source

public getVisibility() source

public setColor(value: String | Color | Hex): RepresentationComponent source

Params:

Return:

public setParameters(params: RepresentationParameters): RepresentationComponent source

Params:

Return:

public setRepresentation() source

public setSelection(string: String): RepresentationComponent source

Params:

Return:

public setVisibility(value: Boolean): RepresentationComponent source

Override:

Params:

Return:

public toggleVisibility(): RepresentationComponent source

Return:

public update(what: Object): RepresentationComponent source

Params:

Return:

public updateVisibility() source