Class NodeMaterialConnectionPoint

Defines a connection point for a block

Hierarchy

NodeMaterialConnectionPoint
- NodeMaterialConnectionPointCustomObject

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

- Defined in .temp/docdirectory/doc.d.ts:43129
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

Properties

acceptedConnectionPointTypesSearch playground for acceptedConnectionPointTypes

acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[]

Gets or sets the additional types supported by this connection point

defineSearch playground for define

define: string

Gets or sets a string indicating that this uniform must be defined under a #ifdef

displayNameSearch playground for displayName

displayName: string

Gets or sets the connection point name

excludedConnectionPointTypesSearch playground for excludedConnectionPointTypes

excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[]

Gets or sets the additional types excluded by this connection point

exposedPortPositionSearch playground for exposedPortPosition

exposedPortPosition: number

Gets or sets number indicating the position that the port is exposed to on a frame

isExposedOnFrameSearch playground for isExposedOnFrame

isExposedOnFrame: boolean

Gets or sets a boolean indicating that this connection point is exposed on a frame

isOptionalSearch playground for isOptional

isOptional: boolean

Gets or sets a boolean indicating that this connection point can be omitted

nameSearch playground for name

name: string

Gets or sets the connection point name

needDualDirectionValidationSearch playground for needDualDirectionValidation

needDualDirectionValidation: boolean

Indicates that this connection point needs dual validation before being connected to another point

onConnectionObservableSearch playground for onConnectionObservable

onConnectionObservable: Observable<NodeMaterialConnectionPoint>

Observable triggered when this point is connected

Accessors

associatedVariableName

get associatedVariableName(): string
set associatedVariableName(value: string): any

- Defined in .temp/docdirectory/doc.d.ts:43055
Gets or sets the associated variable name in the shader

Returns string
- Defined in .temp/docdirectory/doc.d.ts:43056
Gets or sets the associated variable name in the shader

Parameters
- value: string
Returns any

connectInputBlock

get connectInputBlock(): Nullable<InputBlock>

- Defined in .temp/docdirectory/doc.d.ts:43105
Gets a the connected input block (if any)

Returns Nullable<InputBlock>

connectedBlocks

get connectedBlocks(): Array<NodeMaterialBlock>

- Defined in .temp/docdirectory/doc.d.ts:43113
Get the block connected on the endpoints of this connection (if any)

Returns Array<NodeMaterialBlock>

connectedPoint

get connectedPoint(): Nullable<NodeMaterialConnectionPoint>

- Defined in .temp/docdirectory/doc.d.ts:43107
Get the other side of the connection (if any)

Returns Nullable<NodeMaterialConnectionPoint>

direction

get direction(): NodeMaterialConnectionPointDirection

- Defined in .temp/docdirectory/doc.d.ts:43037
Gets the direction of the point

Returns NodeMaterialConnectionPointDirection

endpoints

get endpoints(): NodeMaterialConnectionPoint[]

- Defined in .temp/docdirectory/doc.d.ts:43115
Gets the list of connected endpoints

Returns NodeMaterialConnectionPoint[]

hasEndpoints

get hasEndpoints(): boolean

- Defined in .temp/docdirectory/doc.d.ts:43117
Gets a boolean indicating if that output point is connected to at least one input

Returns boolean

innerType

get innerType(): NodeMaterialBlockConnectionPointTypes

- Defined in .temp/docdirectory/doc.d.ts:43058
Get the inner type (ie AutoDetect for instance instead of the inferred one)

Returns NodeMaterialBlockConnectionPointTypes

isConnected

get isConnected(): boolean

- Defined in .temp/docdirectory/doc.d.ts:43097
Gets a boolean indicating that the current point is connected to another NodeMaterialBlock

Returns boolean

isConnectedInFragmentShader

get isConnectedInFragmentShader(): boolean

- Defined in .temp/docdirectory/doc.d.ts:43123
Gets a boolean indicating that this connection will be used in the fragment shader

Returns boolean

isConnectedInVertexShader

get isConnectedInVertexShader(): boolean

- Defined in .temp/docdirectory/doc.d.ts:43121
Gets a boolean indicating that this connection will be used in the vertex shader

Returns boolean

isConnectedToInputBlock

get isConnectedToInputBlock(): boolean

- Defined in .temp/docdirectory/doc.d.ts:43101
Gets a boolean indicating that the current point is connected to an input block

Returns boolean

isDirectlyConnectedToVertexOutput

get isDirectlyConnectedToVertexOutput(): boolean

- Defined in .temp/docdirectory/doc.d.ts:43119
Gets a boolean indicating that this connection has a path to the vertex output

Returns boolean

ownerBlock

get ownerBlock(): NodeMaterialBlock

- Defined in .temp/docdirectory/doc.d.ts:43109
Get the block that owns this connection point

Returns NodeMaterialBlock

sourceBlock

get sourceBlock(): Nullable<NodeMaterialBlock>

- Defined in .temp/docdirectory/doc.d.ts:43111
Get the block connected on the other side of this connection (if any)

Returns Nullable<NodeMaterialBlock>

