Transform2D

Home | API by Category | Complete API Index | API Compatibility

Field	Value
Full name	Electron2D.Transform2D
Namespace	Electron2D
Kind	struct
Category	Math and Data

Overview

Represents the transform2 d value type.

Syntax

public struct Electron2D.Transform2D : System.IEquatable<Electron2D.Transform2D>

Godot 4.7 C# profile compatibility

Profile: Electron2D 0.1.0 2D
Status: Partial / Not verified
Out of profile: yes
Godot reference: Transform2D

2D basis/origin transform baseline with point transforms, composition and inverse.

Remarks

This type is part of the Electron2D 0.1.0 Preview public API.

Thread Safety

Instances of this type are not synchronized. Access them from the thread that owns the object unless the member documentation states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

Members

Member	Kind	Summary
FlipX	Field	Represents the flip x value.
FlipY	Field	Represents the flip y value.
Identity	Field	Represents the identity value.
Origin	Property	Gets or sets the origin value.
X	Property	Gets or sets the x value.
Y	Property	Gets or sets the y value.
Electron2D.Transform2D(Electron2D.Vector2, Electron2D.Vector2, Electron2D.Vector2)	Constructor	Initializes a new instance of the Transform2D type.
Electron2D.Transform2D(System.Single, Electron2D.Vector2)	Constructor	Initializes a new instance of the Transform2D type.
Electron2D.Transform2D(System.Single, System.Single, System.Single, System.Single, System.Single, System.Single)	Constructor	Initializes a new instance of the Transform2D type.
AffineInverse()	Method	Executes the affine inverse operation.
BasisXform(Electron2D.Vector2)	Method	Executes the basis xform operation.
Determinant()	Method	Executes the determinant operation.
Equals(Electron2D.Transform2D)	Method	Executes the equals operation.
Equals(System.Object)	Method	Executes the equals operation.
GetHashCode()	Method	Gets the hash code value.
Inverse()	Method	Executes the inverse operation.
IsEqualApprox(Electron2D.Transform2D)	Method	Checks whether equal approx is true.
IsFinite()	Method	Checks whether finite is true.
Rotated(System.Single)	Method	Executes the rotated operation.
Scaled(Electron2D.Vector2)	Method	Executes the scaled operation.
ToString()	Method	Executes the to string operation.
Translated(Electron2D.Vector2)	Method	Executes the translated operation.
Xform(Electron2D.Vector2)	Method	Executes the xform operation.
op_Equality(Electron2D.Transform2D, Electron2D.Transform2D)	Method	Applies the == operator.
op_Inequality(Electron2D.Transform2D, Electron2D.Transform2D)	Method	Applies the != operator.
op_Multiply(Electron2D.Transform2D, Electron2D.Rect2)	Method	Applies the * operator.
op_Multiply(Electron2D.Transform2D, Electron2D.Transform2D)	Method	Applies the * operator.
op_Multiply(Electron2D.Transform2D, Electron2D.Vector2)	Method	Applies the * operator.

Member Details

FlipX

Kind: Field

public static Electron2D.Transform2D FlipX

Summary

Represents the flip x value.

Remarks

Use this field as a stable value supplied by the declaring type.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

FlipY

Kind: Field

public static Electron2D.Transform2D FlipY

Summary

Represents the flip y value.

Remarks

Use this field as a stable value supplied by the declaring type.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

Identity

Kind: Field

public static Electron2D.Transform2D Identity

Summary

Represents the identity value.

Remarks

Use this field as a stable value supplied by the declaring type.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

Origin

Kind: Property

public Electron2D.Vector2 Origin { get; set; }

Summary

Gets or sets the origin value.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current origin value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

X

Kind: Property

public Electron2D.Vector2 X { get; set; }

Summary

Gets or sets the x value.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current x value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

Y

Kind: Property

public Electron2D.Vector2 Y { get; set; }

Summary

Gets or sets the y value.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current y value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

Electron2D.Transform2D(Electron2D.Vector2, Electron2D.Vector2, Electron2D.Vector2)

Kind: Constructor

public Electron2D.Transform2D(Electron2D.Vector2 xAxis, Electron2D.Vector2 yAxis, Electron2D.Vector2 origin)

Summary

Initializes a new instance of the Transform2D type.

Remarks

The new instance follows the lifetime and validation rules of its declaring type.

Parameters

• xAxis: The x axis value.
• yAxis: The y axis value.
• origin: The origin value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

Electron2D.Transform2D(System.Single, Electron2D.Vector2)

Kind: Constructor

public Electron2D.Transform2D(System.Single rotation, Electron2D.Vector2 origin)

Summary

Initializes a new instance of the Transform2D type.

Remarks

The new instance follows the lifetime and validation rules of its declaring type.

Parameters

• rotation: The rotation value.
• origin: The origin value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

Electron2D.Transform2D(System.Single, System.Single, System.Single, System.Single, System.Single, System.Single)

Kind: Constructor

public Electron2D.Transform2D(System.Single xx, System.Single xy, System.Single yx, System.Single yy, System.Single ox, System.Single oy)

