Color brush class. More...

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

Inheritance diagram for kanzi::ColorBrush:

Public Member Functions
virtual BrushSharedPtr	clone () KZ_OVERRIDE
	Brush::clone() implementation. More...

virtual BrushRendererPtr	createBrushRenderer (Node *node) KZ_OVERRIDE
	Brush::createBrushRenderer() implementation. More...

Public Member Functions inherited from kanzi::Brush
virtual void	load (struct KzcInputStream inputStream, const struct KzuBinaryFileInfo file)
	Perform brush-specific loading. More...

virtual void	previewPatch (struct KzcInputStream inputStream, const struct KzuBinaryFileInfo file)
	Patch brush. More...

unsigned int	getPropertyChangeCounter () const
	Access property change counter. More...

void	updatePropertyChangeCounter ()
	Update property change counter. More...

TextureSharedPtr	getContentTexture () const
	Access content texture. More...

void	setContentTexture (TextureSharedPtr texture)
	Set content texture. More...

Vector2	getTiling () const
	Get tiling vector. More...

bool	isRenderable () const
	Tell whether or not the brush needs rendering. More...

bool	isOpaque () const
	Tell if the brush is opaque. 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
KzcMemoryManager *	getMemoryManager () const

	Resource (Domain *domain, string_view name)

virtual	~Resource ()

virtual void	loadFromKZB (const ResourceLoaderThreadContext threadContext, KzcInputStream inputStream, const KzuBinaryFileInfo *file)
	Function for loading the resource from .KZB. More...

virtual void	unloadOverride ()
	Unload function for resource. Releases all CPU memory taken by the resource except the resource loader. More...

virtual unsigned int	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource. More...

void	setKZB (const KzuBinaryDirectory *binaryDirectory, string_view path)
	Set the binary directory and path of the resource. More...

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

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

void	setUrl (string_view url)
	Sets the resource URL. More...

void	setNotLoaded ()

bool	isFromKZB () const

void	reload ()

void	reloadFromKzb (KzcInputStream inputStream, const KzuBinaryFileInfo file)

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

void	reloadFromFile (string_view filePath)

void	load ()

void	unload ()

bool	isLoaded () const

void	kzuResourceLoad_private (const ResourceLoaderThreadContext *threadContext)
	Private function for kzuResourceLoad() with specified thread context. More...

void	kzuResourceFinishLoading_private (const ResourceLoaderThreadContext *threadContext)
	Private function for finishing the loading of the resource. More...

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

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

Public Member Functions inherited from kanzi::Object
	Object (Domain *domain)

virtual	~Object ()

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

KzuTaskScheduler *	getTaskScheduler () const
	Returns the task scheduler of the object. More...

KzuMessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

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

virtual const Metaclass *	getDynamicMetaclass () const KZ_OVERRIDE
	Returns the metaclass of the dynamic type of the object. More...

AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

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

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...

Public Member Functions inherited from kanzi::MetaObject
virtual	~MetaObject ()

bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

Public Member Functions inherited from kanzi::PropertyObject
	PropertyObject ()

virtual	~PropertyObject ()

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

void	removeKzbProperties ()

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

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 >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers. More...

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

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

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. 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...

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

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...

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

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

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

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

void	validatePropertyModifiers (AbstractPropertyType propertyType)

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

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

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

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

static ColorBrushSharedPtr	create (Domain *domain, string_view name)
	Create a new color brush. More...

static ColorBrushSharedPtr	create (Domain *domain, string_view name, const ColorRGBA &color)
	Create a new color brush. More...

Static Public Member Functions inherited from kanzi::Brush
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

static const char *	getNullBrushUrl ()
	Get null brush URL. More...

static BrushSharedPtr	acquireNullBrush (ResourceManager &resourceManager)
	Acquire default null brush. More...

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

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
	ColorBrush (Domain *domain, string_view name)
	Constructor. More...

	ColorBrush (Domain *domain, string_view name, const ColorRGBA &color)
	Constructor. More...

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) KZ_OVERRIDE
	Object::onPropertyChanged() implementation. More...

