MaskEffect2DMetadata Interface Reference

Metadata definitions for MaskEffect2D. More...

Inheritance diagram for MaskEffect2DMetadata:

Public Attributes
DynamicPropertyType< MaskEffect2DEnums.Channel >	ChannelProperty
	Sets the texture channel to use as the input for the mask: More...
DynamicPropertyType< Float >	HeightProperty
	Sets the height of the mask to use in a layout. More...
DynamicPropertyType< MaskEffect2DEnums.HorizontalAlignment >	HorizontalAlignmentProperty
	Sets the horizontal alignment of the mask effect: More...
DynamicPropertyType< Boolean >	InvertProperty
	Whether to invert the mask so that transparent areas become opaque and opaque areas become transparent. More...
DynamicPropertyType< Resource >	MaskProperty
	Sets the mask texture. More...
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.MaskEffect2D")
	Metaclass for MaskEffect2D.
DynamicPropertyType< Vector2 >	OffsetProperty
	Sets the mask offset along the X and Y axes in pixels. More...
DynamicPropertyType< Vector2 >	ScaleProperty
	Sets the factor by which to scale the mask. More...
DynamicPropertyType< Boolean >	ScreenSpaceProperty
	Whether to layout the mask relative to the screen instead of the node. More...
DynamicPropertyType< Float >	StrengthProperty
	Sets the strength of the mask effect in the range from 0 to 1: More...
DynamicPropertyType< MaskEffect2DEnums.Stretch >	StretchProperty
	Sets the stretch mode of the mask effect: More...
DynamicPropertyType< MaskEffect2DEnums.VerticalAlignment >	VerticalAlignmentProperty
	Sets the vertical alignment of the mask effect: More...
DynamicPropertyType< Float >	WidthProperty
	Sets the width of the mask to use in a layout. More...
Public Attributes inherited from NodeEffect2DMetadata
DynamicPropertyType< Boolean >	EnabledProperty
	Whether to apply this effect. More...
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 MaskEffect2D.

Member Data Documentation

DynamicPropertyType<MaskEffect2DEnums.Channel> ChannelProperty

Initial value:

=
        new DynamicPropertyType<>("MaskEffect2D.Channel", MaskEffect2DEnums.Channel.class)

Sets the texture channel to use as the input for the mask:

• Alpha uses the alpha channel from the texture. This is the default.
• Red uses the red color channel from the texture.
• Green uses the green color channel from the texture.
• Blue uses the blue color channel from the texture.
• Luminance uses the luminance calculated from the red, green, and blue channels.

DynamicPropertyType<Float> HeightProperty

Initial value:

=
        new DynamicPropertyType<>("MaskEffect2D.Height", Float.class)

Sets the height of the mask to use in a layout.

This value overrides the height of the texture that you use as the mask.

DynamicPropertyType<MaskEffect2DEnums.HorizontalAlignment> HorizontalAlignmentProperty

Initial value:

=
        new DynamicPropertyType<>(
            "MaskEffect2D.HorizontalAlignment", MaskEffect2DEnums.HorizontalAlignment.class)

Sets the horizontal alignment of the mask effect:

• Left aligns the left edge of the mask with the left edge of the node. This is the default.
• Right aligns the right edge of the mask with the right edge of the node.
• Center aligns the mask horizontally to the center of the node.
• Stretch stretches the mask horizontally to fit the node from the left edge to the right edge.

DynamicPropertyType<Boolean> InvertProperty

Initial value:

=
        new DynamicPropertyType<>("MaskEffect2D.Invert", Boolean.class)

Whether to invert the mask so that transparent areas become opaque and opaque areas become transparent.

DynamicPropertyType<Resource> MaskProperty

Initial value:

=
        new DynamicPropertyType<>("MaskEffect2D.Mask", Resource.class)

Sets the mask texture.

The default is no texture.

DynamicPropertyType<Vector2> OffsetProperty

Initial value:

=
        new DynamicPropertyType<>("MaskEffect2D.Offset", Vector2.class)

Sets the mask offset along the X and Y axes in pixels.

Kanzi applies the mask offset after stretch, alignment, and scale.

DynamicPropertyType<Vector2> ScaleProperty

Initial value:

=
        new DynamicPropertyType<>("MaskEffect2D.Scale", Vector2.class)

Sets the factor by which to scale the mask.

Kanzi applies the scale after stretch and alignment.

DynamicPropertyType<Boolean> ScreenSpaceProperty

Initial value:

=
        new DynamicPropertyType<>("MaskEffect2D.ScreenSpace", Boolean.class)

Whether to layout the mask relative to the screen instead of the node.

DynamicPropertyType<Float> StrengthProperty

Initial value:

=
        new DynamicPropertyType<>("MaskEffect2D.Strength", Float.class)

Sets the strength of the mask effect in the range from 0 to 1:

• 0 disables the mask effect.
• 1 applies the mask at full strength. This is the default.
• Any value between 0 and 1 partially applies the mask as if the non-masked result was blended with the fully masked version.

DynamicPropertyType<MaskEffect2DEnums.Stretch> StretchProperty

Initial value:

=
        new DynamicPropertyType<>("MaskEffect2D.Stretch", MaskEffect2DEnums.Stretch.class)

Sets the stretch mode of the mask effect:

• None disables stretching. This is the default.
• Fill stretches the mask to fill the node.
• Uniform stretches the mask using uniform scaling to fill the node in either vertical or horizontal direction, whichever requires smaller scale.
• Uniform To Fill stretches the mask using uniform scaling to fill the node in either vertical or horizontal direction, whichever requires larger scale.
• Repeat does not stretch the mask, and allows the mask to repeat outside of its area based on the mask texture wrap mode.

DynamicPropertyType<MaskEffect2DEnums.VerticalAlignment> VerticalAlignmentProperty

Initial value:

=
        new DynamicPropertyType<>(
            "MaskEffect2D.VerticalAlignment", MaskEffect2DEnums.VerticalAlignment.class)

Sets the vertical alignment of the mask effect:

• Bottom aligns the bottom edge of the mask with the bottom edge of the node.
• Top aligns the top edge of the mask with the top edge of the node. This is the default.
• Center aligns the mask vertically to the center of the node.
• Stretch stretches the mask vertically to fit the node from the top edge to the bottom edge.

DynamicPropertyType<Float> WidthProperty

Initial value:

=
        new DynamicPropertyType<>("MaskEffect2D.Width", Float.class)

Sets the width of the mask to use in a layout.

This value overrides the width of the texture that you use as the mask.