target

get target(): NodeMaterialBlockTargets
set target(value: NodeMaterialBlockTargets): any

- Defined in .temp/docdirectory/doc.d.ts:43092
Gets or sets the target of that connection point

Returns NodeMaterialBlockTargets
- Defined in .temp/docdirectory/doc.d.ts:43093
Gets or sets the target of that connection point

Parameters
- value: NodeMaterialBlockTargets
Returns any

type

get type(): NodeMaterialBlockConnectionPointTypes
set type(value: NodeMaterialBlockConnectionPointTypes): any

- Defined in .temp/docdirectory/doc.d.ts:43062
Gets or sets the connection point type (default is float)

Returns NodeMaterialBlockConnectionPointTypes
- Defined in .temp/docdirectory/doc.d.ts:43063
Gets or sets the connection point type (default is float)

Parameters
- value: NodeMaterialBlockConnectionPointTypes
Returns any

Methods

canConnectToSearch playground for canConnectTo

canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean

- Defined in .temp/docdirectory/doc.d.ts:43147
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

checkCompatibilityStateSearch playground for checkCompatibilityState

checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates

- Defined in .temp/docdirectory/doc.d.ts:43153
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

connectToSearch playground for connectTo

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

- Defined in .temp/docdirectory/doc.d.ts:43160
Connect this point to another connection point

Parameters
- connectionPoint: NodeMaterialConnectionPoint
  
  defines the other connection point
- Optional ignoreConstraints: boolean
  
  defines if the system will ignore connection type constraints (default is false)
Returns NodeMaterialConnectionPoint

the current connection point

createCustomInputBlockSearch playground for createCustomInputBlock

createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>

- Defined in .temp/docdirectory/doc.d.ts:43129
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

disconnectFromSearch playground for disconnectFrom

disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:43166
Disconnect this point from one of his endpoint

Parameters
- endpoint: NodeMaterialConnectionPoint
  
  defines the other connection point
Returns NodeMaterialConnectionPoint

the current connection point

disposeSearch playground for dispose

dispose(): void

- Defined in .temp/docdirectory/doc.d.ts:43176
Release resources

Returns void

getClassNameSearch playground for getClassName

getClassName(): string

- Defined in .temp/docdirectory/doc.d.ts:43141
Gets the current class name e.g. "NodeMaterialConnectionPoint"

Returns string

the class name

serializeSearch playground for serialize

serialize(isInput?: boolean): any

- Defined in .temp/docdirectory/doc.d.ts:43172
Serializes this point in a JSON representation

Parameters
- Optional isInput: boolean
  
  defines if the connection point is an input (default is true)
Returns any

the serialized point object

Static AreEquivalentTypesSearch playground for AreEquivalentTypes

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

- Defined in .temp/docdirectory/doc.d.ts:43017
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

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

name: string

ownerBlock: NodeMaterialBlock

direction: NodeMaterialConnectionPointDirection

Returns NodeMaterialConnectionPoint

Properties

acceptedConnectionPointTypesSearch playground for acceptedConnectionPointTypes

defineSearch playground for define

displayNameSearch playground for displayName

excludedConnectionPointTypesSearch playground for excludedConnectionPointTypes

exposedPortPositionSearch playground for exposedPortPosition

isExposedOnFrameSearch playground for isExposedOnFrame

isOptionalSearch playground for isOptional

nameSearch playground for name

needDualDirectionValidationSearch playground for needDualDirectionValidation

onConnectionObservableSearch playground for onConnectionObservable

Accessors

associatedVariableName

Returns string

Parameters

value: string

Returns any

connectInputBlock

Returns Nullable<InputBlock>

connectedBlocks

Returns Array<NodeMaterialBlock>

connectedPoint

Returns Nullable<NodeMaterialConnectionPoint>

direction

Returns NodeMaterialConnectionPointDirection

endpoints

Returns NodeMaterialConnectionPoint[]

hasEndpoints

Returns boolean

innerType

Returns NodeMaterialBlockConnectionPointTypes

isConnected

Returns boolean

isConnectedInFragmentShader

Returns boolean

isConnectedInVertexShader

Returns boolean

isConnectedToInputBlock

Returns boolean

isDirectlyConnectedToVertexOutput

Returns boolean

ownerBlock

Returns NodeMaterialBlock

sourceBlock

Returns Nullable<NodeMaterialBlock>

target

Returns NodeMaterialBlockTargets

Parameters

value: NodeMaterialBlockTargets

Returns any

type

Returns NodeMaterialBlockConnectionPointTypes

Parameters

value: NodeMaterialBlockConnectionPointTypes

Returns any

Methods

canConnectToSearch playground for canConnectTo

Parameters

connectionPoint: NodeMaterialConnectionPoint

Returns boolean

checkCompatibilityStateSearch playground for checkCompatibilityState

Parameters

connectionPoint: NodeMaterialConnectionPoint

Returns NodeMaterialConnectionPointCompatibilityStates

connectToSearch playground for connectTo

Parameters

connectionPoint: NodeMaterialConnectionPoint