I

IPortLocationModel

Show Usages
Defines the geometry of IPort instances with respect to specific IPortLocationModelParameters.
Inheritance Hierarchy

Remarks

In addition to defining the location of a port with respect to a specific IPortLocationModelParameter, a port location model is typically the factory of the model parameters that are compatible with it, too.

Typically, the port location model defines a compilation of valid locations for ports, and a specific model parameter specifies an exact geometry for a port.

By design, the same instance of a port location model can be shared by multiple port location model parameters. Similarly, the same instance of a port location model parameter can be shared by multiple ports.

This interface provides the getContext method that can be used to query additional aspects of the implementation.

See Also

API

IPortLocationModelParameter, IPort, IGraph

Members

No filters for this type

Methods

createParameter

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

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.

Throws

Exception ({ name: 'ArgumentError' })
location contains one or more NaN values.

getContext

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

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
abstract
Determines the location of the port for the given parameter.
abstract

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.