Class NodeGeometryConnectionPoint
Hierarchy
- NodeGeometryConnectionPoint
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Creates a new connection point
Parameters
name: string
defines the connection point name
ownerBlock: NodeGeometryBlock
defines the block hosting this connection point
direction: NodeGeometryConnectionPointDirection
defines the direction of the connection point
Returns NodeGeometryConnectionPoint
Properties
accepted Connection Point TypesSearch playground for acceptedConnectionPointTypes
Gets or sets the additional types supported by this connection point
default ValueSearch playground for defaultValue
Gets the default value used for this point at creation time
display NameSearch playground for displayName
Gets or sets the connection point display name
excluded Connection Point TypesSearch playground for excludedConnectionPointTypes
Gets or sets the additional types excluded by this connection point
exposed Port PositionSearch playground for exposedPortPosition
Gets or sets number indicating the position that the port is exposed to on a frame
is Exposed On FrameSearch playground for isExposedOnFrame
Gets or sets a boolean indicating that this connection point is exposed on a frame
is OptionalSearch playground for isOptional
Gets or sets a boolean indicating that this connection point can be omitted
nameSearch playground for name
Gets or sets the connection point name
on Connection ObservableSearch playground for onConnectionObservable
Observable triggered when this point is connected
valueSearch playground for value
Gets or sets the default value used for this point if nothing is connected
value MaxSearch playground for valueMax
Gets or sets the max value accepted for this point if nothing is connected
value MinSearch playground for valueMin
Gets or sets the min value accepted for this point if nothing is connected
Accessors
connected Blocks
Get the block connected on the endpoints of this connection (if any)
Returns NodeGeometryBlock[]
connected Point
Get the other side of the connection (if any)
Returns Nullable<NodeGeometryConnectionPoint>
direction
Gets the direction of the point
Returns NodeGeometryConnectionPointDirection
endpoints
Gets the list of connected endpoints
Returns NodeGeometryConnectionPoint[]
has Endpoints
Gets a boolean indicating if that output point is connected to at least one input
Returns boolean
inner Type
Get the inner type (ie AutoDetect for instance instead of the inferred one)
Returns NodeGeometryBlockConnectionPointTypes
is Connected
Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
Returns boolean
owner Block
Get the block that owns this connection point
Returns NodeGeometryBlock
source Block
Get the block connected on the other side of this connection (if any)
Returns Nullable<NodeGeometryBlock>
type
Gets or sets the connection point type (default is float)
Returns NodeGeometryBlockConnectionPointTypes
Gets or sets the connection point type (default is float)
Parameters
Returns void
Methods
add Excluded Connection Point From Allowed TypesSearch playground for addExcludedConnectionPointFromAllowedTypes
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 Connect ToSearch playground for canConnectTo
Gets a boolean indicating if the current point can be connected to another point
Parameters
connectionPoint: NodeGeometryConnectionPoint
defines the other connection point
Returns boolean
a boolean
check Compatibility StateSearch playground for checkCompatibilityState
Gets a number indicating if the current point can be connected to another point
Parameters
connectionPoint: NodeGeometryConnectionPoint
defines the other connection point
Returns NodeGeometryConnectionPointCompatibilityStates
a number defining the compatibility state
connect ToSearch playground for connectTo
Connect this point to another connection point
Parameters
connectionPoint: NodeGeometryConnectionPoint
defines the other connection point
Optional ignoreConstraints: boolean
defines if the system will ignore connection type constraints (default is false)
Returns NodeGeometryConnectionPoint
the current connection point
disconnect FromSearch playground for disconnectFrom
Disconnect this point from one of his endpoint
Parameters
endpoint: NodeGeometryConnectionPoint
defines the other connection point
Returns NodeGeometryConnectionPoint
the current connection point
disposeSearch playground for dispose
Release resources
Returns void
get Class NameSearch playground for getClassName
Gets the current class name e.g. "NodeMaterialConnectionPoint"
Returns string
the class name
get Connected ValueSearch playground for getConnectedValue
Gets the value represented by this connection point
Parameters
state: NodeGeometryBuildState
current evaluation state
Returns any
the connected value or the value if nothing is connected
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
Defines a connection point for a block