MaskEffect2D Class Reference
Use MaskEffect2D to apply a mask to 2D nodes. More...
Inheritance diagram for MaskEffect2D:
Static Public Member Functions | |
| static ObjectRef< MaskEffect2D > | create (Domain domain, String name) |
| Creates a mask effect. | |
Static Public Attributes | |
| static final Metaclass | metaclass |
| The Metaclass for the class. | |
 Static Public Attributes inherited from NodeEffect2D | |
| static final Metaclass | metaclass |
| The Metaclass for the class. | |
| Static Public Attributes inherited from Resource | |
| static final Metaclass | metaclass |
| The Metaclass for the class. | |
| Static Public Attributes inherited from KanziObject | |
| static final Metaclass | metaclass = new AbstractMetaclass("Kanzi.Object") |
| The Metaclass for the class. | |
Additional Inherited Members | |
| Public Member Functions inherited from Resource | |
| String | getName () |
| Gets the resource name. | |
| String | getUrl () |
| Gets the resource URL. | |
| void | setKeepAlive (boolean keepAlive) |
| Sets the keep alive flag. | |
| Public Member Functions inherited from KanziObject | |
| boolean | equals (Object object) |
| Domain | getDomain () |
| Returns the domain the object belongs to. | |
| Metaclass | getDynamicMetaclass () |
| Returns the metaclass of the dynamic type of the object. | |
| long | getNative () |
| Gets a pointer to the backing C++ instance. | |
| TDataType | getOptionalProperty (PropertyType< TDataType > propertyType) |
| Returns the current value of a property type, but does not use the default value if there are no inputs to the property value. | |
| TDataType | getProperty (PropertyType< TDataType > propertyType) |
| Returns the current value of a property type. | |
| int | hashCode () |
| boolean | hasValue (PropertyType< TDataType > propertyType) |
| Evaluates whether there are any inputs into the property value. | |
| boolean | isStale () |
| Test if the object is stale i.e. | |
| void | removeLocalValue (PropertyType< TDataType > propertyType) |
| Removes the local value associated with the property. | |
| void | setFlagKeepDuringPatching (PropertyType< TDataType > propertyType) |
| Sets the flag to indicate that the property was loaded from KZB. | |
| void | setProperty (PropertyType< TDataType > propertyType, TDataType value) |
| Sets the local value of a property type. | |
| ObjectRef< TType > | tryCreateObjectRef (Class< TType > clazz) |
| Tries to create an owning ObjectRef instance to this KanziObject. | |
| Public Attributes inherited from ResourceMetadata | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.Resource") |
| Metaclass for Resource. | |
| Public Attributes inherited from NodeEffect2DMetadata | |
| DynamicPropertyType< Boolean > | EnabledProperty |
| Whether to apply this effect. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.NodeEffect2D") |
| Metaclass for NodeEffect2D. | |
| Public Attributes inherited from MaskEffect2DMetadata | |
| DynamicPropertyType< MaskEffect2DEnums.Channel > | ChannelProperty |
| Sets the texture channel to use as the input for the mask: | |
| DynamicPropertyType< Float > | HeightProperty |
| Sets the height of the mask to use in a layout. | |
| DynamicPropertyType< MaskEffect2DEnums.HorizontalAlignment > | HorizontalAlignmentProperty |
| Sets the horizontal alignment of the mask effect: | |
| DynamicPropertyType< Boolean > | InvertProperty |
| Whether to invert the mask so that transparent areas become opaque and opaque areas become transparent. | |
| DynamicPropertyType< Resource > | MaskProperty |
| Sets the mask texture. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.MaskEffect2D") |
| Metaclass for MaskEffect2D. | |
| DynamicPropertyType< Vector2 > | OffsetProperty |
| Sets the mask offset along the X and Y axes in pixels. | |
| DynamicPropertyType< Vector2 > | ScaleProperty |
| Sets the factor by which to scale the mask. | |
| DynamicPropertyType< Boolean > | ScreenSpaceProperty |
| Whether to layout the mask relative to the screen instead of the node. | |
| DynamicPropertyType< Float > | StrengthProperty |
| Sets the strength of the mask effect in the range from 0 to 1: | |
| DynamicPropertyType< MaskEffect2DEnums.Stretch > | StretchProperty |
| Sets the stretch mode of the mask effect: | |
| DynamicPropertyType< MaskEffect2DEnums.VerticalAlignment > | VerticalAlignmentProperty |
| Sets the vertical alignment of the mask effect: | |
| DynamicPropertyType< Float > | WidthProperty |
| Sets the width of the mask to use in a layout. | |
Detailed Description
Use MaskEffect2D to apply a mask to 2D nodes.
Member Function Documentation
◆ create()
|
static |
Creates a mask effect.
- Parameters
-
domain Domain to use. name Resource name.