Summary

Initializes a new instance of the Transform2D type.

Remarks

The new instance follows the lifetime and validation rules of its declaring type.

Parameters

• xx: The xx value.
• xy: The xy value.
• yx: The yx value.
• yy: The yy value.
• ox: The ox value.
• oy: The oy value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

AffineInverse()

Kind: Method

public Electron2D.Transform2D AffineInverse()()

Summary

Executes the affine inverse operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

BasisXform(Electron2D.Vector2)

Kind: Method

public Electron2D.Vector2 BasisXform(Electron2D.Vector2)(Electron2D.Vector2 value)

Summary

Executes the basis xform operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• value: The value to use.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

Determinant()

Kind: Method

public System.Single Determinant()()

Summary

Executes the determinant operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

Equals(Electron2D.Transform2D)

Kind: Method

public System.Boolean Equals(Electron2D.Transform2D)(Electron2D.Transform2D other)

Summary

Executes the equals operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• other: The other value.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

Equals(System.Object)

Kind: Method

public System.Boolean Equals(System.Object)(System.Object obj)

Summary

Executes the equals operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• obj: The obj value.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

GetHashCode()

Kind: Method

public System.Int32 GetHashCode()()

Summary

Gets the hash code value.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The current hash code value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

Inverse()

Kind: Method

public Electron2D.Transform2D Inverse()()

Summary

Executes the inverse operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

IsEqualApprox(Electron2D.Transform2D)

Kind: Method

public System.Boolean IsEqualApprox(Electron2D.Transform2D)(Electron2D.Transform2D transform)

Summary

Checks whether equal approx is true.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• transform: The transform value.

Returns

true when the condition is met; otherwise, false.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

IsFinite()

Kind: Method

public System.Boolean IsFinite()()

Summary

Checks whether finite is true.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

true when the condition is met; otherwise, false.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

Rotated(System.Single)

Kind: Method

public Electron2D.Transform2D Rotated(System.Single)(System.Single angle)

Summary

Executes the rotated operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• angle: The angle value.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

Scaled(Electron2D.Vector2)

Kind: Method

public Electron2D.Transform2D Scaled(Electron2D.Vector2)(Electron2D.Vector2 scale)

Summary

Executes the scaled operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• scale: The scale value.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

ToString()

Kind: Method

public System.String ToString()()

Summary

Executes the to string operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

Translated(Electron2D.Vector2)

Kind: Method

public Electron2D.Transform2D Translated(Electron2D.Vector2)(Electron2D.Vector2 offset)

Summary

Executes the translated operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• offset: The offset value.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

Xform(Electron2D.Vector2)

Kind: Method

public Electron2D.Vector2 Xform(Electron2D.Vector2)(Electron2D.Vector2 value)

Summary

Executes the xform operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• value: The value to use.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

op_Equality(Electron2D.Transform2D, Electron2D.Transform2D)

Kind: Method

public static System.Boolean op_Equality(Electron2D.Transform2D, Electron2D.Transform2D)(Electron2D.Transform2D left, Electron2D.Transform2D right)

Summary

Applies the == operator.

Remarks

This operator returns a value derived from the supplied operands.

Parameters

• left: The left value.
• right: The right value.

Returns

The result of the operator.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

op_Inequality(Electron2D.Transform2D, Electron2D.Transform2D)

Kind: Method

public static System.Boolean op_Inequality(Electron2D.Transform2D, Electron2D.Transform2D)(Electron2D.Transform2D left, Electron2D.Transform2D right)

Summary

Applies the != operator.

Remarks

This operator returns a value derived from the supplied operands.

Parameters

• left: The left value.
• right: The right value.

Returns

The result of the operator.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

op_Multiply(Electron2D.Transform2D, Electron2D.Rect2)

Kind: Method

public static Electron2D.Rect2 op_Multiply(Electron2D.Transform2D, Electron2D.Rect2)(Electron2D.Transform2D transform, Electron2D.Rect2 rect)

Summary

Applies the * operator.

Remarks

This operator returns a value derived from the supplied operands.

Parameters

• transform: The transform value.
• rect: The rect value.

Returns

The result of the operator.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

op_Multiply(Electron2D.Transform2D, Electron2D.Transform2D)

Kind: Method

public static Electron2D.Transform2D op_Multiply(Electron2D.Transform2D, Electron2D.Transform2D)(Electron2D.Transform2D left, Electron2D.Transform2D right)

Summary

Applies the * operator.

Remarks

This operator returns a value derived from the supplied operands.

Parameters

• left: The left value.
• right: The right value.

Returns

The result of the operator.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D

op_Multiply(Electron2D.Transform2D, Electron2D.Vector2)

Kind: Method

public static Electron2D.Vector2 op_Multiply(Electron2D.Transform2D, Electron2D.Vector2)(Electron2D.Transform2D transform, Electron2D.Vector2 vector)

Summary

Applies the * operator.

Remarks

This operator returns a value derived from the supplied operands.

Parameters

• transform: The transform value.
• vector: The vector value.

Returns

The result of the operator.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Transform2D