kanzi::TextureBrush Class Reference

Texture brush class. More...

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

Inheritance diagram for kanzi::TextureBrush:

Public Member Functions
BrushSharedPtr	clone () override
	Brush::clone() implementation. More...
BrushRendererPtr	createBrushRenderer (Node *node) override
	Brush::createBrushRenderer() implementation. More...
Public Member Functions inherited from kanzi::Brush
optional< int >	getBlendMode () const
	Gets the blend mode assigned to the brush. More...
unsigned int	getPropertyChangeCounter () const
	Access property change counter. More...
Vector2	getTiling () const
	Get tiling vector. More...
bool	isOpaque () const
	Indicates whether the brush is opaque. More...
bool	isRenderable () const
	Tell whether or not the brush needs rendering. More...
bool	isTranslucent () const
	Indicates whether the brush is opaque. More...
void	updatePropertyChangeCounter ()
	Update property change counter. More...
ColorRGBA	getModulateColor () const
	Gets the value of ModulateColorProperty. More...
void	setModulateColor (ColorRGBA value)
	Sets the value of ModulateColorProperty. More...
float	getHorizontalTiling () const
	Gets the value of HorizontalTilingProperty. More...
void	setHorizontalTiling (float value)
	Sets the value of HorizontalTilingProperty. More...
float	getVerticalTiling () const
	Gets the value of VerticalTilingProperty. More...
void	setVerticalTiling (float value)
	Sets the value of VerticalTilingProperty. More...
Public Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource. More...
const string &	getName () const
	Gets the resource name. More...
const string &	getUrl () const
	Gets the resource URL. More...
bool	isKeepAlive () const
	Tells if the resource has keep alive flag set. More...
void	reload ()
void	reloadFromFile (string_view filePath)
void	reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
void	setKeepAlive (bool keepAlive)
	Sets the keep alive flag. More...
void	setUrl (string_view url)
	Sets the resource URL. More...
	~Resource () override
	Destructor. More...
Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...
void	applyObjectStyles ()
	Apply all styles for an object node. More...
Domain *	getDomain () const
	Returns the domain the object belongs to. More...
const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object. More...
MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain. More...
detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...
ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...
ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object. More...
	Object (Domain *domain)
void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object. More...
void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...
	~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. More...
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. More...
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, void *ownerPointer)
template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container. More...
PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container. More...
void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object. More...
void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object. More...
PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container. More...
PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container. More...
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. More...
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. More...
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type. More...
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers. More...
template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type. More...
bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property. More...
bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. More...
bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
	PropertyObject ()
void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set. More...
void	removeKzbProperties ()
	Remove all KZB properties. More...
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. More...
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. More...
void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers. More...
void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers. More...
virtual	~PropertyObject ()

Static Public Member Functions
static TextureBrushSharedPtr	create (Domain *domain, string_view name)
	Create a new texture brush. More...
static TextureBrushSharedPtr	create (Domain *domain, string_view name, TextureSharedPtr texture)
	Create a new texture brush. More...
static TextureBrushSharedPtr	create (Domain *domain, string_view name, TextureSharedPtr texture, const ColorRGBA &color)
	Create a new texture brush. More...
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
Static Public Member Functions inherited from kanzi::Brush
static BrushSharedPtr	acquireNullBrush (ResourceManager &resourceManager)
	Acquire default null brush. More...
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. More...
static const char *	getNullBrushUrl ()
	Get null brush URL. More...
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...
Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Protected Member Functions
void	calculateRenderingProperties ()
	Recalculate rendering properties. More...
void	initialize ()
	Object::initialize() interface. More...
void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
	Object::onPropertyChanged() implementation. More...
	TextureBrush (Domain *domain, string_view name)
	Constructor. More...
	TextureBrush (Domain *domain, string_view name, TextureSharedPtr texture)
	Constructor. More...
	TextureBrush (Domain *domain, string_view name, TextureSharedPtr texture, const ColorRGBA &color)
	Constructor. More...
Protected Member Functions inherited from kanzi::Brush
	Brush (Domain *domain, string_view name)
	Constructor. More...
void	setContentTranslucent (bool flag)
	Sets the status of the content translucency. More...
void	setRenderable (bool renderable)
	Set renderable status. More...
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. More...
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. More...
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. More...
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
	Internally adds a property value source. More...
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
	Internally adds a property value source. More...
AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage. More...
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. More...
PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type. More...
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...
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. More...
virtual void	notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage. More...
void	onCopy (const PropertyObject &other)
void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage. More...
void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
	Removes a property value source. More...
void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers. More...
void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers. More...

Properties
static PropertyType< ResourceSharedPtr >	RenderTextureProperty
	Texture property. More...
