Class NodeMaterialConnectionPoint
Hierarchy
- NodeMaterialConnectionPoint
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
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
accepted
Gets or sets the additional types supported by this connection point
defineSearch playground for define
Gets or sets a string indicating that this uniform must be defined under a #ifdef
display
Gets or sets the connection point name
excluded
Gets or sets the additional types excluded by this connection point
exposed
Gets or sets number indicating the position that the port is exposed to on a frame
is
Gets or sets a boolean indicating that this connection point is exposed on a frame
is
Gets or sets a boolean indicating that this connection point can be omitted
nameSearch playground for name
Gets or sets the connection point name
need
Indicates that this connection point needs dual validation before being connected to another point
on
Observable triggered when this point is connected
Accessors
associated
Gets or sets the associated variable name in the shader
Returns string
Gets or sets the associated variable name in the shader
Parameters
value: string
Returns void
connect
Gets a the connected input block (if any)
Returns Nullable<InputBlock>
connected
Get the block connected on the endpoints of this connection (if any)
Returns NodeMaterialBlock[]
connected
Get the other side of the connection (if any)
Returns Nullable<NodeMaterialConnectionPoint>
direction
Gets the direction of the point
Returns NodeMaterialConnectionPointDirection
endpoints
Gets the list of connected endpoints
Returns NodeMaterialConnectionPoint[]
has
Gets a boolean indicating if that output point is connected to at least one input
Returns boolean
inner
Get the inner type (ie AutoDetect for instance instead of the inferred one)
Returns NodeMaterialBlockConnectionPointTypes
is
Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
Returns boolean
is
Gets a boolean indicating that this connection will be used in the fragment shader
Returns boolean
is
Gets a boolean indicating that this connection will be used in the vertex shader
Returns boolean
is
Gets a boolean indicating that the current point is connected to an input block
Returns boolean
is
Gets a boolean indicating that this connection has a path to the vertex output
Returns boolean
owner
Get the block that owns this connection point
Returns NodeMaterialBlock
source
Get the block connected on the other side of this connection (if any)
Returns Nullable<NodeMaterialBlock>
target
Gets or sets the target of that connection point
Returns NodeMaterialBlockTargets
Gets or sets the target of that connection point
Parameters
value: NodeMaterialBlockTargets
Returns void
type
Gets or sets the connection point type (default is float)
Returns NodeMaterialBlockConnectionPointTypes
Gets or sets the connection point type (default is float)
Parameters
Returns void
Methods
add
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
can
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
check
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
connect
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
create
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
disconnect
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
Release resources
Returns void
get
Gets the current class name e.g. "NodeMaterialConnectionPoint"
Returns string
the class name
serializeSearch playground for serialize
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 Are
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
Defines a connection point for a block