Class VisualMap

Definition

Namespace:

Tizen.NUI

Assembly:

Tizen.NUI.dll

A class encapsulating the transform map of the visual.

public class VisualMap : IDisposable

Inheritance

object

VisualMap

Derived

AnimatedImageVisual

AnimatedImageVisual

BorderVisual

BorderVisual

ColorVisual

ColorVisual

GradientVisual

GradientVisual

ImageVisual

ImageVisual

MeshVisual

MeshVisual

NPatchVisual

NPatchVisual

PrimitiveVisual

PrimitiveVisual

SVGVisual

SVGVisual

TextVisual

TextVisual

VisualAnimator

VisualAnimator

Implements

System.IDisposable

Constructors

VisualMap()

Constructor.

Declaration

public VisualMap()

Fields

_commonlyUsedMap

The map for visual.

Declaration

[Obsolete("Deprecated in API9, will be removed in API11, Please not use _comonlyUsedMap")]
protected PropertyMap _commonlyUsedMap

Field Value

Type	Description
PropertyMap

_mixColor

The mixColor of the Visual.

Declaration

[Obsolete("Deprecated in API9, will be removed in API11, Use MixColor")]
protected Color _mixColor

Field Value

Type	Description
Color

_opacity

The opacity of the visual.

Declaration

[Obsolete("Deprecated in API9, will be removed in API11, Use Opacity")]
protected float? _opacity

Field Value

Type	Description
float?

_outputVisualMap

outputVisualMap.

Declaration

[Obsolete("Deprecated in API9, will be removed in API11, Use OutputVisualMap")]
protected PropertyMap _outputVisualMap

Field Value

Type	Description
PropertyMap

_premultipliedAlpha

The premultipliedAlpha of the visual.

Declaration

[Obsolete("Deprecated in API9, will be removed in API11, Use PremultipliedAlpha")]
protected bool? _premultipliedAlpha

Field Value

Type	Description
bool?

_shader

The shader of the visual.

Declaration

[Obsolete("Deprecated in API9, will be removed in API11, Use Shader")]
protected PropertyMap _shader

Field Value

Type	Description
PropertyMap

_visualFittingMode

The FittingMode of the visual.

Declaration

[Obsolete("Deprecated in API9, will be removed in API11, Use VisualFittingMode")]
protected VisualFittingModeType? _visualFittingMode

Field Value

Type	Description
VisualFittingModeType?

Properties

AnchorPoint

Gets or sets the anchor point of the visual.
By default, the anchor point is AlignType.TopBegin.
Optional.

Declaration

public Visual.AlignType AnchorPoint { get; set; }

Property Value

Type	Description
Visual.AlignType

DepthIndex

Gets or sets the depth index of the visual.
By default, the depth index is 0.
Optional.

Declaration

public int DepthIndex { get; set; }

Property Value

Type	Description
int

MixColor

Mix color is a blend color for any visual.

Declaration

public Color MixColor { get; set; }

Property Value

Type	Description
Color

Opacity

Opacity is the alpha component of the mix color discussed above.

Declaration

public float Opacity { get; set; }

Property Value

Type	Description
float

Origin

Gets or sets the origin of the visual within its control area.
By default, the origin is AlignType.TopBegin.
Optional.

Declaration

public Visual.AlignType Origin { get; set; }

Property Value

Type	Description
Visual.AlignType

OutputTransformMap

Gets the transform map used by the visual.

Declaration

public PropertyMap OutputTransformMap { get; }

Property Value

Type	Description
PropertyMap

OutputVisualMap

Gets the property map to create the visual.

Declaration

public PropertyMap OutputVisualMap { get; }

Property Value

Type	Description
PropertyMap

Position

Gets or sets the offset of the visual.
It can be either relative (percentage of the parent) or absolute (in world units).
Optional.

Declaration

public Vector2 Position { get; set; }

Property Value

Type	Description
Vector2

PositionPolicy

Gets or sets whether the x and y offset values are relative
(percentage [0.0f to 1.0f] of the control) or absolute (in world units).
By default, both the x and the y offset are relative.
Optional.

Declaration

public VisualTransformPolicyType PositionPolicy { get; set; }

Property Value

Type	Description
VisualTransformPolicyType

PositionPolicyX

Gets or sets whether the x offset values are relative
(percentage [0.0f to 1.0f] of the control) or absolute (in world units).
By default, the x offset is relative.
Optional.

Declaration

public VisualTransformPolicyType PositionPolicyX { get; set; }

Property Value

Type	Description
VisualTransformPolicyType

PositionPolicyY

Gets or sets whether the y offset values are relative
(percentage [0.0f to 1.0f] of the control) or absolute (in world units).
By default, the y offset is relative.
Optional.

Declaration

public VisualTransformPolicyType PositionPolicyY { get; set; }

Property Value

Type	Description
VisualTransformPolicyType

PremultipliedAlpha

Enables or disables the premultiplied alpha.
The premultiplied alpha is false by default unless this behavior is modified by the derived visual type.

Declaration

public bool PremultipliedAlpha { get; set; }

Property Value

Type	Description
bool

RelativePosition

Gets or sets the relative offset of the visual
(percentage [0.0f to 1.0f] of the control).
Optional.

Declaration

public RelativeVector2 RelativePosition { get; set; }

Property Value

Type	Description
RelativeVector2

RelativeSize

Gets or sets the relative size of the visual
(percentage [0.0f to 1.0f] of the control).
Optional.

Declaration

public RelativeVector2 RelativeSize { get; set; }

Property Value

Type	Description
RelativeVector2

Shader

The shader to use in the visual.

Declaration

public PropertyMap Shader { get; set; }

Property Value

Type	Description
PropertyMap

Size

Gets or sets the size of the visual.
It can be either relative (percentage of the parent) or absolute (in world units).
Optional.

Declaration

public Size2D Size { get; set; }

Property Value

Type	Description
Size2D

SizePolicy

Gets or sets whether the size values of the width or the height are relative
(percentage [0.0f to 1.0f] of the control) or absolute (in world units).
By default, offsets of both the width and the height are relative to the control's size.
Optional.

Declaration

public VisualTransformPolicyType SizePolicy { get; set; }

Property Value

Type	Description
VisualTransformPolicyType

SizePolicyHeight

Gets or sets whether size values of the height are relative
(percentage [0.0f to 1.0f] of the control) or absolute (in world units).
By default, the height value is relative to the control's height.
Optional.

Declaration

public VisualTransformPolicyType SizePolicyHeight { get; set; }

Property Value

Type	Description
VisualTransformPolicyType

SizePolicyWidth

Gets or sets whether size values of the width are relative.
(percentage [0.0f to 1.0f] of the control) or absolute (in world units).
By default, the value of the width is relative to the control's width.
Optional.

Declaration

public VisualTransformPolicyType SizePolicyWidth { get; set; }

Property Value

Type	Description
VisualTransformPolicyType

VisualFittingMode

The fitting mode of the visual. The default is defined by the type of visual (if it is suitable to be stretched or not).

Declaration

public VisualFittingModeType VisualFittingMode { get; set; }

Property Value

Type	Description
VisualFittingModeType

Methods

ComposingPropertyMap()

Compose the out visual map.

Declaration

protected virtual void ComposingPropertyMap()

Implements

System.IDisposable