Kanzi  3.9.6
Java API
OutlineEffect2D Class Reference

Use the Outline Effect 2D to draw an outline around the content of a 2D node. More...

Inheritance diagram for OutlineEffect2D:
[legend]

Static Public Member Functions

static ObjectRef< T > create (Domain domain, String name)
 Constructs a new OutlineEffect2D. More...
 

Static Public Attributes

static final Metaclass metaclass
 The Metaclass for the class. More...
 
- Static Public Attributes inherited from NodeEffect2D
static final Metaclass metaclass
 The Metaclass for the class. More...
 
- Static Public Attributes inherited from Resource
static final Metaclass metaclass
 The Metaclass for the class. More...
 
- 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. More...
 
String getUrl ()
 Gets the resource URL. More...
 
void setKeepAlive (boolean keepAlive)
 Sets the keep alive flag. More...
 
- Public Member Functions inherited from KanziObject
boolean equals (Object object)
 
Domain getDomain ()
 Returns the domain the object belongs to. More...
 
Metaclass getDynamicMetaclass ()
 Returns the metaclass of the dynamic type of the object. More...
 
long getNative ()
 Gets a pointer to the backing C++ instance. More...
 
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. More...
 
TDataType getProperty (PropertyType< TDataType > propertyType)
 Returns the current value of a property type. More...
 
EnumType getProperty (PropertyType< Integer > propertyType, Class< EnumType > enumClass)
 Returns the current value of an integer property type converted to a matching constant from specified enumeration. More...
 
int hashCode ()
 
boolean hasValue (PropertyType< TDataType > propertyType)
 Evaluates whether there are any inputs into the property value. More...
 
boolean isStale ()
 Test if the object is stale i.e. More...
 
void removeLocalValue (PropertyType< TDataType > propertyType)
 Removes the local value associated with the property. More...
 
void setProperty (PropertyType< TDataType > propertyType, TDataType value)
 Sets the local value of a property type. More...
 
void setProperty (PropertyType< Integer > propertyType, EnumType value)
 Sets the local value of an integer property type using a constant from an enumeration. More...
 
ObjectRef< TType > tryCreateObjectRef (Class< TType > clazz)
 Tries to create an owning ObjectRef instance to this KanziObject. More...
 
- Public Attributes inherited from ResourceMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Resource")
 Metaclass for Resource.
 
- Public Attributes inherited from NodeEffect2DMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.NodeEffect2D")
 Metaclass for NodeEffect2D.
 
- Public Attributes inherited from OutlineEffect2DMetadata
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...
 

Detailed Description

Use the Outline Effect 2D to draw an outline around the content of a 2D node.

Member Function Documentation

◆ create()

static ObjectRef<T> create ( Domain  domain,
String  name 
)
static

Constructs a new OutlineEffect2D.

Parameters
domainUI Domain where this object belongs.
nameName of the object.

Member Data Documentation

◆ metaclass

final Metaclass metaclass
static