Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RenderFlags

A data structure for tracking a set of boolean status flags. This is a restricted set which can only accept flag values which are pre-defined.

param flags

An object which defines the flags which are supported for tracking

param [config]

Optional configuration

param [config.object]

The object which owns this RenderFlags instance

param [config.priority]

The ticker priority at which these render flags are handled

Hierarchy

  • Set
    • RenderFlags

Index

Constructors

Methods

Constructors

constructor

  • new RenderFlags(flags?: {}, __namedParameters?: { object: any; priority: any }): RenderFlags

  • Parameters

    • flags: {} = {}
      • __namedParameters: { object: any; priority: any } = {}
        • object: any
        • priority: any

      Returns RenderFlags

    Methods

    clear

    • clear(): any
    • inheritdoc

      Returns any

      The flags which were previously set that have been cleared.

    handle

    • handle(flag: string): boolean

    • Allow for handling one single flag at a time. This function returns whether the flag needs to be handled and removes it from the pending set.

      Parameters

      • flag: string

      Returns boolean

    set

    • set(changes: any): void

    • Activate certain flags, also toggling propagation and reset behaviors

      Parameters

      • changes: any

      Returns void

    Private #set

    • #set(flag: string, value: boolean, seen: Set<string>): void

    • Recursively set a flag. This method applies propagation or reset behaviors when flags are assigned.

      Parameters

      • flag: string
      • value: boolean
      • seen: Set<string>

      Returns void