Use a brush to fill a Node2D. More...

#include <kanzi/core.ui/graphics2d/brush.hpp>

Inheritance diagram for kanzi::Brush:

Public Member Functions
virtual BrushSharedPtr	clone ()=0
	Creates a clone of a brush.

virtual BrushRendererPtr	createBrushRenderer (Node *node)=0
	Creates a brush renderer for a brush.

unsigned int	getPropertyChangeCounter () const
	Accesses the property change counter.

Vector2	getTiling () const
	Gets the tiling vector.

bool	isRenderable ()
	Indicates whether a brush is renderable.

void	updatePropertyChangeCounter ()
	Updates the property change counter.

Public Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource.

const string &	getName () const
	Gets the resource name.

const string &	getUrl () const
	Gets the resource URL.

bool	isKeepAlive () const
	Tells if the resource has keep alive flag set.

void	reload ()

void	reloadFromFile (string_view filePath)

void	reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

void	setKeepAlive (bool keepAlive)
	Sets the keep alive flag.

void	setUrl (string_view url)
	Sets the resource URL.

	~Resource () override
	Destructor.

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object.

void	applyObjectStyles ()
	Apply all styles for an object node.

Domain *	getDomain () const
	Returns the domain the object belongs to.

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object.

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain.

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object.

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object.

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object.

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object.

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles.

	~Object () override

Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it.

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Adds a property modifier without notifying handlers.

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container.

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object.

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object.

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers.

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type.

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers.

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property.

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property.

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value.

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

	PropertyObject ()

void	removeKzbProperties ()
	Remove all KZB properties.

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set.

template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property.

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type.

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

virtual	~PropertyObject ()

Static Public Member Functions
static BrushSharedPtr	acquireNullBrush (ResourceManager &resourceManager)
	Acquires the default null brush.

static ResourceManager::LoadTaskSharedPtr	createLoadTask (string_view name, KzbFile *kzbFile, ReadOnlyMemoryFilePtr file)
	Factory function for Brush Load Task, which loads a brush from a kzb file.

static const char *	getNullBrushUrl ()
	Gets the kzb URL of the null brush.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Protected Member Functions
	Brush (Domain *domain, string_view name)
	Constructor.

virtual bool	isRenderableOverride ()
	Implementation-specific renderable check.

void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
	Object::onPropertyChanged() implementation.

Protected Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsageOverride () const

virtual void	reloadFromFileOverride (string_view filePath)

virtual void	reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

virtual void	reloadOverride ()

	Resource (Domain *domain, string_view name)
	Constructor.

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
void	initialize ()

	MetaObject ()

Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value.

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

template<typename DataType >
void	addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
	Adds a property modifier entry to the property modifier stack and validates them.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source.

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage.

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor.

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor.

virtual void	notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage.

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage.

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source.

void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers.

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers.

Protected Attributes
unsigned int	m_propertyChangeCounter
	Counter for tracking property updates in the brush.

Vector2	m_tiling
	Tiling coordinate multipliers in both directions.

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object.

Properties
static PropertyType< ColorRGBA >	ModulateColorProperty
	Sets the modulation color for a brush.

static PropertyType< float >	HorizontalTilingProperty
	Sets the scale of the texture coordinates to set the horizontal tiling.

static PropertyType< float >	VerticalTilingProperty
	Sets the scale of the texture coordinates to set the vertical tiling.

ColorRGBA	getModulateColor () const
	Gets the value of ModulateColorProperty.

void	setModulateColor (ColorRGBA value)
	Sets the value of ModulateColorProperty.

float	getHorizontalTiling () const
	Gets the value of HorizontalTilingProperty.

void	setHorizontalTiling (float value)
	Sets the value of HorizontalTilingProperty.

float	getVerticalTiling () const
	Gets the value of VerticalTilingProperty.

void	setVerticalTiling (float value)
	Sets the value of VerticalTilingProperty.

Additional Inherited Members
Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container.

Detailed Description

Use a brush to fill a Node2D.

To set a Node2D to use a brush:

Node2D::setBackgroundBrush sets the brush that fills the background of the node.
Node2D::setForegroundBrush sets the brush that fills the foreground of the node.
Node2D::setCompositionBrush sets the material brush to use when compositing the node.

See Using brushes.

To render a brush manually, use the BrushRenderer.

Since: Kanzi 3.9.9 removed the getBlendMode(), isOpaque(), isTranslucent(), setContentTranslucent(), and setRenderable() functions, and the TranslucencyBits enumerator.

Constructor & Destructor Documentation

◆ Brush()

kanzi::Brush::Brush	(	Domain *	domain,
		string_view	name )

inlineexplicitprotected

Constructor.

Parameters

domain	The domain to which the brush belongs.
name	The name of the brush.

Member Function Documentation

◆ getModulateColor()

ColorRGBA kanzi::Brush::getModulateColor ( ) const

inline

Gets the value of ModulateColorProperty.

See also: setModulateColor()

◆ setModulateColor()

void kanzi::Brush::setModulateColor ( ColorRGBA value )

inline

Sets the value of ModulateColorProperty.

See also: getModulateColor()

◆ getHorizontalTiling()

float kanzi::Brush::getHorizontalTiling ( ) const

inline

Gets the value of HorizontalTilingProperty.

See also: setHorizontalTiling()

◆ setHorizontalTiling()

void kanzi::Brush::setHorizontalTiling ( float value )

inline

Sets the value of HorizontalTilingProperty.

See also: getHorizontalTiling()

◆ getVerticalTiling()

float kanzi::Brush::getVerticalTiling ( ) const

inline

Gets the value of VerticalTilingProperty.

