Home Reference Source
public class | source

TransitionNode

Extends:

GraphNodeProcessingNodeEffectNode → TransitionNode

Constructor Summary

Public Constructor
public

Initialise an instance of a TransitionNode.

Member Summary

Public Members
public
Private Members
private
private
private

Method Summary

Public Methods
public

clearTransition(propertyName: String, time: number): Boolean

Clear a transistion on the passed property that the specified time lies within.

public

clearTransitions(propertyName: String)

Clear all transistions on the passed property.

public

transition(startTime: number, endTime: number, currentValue: number, targetValue: number, propertyName: String): Boolean

Create a transition on the timeline.

public

transitionAt(startTime: number, endTime: number, currentValue: number, targetValue: number, propertyName: String): Boolean

Create a transition on the timeline at an absolute time.

Private Methods
private
private
private

_update(currentTime: *)

Inherited Summary

From class GraphNode
public get

Get whether the node has been destroyed or not.

public get

displayName: *: *

Get a string representation of the class name.

public get

Get the names of the inputs to this node.

public get

Get an array of all the nodes which connect to this node.

public get

The maximum number of connections that can be made to this node.

public get

Get an array of all the nodes which this node outputs to.

private
private
private

_gl: *

private
private
private
private
public

connect(targetNode: GraphNode, targetPort: number | String): *

Connect this node to the targetNode

public

Destory this node, removing it from the graph.

public

disconnect(targetNode: GraphNode): *

Disconnect this node from the targetNode.

From class ProcessingNode
private
private
private
private
private
private
private
private
private
private
private
private
private
private
private
private
public

Destroy and clean-up the node.

public

getProperty(name: string): *

Sets the passed processing node property to the passed value.

public

setProperty(name: string, value: Object)

Sets the passed processing node property to the passed value.

private
private

_seek(currentTime: *)

private

_update(currentTime: *)

From class EffectNode
private
private
private

Public Constructors

public constructor() source

Initialise an instance of a TransitionNode. You should not instantiate this directly, but use VideoContest.createTransitonNode().

Override:

EffectNode#constructor

Public Members

public [propertyName]: * source

Private Members

private _displayName: string source

Override:

EffectNode#_displayName

private _initialPropertyValues: {} source

private _transitions: {} source

Public Methods

public clearTransition(propertyName: String, time: number): Boolean source

Clear a transistion on the passed property that the specified time lies within.

Params:

NameTypeAttributeDescription
propertyName String

The name of the property to clear a transition on.

time number

A time which lies within the property you're trying to clear.

Return:

Boolean

returns True if a transition is removed, false otherwise.

public clearTransitions(propertyName: String) source

Clear all transistions on the passed property. If no property is defined clear all transitions on the node.

Params:

NameTypeAttributeDescription
propertyName String

The name of the property to clear transitions on, if undefined clear all transitions on the node.

public transition(startTime: number, endTime: number, currentValue: number, targetValue: number, propertyName: String): Boolean source

Create a transition on the timeline.

Params:

NameTypeAttributeDescription
startTime number

The time at which the transition should start (relative to currentTime of video context).

endTime number

The time at which the transition should be completed by (relative to currentTime of video context).

currentValue number

The value to start the transition at.

targetValue number

The value to transition to by endTime.

propertyName String

The name of the property to clear transitions on, if undefined default to "mix".

Return:

Boolean

returns True if a transition is successfully added, false otherwise.

public transitionAt(startTime: number, endTime: number, currentValue: number, targetValue: number, propertyName: String): Boolean source

Create a transition on the timeline at an absolute time.

Params:

NameTypeAttributeDescription
startTime number

The time at which the transition should start (relative to time 0).

endTime number

The time at which the transition should be completed by (relative to time 0).

currentValue number

The value to start the transition at.

targetValue number

The value to transition to by endTime.

propertyName String

The name of the property to clear transitions on, if undefined default to "mix".

Return:

Boolean

returns True if a transition is successfully added, false otherwise.

Private Methods

private _doesTransitionFitOnTimeline(testTransition: *): boolean source

Params:

NameTypeAttributeDescription
testTransition *

Return:

boolean

private _insertTransitionInTimeline(transition: *) source

Params:

NameTypeAttributeDescription
transition *

private _update(currentTime: *) source

Override:

ProcessingNode#_update

Params:

NameTypeAttributeDescription
currentTime *