GeneralPathNodeStyleRenderer

The default implementation returns the aspect ratio of the associated style instance if that value is positive and finite. Otherwise, it returns the aspect ratio of the associated node's size.

Must return a value > 0

Returns

↪number: Returns the aspect ratio with which the path is rendered.

getBounds

(context: ICanvasContext) : Rect

Returns a tight rectangular area where the whole rendering would fit into.

Remarks

If calculating the bounds is too expensive or the rendering is not bound to a certain area, this method may return INFINITE. If nothing is rendered, this method should return an empty rectangle, where either or both the width and height is non-positive or EMPTY.

Parameters

options - Object
A map of options to pass to the method.

context - ICanvasContext: the context to calculate the bounds for

Returns

↪Rect: the bounds or EMPTY to indicate an unbound area

Implements

IBoundsProvider

getBoundsProvider

(node: INode, style: INodeStyle) : IBoundsProvider

Configures the style and node parameters, calls configure and returns this.

Parameters

options - Object
A map of options to pass to the method.

node - INode: The node to retrieve the bounds provider for. The value will be stored in the node property.
style - INodeStyle: The style to associate with the node. The value will be stored in the style property.

Configures the style and node parameters, does not call configure and returns this.

Remarks

As this method may be called often it will not automatically call configure, instead subclasses should ensure that in the lookup method call they should call configure only if needed, i.e. if they decide to return this or an instance that depends on a correctly configured this.

Parameters

options - Object
A map of options to pass to the method.

node - INode: The node to query the context for. The value will be stored in the node property.
style - INodeStyle: The style to associate with the node. The value will be stored in the style property.

Returns

↪ILookup: this

Implements

INodeStyleRenderer

getCssClass

() : string

Get the CSS class that is currently used by this renderer.

Remarks

This implementation retrieves the CSS class from the owning style.

Returns

↪string: The CSS class that is currently used by this renderer.

getHitTestable

(node: INode, style: INodeStyle) : IHitTestable

Configures the style and node parameters, calls configure and returns this.

Parameters

options - Object
A map of options to pass to the method.

node - INode: The node to query hit test with. The value will be stored in the node property.
style - INodeStyle: The style to associate with the node. The value will be stored in the style property.

Returns

↪IHitTestable: this

Implements

INodeStyleRenderer

getIntersection

(inner: Point, outer: Point) : Point

Returns the intersection for the given line with this shape's geometry.

Parameters

options - Object
A map of options to pass to the method.

inner - Point: The first point of the line that is inside the shape.
outer - Point: The second point of the line that is outside the shape.

Returns

↪Point: The coordinates of the intersection point, if an intersection was found.

Implements

IShapeGeometry

getMarqueeTestable

(node: INode, style: INodeStyle) : IMarqueeTestable

Configures the style and node parameters, calls configure and returns this.

Parameters

options - Object
A map of options to pass to the method.

node - INode: The node to query marquee intersection tests. The value will be stored in the node property.
style - INodeStyle: The style to associate with the node. The value will be stored in the style property.

Returns

↪IMarqueeTestable: this

Implements

INodeStyleRenderer

getOutline

() : GeneralPath

Returns the outline of the shape or null.

Remarks

If null is returned callers may assume the canonical outline as result. For nodes this is the node's layout.

Returns

↪GeneralPath: The outline or null if no outline can be provided.

Implements

IShapeGeometry

getShapeGeometry

(node: INode, style: INodeStyle) : IShapeGeometry

Configures the style and node properties, calls configure and returns this.

Parameters

options - Object
A map of options to pass to the method.

node - INode: The node to retrieve the shape geometry for. The value will be stored in the node property.
style - INodeStyle: The style to associate with the node. The value will be stored in the style property.

Returns

↪IShapeGeometry: this

Implements

INodeStyleRenderer

getVisibilityTestable

(node: INode, style: INodeStyle) : IVisibilityTestable

Configures the style and node parameters, does not call configure and returns this.

Remarks

Unlike most of the other methods this implementation does not call configure. If the subclass implementation depends on this instance to be configured, it needs to call Configure in isVisible.

Parameters

options - Object
A map of options to pass to the method.

node - INode: The node to query visibility tests. The value will be stored in the node property.
style - INodeStyle: The style to associate with the node. The value will be stored in the style property.

