Class FlowGraphMeshIntersectionEventBlockExperimental
Hierarchy (View Summary)
- FlowGraphEventBlock
- FlowGraphMeshIntersectionEventBlock
Constructors
constructor
-
new FlowGraphMeshIntersectionEventBlock(
config?: IFlowGraphBlockConfiguration,
): FlowGraphMeshIntersectionEventBlockExperimentalConstructs a new FlowGraphMeshIntersectionEventBlock.
Parameters
Optionalconfig: IFlowGraphBlockConfigurationoptional configuration for the block
Returns FlowGraphMeshIntersectionEventBlock
Properties
Optional Experimentalconfig
the configuration of the block
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 Experimentalin
Input connection: The input signal of the block.
Experimentalinit
the priority of initialization of this block. For example, scene start should have a negative priority because it should be initialized last.
Readonly Experimentalis
Output connection: True if the last transition was an enter, false if it was an exit.
Experimentalmetadata
Metadata that can be used by the block.
Experimentalname
The name of the block.
Readonly Experimentalon
Output signal: Fires when a target mesh starts intersecting the source mesh.
Readonly Experimentalon
Output signal: Fires when a target mesh stops intersecting the source mesh.
Readonly Experimentalother
Output connection: The target mesh that started or stopped intersecting the source mesh.
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 Experimentalsource
Input connection: The mesh to check for intersections.
Readonly Experimentaltarget
Input connection: The mesh, or array of meshes, checked against the source mesh.
Readonly Experimentaltype
The type of the event
Experimentalunique
A randomly generated GUID for each block.
Readonly Experimentaluse
Input connection: Whether to use the oriented bounding boxes instead of the axis-aligned ones. Defaults to false.
Accessors
event
-
get eventKey(): string
ExperimentalReturns string
the mesh intersection event key
Methods
_
deserialize
-
ExperimentalDeserializes from an object. Filters out the legacy "in" signal input that existed before event blocks stopped exposing it, so old serialized graphs load without error.
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 = {}
An event block that fires when a source mesh starts or stops intersecting one of a list of target meshes. The intersection is checked before each frame using the meshes' bounding volumes, so no physics engine is required. The
onEntersignal fires when a target starts intersecting the source andonExitfires when it stops. Theoutanddonesignals fire on both transitions; useisIntersectingto tell them apart. Disabled or disposed meshes are treated as not intersecting.