C

EdgePathPortLocationModel

Show Usages
A port location model that places the port on the edge path at a specified ratio.
ImplementsInheritance Hierarchy

Members

No filters for this type

Methods

createParameter

(owner: IPortOwner, location: Point): IPortLocationModelParameter
Factory method that creates a parameter for the given owner that tries to match the provided location in absolute world coordinates.
final

Parameters

owner: IPortOwner
The port owner that will own the port for which the parameter shall be created.
location: Point
The location in the world coordinate system that should be matched as best as possible.

Return Value

IPortLocationModelParameter
A new instance that can be used to describe the location of an IPort at the given owner.

createRatioParameter

(edgePathRatio?: number): EdgePathPortLocationModelParameter
Creates a parameter at the provided edge path ratio.
final

Parameters

edgePathRatio?: number
The ratio at which to place the port at the edge path. A ratio of 0.0 will place the port at the source side of the edge path, a ratio of 1.0 at the target side. The default is 0.5.

Return Value

EdgePathPortLocationModelParameter
A port location parameter at the provided edge path ratio for this model instance.

getContext

(port: IPort): ILookup
Provides a lookup context for the given port.
final

Parameters

port: IPort
The port to use in the context.

Return Value

ILookup
An implementation of the ILookup interface that can be used to query additional aspects of the port.

getLocation

(port: IPort, locationParameter: IPortLocationModelParameter): Point
Determines the location of the port for the given parameter.
final

Parameters

port: IPort
The port to determine the location for.
locationParameter: IPortLocationModelParameter
The parameter to use. The parameter can be expected to be created by this instance having the model property set to this instance.

Return Value

Point
The calculated location of the port.

Constants

INSTANCE

: EdgePathPortLocationModel
static
A static immutable global instance of this class.