#include <SkottieUtils.h>

Classes
struct	MarkerInfo

class	MarkerInterceptor

class	PropertyInterceptor

Public Types
enum class	Mode { kCollapseProperties , kNamespacedProperties }

using	PropKey = std::string

Public Member Functions
	CustomPropertyManager (Mode=Mode::kNamespacedProperties, const char *prefix=nullptr)

	~CustomPropertyManager ()

std::vector< PropKey >	getColorProps () const

skottie::ColorPropertyValue	getColor (const PropKey &) const

std::unique_ptr< skottie::ColorPropertyHandle >	getColorHandle (const PropKey &, size_t) const

bool	setColor (const PropKey &, const skottie::ColorPropertyValue &)

std::vector< PropKey >	getOpacityProps () const

skottie::OpacityPropertyValue	getOpacity (const PropKey &) const

std::unique_ptr< skottie::OpacityPropertyHandle >	getOpacityHandle (const PropKey &, size_t) const

bool	setOpacity (const PropKey &, const skottie::OpacityPropertyValue &)

std::vector< PropKey >	getTransformProps () const

skottie::TransformPropertyValue	getTransform (const PropKey &) const

std::unique_ptr< skottie::TransformPropertyHandle >	getTransformHandle (const PropKey &, size_t) const

bool	setTransform (const PropKey &, const skottie::TransformPropertyValue &)

std::vector< PropKey >	getTextProps () const

skottie::TextPropertyValue	getText (const PropKey &) const

std::unique_ptr< skottie::TextPropertyHandle >	getTextHandle (const PropKey &, size_t index) const

bool	setText (const PropKey &, const skottie::TextPropertyValue &)

const std::vector< MarkerInfo > &	markers () const

sk_sp< skottie::PropertyObserver >	getPropertyObserver () const

sk_sp< skottie::MarkerObserver >	getMarkerObserver () const

Detailed Description

CustomPropertyManager implements a property management scheme where color/opacity/transform attributes are grouped and manipulated by name (one-to-many mapping).

setters apply the value to all properties in a named group
getters return all the managed property groups, and the first value within each of them (unchecked assumption: all properties within the same group have the same value)

Attach to an Animation::Builder using the utility methods below to intercept properties and markers at build time.

Definition at line 46 of file SkottieUtils.h.

Member Typedef Documentation

◆ PropKey

using skottie_utils::CustomPropertyManager::PropKey = std::string

Definition at line 58 of file SkottieUtils.h.

Member Enumeration Documentation

◆ Mode

enum class skottie_utils::CustomPropertyManager::Mode

strong

Enumerator
kCollapseProperties
kNamespacedProperties

Definition at line 48 of file SkottieUtils.h.

                    {
        kCollapseProperties,   // keys ignore the ancestor chain and are
                               // grouped based on the local node name
        kNamespacedProperties, // keys include the ancestor node names (no grouping)
    };

Constructor & Destructor Documentation

◆ CustomPropertyManager()

skottie_utils::CustomPropertyManager::CustomPropertyManager	(	Mode	mode = `Mode::kNamespacedProperties`,
		const char *	prefix = `nullptr`
	)

explicit

Definition at line 97 of file SkottieUtils.cpp.

    : fMode(mode)
    , fPrefix(prefix ? prefix : "$")
    , fPropertyInterceptor(sk_make_sp<PropertyInterceptor>(this))
    , fMarkerInterceptor(sk_make_sp<MarkerInterceptor>(this)) {}

◆ ~CustomPropertyManager()

skottie_utils::CustomPropertyManager::~CustomPropertyManager ( )

default

Member Function Documentation

◆ getColor()

skottie::ColorPropertyValue skottie_utils::CustomPropertyManager::getColor ( const PropKey & key ) const

Definition at line 178 of file SkottieUtils.cpp.

                                                                                  {
    return this->get<skottie::ColorPropertyValue>(key, fColorMap);
}

◆ getColorHandle()

std::unique_ptr< skottie::ColorPropertyHandle > skottie_utils::CustomPropertyManager::getColorHandle	(	const PropKey &	key,
		size_t	index
	)		const

Definition at line 183 of file SkottieUtils.cpp.

                                                                            {
    return this->getHandle(key, index, fColorMap);
}

◆ getColorProps()

std::vector< CustomPropertyManager::PropKey > skottie_utils::CustomPropertyManager::getColorProps ( ) const

Definition at line 174 of file SkottieUtils.cpp.

                                           {
    return this->getProps(fColorMap);
}

◆ getMarkerObserver()

sk_sp< skottie::MarkerObserver > skottie_utils::CustomPropertyManager::getMarkerObserver ( ) const

