Class InstantiateLinearBlock
Hierarchy
- InstantiateBaseBlock
- InstantiateLinearBlock
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Create a new Instantiate Linear Block
Parameters
name: string
defines the block name
Returns InstantiateLinearBlock
Properties
commentsSearch playground for comments
A free comment about the block
evaluate ContextSearch playground for evaluateContext
Gets or sets a boolean indicating that this block can evaluate context Build performance is improved when this value is set to false as the system will cache values instead of reevaluating everything per context change
on Build ObservableSearch playground for onBuildObservable
Gets an observable raised when the block is built
unique IdSearch playground for uniqueId
Gets or sets the unique id of the node
visible On FrameSearch playground for visibleOnFrame
Gets or sets a boolean indicating that this input can be edited from a collapsed frame
Accessors
build Execution Time
Gets the time spent to build this block (in ms)
Returns number
count
Gets the count input component
Returns NodeGeometryConnectionPoint
direction
Gets the direction input component
Returns NodeGeometryConnectionPoint
inputs
Gets the list of input points
Returns NodeGeometryConnectionPoint[]
instance
Gets the instance input component
Returns NodeGeometryConnectionPoint
is Debug
Gets a boolean indicating if this block is a debug block
Returns boolean
is Input
Gets a boolean indicating if this block is an input
Returns boolean
is Teleport In
Gets a boolean indicating if this block is a teleport in
Returns boolean
is Teleport Out
Gets a boolean indicating if this block is a teleport out
Returns boolean
is Unique
Gets a boolean indicating that this block can only be used once per NodeGeometry
Returns boolean
name
Gets or set the name of the block
Returns string
Gets or set the name of the block
Parameters
value: string
Returns void
output
Gets the geometry output component
Returns NodeGeometryConnectionPoint
outputs
Gets the list of output points
Returns NodeGeometryConnectionPoint[]
rotation
Gets the rotation input component
Returns NodeGeometryConnectionPoint
scaling
Gets the scaling input component
Returns NodeGeometryConnectionPoint
Methods
_deserializeSearch playground for _deserialize
Parameters
serializationObject: any
Returns void
auto ConfigureSearch playground for autoConfigure
Lets the block try to connect some inputs automatically
Returns void
buildSearch playground for build
Build the current node and generate the vertex data
Parameters
state: NodeGeometryBuildState
defines the current generation state
Returns boolean
true if already built
cloneSearch playground for clone
Clone the current block to a new identical block
Returns null | NodeGeometryBlock
a copy of the current block
disposeSearch playground for dispose
Release resources
Returns void
get Class NameSearch playground for getClassName
Gets the current class name
Returns string
the class name
get Descendant Of PredicateSearch playground for getDescendantOfPredicate
Get the first descendant using a predicate
Parameters
predicate: ((block: NodeGeometryBlock) => boolean)
defines the predicate to check
Parameters
block: NodeGeometryBlock
Returns boolean
Returns Nullable<NodeGeometryBlock>
descendant or null if none found
get Execution Face IndexSearch playground for getExecutionFaceIndex
Gets the current face index in the current flow
Returns number
the current face index
get Execution IndexSearch playground for getExecutionIndex
Gets the current index in the current flow
Returns number
the current index
get Execution Loop IndexSearch playground for getExecutionLoopIndex
Gets the current loop index in the current flow
Returns number
the current loop index
get Input By NameSearch playground for getInputByName
Find an input by its name
Parameters
name: string
defines the name of the input to look for
Returns null | NodeGeometryConnectionPoint
the input or null if not found
get Instance IndexSearch playground for getInstanceIndex
Gets the current instance index in the current flow
Returns number
the current index
get Output By NameSearch playground for getOutputByName
Find an output by its name
Parameters
name: string
defines the name of the output to look for
Returns null | NodeGeometryConnectionPoint
the output or null if not found
initializeSearch playground for initialize
Initialize the block and prepare the context for build
Returns void
is An Ancestor OfSearch playground for isAnAncestorOf
Checks if the current block is an ancestor of a given block
Parameters
block: NodeGeometryBlock
defines the potential descendant block to check
Returns boolean
true if block is a descendant
is An Ancestor Of TypeSearch playground for isAnAncestorOfType
Checks if the current block is an ancestor of a given type
Parameters
type: string
defines the potential type to check
Returns boolean
true if block is a descendant
register InputSearch playground for registerInput
Register a new input. Must be called inside a block constructor
Parameters
name: string
defines the connection point name
type: NodeGeometryBlockConnectionPointTypes
defines the connection point type
Optional isOptional: boolean
defines a boolean indicating that this input can be omitted
Optional value: any
value to return if there is no connection
Optional valueMin: any
min value accepted for value
Optional valueMax: any
max value accepted for value
Returns InstantiateLinearBlock
the current block
register OutputSearch playground for registerOutput
Register a new output. Must be called inside a block constructor
Parameters
name: string
defines the connection point name
type: NodeGeometryBlockConnectionPointTypes
defines the connection point type
Optional point: NodeGeometryConnectionPoint
an already created connection point. If not provided, create a new one
Returns InstantiateLinearBlock
the current block
serializeSearch playground for serialize
Serializes this block in a JSON representation
Returns any
the serialized block object
Block used to clone geometry along a line