Class NodeMaterialConnectionPoint

constructor

• new NodeMaterialConnectionPoint(
      name: string,
      ownerBlock: NodeMaterialBlock,
      direction: NodeMaterialConnectionPointDirection,
  ): NodeMaterialConnectionPoint

  Creates a new connection point

  Parameters

  • name: string

    defines the connection point name

  • ownerBlock: NodeMaterialBlock

    defines the block hosting this connection point

  • direction: NodeMaterialConnectionPointDirection

    defines the direction of the connection point

  Returns NodeMaterialConnectionPoint

acceptedConnectionPointTypes

define

displayName

excludedConnectionPointTypes

exposedPortPosition

isExposedOnFrame

isOptional

Readonlyname

needDualDirectionValidation

ReadonlyonConnectionObservable

ReadonlyonDisconnectionObservable

ReadonlyonTypeChangedObservable

associatedVariableName

• get associatedVariableName(): string

  Gets or sets the associated variable name in the shader

  Returns string

• set associatedVariableName(value: string): void

  Parameters

  • value: string

  Returns void

connectedBlocks

• get connectedBlocks(): NodeMaterialBlock[]

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

  Returns NodeMaterialBlock[]

connectedPoint

• get connectedPoint(): Nullable<NodeMaterialConnectionPoint>

  Get the other side of the connection (if any)

  Returns Nullable<NodeMaterialConnectionPoint>

connectInputBlock

• get connectInputBlock(): Nullable<InputBlock>

  Gets a the connected input block (if any)

  Returns Nullable<InputBlock>

declarationVariableName

• get declarationVariableName(): string

  Gets the declaration variable name in the shader

  Returns string

direction

• get direction(): NodeMaterialConnectionPointDirection

  Gets the direction of the point

  Returns NodeMaterialConnectionPointDirection

endpoints

• get endpoints(): NodeMaterialConnectionPoint[]

  Gets the list of connected endpoints

  Returns NodeMaterialConnectionPoint[]

hasEndpoints

• get hasEndpoints(): boolean

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

  Returns boolean

innerType

• get innerType(): NodeMaterialBlockConnectionPointTypes

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

  Returns NodeMaterialBlockConnectionPointTypes

isConnected

• get isConnected(): boolean

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

  Returns boolean

isConnectedInFragmentShader

• get isConnectedInFragmentShader(): boolean

  Gets a boolean indicating that this connection will be used in the fragment shader

  Returns boolean

isConnectedInVertexShader

• get isConnectedInVertexShader(): boolean

  Gets a boolean indicating that this connection will be used in the vertex shader

  Returns boolean

isConnectedToInputBlock

• get isConnectedToInputBlock(): boolean

  Gets a boolean indicating that the current point is connected to an input block

  Returns boolean

isDirectlyConnectedToVertexOutput

• get isDirectlyConnectedToVertexOutput(): boolean

  Gets a boolean indicating that this connection has a path to the vertex output

  Returns boolean

isInactive

• get isInactive(): boolean

  Boolean used to provide visual clue to users when some ports are not active in the current block configuration

  Returns boolean

ownerBlock

• get ownerBlock(): NodeMaterialBlock

  Get the block that owns this connection point

  Returns NodeMaterialBlock

sourceBlock

• get sourceBlock(): Nullable<NodeMaterialBlock>

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

  Returns Nullable<NodeMaterialBlock>

target

• get target(): NodeMaterialBlockTargets

  Gets or sets the target of that connection point

  Returns NodeMaterialBlockTargets

• set target(value: NodeMaterialBlockTargets): void

  Parameters

  • value: NodeMaterialBlockTargets

  Returns void

type

• get type(): NodeMaterialBlockConnectionPointTypes

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

  Returns NodeMaterialBlockConnectionPointTypes

• set type(value: NodeMaterialBlockConnectionPointTypes): void

  Parameters

  • value: NodeMaterialBlockConnectionPointTypes

  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: NodeMaterialConnectionPoint): boolean

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

  Parameters

  • connectionPoint: NodeMaterialConnectionPoint

    defines the other connection point

  Returns boolean

  a boolean

checkCompatibilityState

• checkCompatibilityState(
      connectionPoint: NodeMaterialConnectionPoint,
  ): NodeMaterialConnectionPointCompatibilityStates

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

  Parameters

  • connectionPoint: NodeMaterialConnectionPoint

    defines the other connection point

  Returns NodeMaterialConnectionPointCompatibilityStates

  a number defining the compatibility state

connectTo

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

  Connect this point to another connection point

  Parameters

  • connectionPoint: NodeMaterialConnectionPoint

    defines the other connection point

  • ignoreConstraints: boolean = false

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

  Returns NodeMaterialConnectionPoint

  the current connection point

createCustomInputBlock

• createCustomInputBlock(): Nullable<[NodeMaterialBlock, 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<[NodeMaterialBlock, string]>

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

disconnectFrom

• disconnectFrom(
      endpoint: NodeMaterialConnectionPoint,
  ): NodeMaterialConnectionPoint

  Disconnect this point from one of his endpoint

  Parameters

  • endpoint: NodeMaterialConnectionPoint

    defines the other connection point

  Returns NodeMaterialConnectionPoint

  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

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

StaticAreEquivalentTypes

• AreEquivalentTypes(type1: number, type2: number): boolean

  Checks if two types are equivalent

  Parameters

  • type1: number

    type 1 to check

  • type2: number

    type 2 to check

  Returns boolean

  true if both types are equivalent, else false