API Docs for:
Show:

Mask.CompositeMask Class

Controls the mask surrounds the subject (the step focussed area)

Methods

init

()

Initializes the composite mask

pollForScreenChanges

()

A Polling function to check if screen dimension has changed

pollForSubjectChanges

()

A Polling function to check if subject coordinates has changed

render

()

Renders the composite mask

scrollIfNecessary

(
  • position
  • dimension
)

Checks if the subject is fully visible, if not, scrolls 'til it became fully visible

Parameters:

  • position Object

    An object representing the positioning info for the mask

  • dimension Object

    An object representing the dimension info for the mask

update

(
  • position
  • dimension
  • borderRadius
)

Updates the positioning and dimension of each part composing the whole mask, according to the subject coordinates

Parameters:

  • position Object

    An object representing the positioning info for the mask

  • dimension Object

    An object representing the dimension info for the mask

  • borderRadius Object

    An object representing the borderRadius info for the mask