TextureSharedPtr	getRenderTexture () const
	Gets the value of RenderTextureProperty. More...
void	setRenderTexture (ResourceSharedPtr value)
	Sets the value of RenderTextureProperty. More...

Additional Inherited Members
Public Types inherited from kanzi::Brush
enum	TranslucencyBits { TranslucencyBitContent, TranslucencyBitBlendMode, TranslucencyBitCount }
	Brush opaque bits. More...
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
Static Public Attributes inherited from kanzi::Brush
static PropertyType< ColorRGBA >	ModulateColorProperty
	ModulateColor property. More...
static PropertyType< float >	HorizontalTilingProperty
	HorizontalTiling property. More...
static PropertyType< float >	VerticalTilingProperty
	VerticalTiling property. More...
Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. More...
Protected Attributes inherited from kanzi::Brush
optional< int >	m_blendMode
	Blend mode assigned to the brush. More...
bool	m_blendModeOpaque
	Flag for blend mode being opaque. More...
unsigned int	m_propertyChangeCounter
	Counter for tracking property updates in the brush. More...
bool	m_renderable
	Flag for renderable status. More...
Vector2	m_tiling
	Tiling coordinate multipliers in both directions. More...
bitset< TranslucencyBitCount >	m_translucent
	Flags for content being translucent. More...
Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Detailed Description

Texture brush class.

Implements a textured brush used to fill areas with patterns.

Constructor & Destructor Documentation

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

inlineexplicitprotected

Constructor.

Leaves all properties unset.

Parameters

domain	domain the brush belongs to.
name	Name of the brush.

kanzi::TextureBrush::TextureBrush ( Domain *  domain, string_view  name, TextureSharedPtr  texture  )

inlineexplicitprotected

Constructor.

Will use white modulating color by default.

Parameters

domain	domain the brush belongs to.
name	Name of the brush.
texture	Texture to use for rendering the brush.

kanzi::TextureBrush::TextureBrush ( Domain *  domain, string_view  name, TextureSharedPtr  texture, const ColorRGBA &  color  )

inlineexplicitprotected

Constructor.

Parameters

domain	domain the brush belongs to.
name	Name of the brush.
texture	Texture to use for rendering the brush.
color	Color to use for modulating the texture.

Member Function Documentation

TextureSharedPtr kanzi::TextureBrush::getRenderTexture ( ) const

inline

Gets the value of RenderTextureProperty.

See also

setRenderTexture()

void kanzi::TextureBrush::setRenderTexture ( ResourceSharedPtr  value )

inline

Sets the value of RenderTextureProperty.

See also

getRenderTexture()

static PropertyTypeEditorInfoSharedPtr kanzi::TextureBrush::makeEditorInfo ( )

static

static TextureBrushSharedPtr kanzi::TextureBrush::create ( Domain *  domain, string_view  name  )

static

Create a new texture brush.

Leaves all properties unset.

Parameters

domain	uiDomain the brush belongs to.
name	of this texture brush.

static TextureBrushSharedPtr kanzi::TextureBrush::create ( Domain *  domain, string_view  name, TextureSharedPtr  texture  )

static

Create a new texture brush.

Brush will retain shared ownership of texture passed.

Parameters

domain	uiDomain the brush belongs to.
name	of this texture brush.
texture	Texture to use for rendering the brush.

static TextureBrushSharedPtr kanzi::TextureBrush::create ( Domain *  domain, string_view  name, TextureSharedPtr  texture, const ColorRGBA &  color  )

static

Create a new texture brush.

Brush will retain shared ownership of texture passed.

Parameters

domain	uiDomain the brush belongs to.
name	of this texture brush.
texture	Texture to use for rendering the brush.
color	Color to use for modulating the texture.

BrushSharedPtr kanzi::TextureBrush::clone ( )

overridevirtual

Brush::clone() implementation.

Implements kanzi::Brush.

BrushRendererPtr kanzi::TextureBrush::createBrushRenderer ( Node *  node )

overridevirtual

Brush::createBrushRenderer() implementation.

Implements kanzi::Brush.

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

overrideprotectedvirtual

Object::onPropertyChanged() implementation.

Reimplemented from kanzi::Brush.

void kanzi::TextureBrush::calculateRenderingProperties ( )

protected

Recalculate rendering properties.

Must be called when a relevant property has been reassigned.

void kanzi::TextureBrush::initialize ( )

protected

Object::initialize() interface.

Member Data Documentation

PropertyType<ResourceSharedPtr> kanzi::TextureBrush::RenderTextureProperty

static

Texture property.

The default value is ResourceSharedPtr().

See also

setTexture(), getTexture()

---

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

• kanzi/core.ui/graphics2d/texture_brush.hpp