Definition at line 119 of file SkottieUtils.cpp.

                                                                            {
    return fMarkerInterceptor;
}

◆ getOpacity()

skottie::OpacityPropertyValue skottie_utils::CustomPropertyManager::getOpacity ( const PropKey & key ) const

Definition at line 196 of file SkottieUtils.cpp.

                                                                                      {
    return this->get<skottie::OpacityPropertyValue>(key, fOpacityMap);
}

◆ getOpacityHandle()

std::unique_ptr< skottie::OpacityPropertyHandle > skottie_utils::CustomPropertyManager::getOpacityHandle	(	const PropKey &	key,
		size_t	index
	)		const

Definition at line 201 of file SkottieUtils.cpp.

                                                                              {
    return this->getHandle(key, index, fOpacityMap);
}

◆ getOpacityProps()

std::vector< CustomPropertyManager::PropKey > skottie_utils::CustomPropertyManager::getOpacityProps ( ) const

Definition at line 192 of file SkottieUtils.cpp.

                                             {
    return this->getProps(fOpacityMap);
}

◆ getPropertyObserver()

sk_sp< skottie::PropertyObserver > skottie_utils::CustomPropertyManager::getPropertyObserver ( ) const

Definition at line 115 of file SkottieUtils.cpp.

                                                                                {
    return fPropertyInterceptor;
}

◆ getText()

skottie::TextPropertyValue skottie_utils::CustomPropertyManager::getText ( const PropKey & key ) const

Definition at line 233 of file SkottieUtils.cpp.

                                                                                {
    return this->get<skottie::TextPropertyValue>(key, fTextMap);
}

◆ getTextHandle()

std::unique_ptr< skottie::TextPropertyHandle > skottie_utils::CustomPropertyManager::getTextHandle	(	const PropKey &	key,
		size_t	index
	)		const

Definition at line 238 of file SkottieUtils.cpp.

                                                                           {
    return this->getHandle(key, index, fTextMap);
}

◆ getTextProps()

std::vector< CustomPropertyManager::PropKey > skottie_utils::CustomPropertyManager::getTextProps ( ) const

Definition at line 229 of file SkottieUtils.cpp.

                                          {
    return this->getProps(fTextMap);
}

◆ getTransform()

skottie::TransformPropertyValue skottie_utils::CustomPropertyManager::getTransform ( const PropKey & key ) const

Definition at line 214 of file SkottieUtils.cpp.

                                                                                          {
    return this->get<skottie::TransformPropertyValue>(key, fTransformMap);
}

◆ getTransformHandle()

std::unique_ptr< skottie::TransformPropertyHandle > skottie_utils::CustomPropertyManager::getTransformHandle	(	const PropKey &	key,
		size_t	index
	)		const

Definition at line 219 of file SkottieUtils.cpp.

                                                                                {
    return this->getHandle(key, index, fTransformMap);
}

◆ getTransformProps()

std::vector< CustomPropertyManager::PropKey > skottie_utils::CustomPropertyManager::getTransformProps ( ) const

Definition at line 210 of file SkottieUtils.cpp.

                                               {
    return this->getProps(fTransformMap);
}

◆ markers()

const std::vector< MarkerInfo > & skottie_utils::CustomPropertyManager::markers ( ) const

inline

Definition at line 85 of file SkottieUtils.h.

85{ return fMarkers; }

◆ setColor()

bool skottie_utils::CustomPropertyManager::setColor	(	const PropKey &	key,
		const skottie::ColorPropertyValue &	c
	)

Definition at line 187 of file SkottieUtils.cpp.

                                                                                           {
    return this->set(key, c, fColorMap);
}

◆ setOpacity()

bool skottie_utils::CustomPropertyManager::setOpacity	(	const PropKey &	key,
		const skottie::OpacityPropertyValue &	o
	)

Definition at line 205 of file SkottieUtils.cpp.

                                                                                               {
    return this->set(key, o, fOpacityMap);
}

◆ setText()

bool skottie_utils::CustomPropertyManager::setText	(	const PropKey &	key,
		const skottie::TextPropertyValue &	o
	)

Definition at line 242 of file SkottieUtils.cpp.

                                                                                         {
    return this->set(key, o, fTextMap);
}

◆ setTransform()

bool skottie_utils::CustomPropertyManager::setTransform	(	const PropKey &	key,
		const skottie::TransformPropertyValue &	t
	)

Definition at line 223 of file SkottieUtils.cpp.

                                                                                 {
    return this->set(key, t, fTransformMap);
}

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

third_party/skia/modules/skottie/utils/SkottieUtils.h
third_party/skia/modules/skottie/utils/SkottieUtils.cpp

Classes

Public Types

Public Member Functions