new LazyUpdater(updateCallbackOwner, updateCallbackName, updateCallbackArgs (opt))
Object that manages the calling of a given callback, ensuring that it is only called when necessary. This is often used to ensure that calls to methods that are performance-expensive are as limited as possible. First connect the performance-heavy task via the constructor callback parameters, then later call the 'updateIfNeeded' method; if the 'needsUpdate' flag has been set to true since the last 'updateIfNeeded' call, then callback will occur, otherwise it is skipped. An example of how you can use this is in situation where you are doing manual rendering; you only want to render once per ScreenUpdate, and you don't want to render if nothing substantive has changed in the scene. In this case, you would set the 'needsUpdate' flag to true every time something in the scene is adjusted, and ensure that a call to 'updateIfNeeded' is placed in a ScreenUpdater-driven function.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
updateCallbackOwner |
object | The object owning the callback function being managed by this LazyUpdater. |
||
updateCallbackName |
string | The name of the callback function being managed by this LazyUpdater. |
||
updateCallbackArgs |
Array | any |
<optional> |
Arguments for the callback function. |
MEMBERS
-
inheritedTypes :object
-
Dictionary object listing all of the types this object is compatible with.
-
needsUpdate :boolean
-
Flag indicating whether the target method is in need of an update.
- Default Value:
- false
-
type :string
-
Type identifier.
METHODS
-
updateIfNeeded()
-
Calls the target method if the 'needsUpdate' flag is true, and sets it to false either way.