sksg::Node Class Reference

#include <SkSGNode.h>

Inheritance diagram for sksg::Node:

Classes
class	ScopedFlag

Public Member Functions
const SkRect &	revalidate (InvalidationController *, const SkMatrix &)
void	invalidate (bool damage=true)
Public Member Functions inherited from SkRefCntBase
	SkRefCntBase ()
virtual	~SkRefCntBase ()
bool	unique () const
void	ref () const
void	unref () const

Protected Types
enum	InvalTraits { kBubbleDamage_Trait = 1 << 0 , kOverrideDamage_Trait = 1 << 1 }

Protected Member Functions
	Node (uint32_t invalTraits)
	~Node () override
const SkRect &	bounds () const
bool	hasInval () const
virtual SkRect	onRevalidate (InvalidationController *, const SkMatrix &ctm)=0
void	observeInval (const sk_sp< Node > &)
void	unobserveInval (const sk_sp< Node > &)

Friends
class	NodePriv
class	RenderNode

Detailed Description

Base class for all scene graph nodes.

Handles ingress edge management for the DAG (i.e. node -> "parent" node mapping), and invalidation.

Note: egress edges are only implemented/supported in container subclasses (e.g. Group, Effect, Draw).

Definition at line 33 of file SkSGNode.h.

Member Enumeration Documentation

InvalTraits

enum sksg::Node::InvalTraits

protected

Enumerator
kBubbleDamage_Trait
kOverrideDamage_Trait

Definition at line 43 of file SkSGNode.h.

                     {
        // Nodes with this trait never generate direct damage -- instead,
        // the damage bubbles up to ancestors.
        kBubbleDamage_Trait   = 1 << 0,
 
        // Nodes with this trait obscure the descendants' damage and always override it.
        kOverrideDamage_Trait = 1 << 1,
    };

Constructor & Destructor Documentation

Node()

Node::Node ( uint32_t  invalTraits )

explicitprotected

Definition at line 45 of file SkSGNode.cpp.

    : fInvalObserver(nullptr)
    , fBounds(SkRectPriv::MakeLargeS32())
    , fInvalTraits(invalTraits)
    , fFlags(kInvalidated_Flag)
    , fNodeFlags(0) {}

~Node()

Node::~Node ( )

overrideprotected

Definition at line 52 of file SkSGNode.cpp.

            {
    if (fFlags & kObserverArray_Flag) {
        SkASSERT(fInvalObserverArray->empty());
        delete fInvalObserverArray;
    } else {
        SkASSERT(!fInvalObserver);
    }
}

Member Function Documentation

bounds()

const SkRect & sksg::Node::bounds ( ) const

inlineprotected

Definition at line 55 of file SkSGNode.h.

                                 {
        SkASSERT(!this->hasInval());
        return fBounds;
    }

hasInval()

bool sksg::Node::hasInval ( ) const

inlineprotected

Definition at line 60 of file SkSGNode.h.

{ return fFlags & kInvalidated_Flag; }

invalidate()

void Node::invalidate

(

bool

damage = true

)

Definition at line 113 of file SkSGNode.cpp.

                                         {
    TRAVERSAL_GUARD;
 
    if (this->hasInval() && (!damageBubbling || (fFlags & kDamage_Flag))) {
        // All done.
        return;
    }
 
    if (damageBubbling && !(fInvalTraits & kBubbleDamage_Trait)) {
        // Found a damage observer.
        fFlags |= kDamage_Flag;
        damageBubbling = false;
    }
 
    fFlags |= kInvalidated_Flag;
 
    forEachInvalObserver([&](Node* observer) {
        observer->invalidate(damageBubbling);
    });
}

observeInval()

void Node::observeInval ( const sk_sp< Node > &  node )

protected

