Class NodeParticleConnectionPoint

constructor

• new NodeParticleConnectionPoint(
      name: string,
      ownerBlock: NodeParticleBlock,
      direction: NodeParticleConnectionPointDirection,
  ): NodeParticleConnectionPoint

  Creates a new connection point

  Parameters

  • name: string

    defines the connection point name

  • ownerBlock: NodeParticleBlock

    defines the block hosting this connection point

  • direction: NodeParticleConnectionPointDirection

    defines the direction of the connection point

  Returns NodeParticleConnectionPoint

acceptedConnectionPointTypes

defaultValue

displayName

excludedConnectionPointTypes

exposedPortPosition

isExposedOnFrame

isOptional

name

onConnectionObservable

onDisconnectionObservable

value

valueMax

valueMin

connectedBlocks

• get connectedBlocks(): NodeParticleBlock[]

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

  Returns NodeParticleBlock[]

connectedPoint

• get connectedPoint(): Nullable<NodeParticleConnectionPoint>

  Get the other side of the connection (if any)

  Returns Nullable<NodeParticleConnectionPoint>

direction

• get direction(): NodeParticleConnectionPointDirection

  Gets the direction of the point

  Returns NodeParticleConnectionPointDirection

endpoints

• get endpoints(): NodeParticleConnectionPoint[]

  Gets the list of connected endpoints

  Returns NodeParticleConnectionPoint[]

hasEndpoints

• get hasEndpoints(): boolean

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

  Returns boolean

innerType

• get innerType(): NodeParticleBlockConnectionPointTypes

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

  Returns NodeParticleBlockConnectionPointTypes

isConnected

• get isConnected(): boolean

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

  Returns boolean

ownerBlock

• get ownerBlock(): NodeParticleBlock

  Get the block that owns this connection point

  Returns NodeParticleBlock

sourceBlock

• get sourceBlock(): Nullable<NodeParticleBlock>

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

  Returns Nullable<NodeParticleBlock>

type

• get type(): NodeParticleBlockConnectionPointTypes

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

  Returns NodeParticleBlockConnectionPointTypes

• set type(value: NodeParticleBlockConnectionPointTypes): void

  Parameters

  • value: NodeParticleBlockConnectionPointTypes

  Returns void

addExcludedConnectionPointFromAllowedTypes

• addExcludedConnectionPointFromAllowedTypes(mask: number): void

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

  Parameters

  • mask: number

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

  Returns void

canConnectTo

• canConnectTo(connectionPoint: NodeParticleConnectionPoint): boolean

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

  Parameters

  • connectionPoint: NodeParticleConnectionPoint

    defines the other connection point

  Returns boolean

  a boolean

checkCompatibilityState

• checkCompatibilityState(
      connectionPoint: NodeParticleConnectionPoint,
  ): NodeParticleConnectionPointCompatibilityStates

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

  Parameters

  • connectionPoint: NodeParticleConnectionPoint

    defines the other connection point

  Returns NodeParticleConnectionPointCompatibilityStates

  a number defining the compatibility state

connectTo

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

  Connect this point to another connection point

  Parameters

  • connectionPoint: NodeParticleConnectionPoint

    defines the other connection point

  • ignoreConstraints: boolean = false

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

  Returns NodeParticleConnectionPoint

  the current connection point

disconnectFrom

• disconnectFrom(
      endpoint: NodeParticleConnectionPoint,
  ): NodeParticleConnectionPoint

  Disconnect this point from one of his endpoint

  Parameters

  • endpoint: NodeParticleConnectionPoint

    defines the other connection point

  Returns NodeParticleConnectionPoint

  the current connection point

dispose

• dispose(): void

  Release resources

  Returns void

getClassName

• getClassName(): string

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

  Returns string

  the class name

getConnectedValue

• getConnectedValue(state: NodeParticleBuildState): any

  Gets the value represented by this connection point

  Parameters

  • state: NodeParticleBuildState

    current evaluation state

  Returns any

  the connected value or the value if nothing is connected

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