Olympe SDK

Class: BoxElement

olympe.ui.vectorial. BoxElement

<abstract> new BoxElement(uiProxy)

Creates a BoxElement.

Parameters:
Name Type Description
uiProxy olympe.df.Proxy.<olympe.uiapi.vectorial.BoxElement> | olympe.uiapi.vectorial.BoxElement

Extends

Methods

getDimension()

Gets the dimension of this element

Returns:
Type
olympe.df.PVector2

getPosition()

Gets the position of this element

Returns:
Type
olympe.df.PVector2

getScale()

Gets the scale of this element

Returns:
Type
olympe.df.PONumber

<protected> getUIProxyBoxElement()

Returns:
Type
olympe.uiapi.vectorial.BoxElement

<protected> getUIProxySvgElement()

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

isHidden()

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

setDimension(dimension)

Sets the dimension of this element

Parameters:
Name Type Description
dimension olympe.df.PVector2

Dimension of this element
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
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
Returns:
Type
olympe.ui.vectorial.BoxElement