Enumeration RedrawRequestReasonFlag

Enum listing the high level reasons for requesting viewport redraw.

Constructors

Values

ActorActiveChanged: EnumValue<RedrawRequestReasonFlag, number>

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

ActorMobilityChanged: EnumValue<RedrawRequestReasonFlag, number>

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

ActorSceneChanged: EnumValue<RedrawRequestReasonFlag, number>

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

ActorTransformChanged: EnumValue<RedrawRequestReasonFlag, number>

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

AsyncTechniqueCompiled: EnumValue<RedrawRequestReasonFlag, number>

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

ComponentCreated: EnumValue<RedrawRequestReasonFlag, number>

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

ComponentDestroyed: EnumValue<RedrawRequestReasonFlag, number>

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

CoreDataChanged: EnumValue<RedrawRequestReasonFlag, number>

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

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

PropertyChanged: EnumValue<RedrawRequestReasonFlag, number>

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

RenderableChanged: EnumValue<RedrawRequestReasonFlag, number>

Indicates that a redraw was requested because a renderable changed.

RenderSettingsChanged: EnumValue<RedrawRequestReasonFlag, number>

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

SceneGizmosChanged: EnumValue<RedrawRequestReasonFlag, number>

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

SceneObjectCreated: EnumValue<RedrawRequestReasonFlag, number>

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

SceneObjectDestroyed: EnumValue<RedrawRequestReasonFlag, number>

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

SceneObjectTransformChanged: EnumValue<RedrawRequestReasonFlag, number>

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

SceneSelectionChanged: EnumValue<RedrawRequestReasonFlag, number>

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

SettingsChanged: EnumValue<RedrawRequestReasonFlag, number>

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

ShadowBake: EnumValue<RedrawRequestReasonFlag, number>

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

StreamingDataChanged: EnumValue<RedrawRequestReasonFlag, number>

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.