Class: Mask

Extends

• olympe.ui.vectorial.BoxElement

Members

---

absolute :olympe.df.POBoolean

Wether the coordinate system of the mask is absolute or relative to parent object

Type:

• olympe.df.POBoolean

Methods

---

appendChild(child, childId)

Appends a child Svg element

Parameters:

Name	Type	Description
child	olympe.ui.vectorial.GraphicsElement
childId	string

Returns:

Type

olympe.ui.vectorial.Mask

---

getDimension()

Gets the dimension of this element

Inherited From:

• olympe.ui.vectorial.BoxElement#getDimension

Overrides:

• olympe.ui.vectorial.BoxElement#getDimension

Returns:

Type

olympe.df.PVector2

---

getPosition()

Gets the position of this element

Inherited From:

• olympe.ui.vectorial.BoxElement#getPosition

Overrides:

• olympe.ui.vectorial.BoxElement#getPosition

Returns:

Type

olympe.df.PVector2

---

getScale()

Gets the scale of this element

Inherited From:

• olympe.ui.vectorial.BoxElement#getScale

Overrides:

• olympe.ui.vectorial.BoxElement#getScale

Returns:

Type

olympe.df.PONumber

---

<protected> getUIProxyBoxElement()

Inherited From:

• olympe.ui.vectorial.BoxElement#getUIProxyBoxElement

Overrides:

• olympe.ui.vectorial.BoxElement#getUIProxyBoxElement

Returns:

Type

olympe.uiapi.vectorial.BoxElement

---

getUIProxyMask()

This method needs to be public for GraphicsElement to be able to access this uiProxy

Returns:

Proxified Svg container

Type

olympe.uiapi.vectorial.Mask

---

<protected> getUIProxySvgElement()

Inherited From:

• olympe.ui.vectorial.SvgElement#getUIProxySvgElement

Overrides:

• olympe.ui.vectorial.BoxElement#getUIProxySvgElement

Returns:

Type

olympe.uiapi.vectorial.SvgElement

---

isHidden()

Inherited From:

• olympe.ui.vectorial.SvgElement#isHidden

Overrides:

• olympe.ui.vectorial.BoxElement#isHidden

Returns:

Type

olympe.df.POBoolean

---

removeChild(childId)

Removes a child Svg element

Parameters:

Name	Type	Description
childId	string

Returns:

Type

olympe.ui.vectorial.Mask

---

setAbsolute(value)

Sets wether the coordinate system of the mask is absolute or relative to the parent object

Parameters:

Name	Type	Description
value	olympe.df.POBoolean | boolean

Returns:

Type

olympe.ui.vectorial.Mask

---

setDimension(dimension)

Sets the dimension of this element

Parameters:

Name	Type	Description
dimension	olympe.df.PVector2	Dimension of this element

Inherited From:

• olympe.ui.vectorial.BoxElement#setDimension

Overrides:

• olympe.ui.vectorial.BoxElement#setDimension

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:

• olympe.ui.vectorial.SvgElement#setHidden

Overrides:

• olympe.ui.vectorial.BoxElement#setHidden

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:

• olympe.ui.vectorial.SvgElement#setIgnoreUserInteraction

Overrides:

• olympe.ui.vectorial.BoxElement#setIgnoreUserInteraction

---

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:

• olympe.ui.vectorial.BoxElement#setPosition

Overrides:

• olympe.ui.vectorial.BoxElement#setPosition

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:

• olympe.ui.vectorial.BoxElement#setScale

Overrides:

• olympe.ui.vectorial.BoxElement#setScale

Returns:

Type

olympe.ui.vectorial.BoxElement