See also: setVerticalTiling()

◆ setVerticalTiling()

void kanzi::Brush::setVerticalTiling ( float value )

inline

Sets the value of VerticalTilingProperty.

See also: getVerticalTiling()

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::Brush::makeEditorInfo ( )

static

◆ createBrushRenderer()

virtual BrushRendererPtr kanzi::Brush::createBrushRenderer ( Node * node )

pure virtual

Creates a brush renderer for a brush.

Parameters

node	The node to which to attach the brush renderer.

Returns: The brush renderer.

Implemented in kanzi::ColorBrush, kanzi::CompositionBrush, kanzi::ContentBrush, kanzi::NullBrush, kanzi::TextureBrush, and kanzi::MaterialBrush.

◆ clone()

virtual BrushSharedPtr kanzi::Brush::clone ( )

pure virtual

Creates a clone of a brush.

Returns: Shared pointer to the clone of the brush.

Implemented in kanzi::ColorBrush, kanzi::CompositionBrush, kanzi::ContentBrush, kanzi::NullBrush, kanzi::TextureBrush, and kanzi::MaterialBrush.

◆ getPropertyChangeCounter()

unsigned int kanzi::Brush::getPropertyChangeCounter ( ) const

inline

Accesses the property change counter.

◆ updatePropertyChangeCounter()

void kanzi::Brush::updatePropertyChangeCounter ( )

inline

Updates the property change counter.

◆ getTiling()

Vector2 kanzi::Brush::getTiling ( ) const

inline

Gets the tiling vector.

Returns: The tiling vector.

◆ isRenderable()

bool kanzi::Brush::isRenderable ( )

inline

Indicates whether a brush is renderable.

All brushes except the null brush are inherently renderable. Even if the rendering-related properties of a brush are set to values that result in an invalid state, this function still returns whether that brush is theoretically renderable.

To find out whether a brush renderer is renderable, use BrushRenderer::isRenderable().

Returns: If the brush is renderable, true, otherwise false.

◆ getNullBrushUrl()

static const char * kanzi::Brush::getNullBrushUrl ( )

inlinestatic

Gets the kzb URL of the null brush.

◆ acquireNullBrush()

static BrushSharedPtr kanzi::Brush::acquireNullBrush ( ResourceManager & resourceManager )

static

Acquires the default null brush.

◆ createLoadTask()

static ResourceManager::LoadTaskSharedPtr kanzi::Brush::createLoadTask	(	string_view	name,
		KzbFile *	kzbFile,
		ReadOnlyMemoryFilePtr	file )

static

Factory function for Brush Load Task, which loads a brush from a kzb file.

Parameters

name	Name of the brush to load.
kzbFile	Pointer to instance of KzbFile, which holds information about the kzb file.
file	Pointer to instance of ReadOnlyMemoryFile, which wraps the kzb file.

Returns: Shared pointer to the created load task.

◆ onPropertyChanged()

void kanzi::Brush::onPropertyChanged	(	AbstractPropertyType	propertyType,
		PropertyNotificationReason	reason )

overrideprotectedvirtual

Object::onPropertyChanged() implementation.

Reimplemented from kanzi::PropertyObject.

Reimplemented in kanzi::ColorBrush, kanzi::TextureBrush, and kanzi::MaterialBrush.

◆ isRenderableOverride()

virtual bool kanzi::Brush::isRenderableOverride ( )

protectedvirtual

Implementation-specific renderable check.

Default implementation always returns true.

Returns: If the brush is renderable, true, otherwise false.

Reimplemented in kanzi::NullBrush.

Member Data Documentation

◆ ModulateColorProperty

PropertyType<ColorRGBA> kanzi::Brush::ModulateColorProperty

static

Sets the modulation color for a brush.

The default value is sRGB ColorRGBA(1.0f, 1.0f, 1.0f, 1.0f).

See also: setModulateColor(), getModulateColor()

◆ HorizontalTilingProperty

PropertyType<float> kanzi::Brush::HorizontalTilingProperty

static

Sets the scale of the texture coordinates to set the horizontal tiling.

The default value is 1.0f.

See also: setHorizontalTiling(), getHorizontalTiling()

◆ VerticalTilingProperty

PropertyType<float> kanzi::Brush::VerticalTilingProperty

static

Sets the scale of the texture coordinates to set the vertical tiling.

The default value is 1.0f.

See also: setVerticalTiling(), getVerticalTiling()

◆ m_tiling

Vector2 kanzi::Brush::m_tiling

protected

Tiling coordinate multipliers in both directions.

Since: Kanzi 3.9.1 protection changed from private to protected.

◆ m_propertyChangeCounter

unsigned int kanzi::Brush::m_propertyChangeCounter

protected

Counter for tracking property updates in the brush.

To know when the brush was updated, the brush renderer stores the last state of this counter.

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

kanzi/core.ui/graphics2d/brush.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Brush()

Member Function Documentation

◆ getModulateColor()

◆ setModulateColor()

◆ getHorizontalTiling()

◆ setHorizontalTiling()

◆ getVerticalTiling()

◆ setVerticalTiling()

◆ makeEditorInfo()

◆ createBrushRenderer()

◆ clone()

◆ getPropertyChangeCounter()

◆ updatePropertyChangeCounter()

◆ getTiling()

◆ isRenderable()

◆ getNullBrushUrl()

◆ acquireNullBrush()

◆ createLoadTask()

◆ onPropertyChanged()

◆ isRenderableOverride()

Member Data Documentation

◆ ModulateColorProperty

◆ HorizontalTilingProperty

◆ VerticalTilingProperty

◆ m_tiling

◆ m_propertyChangeCounter