Use OutlineEffect2D to apply an outline to the content of 2D nodes. More...

#include <kanzi/core.ui/effect/outline_effect2d.hpp>

Inheritance diagram for kanzi::OutlineEffect2D:

Public Types
enum	OutlineMethod { OutlineMethod::Box, OutlineMethod::TwoPass, OutlineMethod::Count }
	Specifies the available outline calculation methods. 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

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

Vector2	getContentGradient () const
	Gets the value of ContentGradientProperty. More...

Vector4	getContentMask () const
	Gets the value of ContentMaskProperty. More...

float	getContentThreshold () const
	Gets the value of ContentThresholdProperty. More...

float	getInnerSoftness () const
	Gets the value of InnerSoftnessProperty. More...

int	getInnerWidth () const
	Gets the value of InnerWidthProperty. More...

bool	getInvertContentMask () const
	Gets the value of InvertContentMaskProperty. More...

OutlineMethod	getMethod () const
	Gets the value of MethodProperty. More...

float	getSoftness () const
	Gets the value of SoftnessProperty. More...

TextureSharedPtr	getTexture () const
	Gets the value of TextureProperty. More...

float	getTextureOffset () const
	Gets the value of TextureOffsetProperty. More...

float	getTextureTiling () const
	Gets the value of TextureTilingProperty. More...

int	getWidth () const
	Gets the value of WidthProperty. More...

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

void	setContentGradient (Vector2 value)
	Sets the value of ContentGradientProperty. More...

void	setContentMask (Vector4 value)
	Sets the value of ContentMaskProperty. More...

void	setContentThreshold (float value)
	Sets the value of ContentThresholdProperty. More...

void	setInnerSoftness (float value)
	Sets the value of InnerSoftnessProperty. More...

void	setInnerWidth (int value)
	Sets the value of InnerWidthProperty. More...

void	setInvertContentMask (bool value)
	Sets the value of InvertContentMaskProperty. More...

void	setMethod (OutlineMethod value)
	Sets the value of MethodProperty. More...

void	setSoftness (float value)
	Sets the value of SoftnessProperty. More...

void	setTexture (TextureSharedPtr value)
	Sets the value of TextureProperty. More...

void	setTextureOffset (float value)
	Sets the value of TextureOffsetProperty. More...

void	setTextureTiling (float value)
	Sets the value of TextureTilingProperty. More...

void	setWidth (int value)
	Sets the value of WidthProperty. More...

Public Member Functions inherited from kanzi::NodeEffect2D
NodeEffectRenderer2DUniquePtr	createRenderer ()
	Creates a renderer instance. More...

unsigned int	getEffectPaddingChangeCounter () const
	Gets the effect quad change counter. More...

Vector4	getEffectQuadPadding () const
	Gets the effect quad padding. More...

Vector2	getEffectQuadPaddingOffset () const
	Gets the effect quad offset relative relative to the top-left corner of the node. More...

Vector2	getEffectQuadPaddingSize () const
	Gets the effect quad padding size. More...

NodeEffectRenderer2D *	getRendererInstance () const
	Gets a pointer to NodeEffectRenderer2D instance or null pointer if none exists. More...

bool	isAlphaRequired () const
	Indicates whether the effect requires alpha channel for the result. More...

bool	isRenderingRequired ()
	Indicates whether the effect requires rendering. More...

void	unregisterEffectRenderer (NodeEffectRenderer2D *effectRenderer)
	Unregister effect renderer. More...

	~NodeEffect2D ()

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

void	validatePropertyModifiers (AbstractPropertyType propertyType)

virtual	~PropertyObject ()

Static Public Member Functions
static OutlineEffect2DSharedPtr	create (Domain *domain, string_view name)
	Creates an outline effect. 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...

Static Public Attributes
static PropertyType< ColorRGBA >	ColorProperty
	Sets the color of the outline. More...

static PropertyType< Vector2 >	ContentGradientProperty
	Sets the gradient along which the content fades out. More...

static PropertyType< Vector4 >	ContentMaskProperty
	Sets the outline mask value that Kanzi uses to calculate the comparison value for content. More...

static PropertyType< float >	ContentThresholdProperty
	Sets the threshold where the outline calculation considers a pixel to exist. More...

static PropertyType< float >	InnerSoftnessProperty
	Sets the softness of the outline inside the content area. More...