Definition at line 61 of file SkSGNode.cpp.

                                               {
    SkASSERT(node);
    if (!(node->fFlags & kObserverArray_Flag)) {
        if (!node->fInvalObserver) {
            node->fInvalObserver = this;
            return;
        }
 
        auto observers = new std::vector<Node*>();
        observers->reserve(2);
        observers->push_back(node->fInvalObserver);
 
        node->fInvalObserverArray = observers;
        node->fFlags |= kObserverArray_Flag;
    }
 
    // No duplicate observers.
    SkASSERT(std::find(node->fInvalObserverArray->begin(),
                       node->fInvalObserverArray->end(), this) == node->fInvalObserverArray->end());
 
    node->fInvalObserverArray->push_back(this);
}

onRevalidate()

virtual SkRect sksg::Node::onRevalidate ( InvalidationController *  , const SkMatrix &  ctm  )

protectedpure virtual

Implemented in sksg::ColorFilter, sksg::GeometryEffect, sksg::Shader, sksg::ImageFilter, sksg::ClipEffect, sksg::Draw, sksg::EffectNode, sksg::Group, sksg::Image, sksg::MaskEffect, sksg::Merge, sksg::OpacityEffect, sksg::Color, sksg::ShaderPaint, sksg::Path, sksg::Plane, sksg::Rect, sksg::RRect, sksg::ShaderEffect, sksg::ImageFilterEffect, sksg::Text, sksg::Matrix< T >, sksg::Matrix< SkM44 >, sksg::Matrix< SkMatrix >, sksg::TransformEffect, skottie::internal::MotionBlurEffect, and skottie::internal::TextAdapter::GlyphDecoratorNode.

revalidate()

const SkRect & Node::revalidate	(	InvalidationController *	ic,
		const SkMatrix &	ctm
	)

Definition at line 134 of file SkSGNode.cpp.

                                                                              {
    TRAVERSAL_GUARD fBounds;
 
    if (!this->hasInval()) {
        return fBounds;
    }
 
    const auto generate_damage =
            ic && ((fFlags & kDamage_Flag) || (fInvalTraits & kOverrideDamage_Trait));
    if (!generate_damage) {
        // Trivial transitive revalidation.
        fBounds = this->onRevalidate(ic, ctm);
    } else {
        // Revalidate and emit damage for old-bounds, new-bounds.
        const auto prev_bounds = fBounds;
 
        auto* ic_override = (fInvalTraits & kOverrideDamage_Trait) ? nullptr : ic;
        fBounds = this->onRevalidate(ic_override, ctm);
 
        ic->inval(prev_bounds, ctm);
        if (fBounds != prev_bounds) {
            ic->inval(fBounds, ctm);
        }
    }
 
    fFlags &= ~(kInvalidated_Flag | kDamage_Flag);
 
    return fBounds;
}

unobserveInval()

void Node::unobserveInval ( const sk_sp< Node > &  node )

protected

Definition at line 84 of file SkSGNode.cpp.

                                                 {
    SkASSERT(node);
    if (!(node->fFlags & kObserverArray_Flag)) {
        SkASSERT(node->fInvalObserver == this);
        node->fInvalObserver = nullptr;
        return;
    }
 
    SkDEBUGCODE(const auto origSize = node->fInvalObserverArray->size());
    node->fInvalObserverArray->erase(std::remove(node->fInvalObserverArray->begin(),
                                                 node->fInvalObserverArray->end(), this),
                                     node->fInvalObserverArray->end());
    SkASSERT(node->fInvalObserverArray->size() == origSize - 1);
}

Friends And Related Symbol Documentation

NodePriv

friend class NodePriv

friend

Definition at line 93 of file SkSGNode.h.

RenderNode

friend class RenderNode

friend

Definition at line 94 of file SkSGNode.h.

Member Data Documentation

fInvalObserver

Node* sksg::Node::fInvalObserver

Definition at line 84 of file SkSGNode.h.

fInvalObserverArray

std::vector<Node*>* sksg::Node::fInvalObserverArray

Definition at line 85 of file SkSGNode.h.

---

The documentation for this class was generated from the following files:

• third_party/skia/modules/sksg/include/SkSGNode.h
• third_party/skia/modules/sksg/src/SkSGNode.cpp