Olympe SDK

Class: FloodFE

olympe.ui.vectorial. FloodFE

Flood filter element

new FloodFE()

Creates a Flood Filter Element.

Extends

Methods

getDimension()

Gets the dimension of this element

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

getPosition()

Gets the position of this element

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

getScale()

Gets the scale of this element

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

<protected> getUIProxyBoxElement()

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

getUIProxyFilterElement()

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

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

getUIProxyFloodFE()

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.FloodFE

<protected> getUIProxySvgElement()

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

isHidden()

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

setColor(color)

Sets the flood color and opacity

Parameters:
Name Type Description
color olympe.df.Proxy.<olympe.df.Color> | olympe.df.Color
Returns:
Type
olympe.ui.vectorial.FloodFE

setDimension(dimension)

Sets the dimension of this element

Parameters:
Name Type Description
dimension olympe.df.PVector2

Dimension of this element
Inherited From:
Overrides:
Returns:
Type
olympe.ui.vectorial.BoxElement

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 this element

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

The position of this element
Inherited From:
Overrides:
Returns:
Type
olympe.ui.vectorial.BoxElement

setScale(scale)

Sets the scale of this element

Parameters:
Name Type Description
scale olympe.df.PONumber | number

Scale of this element
Inherited From:
Overrides:
Returns:
Type
olympe.ui.vectorial.BoxElement