Kanzi  3.9.6
Java API
OutlineEffect2DMetadata Interface Reference

Metadata definitions for OutlineEffect2D. More...

Inheritance diagram for OutlineEffect2DMetadata:
[legend]

Public Attributes

DynamicPropertyType< ColorRGBAColorProperty
 Sets the color of the outline. More...
 
DynamicPropertyType< Vector2ContentGradientProperty
 Sets the gradient along which the content fades out: More...
 
DynamicPropertyType< Vector4ContentMaskProperty
 Sets the color that masks color components relevant to the outline calculation. More...
 
DynamicPropertyType< Float > ContentThresholdProperty
 Sets the threshold at which the value Kanzi calculates using the content mask is considered valid. More...
 
DynamicPropertyType< Float > InnerSoftnessProperty
 Sets the softness of the outline relative to its width inside the content area. More...
 
DynamicPropertyType< Integer > InnerWidthProperty
 Sets the width of the outline in pixels inside the content area. More...
 
DynamicPropertyType< Boolean > InvertContentMaskProperty
 Whether to invert the value that Kanzi calculates using content masking. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.OutlineEffect2D")
 Metaclass for OutlineEffect2D.
 
DynamicPropertyType< Integer > MethodProperty
 Sets the method for outline calculation: More...
 
DynamicPropertyType< Float > SoftnessProperty
 Sets the softness of the outline. More...
 
DynamicPropertyType< Float > TextureOffsetProperty
 Sets the relative starting offset for sampling the outline texture. More...
 
DynamicPropertyType< ResourceTextureProperty
 Sets the texture to apply to the outline. More...
 
DynamicPropertyType< Float > TextureTilingProperty
 Sets the number of times the texture wraps around within the outline area. More...
 
DynamicPropertyType< Integer > WidthProperty
 Sets the width of the outline in pixels outside the content area. 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 OutlineEffect2D.

Member Data Documentation

◆ ColorProperty

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

Sets the color of the outline.

◆ ContentGradientProperty

DynamicPropertyType<Vector2> ContentGradientProperty
Initial value:
=
new DynamicPropertyType<>("OutlineEffect2D.ContentGradient", Vector2.class)

Sets the gradient along which the content fades out:

  • Start sets the minimum intensity at which the content starts to fade out.
  • Softness sets the difference in intensity it takes for the content to disappear.

For a perfectly smooth gradient, set Start to 0 and Softness to 1. The default value [ 0.0, 0.19 ] makes the content fade out quickly before the outline fade-out starts.

◆ ContentMaskProperty

DynamicPropertyType<Vector4> ContentMaskProperty
Initial value:
=
new DynamicPropertyType<>("OutlineEffect2D.ContentMask", Vector4.class)

Sets the color that masks color components relevant to the outline calculation.

The comparison value is the result of a dot product between the mask and the content RGBA color value. By default Kanzi calculates the outline only from the alpha value.

◆ ContentThresholdProperty

DynamicPropertyType<Float> ContentThresholdProperty
Initial value:
=
new DynamicPropertyType<>("OutlineEffect2D.ContentThreshold", Float.class)

Sets the threshold at which the value Kanzi calculates using the content mask is considered valid.

When the value calculated from masking the content exceeds this value, that pixel is part of the outlined area.

◆ InnerSoftnessProperty

DynamicPropertyType<Float> InnerSoftnessProperty
Initial value:
=
new DynamicPropertyType<>("OutlineEffect2D.InnerSoftness", Float.class)

Sets the softness of the outline relative to its width inside the content area.

For a sharp outline, set to 0. For a fade-in that takes the complete outline width to reach maximum value, set to 1. By default, this property uses the value of the Outline Softness property.

◆ InnerWidthProperty

DynamicPropertyType<Integer> InnerWidthProperty
Initial value:
=
new DynamicPropertyType<>("OutlineEffect2D.InnerWidth", Integer.class)

Sets the width of the outline in pixels inside the content area.

By default, this property uses the value of the Outline Width property.

◆ InvertContentMaskProperty

DynamicPropertyType<Boolean> InvertContentMaskProperty
Initial value:
=
new DynamicPropertyType<>("OutlineEffect2D.InvertContentMask", Boolean.class)

Whether to invert the value that Kanzi calculates using content masking.

◆ MethodProperty

DynamicPropertyType<Integer> MethodProperty
Initial value:
=
new DynamicPropertyType<>("OutlineEffect2D.Method", Integer.class)

Sets the method for outline calculation:

  • Box search. Potentially consumes less memory, slower.
  • Two-pass search. Potentially consumes more memory, faster. This the default.

◆ SoftnessProperty

DynamicPropertyType<Float> SoftnessProperty
Initial value:
=
new DynamicPropertyType<>("OutlineEffect2D.Softness", Float.class)

Sets the softness of the outline.

For a sharp outline, set to 0. For a fade-in that takes the complete outline width to reach maximum value, set to 1. The default value is 0.27.

◆ TextureOffsetProperty

DynamicPropertyType<Float> TextureOffsetProperty
Initial value:
=
new DynamicPropertyType<>("OutlineEffect2D.TextureOffset", Float.class)

Sets the relative starting offset for sampling the outline texture.

The default value is 0.0.

◆ TextureProperty

DynamicPropertyType<Resource> TextureProperty
Initial value:
=
new DynamicPropertyType<>("OutlineEffect2D.Texture", Resource.class)

Sets the texture to apply to the outline.

Kanzi applies to the outline only the top row of pixels from this texture. Set Outline Color to the color with which you want to modulate the colors in this texture.

◆ TextureTilingProperty

DynamicPropertyType<Float> TextureTilingProperty
Initial value:
=
new DynamicPropertyType<>("OutlineEffect2D.TextureTiling", Float.class)

Sets the number of times the texture wraps around within the outline area.

To repeat a texture, set its Wrap Mode to Repeat. The default value is 1.0

◆ WidthProperty

DynamicPropertyType<Integer> WidthProperty
Initial value:
=
new DynamicPropertyType<>("OutlineEffect2D.Width", Integer.class)

Sets the width of the outline in pixels outside the content area.

The default value is 4 pixels.