Returns

↪IVisibilityTestable: this

Implements

INodeStyleRenderer

getVisualCreator

(node: INode, style: INodeStyle) : IVisualCreator

Configures the style and node parameters, calls configure and returns this.

Parameters

options - Object
A map of options to pass to the method.

node - INode: The node to retrieve the IVisualCreator for. The value will be stored in the node property.
style - INodeStyle: The style to associate with the node. The value will be stored in the style property.

Returns

↪IVisualCreator: this

Implements

INodeStyleRenderer

isHit

(context: IInputModeContext, location: Point) : boolean

Determines if something has been hit at the given coordinates in the world coordinate system.

Remarks

Implementations should inspect the hitTestRadius and take the value into account when performing hit tests. This allows the user to hit elements even if the zoom level is very small and allows for accurate hit tests at greater zoom levels.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: the context the hit test is performed in
location - Point: the coordinates in world coordinate system

Returns

↪boolean: whether something has been hit

Implements

IHitTestable

isInBox

(context: IInputModeContext, rectangle: Rect) : boolean

Returns true if the corresponding item is considered to intersect the given rectangular box.

Remarks

This method may return false if the item cannot be selected using a selection marquee or optionally if the item is only partially contained within the box.

Implementations should respect the hitTestRadius if marquee selections should behave differently on different zoom levels.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: the current input mode context
rectangle - Rect: the box describing the marquee's bounds

Returns

↪boolean: true if the item is considered to be captured by the marquee

Implements

IMarqueeTestable

isInPath

(context: IInputModeContext, lassoPath: GeneralPath) : boolean

Returns true if the corresponding item is considered to intersect the given path.

Remarks

This method may return false if the item cannot be selected using a lasso selection or optionally if the item is only partially contained within the path.

Implementations should respect the hitTestRadius if lasso selections should behave differently on different zoom levels.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: the current input mode context
lassoPath - GeneralPath: the path describing the lasso selection bounds

Returns

↪boolean: true if the item is considered to be captured by the lasso

Implements

ILassoTestable

isInside

(location: Point) : boolean

Checks whether the given coordinate is deemed to lie within the shape's geometric bounds.

Parameters

options - Object
A map of options to pass to the method.

location - Point: The point to test.

Returns

↪boolean: True if the point lies within the shape.

Implements

IShapeGeometry

isVisible

(context: ICanvasContext, rectangle: Rect) : boolean

Determines visibility by checking for an intersection with the bounds of the path.

Parameters

options - Object
A map of options to pass to the method.

context - ICanvasContext: The context.
rectangle - Rect: The current clip

Returns

↪boolean: Whether the bounds of the path are visible in the clip.

Implements

IVisibilityTestable

lookup

<Textends any>(type: Class<T>) : T

Implements the ILookup interface.

Remarks

This method will be used by default if getContext has been queried for a lookup implementation. Note that it cannot be assumed that configure has already been invoked. However, normally node and style will be correctly configured if invoked directly after GetContext. Subclass implementations should make sure to configure this instance before they return this as a result of a successful lookup. This implementation will check if type.IsInstanceOfType(this) and will call configure on success and return this.

Type Parameters

T: any

Parameters

options - Object
A map of options to pass to the method.

type - Class<T>: The type to query for.

Returns

↪T: An implementation or null.

Implements

ILookup

updateVisual

(context: IRenderContext, oldVisual: Visual) : Visual

This method updates or replaces a previously created Visual for inclusion in the IRenderContext.

Remarks

The CanvasComponent uses this method to give implementations a chance to update an existing Visual that has previously been created by the same instance during a call to createVisual. Implementation may update the oldVisual and return that same reference, or create a new visual and return the new instance or null.

I most cases oldVisual is a visual instance that has been returned by the createVisual method of this instance. This is, however, not guaranteed. Implementations have to be aware of this.

Parameters

options - Object
A map of options to pass to the method.

context - IRenderContext: The context that describes where the visual will be used in.
oldVisual - Visual: The visual instance to be updated.

Returns

↪Visual: oldVisual, if this instance modified the visual, or a new visual that should replace the existing one in the canvas object visual tree.

Implements

IVisualCreator

GeneralPathNodeStyleRenderer

Type Details

Constructors