void	calculateRenderingProperties ()
	Calculate rendering properties for this. More...

void	initialize ()
	Object::initialize() interface. More...

Protected Member Functions inherited from kanzi::Brush
	Brush (Domain *domain, string_view name)
	Constructor. More...

virtual	~Brush ()
	Destructor. More...

void	setRenderable (bool renderable)
	Set renderable status. More...

void	setOpaque (bool opaque)
	Set opaqueness status. More...

Protected Member Functions inherited from kanzi::Resource
virtual void	reloadOverride ()

virtual void	reloadFromKzbOverride (KzcInputStream inputStream, const KzuBinaryFileInfo file)

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

virtual void	reloadFromFileOverride (string_view filePath)

virtual unsigned int	getCPUMemoryUsageOverride () const

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

void	onCopy (const Object &other)

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

void	initialize ()

Protected Member Functions inherited from kanzi::PropertyObject
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void owner)

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const

AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const

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

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

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

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

AbstractPropertyTypeDescriptor::ValueSourceEntry *	findLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

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

AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

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

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

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

PropertyStorageContainer::iterator	beginPropertyStorage ()

PropertyStorageContainer::iterator	endPropertyStorage ()

virtual void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)

void	onCopy (const PropertyObject &other)

Properties
static PropertyType< ColorRGBA >	ColorProperty
	Color property. More...

ColorRGBA	getColor () const
	Gets the value of ColorProperty. More...

void	setColor (ColorRGBA value)
	Sets the value of ColorProperty. More...

Additional Inherited Members
Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

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::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Detailed Description

Color brush class.

Implements a solid-color brush used to fill areas.

Constructor & Destructor Documentation

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

inlineexplicitprotected

Constructor.

Leaves color unset.

Parameters

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

kanzi::ColorBrush::ColorBrush	(	Domain *	domain,
		string_view	name,
		const ColorRGBA &	color
	)

inlineexplicitprotected

Constructor.

Parameters

domain	domain the brush belongs to.
name	Name of the color brush
color	Color to use.

Member Function Documentation

ColorRGBA kanzi::ColorBrush::getColor ( ) const

inline

Gets the value of ColorProperty.

See also: setColor()

void kanzi::ColorBrush::setColor ( ColorRGBA value )

inline

Sets the value of ColorProperty.

See also: getColor()

static PropertyTypeEditorInfoSharedPtr kanzi::ColorBrush::makeEditorInfo ( )

static

static ColorBrushSharedPtr kanzi::ColorBrush::create	(	Domain *	domain,
		string_view	name
	)

static

Create a new color brush.

Color assumes default property value.

Default rendering is used.

Parameters

uiDomain	uiDomain the brush belongs to.
name	Name of the color brush

static ColorBrushSharedPtr kanzi::ColorBrush::create	(	Domain *	domain,
		string_view	name,
		const ColorRGBA &	color
	)

static

Create a new color brush.

Default rendering is used.

Parameters

uiDomain	uiDomain the brush belongs to.
name	Name of the color brush

virtual BrushSharedPtr kanzi::ColorBrush::clone ( )

virtual

Brush::clone() implementation.

Implements kanzi::Brush.

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

virtual

Brush::createBrushRenderer() implementation.

Implements kanzi::Brush.

virtual void kanzi::ColorBrush::onPropertyChanged	(	AbstractPropertyType	propertyType,
		PropertyNotificationReason	reason
	)

protectedvirtual

Object::onPropertyChanged() implementation.

Reimplemented from kanzi::Brush.

void kanzi::ColorBrush::calculateRenderingProperties ( )

protected

Calculate rendering properties for this.

void kanzi::ColorBrush::initialize ( )

protected

Object::initialize() interface.

Member Data Documentation

PropertyType<ColorRGBA> kanzi::ColorBrush::ColorProperty

static

Color property.

See also: setColor(), getColor()

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

kanzi/core.ui/graphics2d/color_brush.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation