OutlineEffect2D Class Reference
Use OutlineEffect2D to apply an outline to the content of 2D nodes. More...
Inheritance diagram for OutlineEffect2D:
Static Public Member Functions | |
| static ObjectRef< OutlineEffect2D > | create (Domain domain, String name) |
| Creates an outline 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 OutlineEffect2DMetadata | |
| DynamicPropertyType< Integer > | BlendModeProperty |
| Sets the blend mode to use for rendering the outline. | |
| DynamicPropertyType< ColorRGBA > | ColorProperty |
| Sets the color of the outline. | |
| DynamicPropertyType< Vector2 > | ContentGradientProperty |
| Sets the gradient along which the content fades out: | |
| DynamicPropertyType< Vector4 > | ContentMaskProperty |
| Sets the color that masks color components relevant to the outline calculation. | |
| DynamicPropertyType< Float > | ContentThresholdProperty |
| Sets the threshold at which the value Kanzi calculates using the content mask is considered valid. | |
| DynamicPropertyType< Float > | InnerSoftnessProperty |
| Sets the softness of the outline relative to its width inside the content area. | |
| DynamicPropertyType< Integer > | InnerWidthProperty |
| Sets the width of the outline in pixels inside the content area. | |
| DynamicPropertyType< Boolean > | InvertContentMaskProperty |
| Whether to invert the value that Kanzi calculates using content masking. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.OutlineEffect2D") |
| Metaclass for OutlineEffect2D. | |
| DynamicPropertyType< OutlineEffect2DEnums.OutlineMethod > | MethodProperty |
| Sets the method for outline calculation: | |
| DynamicPropertyType< Float > | SoftnessProperty |
| Sets the softness of the outline. | |
| DynamicPropertyType< Float > | TextureOffsetProperty |
| Sets the relative starting offset for sampling the outline texture. | |
| DynamicPropertyType< Resource > | TextureProperty |
| Sets the texture to apply to the outline. | |
| DynamicPropertyType< Float > | TextureTilingProperty |
| Sets the number of times the texture wraps around within the outline area. | |
| DynamicPropertyType< Integer > | WidthProperty |
| Sets the width of the outline in pixels outside the content area. | |
Detailed Description
Use OutlineEffect2D to apply an outline to the content of 2D nodes.
Member Function Documentation
◆ create()
|
static |
Creates an outline effect.
- Parameters
-
domain Domain to use. name Resource name.
- Returns
- handle to the created OutlineEffect2D instance.