include/rive/component_dirt.hpp

#ifndef _RIVE_DIRTY_FLAGS_HPP_
#define _RIVE_DIRTY_FLAGS_HPP_

#include "rive/enums.hpp"

namespace rive
{
enum class ComponentDirt : unsigned short
{
    None = 0,

    /// Used to mark that a component (and subsequently it's children) do not
    /// update with the Artboard update cycle and that any drawable should also
    /// be hidden. Used by Solos.
    Collapsed = 1 << 0,

    Dependents = 1 << 1,

    /// General flag for components are dirty (if this is up, the update
    /// cycle runs). It gets automatically applied with any other dirt.
    Components = 1 << 2,

    /// Draw order needs to be re-computed.
    DrawOrder = 1 << 3,

    /// Path is dirty and needs to be rebuilt.
    Path = 1 << 4,

    /// TextShape is dirty and needs to be rebuilt.
    TextShape = 1 << 4,

    /// Skin needs to recompute bone transformations.
    Skin = 1 << 4,

    /// Vertices have changed, re-order cached lists.
    Vertices = 1 << 5,

    /// Text modifier coverage is dirty and needs to be rebuilt.
    TextCoverage = 1 << 5,

    /// Used by any component that needs to recompute their local transform.
    /// Usually components that have their transform dirty will also have
    /// their worldTransform dirty.
    Transform = 1 << 6,

    /// Used by any component that needs to update its world transform.
    WorldTransform = 1 << 7,

    /// Marked when the stored render opacity needs to be updated.
    RenderOpacity = 1 << 8,

    /// Dirt used to mark some stored paint needs to be rebuilt or that we
    /// just want to trigger an update cycle so painting occurs.
    Paint = 1 << 9,

    /// Used by the gradients track when the stops need to be re-ordered.
    Stops = 1 << 10,

    /// Blend modes need to be updated
    // TODO: do we need this?
    // BlendMode = 1 << 9,

    LayoutStyle = 1 << 11,

    /// Used by data binds to track the value has changed.
    Bindings = 1 << 12,

    /// Set when components deformed by an NSlicer need to recalculate
    /// their render paths, mesh, points, etc.
    NSlicer = 1 << 13,

    /// Set by Core::notifyPropertyChanged on a DataBind when its TARGET
    /// property changes — distinct from Bindings (a source change). Lets a
    /// TwoWay bind run target→source without update()'s source→target apply
    /// clobbering the just-changed target value.
    BindingsTarget = 1 << 13,

    /// Set when a ScriptedObject needs to call update on the scripted
    /// interface.
    ScriptUpdate = 1 << 14,

    /// Clipping needs to be recalculated
    Clipping = 1 << 15,

    /// All dirty. Every flag (apart from Collapsed) is set.
    Filthy = 0xFFFE
};
} // namespace rive
#endif