static PropertyType< int >	InnerWidthProperty
	Sets the maximum width of the outline inside the content area. More...

static PropertyType< bool >	InvertContentMaskProperty
	Indicates whether to invert inside and outside for the outline masking. More...

static PropertyType< OutlineMethod >	MethodProperty
	Sets the outline calculation method. More...

static PropertyType< float >	SoftnessProperty
	Sets the softness of the outline outside the content area. More...

static PropertyType< float >	TextureOffsetProperty
	Sets the relative start position at which Kanzi starts to sample the texture that you set with the TextureProperty. More...

static PropertyType< ResourceSharedPtr >	TextureProperty
	Sets the texture to apply to the outline. More...

static PropertyType< float >	TextureTilingProperty
	Sets the number of times that the outline texture, which you set with the TextureProperty, wraps on the outline. More...

static PropertyType< int >	WidthProperty
	Sets the maximum width of the outline outside the content area. More...

Protected Member Functions
NodeEffectRenderer2DUniquePtr	createRendererOverride () override
	NodeEffect2D::createRendererOverride implementation. More...

void	initializeRendererOverride () override
	NodeEffect2D::initializeRendererOverride implementation. More...

bool	isRenderingRequiredOverride () override
	NodeEffect2D::isRenderingRequiredOverride() implementation. More...

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

	OutlineEffect2D (Domain *domain, string_view name)
	Constructor. More...

void	updateEffectQuadPadding ()
	Update NodeEffect2D effect quad padding based on the current parameters. More...

void	updatePremultipliedColor ()
	Update premultiplied color for the outline effect. More...

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

void	setAlphaRequired (bool required)
	Sets the framebuffer alpha channel requirements of the effect. More...

void	setEffectQuadPadding (float left, float right, float top, float bottom)
	Sets the padding required by the effect around the node bounds during the rendering of the effect. 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)

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 &propertyStorage, PropertyNotificationReason reason)

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	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

Protected Attributes
unsigned int	m_innerWidth
	Cached outline width inside content area. More...

unsigned int	m_outerWidth
	Cached outline width outside content area. More...

ColorRGBA	m_premultipliedColor
	Premultiplied color for rendering the outline. More...

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

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

Detailed Description

Use OutlineEffect2D to apply an outline to the content of 2D nodes.

Examples

To create an outline effect:

    // Create an effect template for the OutlineEffect2D effect prefab.
    NodeEffectTemplate2DSharedPtr outlineEffectTemplate =
        NodeEffectTemplate2D::create(OutlineEffect2D::getStaticMetaclass()->getName(), "OutlineEffect");
    // Create a node effect prefab from the effect template.
    NodeEffectPrefab2DSharedPtr outlineEffectPrefab =
        NodeEffectPrefab2D::create(getDomain(), "OutlineEffect prefab", outlineEffectTemplate);

To set the outline effect properties:

    // Create an outline effect template.
    NodeEffectTemplate2DSharedPtr outlineEffectTemplate =
        NodeEffectTemplate2D::create(OutlineEffect2D::getStaticMetaclass()->getName(), "OutlineEffect");
    // Set the value of the WidthProperty in the outline effect template.
    // The WidthProperty defines the maximum width of the outline outside the content area.
    outlineEffectTemplate->addPropertyValue(OutlineEffect2D::WidthProperty, Variant(8));
    // Create an outline effect prefab.
    NodeEffectPrefab2DSharedPtr outlineEffectPrefab =
        NodeEffectPrefab2D::create(getDomain(), "OutlineEffect prefab", outlineEffectTemplate);
    // Assign the outline effect to a 2D node.
    node2d->setEffectPrefab(outlineEffectPrefab);
    // Get the node-specific effect instance created from the assigned prefab.
    OutlineEffect2DSharedPtr outlineEffect = dynamic_pointer_cast<OutlineEffect2D>(node2d->getEffect());
    // Set the SoftnessProperty to 0.7 for this node only. This overrides
    // the property default value defined by the OutlineEffect2D metaclass.
    outlineEffect->setSoftness(0.7f);

See also: NodeEffect2D, NodeEffectPrefab2D, NodeEffectTemplate2D

Since: Kanzi 3.9.5

Member Enumeration Documentation

◆ OutlineMethod

enum kanzi::OutlineEffect2D::OutlineMethod

strong

Specifies the available outline calculation methods.

