# OfficeImageFrameTransform

Describes rotation and mirror transforms applied to an image frame in destination coordinates.

Struct 

`OfficeIMO.Drawing`

**Namespace**

`OfficeIMO.Drawing`

**Assembly**

`OfficeIMO.Core`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OfficeImageFrameTransform.cs:18](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImageFrameTransform.cs#L18)

**Base**

`ValueType`

**Implements**

`IEquatable<OfficeImageFrameTransform>`

**Modifiers**

sealed

Describes rotation and mirror transforms applied to an image frame in destination coordinates.

## Inheritance

- ValueType
- OfficeImageFrameTransform

## Usage

Explore 15 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

### Returned or exposed by 4

- Property [OfficeDrawingGroup.FrameTransform](/api/core/officeimo-drawing-officedrawinggroup/#property-frametransform)
- Method [OfficeDrawingRichText.CreateFrameTransform](/api/core/officeimo-drawing-officedrawingrichtext/#method-createframetransform)
- Method [OfficeDrawingText.CreateFrameTransform](/api/core/officeimo-drawing-officedrawingtext/#method-createframetransform)
- Method [OfficeImageProjection.CreateFrameTransform](/api/core/officeimo-drawing-officeimageprojection/#method-createframetransform)

### Accepted by parameters 11

- Method [OfficeDrawing.AddClippedDrawing](/api/core/officeimo-drawing-officedrawing/#method-addclippeddrawing-officeimo-drawing-officedrawing-double-double-officeimo-drawing-officeclippath-officeimo-drawing-officeimageframetransform) parameter `frameTransform`
- Method [OfficeDrawing.AddClippedPositionedText](/api/core/officeimo-drawing-officedrawing/#method-addclippedpositionedtext-string-double-double-double-double-double-double-officeimo-drawing-officeclippath-officeimo-drawing-officeimageframetransform-nullable-officeimo-drawing-officefontinfo-nullable-officeimo-officecolor-officeimo-drawing-officetextalignment-nullable-system-double-nullable-system-double) parameter `frameTransform`
- Method [OfficeDrawing.AddDrawing](/api/core/officeimo-drawing-officedrawing/#method-adddrawing-officeimo-drawing-officedrawing-double-double-officeimo-drawing-officeimageframetransform) parameter `frameTransform`
- Method [OfficeDrawing.AddPositionedText](/api/core/officeimo-drawing-officedrawing/#method-addpositionedtext-string-double-double-double-double-officeimo-drawing-officeimageframetransform-nullable-officeimo-drawing-officefontinfo-nullable-officeimo-officecolor-officeimo-drawing-officetextalignment-nullable-system-double-nullable-system-double) parameter `frameTransform`
- Constructor [OfficeDrawingGroup.OfficeDrawingGroup](/api/core/officeimo-drawing-officedrawinggroup/#constructor-ctor-officeimo-drawing-officedrawing-double-double-officeimo-drawing-officeclippath-nullable-officeimo-drawing-officeimageframetransform) parameter `frameTransform`
- Method [OfficeImageFrameTransform.Equals](/api/core/officeimo-drawing-officeimageframetransform/#method-equals-officeimo-drawing-officeimageframetransform) parameter `other`
- Method [OfficeImageFrameTransform.op_Equality](/api/core/officeimo-drawing-officeimageframetransform/#method-op-equality-officeimo-drawing-officeimageframetransform-officeimo-drawing-officeimageframetransform) parameter `left`
- Method [OfficeImageFrameTransform.op_Equality](/api/core/officeimo-drawing-officeimageframetransform/#method-op-equality-officeimo-drawing-officeimageframetransform-officeimo-drawing-officeimageframetransform) parameter `right`
- Method [OfficeImageFrameTransform.op_Inequality](/api/core/officeimo-drawing-officeimageframetransform/#method-op-inequality-officeimo-drawing-officeimageframetransform-officeimo-drawing-officeimageframetransform) parameter `left`
- Method [OfficeImageFrameTransform.op_Inequality](/api/core/officeimo-drawing-officeimageframetransform/#method-op-inequality-officeimo-drawing-officeimageframetransform-officeimo-drawing-officeimageframetransform) parameter `right`
- Method [OfficeSvgFormatting.FormatImageFrameTransform](/api/core/officeimo-drawing-officesvgformatting/#method-formatimageframetransform-officeimo-drawing-officeimageframetransform) parameter `transform`

Filter members 

Show inherited

## Constructors

`public OfficeImageFrameTransform(double rotationDegrees, double centerX, double centerY, bool flipHorizontal = false, bool flipVertical = false)` [#](#constructor-ctor-double-double-double-boolean-boolean)

[OfficeImageFrameTransform.cs:18](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImageFrameTransform.cs#L18)

Creates a destination-space image frame transform.

Parameters

**rotationDegrees double required**

Clockwise rotation in degrees.

**centerX double required**

Rotation and mirror center X coordinate.

**centerY double required**

Rotation and mirror center Y coordinate.

**flipHorizontal bool = false optional**

Whether to mirror horizontally around the center.

**flipVertical bool = false optional**

Whether to mirror vertically around the center.

## Methods

`public OfficeTransform CreateDestinationTransform()` [#](#method-createdestinationtransform)

[OfficeImageFrameTransform.cs:67](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImageFrameTransform.cs#L67)

Creates an affine matrix that applies this frame transform to destination-space coordinates.

Returns

`OfficeTransform`

Equals 2 overloads

`public bool Equals(OfficeImageFrameTransform other)` [#](#method-equals-officeimo-drawing-officeimageframetransform)

[OfficeImageFrameTransform.cs:85](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImageFrameTransform.cs#L85)

Indicates whether the current object is equal to another object of the same type.

Parameters

**other OfficeIMO.Drawing.OfficeImageFrameTransform required**

An object to compare with this object.

Returns

`bool` true if the current object is equal to the other parameter; otherwise, false.

`public override bool Equals(object? obj)` [#](#method-equals-object)

[OfficeImageFrameTransform.cs:92](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImageFrameTransform.cs#L92)

Indicates whether this instance and a specified object are equal.

Parameters

**obj object? required**

The object to compare with the current instance.

Returns

`bool` true if obj and this instance are the same type and represent the same value; otherwise, false.

`public override int GetHashCode()` [#](#method-gethashcode)

[OfficeImageFrameTransform.cs:97](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImageFrameTransform.cs#L97)

Returns the hash code for this instance.

Returns

`int` A 32-bit signed integer that is the hash code for this instance.

`public static bool op_Equality(OfficeImageFrameTransform left, OfficeImageFrameTransform right)` [#](#method-op-equality-officeimo-drawing-officeimageframetransform-officeimo-drawing-officeimageframetransform)

[OfficeImageFrameTransform.cs:107](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImageFrameTransform.cs#L107)

Returns true when two frame transforms are equal.

Parameters

**left OfficeIMO.Drawing.OfficeImageFrameTransform required**

**right OfficeIMO.Drawing.OfficeImageFrameTransform required**

Returns

`bool`

`public static bool op_Inequality(OfficeImageFrameTransform left, OfficeImageFrameTransform right)` [#](#method-op-inequality-officeimo-drawing-officeimageframetransform-officeimo-drawing-officeimageframetransform)

[OfficeImageFrameTransform.cs:110](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImageFrameTransform.cs#L110)

Returns true when two frame transforms are not equal.

Parameters

**left OfficeIMO.Drawing.OfficeImageFrameTransform required**

**right OfficeIMO.Drawing.OfficeImageFrameTransform required**

Returns

`bool`

`public ValueTuple<double, double, double, bool, bool> ToTuple()` [#](#method-totuple)

[OfficeImageFrameTransform.cs:81](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImageFrameTransform.cs#L81)

Converts the frame transform into a tuple useful for assertions and diagnostics.

Returns

`ValueTuple<double, double, double, bool, bool>`

## Inherited Methods

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public override string? ToString()` [#](#method-tostring)

Inherited from ValueType

Returns

`string?`

## Properties

`public double RotationDegrees { get; }` [#](#property-rotationdegrees)

[OfficeImageFrameTransform.cs:30](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImageFrameTransform.cs#L30)

Clockwise rotation in degrees.

`public double CenterX { get; }` [#](#property-centerx)

[OfficeImageFrameTransform.cs:33](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImageFrameTransform.cs#L33)

Rotation and mirror center X coordinate.

`public double CenterY { get; }` [#](#property-centery)

[OfficeImageFrameTransform.cs:36](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImageFrameTransform.cs#L36)

Rotation and mirror center Y coordinate.

`public bool FlipHorizontal { get; }` [#](#property-fliphorizontal)

[OfficeImageFrameTransform.cs:39](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImageFrameTransform.cs#L39)

Whether to mirror horizontally around the center.

`public bool FlipVertical { get; }` [#](#property-flipvertical)

[OfficeImageFrameTransform.cs:42](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImageFrameTransform.cs#L42)

Whether to mirror vertically around the center.

`public double ScaleX { get; }` [#](#property-scalex)

[OfficeImageFrameTransform.cs:45](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImageFrameTransform.cs#L45)

Horizontal frame scale used for mirror transforms.

`public double ScaleY { get; }` [#](#property-scaley)

[OfficeImageFrameTransform.cs:48](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImageFrameTransform.cs#L48)

Vertical frame scale used for mirror transforms.

`public bool HasRotation { get; }` [#](#property-hasrotation)

[OfficeImageFrameTransform.cs:51](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImageFrameTransform.cs#L51)

Whether the frame applies rotation.

`public bool HasFlip { get; }` [#](#property-hasflip)

[OfficeImageFrameTransform.cs:54](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImageFrameTransform.cs#L54)

Whether the frame applies any mirror transform.

`public bool HasTransform { get; }` [#](#property-hastransform)

[OfficeImageFrameTransform.cs:57](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/OfficeImageFrameTransform.cs#L57)

Whether the frame applies rotation or mirroring.

<!-- PowerForge markdown artifact sha256:60ADFF7E0404226FF680E5A4407B023DA6F6330A748976CC71F5EB125EE639B3 -->
