Class Size
Definition
- Assembly:
- Tizen.NUI.dll
A three-dimensional size.
public class Size : Disposable, IDisposable, ICloneable
- Inheritance
- Implements
-
System.IDisposableSystem.ICloneable
Constructors
View SourceSize()
The constructor.
Declaration
public Size()
Remarks
Size2D and Size are implicitly converted to each other, so these are compatible and can be replaced without any type casting.
For example, the followings are possible.
view.Size2D = new Size(10.0f, 10.0f, 10.0f); // be aware that here the depth value(10.0f) will be lost.
view.Size = new Size2D(10, 10); // be aware that here the depth value is 0.0f by default.
view.MinimumSize = new Size(10, 10, 0);
Size Tmp = view.MaximumSize; //here Tmp.Depth will be 0.0f.
Size(float, float, float)
The constructor.
Declaration
public Size(float width, float height, float depth = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| float | width | The width component. |
| float | height | The height component. |
| float | depth | The depth component(optional). |
Remarks
Size2D and Size are implicitly converted to each other, so these are compatible and can be replaced without any type casting.
For example, the followings are possible.
view.Size2D = new Size(10.0f, 10.0f, 10.0f); // be aware that here the depth value(10.0f) will be lost.
view.Size = new Size2D(10, 10); // be aware that here the depth value is 0.0f by default.
view.MinimumSize = new Size(10, 10, 0);
Size Tmp = view.MaximumSize; //here Tmp.Depth will be 0.0f.
Size(Size2D)
The constructor.
Declaration
public Size(Size2D size2d)
Parameters
| Type | Name | Description |
|---|---|---|
| Size2D | size2d | Size2D with width and height. |
Properties
View SourceDepth
The Depth property for the depth component of size.
Declaration
public float Depth { get; set; }
Property Value
| Type | Description |
|---|---|
| float |
Remarks
The setter is deprecated in API8 and will be removed in API10. Use new Size(...) constructor.
Height
The Height property for the height component of size.
Declaration
public float Height { get; set; }
Property Value
| Type | Description |
|---|---|
| float |
Remarks
The setter is deprecated in API8 and will be removed in API10. Use new Size(...) constructor.
this[uint]
The array subscript operator.
Declaration
public float this[uint index] { get; }
Parameters
| Type | Name | Description |
|---|---|---|
| uint | index | Subscript index. |
Property Value
| Type | Description |
|---|---|
| float | The float at the given index. |
Width
The Width property for the width component of size
Declaration
public float Width { get; set; }
Property Value
| Type | Description |
|---|---|
| float |
Remarks
The setter is deprecated in API8 and will be removed in API10. Use new Size(...) constructor.
Zero
The Zero constant, (0.0f, 0.0f, 0.0f).
Declaration
public static Size Zero { get; }
Property Value
| Type | Description |
|---|---|
| Size |
Methods
View SourceEquals(Object)
Determines whether the specified object is equal to the current object.
Declaration
public override bool Equals(Object obj)
Parameters
| Type | Name | Description |
|---|---|---|
| Tizen.System.Object | obj | The object to compare with the current object. |
Returns
| Type | Description |
|---|---|
| bool | true if the specified object is equal to the current object; otherwise, false. |
EqualTo(Size)
Checks equality.
Utilizes appropriate machine epsilon values.
Declaration
public bool EqualTo(Size rhs)
Parameters
| Type | Name | Description |
|---|---|---|
| Size | rhs | The size to test against. |
Returns
| Type | Description |
|---|---|
| bool | True if the sizes are equal. |
GetHashCode()
Gets the hash code of this Size.
Declaration
public override int GetHashCode()
Returns
| Type | Description |
|---|---|
| int | The Hash Code. |
Overrides
NotEqualTo(Size)
Checks inequality.
Utilizes appropriate machine epsilon values.
Declaration
public bool NotEqualTo(Size rhs)
Parameters
| Type | Name | Description |
|---|---|---|
| Size | rhs | The size to test against. |
Returns
| Type | Description |
|---|---|
| bool | True if the sizes are not equal. |
Operators
View Sourceoperator +(Size, Size)
The addition operator for A+B.
Declaration
public static Size operator +(Size arg1, Size arg2)
Parameters
| Type | Name | Description |
|---|---|---|
| Size | arg1 | Size to assign A. |
| Size | arg2 | Size to assign B. |
Returns
| Type | Description |
|---|---|
| Size | A size containing the result of the addition. |
operator /(Size, float)
The division operator.
Declaration
public static Size operator /(Size arg1, float arg2)
Parameters
| Type | Name | Description |
|---|---|---|
| Size | arg1 | Size for division. |
| float | arg2 | The float value to scale the size by. |
Returns
| Type | Description |
|---|---|
| Size | A Size containing the result of the scaling. |
operator /(Size, Size)
The division operator.
Declaration
public static Size operator /(Size arg1, Size arg2)
Parameters
| Type | Name | Description |
|---|---|---|
| Size | arg1 | Size for division. |
| Size | arg2 | The size to divide. |
Returns
| Type | Description |
|---|---|
| Size | A size containing the result of the division. |
implicit operator Vector3(Size)
The type cast operator, Size to Vector3.
Declaration
public static implicit operator Vector3(Size size)
Parameters
| Type | Name | Description |
|---|---|---|
| Size | size | The object of size type. |
Returns
| Type | Description |
|---|---|
| Vector3 |
implicit operator Size(Vector3)
The type cast operator, Vector3 to Size type.
Declaration
public static implicit operator Size(Vector3 vec)
Parameters
| Type | Name | Description |
|---|---|---|
| Vector3 | vec | The object of Vector3 type. |
Returns
| Type | Description |
|---|---|
| Size |
operator *(Size, float)
The multiplication operator.
Declaration
public static Size operator *(Size arg1, float arg2)
Parameters
| Type | Name | Description |
|---|---|---|
| Size | arg1 | Size for multiplication. |
| float | arg2 | The float value to scale the size. |
Returns
| Type | Description |
|---|---|
| Size | A size containing the result of the scaling. |
operator *(Size, Size)
The multiplication operator.
Declaration
public static Size operator *(Size arg1, Size arg2)
Parameters
| Type | Name | Description |
|---|---|---|
| Size | arg1 | Size for multiplication. |
| Size | arg2 | The size to multiply. |
Returns
| Type | Description |
|---|---|
| Size | A size containing the result of the multiplication. |
operator -(Size, Size)
The subtraction operator for A-B.
Declaration
public static Size operator -(Size arg1, Size arg2)
Parameters
| Type | Name | Description |
|---|---|---|
| Size | arg1 | Size to subtract A. |
| Size | arg2 | Size to subtract B. |
Returns
| Type | Description |
|---|---|
| Size | The size containing the result of the subtraction. |
operator -(Size)
The unary negation operator.
Declaration
public static Size operator -(Size arg1)
Parameters
| Type | Name | Description |
|---|---|---|
| Size | arg1 | Size for unary negation. |
Returns
| Type | Description |
|---|---|
| Size | A size containing the negation. |