Use ShadowEffect2D to apply drop- and inner-shadow post-processing effects to 2D nodes. More...

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

Inheritance diagram for kanzi::ShadowEffect2D:

Public Types
enum	Quality { Quality::Low, Quality::Normal, Quality::High, Quality::Count }
	Defines the visual quality levels of the shadow effect. More...

enum	Type { Type::DropShadow, Type::InnerShadow, Type::Count }
	Defines the types of the shadow effect. 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
Vector2	getActualOffset () const
	Gets the value of ActualOffsetProperty. More...

float	getAngle () const
	Gets the value of AngleProperty. More...

float	getBlurRadius () const
	Gets the value of BlurRadiusProperty. More...

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

float	getDistance () const
	Gets the value of DistanceProperty. More...

Vector2	getOverrideOffset () const
	Gets the value of OverrideOffsetProperty. More...

ColorRGBA	getPremultipliedColor () const
	Gets the premultiplied color used by the shadow effect. More...

Quality	getQuality () const
	Gets the value of QualityProperty. More...

bool	getShadowOnly () const
	Gets the value of ShadowOnlyProperty. More...

Type	getType () const
	Gets the value of TypeProperty. More...

void	setAngle (float value)
	Sets the value of AngleProperty. More...

void	setBlurRadius (float value)
	Sets the value of BlurRadiusProperty. More...

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

void	setDistance (float value)
	Sets the value of DistanceProperty. More...

void	setOverrideOffset (Vector2 value)
	Sets the value of OverrideOffsetProperty. More...

void	setQuality (Quality value)
	Sets the value of QualityProperty. More...

void	setShadowOnly (bool value)
	Sets the value of ShadowOnlyProperty. More...

void	setType (Type value)
	Sets the value of TypeProperty. 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 ShadowEffect2DSharedPtr	create (Domain *domain, string_view name)
	Creates a shadow 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< Vector2 >	ActualOffsetProperty
	Gets the calculated offset of the shadow from the object along the x and y axes in pixels. More...

static PropertyType< float >	AngleProperty
	Sets the direction of the shadow as an angle relative to the positive x-axis. More...

static PropertyType< float >	BlurRadiusProperty
	Sets the softness of the shadow by defining the distance in pixels the shadow blur extends outward from an edge. More...

static PropertyType< ColorRGBA >	ColorProperty
	Sets the color of the shadow. More...

static PropertyType< float >	DistanceProperty
	Sets how far to move the shadow from the object in the direction set by the AngleProperty. More...

static PropertyType< Vector2 >	OverrideOffsetProperty
	Sets the offset of the shadow from the object along the x and y axes in pixels. More...

static PropertyType< Quality >	QualityProperty
	Sets the visual quality of the shadow. More...

static PropertyType< bool >	ShadowOnlyProperty
	Sets whether to render only the shadow without the node contents. More...

