Class InstantiateBlock

comments

evaluateContext

onBuildObservable

uniqueId

visibleOnFrame

buildExecutionTime

• get buildExecutionTime(): number

  Gets the time spent to build this block (in ms)

  Returns number

count

• get count(): NodeGeometryConnectionPoint

  Gets the count input component

  Returns NodeGeometryConnectionPoint

inputs

• get inputs(): NodeGeometryConnectionPoint[]

  Gets the list of input points

  Returns NodeGeometryConnectionPoint[]

instance

• get instance(): NodeGeometryConnectionPoint

  Gets the instance input component

  Returns NodeGeometryConnectionPoint

isDebug

• get isDebug(): boolean

  Gets a boolean indicating if this block is a debug block

  Returns boolean

isInput

• get isInput(): boolean

  Gets a boolean indicating if this block is an input

  Returns boolean

isTeleportIn

• get isTeleportIn(): boolean

  Gets a boolean indicating if this block is a teleport in

  Returns boolean

isTeleportOut

• get isTeleportOut(): boolean

  Gets a boolean indicating if this block is a teleport out

  Returns boolean

isUnique

• get isUnique(): boolean

  Gets a boolean indicating that this block can only be used once per NodeGeometry

  Returns boolean

name

• get name(): string

  Gets or set the name of the block

  Returns string

• set name(value: string): void

  Parameters

  • value: string

  Returns void

output

• get output(): NodeGeometryConnectionPoint

  Gets the geometry output component

  Returns NodeGeometryConnectionPoint

outputs

• get outputs(): NodeGeometryConnectionPoint[]

  Gets the list of output points

  Returns NodeGeometryConnectionPoint[]

autoConfigure

• autoConfigure(_nodeGeometry: NodeGeometry): void

  Lets the block try to connect some inputs automatically

  Parameters

  • _nodeGeometry: NodeGeometry

    defines the node geometry to use for auto connection

  Returns void

build

• build(state: NodeGeometryBuildState): boolean

  Build the current node and generate the vertex data

  Parameters

  • state: NodeGeometryBuildState

    defines the current generation state

  Returns boolean

  true if already built

clone

• clone(): NodeGeometryBlock | null

  Clone the current block to a new identical block

  Returns NodeGeometryBlock | null

  a copy of the current block

dispose

• dispose(): void

  Release resources

  Returns void

getDescendantOfPredicate

• getDescendantOfPredicate(
      predicate: (block: NodeGeometryBlock) => boolean,
  ): Nullable<NodeGeometryBlock>

  Get the first descendant using a predicate

  Parameters

  • predicate: (block: NodeGeometryBlock) => boolean

    defines the predicate to check

  Returns Nullable<NodeGeometryBlock>

  descendant or null if none found

getInputByName

• getInputByName(name: string): NodeGeometryConnectionPoint | null

  Find an input by its name

  Parameters

  • name: string

    defines the name of the input to look for

  Returns NodeGeometryConnectionPoint | null

  the input or null if not found

getOutputByName

• getOutputByName(name: string): NodeGeometryConnectionPoint | null

  Find an output by its name

  Parameters

  • name: string

    defines the name of the output to look for

  Returns NodeGeometryConnectionPoint | null

  the output or null if not found

initialize

• initialize(): void

  Initialize the block and prepare the context for build

  Returns void

isAnAncestorOf

• isAnAncestorOf(block: NodeGeometryBlock): boolean

  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

isAnAncestorOfType

• isAnAncestorOfType(type: string): boolean

  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

registerInput

• registerInput(
      name: string,
      type: NodeGeometryBlockConnectionPointTypes,
      isOptional?: boolean,
      value?: any,
      valueMin?: any,
      valueMax?: any,
  ): InstantiateBlock

  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

  • isOptional: boolean = false

    defines a boolean indicating that this input can be omitted

  • Optionalvalue: any

    value to return if there is no connection

  • OptionalvalueMin: any

    min value accepted for value

  • OptionalvalueMax: any

    max value accepted for value

  Returns InstantiateBlock

  the current block

registerOutput

• registerOutput(
      name: string,
      type: NodeGeometryBlockConnectionPointTypes,
      point?: NodeGeometryConnectionPoint,
  ): InstantiateBlock

  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

  • Optionalpoint: NodeGeometryConnectionPoint

    an already created connection point. If not provided, create a new one

  Returns InstantiateBlock

  the current block

serialize

• serialize(): any

  Serializes this block in a JSON representation

  Returns any

  the serialized block object