new Supervisor(owner)
A Supervisor is a class that helps manage the processes behind UI components that allow the end-user to monitor and adjust values and properties during runtime. For example, the UiNumberSupervisor_TextField type is a specialized UiTextField that contains an additional Supervisor member, and its purpose is to serve as a visual 'supervisor' for any numeric property, displaying the current value as it changes, and updating the value if the end-user types a new number into the UiTextField. The Supervisor object itself houses callbacks for setting the target property, getting the target property, and updating the associated visual compoenents (i.e. setting the string in the UiTextField to the target number value). [REQUIREMENT: optional code module - 'extendedUi']
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
owner |
SceneObject | The SceneObject owning the visual components associated with this Supervisor. |
MEMBERS
-
inheritedTypes :object
-
Dictionary object listing all of the types this object is compatible with.
-
supervisedPropertyGetterCallbackArgs :Array|any
-
Arguments for the callback function that is called whenever this Supervisor needs to retrieve the property being supervised. The provided callback function must return the value being supervised.
-
supervisedPropertyGetterCallbackName :string
-
The name of the callback function that is called whenever this Supervisor needs to retrieve the property being supervised. The provided callback function must return the value being supervised.
-
supervisedPropertyGetterCallbackOwner :object
-
The owner of the callback function that is called whenever this Supervisor needs to retrieve the property being supervised. The provided callback function must return the value being supervised.
-
supervisedPropertySetterCallbackArgs :Array|any
-
Arguments for the callback function that is called whenever this Supervisor sets the value of the property being supervised. The provided callback function will receive the new value for the property as its first parameter.
-
supervisedPropertySetterCallbackName :string
-
The name of the callback function that is called whenever this Supervisor sets the value of the property being supervised. The provided callback function will receive the new value for the property as its first parameter.
-
supervisedPropertySetterCallbackOwner :object
-
The owner of the callback function that is called whenever this Supervisor sets the value of the property being supervised. The provided callback function will receive the new value for the property as its first parameter.
-
type :string
-
Type identifier.
-
updateVisualsCallbackArgs :Array|any
-
Arguments for the callback function that is called whenever this Supervisor updates the visuals to reflect changes to the value of the property being supervised. The provided callback function will receive the up-to-date property value as its first parameter.
-
updateVisualsCallbackName :string
-
The name of the callback function that is called whenever this Supervisor updates the visuals to reflect changes to the value of the property being supervised. The provided callback function will receive the up-to-date property value as its first parameter.
-
updateVisualsCallbackOwner :object
-
The owner of the callback function that is called whenever this Supervisor updates the visuals to reflect changes to the value of the property being supervised. The provided callback function will receive the up-to-date property value as its first parameter.
METHODS
-
performStandardSetup(supervisedPropertyOwner, supervisedPropertyName, validationFunctionOwner (opt), validationFunctionName (opt))
-
Creates and connects to 'standard' setter and getter functions that are simply defined by getting an property (by owner and name), and setting a property (by owner and name); For more custom functionality, such as conditional getting and setting functionality, custom getter and setter functions can be built and linked to directly using 'supervisedPropertyGetterCallbackOwner', 'supervisedPropertyGetterCallbackName', 'supervisedPropertySetterCallbackOwner', and 'supervisedPropertySetterCallbackName'.
Parameters:
Name Type Attributes Default Description supervisedPropertyOwnerobject The owner of the propertry being supervised.
supervisedPropertyNamestring The name of the propertry being supervised.
validationFunctionOwnerobject <optional>
The owner of an optional validation function. This function receives, sanitizes, and returns the supervised property.
validationFunctionNamestring <optional>
The name of an optional validation function. This function receives, sanitizes, and returns the supervised property.
-
performStandardSetupForMultiSupervision(standardSetupPropertyOwnerArray, supervisedPropertyName, validationFunctionOwner (opt), validationFunctionName (opt))
-
Creates and connects to 'standard' setter and getter functions for "multi-supervision" scenarios; For more custom functionality, such as conditional getting and setting functionality, custom getter and setter functions can be built and linked to directly using 'supervisedPropertyGetterCallbackOwner', 'supervisedPropertyGetterCallbackName', 'supervisedPropertySetterCallbackOwner', and 'supervisedPropertySetterCallbackName'.
Parameters:
Name Type Attributes Default Description standardSetupPropertyOwnerArrayArray The array where the objects owning the supervised properties will be referenced.
supervisedPropertyNamestring | Array.<string> The name of the propertry being supervised. An array can be supplied here if the supervised property not a direct member.
validationFunctionOwnerobject <optional>
The owner of an optional validation function. This function receives, sanitizes, and returns the supervised property.
validationFunctionNamestring <optional>
The name of an optional validation function. This function receives, sanitizes, and returns the supervised property.
-
setSupervisedProperty(value)
-
Sets the supervised property's value. This call is invoked upon the end-user manipulation of the associated visual components.
Parameters:
Name Type Attributes Default Description valueany The value to set the supervised property to.