static PropertyType< Type >	TypeProperty
	Sets the type of the shadow: 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...

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

	ShadowEffect2D (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 shadow effect. More...

void	updateShadowOffset ()
	Update the shadow offset based on the shadow angle and distance. 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 &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	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

Protected Attributes
ColorRGBA	m_premultipliedColor
	Premultiplied color for the shadow. 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 ShadowEffect2D to apply drop- and inner-shadow post-processing effects to 2D nodes.

Examples

To create a shadow effect:

    // An effect that is assigned to a 2D node is an effect prefab.
    // Before you can construct an effect prefab, you must create an effect template.
    // This example creates an effect template for the ShadowEffect2D effect prefab.
    NodeEffectTemplate2DSharedPtr shadowEffectTemplate =
        NodeEffectTemplate2D::create(ShadowEffect2D::getStaticMetaclass()->getName(), "DropShadow");
    // Create a node effect prefab from the effect template.
    NodeEffectPrefab2DSharedPtr shadowEffectPrefab =
        NodeEffectPrefab2D::create(getDomain(), "DropShadow prefab", shadowEffectTemplate);

To set the shadow effect properties:

    // Create an effect template.
    NodeEffectTemplate2DSharedPtr shadowEffectTemplate =
        NodeEffectTemplate2D::create(ShadowEffect2D::getStaticMetaclass()->getName(), "DropShadow");
    // Set the value of the AngleProperty in the template. This value serves as the default value
    // of the property in instances of the effect prefab.
    shadowEffectTemplate->addPropertyValue(ShadowEffect2D::AngleProperty, Variant(35.f)); 
    // Create an effect prefab.
    NodeEffectPrefab2DSharedPtr shadowEffectPrefab =
        NodeEffectPrefab2D::create(getDomain(), "DropShadow prefab", shadowEffectTemplate);
    // Assign the effect to a 2D node.
    node2d->setEffectPrefab(shadowEffectPrefab);
    // Get the node-specific effect instance created from the assigned prefab.
    ShadowEffect2DSharedPtr shadowEffect = dynamic_pointer_cast<ShadowEffect2D>(node2d->getEffect());
    // Set the shadow distance to 15 pixels for this node only. This overrides
    // the property default value defined by the ShadowEffect2D metaclass.
    shadowEffect->setDistance(15.f);
    // Set the direction of the shadow to 55 degrees relative to the positive x axis.
    // This overrides the default value of 35 degrees set in the shadow effect template.
    shadowEffect->setAngle(55.f);

See also: NodeEffect2D, NodeEffectPrefab2D, NodeEffectTemplate2D

Since: Kanzi 3.9.0; Kanzi 3.9.5 added ShadowEffect2D::OverrideOffsetProperty.

Member Enumeration Documentation

◆ Type

enum kanzi::ShadowEffect2D::Type

strong

Defines the types of the shadow effect.

Enumerator
DropShadow	Drop shadow appears behind or below objects.
InnerShadow	Inner shadow appears inside objects.
Count	Number of shadow types.

◆ Quality

enum kanzi::ShadowEffect2D::Quality

strong

Defines the visual quality levels of the shadow effect.

Enumerator
Low	Lowest shadow quality.
Normal	Normal shadow quality. This is the default.
High	High shadow quality.
Count	Number of quality options.

Constructor & Destructor Documentation

◆ ShadowEffect2D()

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

explicitprotected

Constructor.

Parameters

domain	Domain to use.
name	Resource name.

Member Function Documentation

◆ getBlurRadius()

float kanzi::ShadowEffect2D::getBlurRadius ( ) const

inline

Gets the value of BlurRadiusProperty.

See also: setBlurRadius()

◆ setBlurRadius()

void kanzi::ShadowEffect2D::setBlurRadius ( float value )

inline

Sets the value of BlurRadiusProperty.

See also: getBlurRadius()

◆ getQuality()

Quality kanzi::ShadowEffect2D::getQuality ( ) const

inline

Gets the value of QualityProperty.

See also: setQuality()

◆ setQuality()

void kanzi::ShadowEffect2D::setQuality ( Quality value )

inline

Sets the value of QualityProperty.

See also: getQuality()

◆ getType()

Type kanzi::ShadowEffect2D::getType ( ) const

inline

Gets the value of TypeProperty.

See also: setType()

◆ setType()

void kanzi::ShadowEffect2D::setType ( Type value )

inline

Sets the value of TypeProperty.

See also: getType()

◆ getDistance()

float kanzi::ShadowEffect2D::getDistance ( ) const

inline

Gets the value of DistanceProperty.

See also: setDistance()

◆ setDistance()

void kanzi::ShadowEffect2D::setDistance ( float value )

inline

Sets the value of DistanceProperty.

See also: getDistance()

◆ getAngle()

float kanzi::ShadowEffect2D::getAngle ( ) const

inline

Gets the value of AngleProperty.

See also: setAngle()

◆ setAngle()

void kanzi::ShadowEffect2D::setAngle ( float value )

inline

Sets the value of AngleProperty.

See also: getAngle()

◆ getOverrideOffset()

Vector2 kanzi::ShadowEffect2D::getOverrideOffset ( ) const

inline

Gets the value of OverrideOffsetProperty.

See also: setOverrideOffset()

Since: Kanzi 3.9.6

◆ setOverrideOffset()

void kanzi::ShadowEffect2D::setOverrideOffset ( Vector2 value )

inline

Sets the value of OverrideOffsetProperty.

See also: getOverrideOffset()

Since: Kanzi 3.9.6

◆ getActualOffset()

Vector2 kanzi::ShadowEffect2D::getActualOffset ( ) const

inline

Gets the value of ActualOffsetProperty.

See also: setActualOffset()

Since: Kanzi 3.9.6

◆ getColor()

ColorRGBA kanzi::ShadowEffect2D::getColor ( ) const

inline

Gets the value of ColorProperty.

See also: setColor()

◆ setColor()

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

inline

Sets the value of ColorProperty.

See also: getColor()

◆ getShadowOnly()

bool kanzi::ShadowEffect2D::getShadowOnly ( ) const

inline

Gets the value of ShadowOnlyProperty.

See also: setShadowOnly()

◆ setShadowOnly()

void kanzi::ShadowEffect2D::setShadowOnly ( bool value )

inline

Sets the value of ShadowOnlyProperty.

See also: getShadowOnly()

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::ShadowEffect2D::makeEditorInfo ( )

static

◆ create()

static ShadowEffect2DSharedPtr kanzi::ShadowEffect2D::create	(	Domain *	domain,
		string_view	name
	)

static

Creates a shadow effect.

Parameters

domain	Domain to use.
name	Resource name.

Returns: Shared pointer to the created ShadowEffect2D instance.

◆ getPremultipliedColor()

ColorRGBA kanzi::ShadowEffect2D::getPremultipliedColor ( ) const

inline

Gets the premultiplied color used by the shadow effect.

◆ createRendererOverride()

NodeEffectRenderer2DUniquePtr kanzi::ShadowEffect2D::createRendererOverride ( )

overrideprotectedvirtual

NodeEffect2D::createRendererOverride implementation.

Implements kanzi::NodeEffect2D.

◆ initializeRendererOverride()

void kanzi::ShadowEffect2D::initializeRendererOverride ( )

overrideprotectedvirtual

NodeEffect2D::initializeRendererOverride implementation.

Implements kanzi::NodeEffect2D.

◆ isRenderingRequiredOverride()

bool kanzi::ShadowEffect2D::isRenderingRequiredOverride ( )

overrideprotectedvirtual

NodeEffect2D::isRenderingRequiredOverride() implementation.

Reimplemented from kanzi::NodeEffect2D.

◆ onPropertyChanged()

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

overrideprotectedvirtual

PropertyObject::onPropertyChanged implementation.

Reimplemented from kanzi::PropertyObject.

◆ updateEffectQuadPadding()

void kanzi::ShadowEffect2D::updateEffectQuadPadding ( )

protected

Update NodeEffect2D effect quad padding based on the current parameters.

◆ updatePremultipliedColor()

void kanzi::ShadowEffect2D::updatePremultipliedColor ( )

protected

Update premultiplied color for the shadow effect.

◆ updateShadowOffset()

void kanzi::ShadowEffect2D::updateShadowOffset ( )

protected

Update the shadow offset based on the shadow angle and distance.

Member Data Documentation

◆ BlurRadiusProperty

PropertyType<float> kanzi::ShadowEffect2D::BlurRadiusProperty

static

Sets the softness of the shadow by defining the distance in pixels the shadow blur extends outward from an edge.

For a shadow with sharp edges, set to 0. The default value is 8.

See also: setBlurRadius(), getBlurRadius()

◆ QualityProperty

PropertyType<Quality> kanzi::ShadowEffect2D::QualityProperty

static

Sets the visual quality of the shadow.

Lower quality uses less computing and memory resources. The default value is Normal.

See also: setQuality(), getQuality()

◆ TypeProperty

PropertyType<Type> kanzi::ShadowEffect2D::TypeProperty

static

Sets the type of the shadow:

DropShadow appears behind or below an object. This is the default value.
InnerShadow appears inside an object.
See also
setType(), getType()

◆ DistanceProperty

PropertyType<float> kanzi::ShadowEffect2D::DistanceProperty

static

Sets how far to move the shadow from the object in the direction set by the AngleProperty.

The default value is 10.

See also: setDistance(), getDistance()

◆ AngleProperty

PropertyType<float> kanzi::ShadowEffect2D::AngleProperty

static

Sets the direction of the shadow as an angle relative to the positive x-axis.

The default value is 45.

See also: setAngle(), getAngle()

◆ OverrideOffsetProperty

PropertyType<Vector2> kanzi::ShadowEffect2D::OverrideOffsetProperty

static

Sets the offset of the shadow from the object along the x and y axes in pixels.

When you set this property, the AngleProperty and DistanceProperty have no effect. To disable the offset override, remove this property.

See also: setOverrideOffset(), getOverrideOffset()

Since: Kanzi 3.9.6

◆ ActualOffsetProperty

PropertyType<Vector2> kanzi::ShadowEffect2D::ActualOffsetProperty

static

Gets the calculated offset of the shadow from the object along the x and y axes in pixels.

Kanzi calculates the offset from the values of the DistanceProperty and AngleProperty or, if the OverrideOffsetProperty is set, from its value.

See also: setActualOffset(), getActualOffset()

Since: Kanzi 3.9.6

◆ ColorProperty

PropertyType<ColorRGBA> kanzi::ShadowEffect2D::ColorProperty

static

Sets the color of the shadow.

The default value is ColorRGBA(0.f, 0.f, 0.f, 0.75f).

See also: setColor(), getColor()

◆ ShadowOnlyProperty

PropertyType<bool> kanzi::ShadowEffect2D::ShadowOnlyProperty

static

Sets whether to render only the shadow without the node contents.

The default value is false.

See also: setShadowOnly(), getShadowOnly()

◆ m_premultipliedColor

ColorRGBA kanzi::ShadowEffect2D::m_premultipliedColor

protected

Premultiplied color for the shadow.

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

kanzi/core.ui/effect/shadow_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

◆ Type

◆ Quality

Constructor & Destructor Documentation

◆ ShadowEffect2D()

Member Function Documentation

◆ getBlurRadius()

◆ setBlurRadius()

◆ getQuality()

◆ setQuality()

◆ getType()

◆ setType()

◆ getDistance()

◆ setDistance()

◆ getAngle()

◆ setAngle()

◆ getOverrideOffset()

◆ setOverrideOffset()

◆ getActualOffset()

◆ getColor()

◆ setColor()

◆ getShadowOnly()

◆ setShadowOnly()

◆ makeEditorInfo()

◆ create()

◆ getPremultipliedColor()

◆ createRendererOverride()

◆ initializeRendererOverride()

◆ isRenderingRequiredOverride()

◆ onPropertyChanged()

◆ updateEffectQuadPadding()

◆ updatePremultipliedColor()

◆ updateShadowOffset()

Member Data Documentation

◆ BlurRadiusProperty

◆ QualityProperty

◆ TypeProperty

◆ DistanceProperty

◆ AngleProperty

◆ OverrideOffsetProperty

◆ ActualOffsetProperty

◆ ColorProperty

◆ ShadowOnlyProperty

◆ m_premultipliedColor