ShadowEffect2D Class Reference
Use ShadowEffect2D to apply drop- and inner-shadow post-processing effects to 2D nodes. More...
Inheritance diagram for ShadowEffect2D:
Static Public Member Functions | |
| static ObjectRef< ShadowEffect2D > | create (Domain domain, String name) |
| Creates a shadow 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 | 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 ShadowEffect2DMetadata | |
| DynamicPropertyType< Vector2 > | ActualOffsetProperty |
| Reports the offset of the shadow from the object along the x and y axes in pixels. | |
| DynamicPropertyType< Float > | AngleProperty |
| Sets the direction of the shadow as an angle relative to the positive x axis. | |
| DynamicPropertyType< Integer > | BlendModeProperty |
| Sets the blend mode to use for rendering the shadow. | |
| DynamicPropertyType< Float > | BlurRadiusProperty |
| Sets the softness of the shadow by defining the distance in pixels the shadow blur extends outward from an edge. | |
| DynamicPropertyType< ColorRGBA > | ColorProperty |
| Sets the color and alpha of the shadow. | |
| DynamicPropertyType< Float > | DistanceProperty |
| Sets how far to move the shadow from the object in the direction set by the Shadow Angle property. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.ShadowEffect2D") |
| Metaclass for ShadowEffect2D. | |
| DynamicPropertyType< Vector2 > | OverrideOffsetProperty |
| Sets the offset of the shadow from the object along the x and y axes in pixels. | |
| DynamicPropertyType< ShadowEffect2DEnums.Quality > | QualityProperty |
| Sets the visual quality of the shadow. | |
| DynamicPropertyType< Boolean > | ShadowOnlyProperty |
| Whether to render only the shadow without the node contents. | |
| DynamicPropertyType< ShadowEffect2DEnums.Type > | TypeProperty |
| Sets the type of the shadow: | |
Detailed Description
Use ShadowEffect2D to apply drop- and inner-shadow post-processing effects to 2D nodes.
Member Function Documentation
◆ create()
|
static |
Creates a shadow effect.
- Parameters
-
domain Domain to use. name Resource name.
- Returns
- handle to the created ShadowEffect2D instance.