-
Notifications
You must be signed in to change notification settings - Fork 0
Rect2I
Home | API by Category | Complete API Index | API Compatibility
| Field | Value |
|---|---|
| Full name | Electron2D.Rect2I |
| Namespace | Electron2D |
| Kind | struct |
| Category | Math and Data |
Represents the rect2 i value type.
public struct Electron2D.Rect2I : System.IEquatable<Electron2D.Rect2I>Profile: Electron2D 0.1.0 2D
Status: Partial / Not verified
Out of profile: yes
Godot reference: Rect2I
Integer axis-aligned rectangle baseline with intersection, merge, grow and normalization helpers.
This type is part of the Electron2D 0.1.0 Preview public API.
Instances of this type are not synchronized. Access them from the thread that owns the object unless the member documentation states otherwise.
This API is available since Electron2D 0.1.0 Preview.
| Member | Kind | Summary |
|---|---|---|
End |
Property | Gets or sets the end value. |
Position |
Property | Gets or sets the position value. |
Size |
Property | Gets or sets the size value. |
Electron2D.Rect2I(Electron2D.Vector2I, Electron2D.Vector2I) |
Constructor | Initializes a new instance of the Rect2I type. |
Electron2D.Rect2I(System.Int32, System.Int32, System.Int32, System.Int32) |
Constructor | Initializes a new instance of the Rect2I type. |
Abs() |
Method | Executes the abs operation. |
Encloses(Electron2D.Rect2I) |
Method | Executes the encloses operation. |
Equals(Electron2D.Rect2I) |
Method | Executes the equals operation. |
Equals(System.Object) |
Method | Executes the equals operation. |
Expand(Electron2D.Vector2I) |
Method | Executes the expand operation. |
GetArea() |
Method | Gets the area value. |
GetCenter() |
Method | Gets the center value. |
GetHashCode() |
Method | Gets the hash code value. |
Grow(System.Int32) |
Method | Executes the grow operation. |
HasArea() |
Method | Checks whether area is available. |
HasPoint(Electron2D.Vector2I) |
Method | Checks whether point is available. |
Intersection(Electron2D.Rect2I) |
Method | Executes the intersection operation. |
Intersects(Electron2D.Rect2I, System.Boolean) |
Method | Executes the intersects operation. |
Merge(Electron2D.Rect2I) |
Method | Executes the merge operation. |
ToString() |
Method | Executes the to string operation. |
op_Equality(Electron2D.Rect2I, Electron2D.Rect2I) |
Method | Applies the == operator. |
op_Inequality(Electron2D.Rect2I, Electron2D.Rect2I) |
Method | Applies the != operator. |
Kind: Property
public Electron2D.Vector2I End { get; set; }Gets or sets the end value.
This property follows the validation and lifetime rules of its declaring type.
The current end value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Rect2I
Kind: Property
public Electron2D.Vector2I Position { get; set; }Gets or sets the position value.
This property follows the validation and lifetime rules of its declaring type.
The current position value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Rect2I
Kind: Property
public Electron2D.Vector2I Size { get; set; }Gets or sets the size value.
This property follows the validation and lifetime rules of its declaring type.
The current size value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Rect2I
Kind: Constructor
public Electron2D.Rect2I(Electron2D.Vector2I position, Electron2D.Vector2I size)Initializes a new instance of the Rect2I type.
The new instance follows the lifetime and validation rules of its declaring type.
-
position: The position value. -
size: The size value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Rect2I
Kind: Constructor
public Electron2D.Rect2I(System.Int32 x, System.Int32 y, System.Int32 width, System.Int32 height)Initializes a new instance of the Rect2I type.
The new instance follows the lifetime and validation rules of its declaring type.
-
x: The X coordinate or component. -
y: The Y coordinate or component. -
width: The width value. -
height: The height value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Rect2I
Kind: Method
public Electron2D.Rect2I Abs()()Executes the abs operation.
This method follows the validation and lifetime rules of its declaring type.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Rect2I
Kind: Method
public System.Boolean Encloses(Electron2D.Rect2I)(Electron2D.Rect2I rect)Executes the encloses operation.
This method follows the validation and lifetime rules of its declaring type.
-
rect: The rect value.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Rect2I
Kind: Method
public System.Boolean Equals(Electron2D.Rect2I)(Electron2D.Rect2I other)Executes the equals operation.
This method follows the validation and lifetime rules of its declaring type.
-
other: The other value.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Rect2I
Kind: Method
public System.Boolean Equals(System.Object)(System.Object obj)Executes the equals operation.
This method follows the validation and lifetime rules of its declaring type.
-
obj: The obj value.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Rect2I
Kind: Method
public Electron2D.Rect2I Expand(Electron2D.Vector2I)(Electron2D.Vector2I to)Executes the expand operation.
This method follows the validation and lifetime rules of its declaring type.
-
to: The to value.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Rect2I
Kind: Method
public System.Int32 GetArea()()Gets the area value.
This method follows the validation and lifetime rules of its declaring type.
The current area value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Rect2I
Kind: Method
public Electron2D.Vector2I GetCenter()()Gets the center value.
This method follows the validation and lifetime rules of its declaring type.
The current center value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Rect2I
Kind: Method
public System.Int32 GetHashCode()()Gets the hash code value.
This method follows the validation and lifetime rules of its declaring type.
The current hash code value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Rect2I
Kind: Method
public Electron2D.Rect2I Grow(System.Int32)(System.Int32 amount)Executes the grow operation.
This method follows the validation and lifetime rules of its declaring type.
-
amount: The amount value.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Rect2I
Kind: Method
public System.Boolean HasArea()()Checks whether area is available.
This method follows the validation and lifetime rules of its declaring type.
true when the condition is met; otherwise, false.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Rect2I
Kind: Method
public System.Boolean HasPoint(Electron2D.Vector2I)(Electron2D.Vector2I point)Checks whether point is available.
This method follows the validation and lifetime rules of its declaring type.
-
point: The point value.
true when the condition is met; otherwise, false.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Rect2I
Kind: Method
public Electron2D.Rect2I Intersection(Electron2D.Rect2I)(Electron2D.Rect2I rect)Executes the intersection operation.
This method follows the validation and lifetime rules of its declaring type.
-
rect: The rect value.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Rect2I
Kind: Method
public System.Boolean Intersects(Electron2D.Rect2I, System.Boolean)(Electron2D.Rect2I rect, System.Boolean includeBorders)Executes the intersects operation.
This method follows the validation and lifetime rules of its declaring type.
-
rect: The rect value. -
includeBorders: The include borders value.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Rect2I
Kind: Method
public Electron2D.Rect2I Merge(Electron2D.Rect2I)(Electron2D.Rect2I rect)Executes the merge operation.
This method follows the validation and lifetime rules of its declaring type.
-
rect: The rect value.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Rect2I
Kind: Method
public System.String ToString()()Executes the to string operation.
This method follows the validation and lifetime rules of its declaring type.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Rect2I
Kind: Method
public static System.Boolean op_Equality(Electron2D.Rect2I, Electron2D.Rect2I)(Electron2D.Rect2I left, Electron2D.Rect2I right)Applies the == operator.
This operator returns a value derived from the supplied operands.
-
left: The left value. -
right: The right value.
The result of the operator.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Rect2I
Kind: Method
public static System.Boolean op_Inequality(Electron2D.Rect2I, Electron2D.Rect2I)(Electron2D.Rect2I left, Electron2D.Rect2I right)Applies the != operator.
This operator returns a value derived from the supplied operands.
-
left: The left value. -
right: The right value.
The result of the operator.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Rect2I
Electron2D 0.1.0 Preview API reference. Generated from 175 public runtime types.