Options
All
  • Public
  • Public/Protected
  • All
Menu

Defines a block that can be used inside a node based geometry

Hierarchy

Index

Constructors

  • Creates a new NodeGeometryBlock

    Parameters

    • name: string

      defines the block name

    Returns NodeGeometryBlock

Properties

comments: string

A free comment about the block

onBuildObservable: Observable<NodeGeometryBlock>

Gets an observable raised when the block is built

uniqueId: number

Gets or sets the unique id of the node

visibleOnFrame: boolean

Gets or sets a boolean indicating that this input can be edited from a collapsed frame

Accessors

  • get buildExecutionTime(): number
  • Gets the time spent to build this block (in ms)

    Returns number

  • get isDebug(): boolean
  • Gets a boolean indicating if this block is a debug block

    Returns boolean

  • get isInput(): boolean
  • Gets a boolean indicating if this block is an input

    Returns boolean

  • get isTeleportIn(): boolean
  • Gets a boolean indicating if this block is a teleport in

    Returns boolean

  • get isTeleportOut(): boolean
  • Gets a boolean indicating if this block is a teleport out

    Returns boolean

  • get isUnique(): boolean
  • Gets a boolean indicating that this block can only be used once per NodeGeometry

    Returns boolean

  • get name(): string
  • set name(value: string): void
  • Gets or set the name of the block

    Returns string

  • Gets or set the name of the block

    Parameters

    • value: string

    Returns void

Methods

  • autoConfigure(): void
  • Lets the block try to connect some inputs automatically

    Returns void

  • Build the current node and generate the vertex data

    Parameters

    Returns boolean

    true if already built

  • Clone the current block to a new identical block

    Returns null | NodeGeometryBlock

    a copy of the current block

  • dispose(): void
  • Release resources

    Returns void

  • getClassName(): string
  • Gets the current class name e.g. "NodeGeometryBlock"

    Returns string

    the class name

  • 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

  • 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

  • initialize(): void
  • Initialize the block and prepare the context for build

    Returns void

  • Checks if the current block is an ancestor of a given block

    Parameters

    Returns boolean

    true if block is a descendant

  • 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

  • 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 NodeGeometryBlock

    the current block

  • serialize(_saveMeshData?: boolean): any
  • Serializes this block in a JSON representation

    Parameters

    • Optional _saveMeshData: boolean

      defines a boolean indicating that mesh data must be saved as well

    Returns any

    the serialized block object

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Property
  • Method
  • Static method

Settings

Theme