import Trajectory from 'ngl/src/trajectory/trajectory.js'

public interface | source

Trajectory

Direct Subclass:

FramesTrajectory, RemoteTrajectory, StructureTrajectory

Base class for trajectories, tying structures and coordinates together

Constructor Summary

Public Constructor
public	constructor(trajPath: String \| Frames, structure: Structure, params: TrajectoryParameters)

Member Summary

Public Members
public	atomCount
public	backboneIndices
public	boxCache
public	centerPbc
public	coords1
public	coords2
public get	currentFrame: Number Currently set frame of the trajectory
public	deltaTime
public	frameCache
public	frameCacheSize
public get	frameCount: Number Number of frames in the trajectory
public	inProgress
public	initialCoords
public	loadQueue
public	name
public	pathCache
public	player
public	removePbc
public	removePeriodicity
public	selection: Selection selection to restrict atoms used for superposition
public	selectionIndices
public	signals: TrajectorySignals Events emitted by the trajectory
public	structure
public	structureCoords
public	superpose
public	timeOffset
public	trajPath

Private Members
private	_currentFrame
private	_disposed
private	_frameCount

Method Summary

Public Methods
public	dispose(): undefined Dispose of the trajectory object
public	getFrameTime(i: Integer): Number Get time for frame
public	getPath(index: Integer, callback: Function): undefined Get path of atom abstract
public	hasFrame(i: Integer \| Integer[]): Boolean Check if a frame is available
public	loadFrame(i: Integer \| Integer[], callback: Function) Load frame index
public	setFrame(i: Integer, callback: Function) Set trajectory to a frame index
public	setFrameInterpolated(i: Integer, ip: Integer, ipp: Integer, ippp: Integer, t: Number, type: String, callback: Function) Interpolated and set trajectory to frame indices
public	setParameters()
public	setPlayer(player: TrajectoryPlayer) Set player for this trajectory
public	setSelection()
public	setStructure()

Private Methods
private	_doSuperpose()
private	_getIndices()
private	_init()
private	_interpolate()
private abstract	_loadFrame(i: Integer, callback: Function) Load frame index
private	_makeAtomIndices()
private	_makeSuperposeCoords()
private	_process()
private	_resetCache()
private	_saveInitialCoords()
private	_saveStructureCoords()
private	_setFrameCount()
private	_updateStructure()

Public Constructors

public constructor(trajPath: String | Frames, structure: Structure, params: TrajectoryParameters) source

Params:

Name	Type	Attribute	Description
trajPath	String \| Frames		trajectory source
structure	Structure		the structure object
params	TrajectoryParameters		trajectory parameters

Public Members

public atomCount source

public backboneIndices source

public boxCache source

public centerPbc source

public coords1 source

public coords2 source

public get currentFrame: Number source

Currently set frame of the trajectory

Return:

Number

frame

public deltaTime source

public frameCache source

public frameCacheSize source

public get frameCount: Number source

Number of frames in the trajectory

Return:

Number

count

public inProgress source

public initialCoords source

public loadQueue source

public name source

public pathCache source

public player source

public removePbc source

public removePeriodicity source

public selection: Selection source

selection to restrict atoms used for superposition

public selectionIndices source

public signals: TrajectorySignals source

Events emitted by the trajectory

public structure source

public structureCoords source

public superpose source

public timeOffset source

public trajPath source

Private Members

private _currentFrame source

private _disposed source

private _frameCount source

Public Methods

public dispose(): undefined source

Dispose of the trajectory object

Return:

undefined

public getFrameTime(i: Integer): Number source

Get time for frame

Params:

Name	Type	Attribute	Description
i	Integer		frame index

Return:

Number

time in picoseconds

public getPath(index: Integer, callback: Function): undefined source

Get path of atom abstract

Params:

Name	Type	Attribute	Description
index	Integer		atom index
callback	Function		fired when the path is available

Return:

undefined

public hasFrame(i: Integer | Integer[]): Boolean source

Check if a frame is available

Params:

Name	Type	Attribute	Description
i	Integer \| Integer[]		the frame index

Return:

Boolean

frame availability

public loadFrame(i: Integer | Integer[], callback: Function) source

Load frame index

Params:

Name	Type	Attribute	Description
i	Integer \| Integer[]		the frame index
callback	Function		fired when the frame has been loaded

public setFrame(i: Integer, callback: Function) source

Set trajectory to a frame index

Params:

Name	Type	Attribute	Description
i	Integer		the frame index
callback	Function		fired when the frame has been set

public setFrameInterpolated(i: Integer, ip: Integer, ipp: Integer, ippp: Integer, t: Number, type: String, callback: Function) source

Interpolated and set trajectory to frame indices

Params:

Name	Type	Attribute	Description
i	Integer		the frame index
ip	Integer		one before frame index
ipp	Integer		two before frame index
ippp	Integer		three before frame index
t	Number		interpolation step [0,1]
type	String		interpolation type, '', 'spline' or 'linear'
callback	Function		fired when the frame has been set

public setParameters() source

public setPlayer(player: TrajectoryPlayer) source

Set player for this trajectory

Params:

Name	Type	Attribute	Description
player	TrajectoryPlayer		the player

public setSelection() source

public setStructure() source

Private Methods

private _doSuperpose() source

private _getIndices() source

private _init() source

private _interpolate() source

private abstract _loadFrame(i: Integer, callback: Function) source

Load frame index

Params:

Name	Type	Attribute	Description
i	Integer		the frame index
callback	Function		fired when the frame has been loaded

Trajectory

Direct Subclass:

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor(trajPath: String | Frames, structure: Structure, params: TrajectoryParameters) source

Params:

Public Members

public atomCount source

public backboneIndices source

public boxCache source

public centerPbc source

public coords1 source

public coords2 source

public get currentFrame: Number source

Return:

public deltaTime source

public frameCache source

public frameCacheSize source

public get frameCount: Number source

Return:

public inProgress source

public initialCoords source

public loadQueue source

public name source

public pathCache source

public player source

public removePbc source

public removePeriodicity source

public selection: Selection source

public selectionIndices source

public signals: TrajectorySignals source

public structure source

public structureCoords source

public superpose source

public timeOffset source

public trajPath source

Private Members

private _currentFrame source

private _disposed source

private _frameCount source

Public Methods

public dispose(): undefined source

Return:

public getFrameTime(i: Integer): Number source

Params:

Return:

public getPath(index: Integer, callback: Function): undefined source

Params:

Return:

public hasFrame(i: Integer | Integer[]): Boolean source

Params:

Return:

public loadFrame(i: Integer | Integer[], callback: Function) source

Params:

public setFrame(i: Integer, callback: Function) source

Params:

public setFrameInterpolated(i: Integer, ip: Integer, ipp: Integer, ippp: Integer, t: Number, type: String, callback: Function) source

Params:

public setParameters() source

public setPlayer(player: TrajectoryPlayer) source

Params:

public setSelection() source

public setStructure() source

Private Methods

private _doSuperpose() source

private _getIndices() source

private _init() source

private _interpolate() source

private abstract _loadFrame(i: Integer, callback: Function) source

Params:

private _makeAtomIndices() source

private _makeSuperposeCoords() source

private _process() source

private _resetCache() source

private _saveInitialCoords() source

private _saveStructureCoords() source

private _setFrameCount() source

private _updateStructure() source