Enumerator
Box	Box search over the pixel.
TwoPass	Two-pass blur-like search.
Count	Number of methods.

Constructor & Destructor Documentation

◆ OutlineEffect2D()

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

explicitprotected

Constructor.

Parameters

domain	Domain to use.
name	Resource name.

Member Function Documentation

◆ getColor()

ColorRGBA kanzi::OutlineEffect2D::getColor ( ) const

inline

Gets the value of ColorProperty.

See also: setColor()

◆ setColor()

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

inline

Sets the value of ColorProperty.

See also: getColor()

◆ getContentGradient()

Vector2 kanzi::OutlineEffect2D::getContentGradient ( ) const

inline

Gets the value of ContentGradientProperty.

See also: setContentGradient()

◆ setContentGradient()

void kanzi::OutlineEffect2D::setContentGradient ( Vector2 value )

inline

Sets the value of ContentGradientProperty.

See also: getContentGradient()

◆ getContentMask()

Vector4 kanzi::OutlineEffect2D::getContentMask ( ) const

inline

Gets the value of ContentMaskProperty.

See also: setContentMask()

◆ setContentMask()

void kanzi::OutlineEffect2D::setContentMask ( Vector4 value )

inline

Sets the value of ContentMaskProperty.

See also: getContentMask()

◆ getContentThreshold()

float kanzi::OutlineEffect2D::getContentThreshold ( ) const

inline

Gets the value of ContentThresholdProperty.

See also: setContentThreshold()

◆ setContentThreshold()

void kanzi::OutlineEffect2D::setContentThreshold ( float value )

inline

Sets the value of ContentThresholdProperty.

See also: getContentThreshold()

◆ getInvertContentMask()

bool kanzi::OutlineEffect2D::getInvertContentMask ( ) const

inline

Gets the value of InvertContentMaskProperty.

See also: setInvertContentMask()

◆ setInvertContentMask()

void kanzi::OutlineEffect2D::setInvertContentMask ( bool value )

inline

Sets the value of InvertContentMaskProperty.

See also: getInvertContentMask()

◆ getTexture()

TextureSharedPtr kanzi::OutlineEffect2D::getTexture ( ) const

inline

Gets the value of TextureProperty.

See also: setTexture()

◆ setTexture()

void kanzi::OutlineEffect2D::setTexture ( TextureSharedPtr value )

inline

Sets the value of TextureProperty.

See also: getTexture()

◆ getTextureOffset()

float kanzi::OutlineEffect2D::getTextureOffset ( ) const

inline

Gets the value of TextureOffsetProperty.

See also: setTextureOffset()

◆ setTextureOffset()

void kanzi::OutlineEffect2D::setTextureOffset ( float value )

inline

Sets the value of TextureOffsetProperty.

See also: getTextureOffset()

◆ getTextureTiling()

float kanzi::OutlineEffect2D::getTextureTiling ( ) const

inline

Gets the value of TextureTilingProperty.

See also: setTextureTiling()

◆ setTextureTiling()

void kanzi::OutlineEffect2D::setTextureTiling ( float value )

inline

Sets the value of TextureTilingProperty.

See also: getTextureTiling()

◆ getMethod()

OutlineMethod kanzi::OutlineEffect2D::getMethod ( ) const

inline

Gets the value of MethodProperty.

See also: setMethod()

◆ setMethod()

void kanzi::OutlineEffect2D::setMethod ( OutlineMethod value )

inline

Sets the value of MethodProperty.

See also: getMethod()

◆ getSoftness()

float kanzi::OutlineEffect2D::getSoftness ( ) const

inline

Gets the value of SoftnessProperty.

See also: setSoftness()

◆ setSoftness()

void kanzi::OutlineEffect2D::setSoftness ( float value )

inline

Sets the value of SoftnessProperty.

See also: getSoftness()

◆ getInnerSoftness()

float kanzi::OutlineEffect2D::getInnerSoftness ( ) const

inline

Gets the value of InnerSoftnessProperty.

See also: setInnerSoftness()

◆ setInnerSoftness()

void kanzi::OutlineEffect2D::setInnerSoftness ( float value )

inline

Sets the value of InnerSoftnessProperty.

See also: getInnerSoftness()

◆ getWidth()

int kanzi::OutlineEffect2D::getWidth ( ) const

inline

Gets the value of WidthProperty.

See also: setWidth()

