Class NodeRenderGraphConnectionPoint

constructor

• new NodeRenderGraphConnectionPoint(
      name: string,
      ownerBlock: NodeRenderGraphBlock,
      direction: NodeRenderGraphConnectionPointDirection,
  ): NodeRenderGraphConnectionPoint

  Creates a new connection point

  Parameters

  • name: string

    defines the connection point name

  • ownerBlock: NodeRenderGraphBlock

    defines the block hosting this connection point

  • direction: NodeRenderGraphConnectionPointDirection

    defines the direction of the connection point

  Returns NodeRenderGraphConnectionPoint

acceptedConnectionPointTypes

displayName

excludedConnectionPointTypes

exposedPortPosition

isExposedOnFrame

isOptional

name

needDualDirectionValidation

onConnectionObservable

onDisconnectionObservable

value

connectedBlocks

• get connectedBlocks(): NodeRenderGraphBlock[]

  Get the block connected on the endpoints of this connection (if any)

  Returns NodeRenderGraphBlock[]

connectedPoint

• get connectedPoint(): Nullable<NodeRenderGraphConnectionPoint>

  Get the other side of the connection (if any)

  Returns Nullable<NodeRenderGraphConnectionPoint>

direction

• get direction(): NodeRenderGraphConnectionPointDirection

  Gets the direction of the point

  Returns NodeRenderGraphConnectionPointDirection

endpoints

• get endpoints(): NodeRenderGraphConnectionPoint[]

  Gets the list of connected endpoints

  Returns NodeRenderGraphConnectionPoint[]

hasEndpoints

• get hasEndpoints(): boolean

  Gets a boolean indicating if that output point is connected to at least one input

  Returns boolean

innerType

• get innerType(): NodeRenderGraphBlockConnectionPointTypes

  Get the inner type (ie AutoDetect for instance instead of the inferred one)

  Returns NodeRenderGraphBlockConnectionPointTypes

isConnected

• get isConnected(): boolean

  Gets a boolean indicating that the current point is connected to another NodeRenderGraphBlock

  Returns boolean

ownerBlock

• get ownerBlock(): NodeRenderGraphBlock

  Get the block that owns this connection point

  Returns NodeRenderGraphBlock

sourceBlock

• get sourceBlock(): Nullable<NodeRenderGraphBlock>

  Get the block connected on the other side of this connection (if any)

  Returns Nullable<NodeRenderGraphBlock>

type

• get type(): NodeRenderGraphBlockConnectionPointTypes

  Gets or sets the connection point type (default is Undefined)

  Returns NodeRenderGraphBlockConnectionPointTypes

• set type(value: NodeRenderGraphBlockConnectionPointTypes): void

  Parameters

  • value: NodeRenderGraphBlockConnectionPointTypes

  Returns void

addAcceptedConnectionPointTypes

• addAcceptedConnectionPointTypes(mask: number): void

  Adds accepted connection point types

  Parameters

  • mask: number

    Types (ORed values of NodeRenderGraphBlockConnectionPointTypes) that are allowed to connect to this point

  Returns void

addExcludedConnectionPointFromAllowedTypes

• addExcludedConnectionPointFromAllowedTypes(mask: number): void

  Fills the list of excluded connection point types with all types other than those passed in the parameter

  Parameters

  • mask: number

    Types (ORed values of NodeRenderGraphBlockConnectionPointTypes) that are allowed, and thus will not be pushed to the excluded list

  Returns void

canConnectTo

• canConnectTo(connectionPoint: NodeRenderGraphConnectionPoint): boolean

  Gets a boolean indicating if the current point can be connected to another point

  Parameters

  • connectionPoint: NodeRenderGraphConnectionPoint

    defines the other connection point

  Returns boolean

  a boolean

checkCompatibilityState

• checkCompatibilityState(
      connectionPoint: NodeRenderGraphConnectionPoint,
  ): NodeRenderGraphConnectionPointCompatibilityStates

  Gets a number indicating if the current point can be connected to another point

  Parameters

  • connectionPoint: NodeRenderGraphConnectionPoint

    defines the other connection point

  Returns NodeRenderGraphConnectionPointCompatibilityStates

  a number defining the compatibility state

connectTo

• connectTo(
      connectionPoint: NodeRenderGraphConnectionPoint,
      ignoreConstraints?: boolean,
  ): NodeRenderGraphConnectionPoint

  Connect this point to another connection point

  Parameters

  • connectionPoint: NodeRenderGraphConnectionPoint

    defines the other connection point

  • ignoreConstraints: boolean = false

    defines if the system will ignore connection type constraints (default is false)

  Returns NodeRenderGraphConnectionPoint

  the current connection point

createCustomInputBlock

• createCustomInputBlock(): Nullable<[NodeRenderGraphBlock, string]>

  Creates a block suitable to be used as an input for this input point. If null is returned, a block based on the point type will be created.

  Returns Nullable<[NodeRenderGraphBlock, string]>

  The returned string parameter is the name of the output point of NodeRenderGraphBlock (first parameter of the returned array) that can be connected to the input

disconnectFrom

• disconnectFrom(
      endpoint: NodeRenderGraphConnectionPoint,
  ): NodeRenderGraphConnectionPoint

  Disconnect this point from one of his endpoint

  Parameters

  • endpoint: NodeRenderGraphConnectionPoint

    defines the other connection point

  Returns NodeRenderGraphConnectionPoint

  the current connection point

dispose

• dispose(): void

  Release resources

  Returns void

getClassName

• getClassName(): string

  Gets the current class name e.g. "NodeRenderGraphConnectionPoint"

  Returns string

  the class name

serialize

• serialize(isInput?: boolean): any

  Serializes this point in a JSON representation

  Parameters

  • isInput: boolean = true

    defines if the connection point is an input (default is true)

  Returns any

  the serialized point object

StaticIsShadowGenerator

• IsShadowGenerator(value: any): boolean

  Checks if the value is a shadow generator task

  Parameters

  • value: any

    The value to check

  Returns boolean

  True if the value is a shadow generator

StaticIsShadowLight

• IsShadowLight(value: any): boolean

  Checks if the value is a shadow light

  Parameters

  • value: any

    The value to check

  Returns boolean

  True if the value is a shadow light

StaticIsTextureHandle

• IsTextureHandle(value: any): boolean

  Checks if the value is a texture handle

  Parameters

  • value: any

    The value to check

  Returns boolean

  True if the value is a texture handle