Olympe SDK

Class: PathSegLine

olympe.ui.vectorial. PathSegLine

Straight line path segment

new PathSegLine( [position] [, hidden])

Creates Straight line path segment.

Parameters:
Name Type Argument Description
position olympe.df.PVector2 <optional>
hidden boolean | olympe.df.POBoolean <optional>

Wether this path segement is hidden

Extends

Methods

getPosition()

Gets the position of the path segment

Inherited From:
Overrides:
Returns:
Type
olympe.df.PVector2

getUIProxyPathSegLine()

Get the UI proxy object. This method needs to be public for the Path element to be able to access it.

Returns:
Type
olympe.uiapi.vectorial.PathSegLine

getUIProxyPathSegment()

Get the UI proxy object. This method needs to be public for the Path element to be able to access it.

Inherited From:
Overrides:
Returns:
Type
olympe.uiapi.vectorial.PathSeg

<protected> getUIProxySvgElement()

Inherited From:
Overrides:
Returns:
Type
olympe.uiapi.vectorial.SvgElement

isHidden()

Inherited From:
Overrides:
Returns:
Type
olympe.df.POBoolean

setHidden(hidden)

Parameters:
Name Type Description
hidden boolean | olympe.df.POBoolean
Overrides:
Returns:
Type
olympe.ui.vectorial.PathSegLine

setIgnoreUserInteraction( [ignore])

Disables mouse events for this element. However, mouse events will target its descendants unless they are manually set to also ignore user interactions.

Parameters:
Name Type Argument Default Description
ignore boolean <optional>
 false

ignore If true, this element is never the target of mouse events (but not its descendants).
Inherited From:
Overrides:

setPosition(position)

Sets the position of the path segment

Parameters:
Name Type Description
position olympe.df.PVector2 | olympe.df.Vector2

The position of the path segment
Inherited From:
Overrides:
Returns:
Type
olympe.ui.vectorial.PathSeg