◆ setWidth()

void kanzi::OutlineEffect2D::setWidth ( int value )

inline

Sets the value of WidthProperty.

See also: getWidth()

◆ getInnerWidth()

int kanzi::OutlineEffect2D::getInnerWidth ( ) const

inline

Gets the value of InnerWidthProperty.

See also: setInnerWidth()

◆ setInnerWidth()

void kanzi::OutlineEffect2D::setInnerWidth ( int value )

inline

Sets the value of InnerWidthProperty.

See also: getInnerWidth()

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::OutlineEffect2D::makeEditorInfo ( )

static

◆ create()

static OutlineEffect2DSharedPtr kanzi::OutlineEffect2D::create	(	Domain *	domain,
		string_view	name
	)

static

Creates an outline effect.

Parameters

domain	Domain to use.
name	Resource name.

Returns: Shared pointer to the created OutlineEffect2D instance.

◆ createRendererOverride()

NodeEffectRenderer2DUniquePtr kanzi::OutlineEffect2D::createRendererOverride ( )

overrideprotectedvirtual

NodeEffect2D::createRendererOverride implementation.

Implements kanzi::NodeEffect2D.

◆ initializeRendererOverride()

void kanzi::OutlineEffect2D::initializeRendererOverride ( )

overrideprotectedvirtual

NodeEffect2D::initializeRendererOverride implementation.

Implements kanzi::NodeEffect2D.

◆ isRenderingRequiredOverride()

bool kanzi::OutlineEffect2D::isRenderingRequiredOverride ( )

overrideprotectedvirtual

NodeEffect2D::isRenderingRequiredOverride() implementation.

Reimplemented from kanzi::NodeEffect2D.

◆ onPropertyChanged()

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

overrideprotectedvirtual

PropertyObject::onPropertyChanged implementation.

Reimplemented from kanzi::PropertyObject.

◆ updateEffectQuadPadding()

void kanzi::OutlineEffect2D::updateEffectQuadPadding ( )

protected

Update NodeEffect2D effect quad padding based on the current parameters.

◆ updatePremultipliedColor()

void kanzi::OutlineEffect2D::updatePremultipliedColor ( )

protected

Update premultiplied color for the outline effect.

Member Data Documentation

◆ ColorProperty

PropertyType<ColorRGBA> kanzi::OutlineEffect2D::ColorProperty

static

Sets the color of the outline.

This property defines the color of the outline at its maximum intensity. Use the SoftnessProperty to control the softness of the outline.

See also: setColor(), getColor()

◆ ContentGradientProperty

PropertyType<Vector2> kanzi::OutlineEffect2D::ContentGradientProperty

static

Sets the gradient along which the content fades out.

The first component defines the minimum intensity at which the content starts to fade out outside the content area. The second component defines the distance it takes for the content to completely disappear.

The default value [ 0.0f, 0.19f ] makes the content fade out quickly before the outline fade-out starts. For a perfectly smooth gradient from maximum content intensity to zero at the edge of the outline radius, set to [ 0.0, 1.0 ].

See also: setContentGradient(), getContentGradient()

◆ ContentMaskProperty

PropertyType<Vector4> kanzi::OutlineEffect2D::ContentMaskProperty

static

Sets the outline mask value that Kanzi uses to calculate the comparison value for content.

Kanzi combines the mask value with the content RGBA color to produce the scalar value for comparison. Kanzi calculates the comparison value with a dot product between the color and the mask. The default value is [ 0.0f, 0.0f, 0.0f, 1.0f ].

See also: setContentMask(), getContentMask()

◆ ContentThresholdProperty

PropertyType<float> kanzi::OutlineEffect2D::ContentThresholdProperty

static

Sets the threshold where the outline calculation considers a pixel to exist.

The comparison value that Kanzi calculates from the content color using the ContentMaskProperty must be greater than the value of this property. The default value is 0.0f.

See also: setContentThreshold(), getContentThreshold()

◆ InvertContentMaskProperty

PropertyType<bool> kanzi::OutlineEffect2D::InvertContentMaskProperty

static

Indicates whether to invert inside and outside for the outline masking.

The default value is false.

See also: setInvertContentMask(), getInvertContentMask()

◆ TextureProperty

PropertyType<ResourceSharedPtr> kanzi::OutlineEffect2D::TextureProperty

static

Sets the texture to apply to the outline.

