MaskEffect2D Class Reference

Use the Mask Effect 2D to apply a mask to a 2D node. More...

Inheritance diagram for MaskEffect2D:

Static Public Member Functions
static ObjectRef< T >	create (Domain domain, String name)
	Constructs a new MaskEffect2D. 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 = com.rightware.kanzi.metadata.ResourceMetadata.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. 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...
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 MaskEffect2DMetadata
DynamicPropertyType< Integer >	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< Integer >	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< Integer >	StretchProperty
	Sets the stretch mode of the mask effect: More...
DynamicPropertyType< Integer >	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...

Detailed Description

Use the Mask Effect 2D to apply a mask to a 2D node.

Member Function Documentation

create()

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

static

Constructs a new MaskEffect2D.

Parameters

domain	UI Domain where this object belongs.
name	Name of the object.

Member Data Documentation

metaclass

final Metaclass metaclass

static

Initial value:

=
        com.rightware.kanzi.metadata.MaskEffect2DMetadata.metaclass

The Metaclass for the class.