Kanzi  3.9.7
Java API
ShadowEffect2DMetadata Interface Reference

Metadata definitions for ShadowEffect2D. More...

Inheritance diagram for ShadowEffect2DMetadata:
[legend]

Public Attributes

DynamicPropertyType< Vector2ActualOffsetProperty
 Reports the offset of the shadow from the object along the x and y axes in pixels. More...
 
DynamicPropertyType< Float > AngleProperty
 Sets the direction of the shadow as an angle relative to the positive x axis. More...
 
DynamicPropertyType< Float > BlurRadiusProperty
 Sets the softness of the shadow by defining the distance in pixels the shadow blur extends outward from an edge. More...
 
DynamicPropertyType< ColorRGBAColorProperty
 Sets the color and alpha of the shadow. More...
 
DynamicPropertyType< Float > DistanceProperty
 Sets how far to move the shadow from the object in the direction set by the Shadow Angle property. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.ShadowEffect2D")
 Metaclass for ShadowEffect2D.
 
DynamicPropertyType< Vector2OverrideOffsetProperty
 Sets the offset of the shadow from the object along the x and y axes in pixels. More...
 
DynamicPropertyType< ShadowEffect2DEnums.QualityQualityProperty
 Sets the visual quality of the shadow. More...
 
DynamicPropertyType< Boolean > ShadowOnlyProperty
 Whether to render only the shadow without the node contents. More...
 
DynamicPropertyType< ShadowEffect2DEnums.TypeTypeProperty
 Sets the type of the shadow: More...
 
- Public Attributes inherited from NodeEffect2DMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.NodeEffect2D")
 Metaclass for NodeEffect2D.
 
- Public Attributes inherited from ResourceMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Resource")
 Metaclass for Resource.
 

Detailed Description

Metadata definitions for ShadowEffect2D.

Member Data Documentation

DynamicPropertyType<Vector2> ActualOffsetProperty
Initial value:
=
new DynamicPropertyType<>("ShadowEffect2D.ActualOffset", Vector2.class)

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

Kanzi calculates the offset from the values of the Shadow Distance and Shadow Angle properties or from the Override Shadow Offset, if it is set.

DynamicPropertyType<Float> AngleProperty
Initial value:
=
new DynamicPropertyType<>("ShadowEffect2D.Angle", Float.class)

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

The default is 45 degrees. When you set the Override Shadow Offset property, this property has no effect.

DynamicPropertyType<Float> BlurRadiusProperty
Initial value:
=
new DynamicPropertyType<>("ShadowEffect2D.BlurRadius", Float.class)

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 is 8 pixels.

Initial value:
=
new DynamicPropertyType<>("ShadowEffect2D.Color", ColorRGBA.class)

Sets the color and alpha of the shadow.

DynamicPropertyType<Float> DistanceProperty
Initial value:
=
new DynamicPropertyType<>("ShadowEffect2D.Distance", Float.class)

Sets how far to move the shadow from the object in the direction set by the Shadow Angle property.

The default is 10 pixels. When you set the Override Shadow Offset property, this property has no effect.

DynamicPropertyType<Vector2> OverrideOffsetProperty
Initial value:
=
new DynamicPropertyType<>("ShadowEffect2D.OverrideOffset", Vector2.class)

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

When you set this property, the Shadow Angle and Shadow Distance properties have no effect. To disable the offset override, remove this property.

Initial value:
=
new DynamicPropertyType<>("ShadowEffect2D.Quality", ShadowEffect2DEnums.Quality.class)

Sets the visual quality of the shadow.

Lower quality uses less computing and memory resources.

DynamicPropertyType<Boolean> ShadowOnlyProperty
Initial value:
=
new DynamicPropertyType<>("ShadowEffect2D.ShadowOnly", Boolean.class)

Whether to render only the shadow without the node contents.

Initial value:
=
new DynamicPropertyType<>("ShadowEffect2D.Type", ShadowEffect2DEnums.Type.class)

Sets the type of the shadow:

  • Drop Shadow appears behind or below objects.
  • Inner Shadow appears inside objects.