Kanzi applies to the outline only the top row of pixels from this texture.

The leftmost pixel in the texture maps to the innermost part of the outline and the rightmost pixel to the outmost part of the outline. Kanzi scales the width of the texture to the width of the outline.

Kanzi modulates the colors in the outline texture with the color that you set with the ColorProperty.

See also: setTexture(), getTexture()

◆ TextureOffsetProperty

PropertyType<float> kanzi::OutlineEffect2D::TextureOffsetProperty

static

Sets the relative start position at which Kanzi starts to sample the texture that you set with the TextureProperty.

See also: setTextureOffset(), getTextureOffset()

◆ TextureTilingProperty

PropertyType<float> kanzi::OutlineEffect2D::TextureTilingProperty

static

Sets the number of times that the outline texture, which you set with the TextureProperty, wraps on the outline.

See also: setTextureTiling(), getTextureTiling()

◆ MethodProperty

PropertyType<OutlineMethod> kanzi::OutlineEffect2D::MethodProperty

static

Sets the outline calculation method.

The default method is OutlineMethod::TwoPass.

See also: setMethod(), getMethod()

◆ SoftnessProperty

PropertyType<float> kanzi::OutlineEffect2D::SoftnessProperty

static

Sets the softness of the outline outside the content area.

The default value is 0.27f.

See also: setSoftness(), getSoftness()

◆ InnerSoftnessProperty

PropertyType<float> kanzi::OutlineEffect2D::InnerSoftnessProperty

static

Sets the softness of the outline inside the content area.

The default value is 0.27f.

See also: setInnerSoftness(), getInnerSoftness()

◆ WidthProperty

PropertyType<int> kanzi::OutlineEffect2D::WidthProperty

static

Sets the maximum width of the outline outside the content area.

The default value is 4.

See also: setWidth(), getWidth()

◆ InnerWidthProperty

PropertyType<int> kanzi::OutlineEffect2D::InnerWidthProperty

static

Sets the maximum width of the outline inside the content area.

The default value is 3.

See also: setInnerWidth(), getInnerWidth()

◆ m_premultipliedColor

ColorRGBA kanzi::OutlineEffect2D::m_premultipliedColor

protected

Premultiplied color for rendering the outline.

◆ m_innerWidth

unsigned int kanzi::OutlineEffect2D::m_innerWidth

protected

Cached outline width inside content area.

Kanzi uses this to determine whether the outline effect is renderable.

◆ m_outerWidth

unsigned int kanzi::OutlineEffect2D::m_outerWidth

protected

Cached outline width outside content area.

Kanzi uses this to determine whether the outline effect is renderable.

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

kanzi/core.ui/effect/outline_effect2d.hpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Examples

Member Enumeration Documentation

◆ OutlineMethod

Constructor & Destructor Documentation

◆ OutlineEffect2D()

Member Function Documentation

◆ getColor()

◆ setColor()

◆ getContentGradient()

◆ setContentGradient()

◆ getContentMask()

◆ setContentMask()

◆ getContentThreshold()

◆ setContentThreshold()

◆ getInvertContentMask()

◆ setInvertContentMask()

◆ getTexture()

◆ setTexture()

◆ getTextureOffset()

◆ setTextureOffset()

◆ getTextureTiling()

◆ setTextureTiling()

◆ getMethod()

◆ setMethod()

◆ getSoftness()

◆ setSoftness()

◆ getInnerSoftness()

◆ setInnerSoftness()

◆ getWidth()

◆ setWidth()

◆ getInnerWidth()

◆ setInnerWidth()

◆ makeEditorInfo()

◆ create()

◆ createRendererOverride()

◆ initializeRendererOverride()

◆ isRenderingRequiredOverride()

◆ onPropertyChanged()

◆ updateEffectQuadPadding()

◆ updatePremultipliedColor()

Member Data Documentation

◆ ColorProperty

◆ ContentGradientProperty

◆ ContentMaskProperty

◆ ContentThresholdProperty

◆ InvertContentMaskProperty

◆ TextureProperty

◆ TextureOffsetProperty

◆ TextureTilingProperty

◆ MethodProperty

◆ SoftnessProperty

◆ InnerSoftnessProperty

◆ WidthProperty

◆ InnerWidthProperty

◆ m_premultipliedColor

◆ m_innerWidth

◆ m_outerWidth