Olympe SDK

Class: PathSeg

olympe.ui.vectorial. PathSeg

<abstract> new PathSeg(uiProxy [, position])

Creates a Path Segment.

Parameters:
Name Type Argument Description
uiProxy olympe.df.Proxy.<olympe.uiapi.vectorial.PathSeg> | olympe.uiapi.vectorial.PathSeg
position olympe.df.PVector2 <optional>

Extends

Methods

getPosition()

Gets the position of the path segment

Returns:
Type
olympe.df.PVector2

getUIProxyPathSegment()

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.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 olympe.df.OBoolean | boolean | olympe.df.Proxy | olympe.df.Node

True if content must be hidden, false otherwise
Inherited From:
Overrides:
Returns:
Type
olympe.ui.vectorial.SvgElement

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
Returns:
Type
olympe.ui.vectorial.PathSeg