Class FlowGraphPlayAnimationBlockExperimental
Hierarchy
- FlowGraphAsyncExecutionBlock
- FlowGraphPlayAnimationBlock
Constructors
constructor
-
new FlowGraphPlayAnimationBlock(
config?: IFlowGraphPlayAnimationBlockConfiguration,
): FlowGraphPlayAnimationBlockExperimentalParameters
Optionalconfig: IFlowGraphPlayAnimationBlockConfigurationthe configuration of the block
Returns FlowGraphPlayAnimationBlock
Properties
Readonly Experimentalanimation
Input: If provided this animation will be used. Priority will be given to the animation group input.
Readonly Experimentalanimation
Input: Will be initialized if no animation group was provided in the configuration.
Optional Experimentalconfig
the configuration of the block
Readonly Experimentalcurrent
Output connection: The animatable that is currently running.
Readonly Experimentalcurrent
Output connection: The current frame of the animation.
Readonly Experimentalcurrent
Output connection: The current time of the animation.
Experimentaldata
The data inputs of the block.
Experimentaldata
The data outputs of the block.
Experimentaldone
Output connection: The signal that is triggered when the asynchronous execution of this block is done.
Readonly Experimentalerror
An output connection that can be used to signal an error, if the block defines it.
Readonly Experimentalfrom
Input connection: The starting frame of the animation.
Readonly Experimentalin
Input connection: The input signal of the block.
Readonly Experimentalloop
Input connection: Should the animation loop? Not in glTF specs, but useful for the engine.
Experimentalmetadata
Metadata that can be used by the block.
Experimentalname
The name of the block.
Readonly Experimentalobject
Input connection: The target object that will be animated. If animation group is provided this input will be ignored.
Readonly Experimentalout
Output connection: The signal that is synchronous triggered when the execution of this block is done.
Note that is case of events or async you might want to use the done signal instead.
Readonly Experimentalpriority
The priority of the block. Higher priority blocks will be executed first. Note that priority cannot be change AFTER the block was added as sorting happens when the block is added to the execution queue.
Experimentalsignal
Input connections that activate the block.
Experimentalsignal
Output connections that can activate downstream blocks.
Readonly Experimentalspeed
Input connection: The speed of the animation.
Readonly Experimentalto
Input connection: The ending frame of the animation.
Experimentalunique
A randomly generated GUID for each block.
Methods
_
deserialize
-
ExperimentalDeserializes from an object
Parameters
- serializationObject: any
the object to deserialize from
Returns void
- serializationObject: any
get
-
ExperimentalReturns string
class name of the block.
get
-
ExperimentalGiven the name of a data input, returns the connection if it exists
Parameters
- name: string
the name of the input
Returns FlowGraphDataConnection<any> | undefined
the connection if it exists, undefined otherwise
- name: string
get
-
ExperimentalGiven the name of a data output, returns the connection if it exists
Parameters
- name: string
the name of the output
Returns FlowGraphDataConnection<any> | undefined
the connection if it exists, undefined otherwise
- name: string
get
-
ExperimentalGiven a name of a signal input, return that input if it exists
Parameters
- name: string
the name of the input
Returns FlowGraphSignalConnection | undefined
if the input exists, the input. Otherwise, undefined.
- name: string
get
-
ExperimentalGiven a name of a signal output, return that input if it exists
Parameters
- name: string
the name of the input
Returns FlowGraphSignalConnection | undefined
if the input exists, the input. Otherwise, undefined.
- name: string
register
-
registerDataInput<T>(
name: string,
richType: RichType<T>,
defaultValue?: T,
): FlowGraphDataConnection<T>ExperimentalRegisters a data input on the block.
Type Parameters
- T
Parameters
Returns FlowGraphDataConnection<T>
the created connection
register
-
registerDataOutput<T>(
name: string,
richType: RichType<T>,
defaultValue?: T,
): FlowGraphDataConnection<T>ExperimentalRegisters a data output on the block.
Type Parameters
- T
Parameters
Returns FlowGraphDataConnection<T>
the created connection
serialize
-
ExperimentalSerializes this block
Parameters
- serializationObject: any = {}
the object to serialize in
Returns void
- serializationObject: any = {}
A block that plays an animation on an animatable object.