#include <kanzi/graphics_2d/brush.hpp>
Public Member Functions | |
virtual shared_ptr< BrushRenderer > | createBrushRenderer (Node *node)=0 |
Create a brush renderer for this brush. More... | |
virtual BrushSharedPtr | clone ()=0 |
Create clone of this brush. More... | |
virtual void | load (ResourceManager *resourceManager) |
Perform brush-specific loading. 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... | |
string | getName () const |
Get name of this brush. More... | |
void | setName (string_view name) |
Set name of this brush. 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... | |
![]() | |
Object (Domain *domain) | |
virtual | ~Object () |
Domain * | getDomain () const |
Returns the domain the object belongs to. More... | |
KzuPropertyManager * | getPropertyManager () const |
Returns the property manager of the object. 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 |
Returns the metaclass of the dynamic type of the object. More... | |
bool | isTypeOf (const Metaclass *objectType) const |
Determines if the type of this object is the given type or derived from it. More... | |
template<typename DataType > | |
void | setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType value) |
Sets the local value of a property. More... | |
void | setProperty (const PropertyType< ResourceID > &propertyType, ResourceSharedPtr value) |
Sets the local value of a resource id property with a resource pointer. More... | |
template<typename DataType > | |
DataType | getProperty (const PropertyType< DataType > &propertyType) const |
Returns the current value of a property. More... | |
template<typename DataType > | |
bool | getProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType &value) 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 > | |
void | setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType value) |
void | setAbstractProperty (AbstractPropertyType abstractPropertyType, ResourceSharedPtr value) |
template<typename DataType > | |
DataType | getAbstractProperty (AbstractPropertyType abstractPropertyType) const |
template<typename DataType > | |
bool | getAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType &value) const |
bool | hasValue (AbstractPropertyType propertyType) const |
Evaluates whether there are any inputs into the property value. More... | |
bool | hasLocalValue (AbstractPropertyType propertyType) const |
Evaluates whether there is a local value set for the property. More... | |
void | removeLocalValue (AbstractPropertyType propertyType) |
Removes the local value associated with the property. More... | |
void | copyLocalValues (const Object &other) |
Copies all local values from another object. More... | |
AppliedStyleEntry * | applyObjectStyle (kanzi::StyleSharedPtr style) |
Applies a style to an object. More... | |
void | unapplyObjectStyle (AppliedStyleEntry *appliedStyleEntry) |
void | applyObjectStyles () |
Apply all styles for an object node. More... | |
void | unapplyObjectStyles () |
Unapplies and removes all applied styles. More... | |
Static Public Member Functions | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
![]() | |
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 | |
Brush (Domain *domain, string_view name) | |
Constructor. More... | |
virtual | ~Brush () |
Destructor. More... | |
virtual void | onPropertyChanged (AbstractPropertyType propertyType, KzuPropertyNotificationReason reason) KZ_OVERRIDE |
Object::onPropertyChanged() implementation. More... | |
void | setRenderable (bool renderable) |
Set renderable status. More... | |
void | setOpaque (bool opaque) |
Set opaqueness status. More... | |
![]() | |
void | initialize () |
void | onCopy (const Object &other) |
Properties | |
static PropertyType< ColorRGBA > | ModulateColorProperty |
ModulateColor property. More... | |
static PropertyType< float > | HorizontalTilingProperty |
HorizontalTiling property. More... | |
static PropertyType< float > | VerticalTilingProperty |
VerticalTiling property. 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... | |
Additional Inherited Members | |
![]() | |
typedef vector < AppliedStyleEntry * > | AppliedStyleContainer |
Applied style container. More... | |
![]() | |
AppliedStyleContainer | m_appliedStyles |
Listing of applied styles applied to this object. More... | |
Brush class.
Implements a brush that can be used to fill areas, typically layer backgrounds.
|
explicitprotected |
Constructor.
domain | domain the brush belongs to. |
name | Name of the brush |
|
inlineprotectedvirtual |
Destructor.
|
inline |
Gets the value of ModulateColorProperty.
|
inline |
Sets the value of ModulateColorProperty.
|
inline |
Gets the value of HorizontalTilingProperty.
|
inline |
Sets the value of HorizontalTilingProperty.
|
inline |
Gets the value of VerticalTilingProperty.
|
inline |
Sets the value of VerticalTilingProperty.
|
static |
|
pure virtual |
Create a brush renderer for this brush.
node | Node to attach to. |
Implemented in kanzi::TextureBrush, kanzi::ColorBrush, kanzi::MaterialBrush, kanzi::ContentBrush, and kanzi::NullBrush.
|
pure virtual |
Create clone of this brush.
Implemented in kanzi::TextureBrush, kanzi::ColorBrush, kanzi::MaterialBrush, kanzi::ContentBrush, and kanzi::NullBrush.
|
virtual |
Perform brush-specific loading.
resourceManager | Resource manager to use. |
Reimplemented in kanzi::TextureBrush, and kanzi::MaterialBrush.
|
inline |
Access property change counter.
|
inline |
Update property change counter.
|
inline |
Access content texture.
|
inline |
Set content texture.
|
inline |
Get name of this brush.
|
inline |
Set name of this brush.
name | New name. |
|
inline |
Get tiling vector.
|
inline |
Tell whether or not the brush needs rendering.
|
inline |
Tell if the brush is opaque.
Brush may not need rendering but still not be considered opaque, for example if it is full transparent black.
|
protectedvirtual |
Object::onPropertyChanged() implementation.
Reimplemented from kanzi::Object.
Reimplemented in kanzi::TextureBrush, kanzi::MaterialBrush, and kanzi::ColorBrush.
|
inlineprotected |
Set renderable status.
renderable | Does this brush need rendering? |
|
inlineprotected |
Set opaqueness status.
opaque | Is this brush opaque? |
|
static |
ModulateColor property.
The default value is ColorRGBA(1.0f, 1.0f, 1.0f, 1.0f).
|
static |
HorizontalTiling property.
The default value is 1.0f.
|
static |
VerticalTiling property.
The default value is 1.0f.