Enumeration RedrawRequestReasonFlag

Enum listing the high level reasons for requesting viewport redraw.

Constructors

Values

ActorActiveChanged = 1024

Indicates that a redraw was requested because an actor active state changed.

ActorMobilityChanged = 512

Indicates that a redraw was requested because an actor mobility flags changed.

ActorSceneChanged = 2048

Indicates that a redraw was requested because an actor has changed it's scene.

ActorTransformChanged = 256

Indicates that a redraw was requested because an actor transform changed.

AsyncTechniqueCompiled = 262144

Indicates that a redraw was requested because a technique was compiled asynchronously.

ComponentCreated = 4

Indicates that a redraw was requested because a new component was created.

ComponentDestroyed = 8

Indicates that a redraw was requested because a component was destroyed.

CoreDataChanged = 131072

Indicates that a redraw was requested because a core data changed. This event typically originates from Actors or Components.

Other = 2147483648

Indicates that a redraw was requested because of another, unspecified reason.

PropertyChanged = 4096

Indicates that a redraw was requested because a generic property has changed scene.

RenderableChanged = 65536

Indicates that a redraw was requested because a renderable changed.

RenderSettingsChanged = 64

Indicates that a redraw was requested because the render settings have changed.

SceneGizmosChanged = 32

Indicates that a redraw was requested because a scene gizmo has changed.

SceneObjectCreated = 1

Indicates that a redraw was requested because a new SceneObject was created.

SceneObjectDestroyed = 2

Indicates that a redraw was requested because a SceneObject was destroyed.

SceneObjectTransformChanged = 8192

Indicates that a redraw was requested because an scene object transform changed.

SceneSelectionChanged = 16

Indicates that a redraw was requested because a selection has changed.

SettingsChanged = 128

Indicates that a redraw was requested because the settings have changed.

ShadowBake = 16384

Indicates that a redraw was requested because a light shadow map was baked.

StreamingDataChanged = 32768

Indicates that a redraw was requested because a resource streaming data has changed.

Methods

  • Takes an array of enum values and combines them as a single enum flag value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.

    Type Parameters

    Parameters

    Returns EnumValueTyped<T, number>

    The combined enum value.

  • Type Parameters

    • T

    Parameters

    Returns string

    Compatibility

  • Returns string[]

    Compatibility

  • Parameters

    • index: number

    Returns number

    Compatibility

  • Returns number[]

    Compatibility

  • Gets the name for the enumeration value that matches the specified enumValue.

    Type Parameters

    • T

    Parameters

    Returns string

    The enumeration value or undefined if not found.

  • Gets the enumeration names

    Returns string[]

    The enumeration names.

  • Gets the enumeration value at the specified index.

    Type Parameters

    • T = number

    Parameters

    • index: number

      The index.

    Returns EnumValueTyped<T, number>

    The enumeration value or undefined if not found.

  • Determines if the enum value has the flags set.

    Type Parameters

    Parameters

    Returns boolean

  • Determines if the enum bits were changed from previousValue to currentValue.

    Type Parameters

    Parameters

    Returns boolean

  • Iterates the enumeration names

    Returns Generator<string, any, any>

    The enumeration names.

  • Iterates the enumeration values

    Type Parameters

    • T = any

    Returns Generator<EnumValueTyped<T, number>, any, any>

    The enumeration values.

  • Takes a single enum value and splits it into separated flag values set on the value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.

    Type Parameters

    Parameters

    • value: number | BrandedType<number, "enum"> | BrandedType<T, "enum">

      The enum value to have it's value split using bitwise-and operator.

    Returns EnumValueTyped<T, number>[]

    An array of each "bit flag" set in the enum.