Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Struct

OfficeImageFrameTransform

Namespace OfficeIMO.Drawing
Assembly OfficeIMO.Core
Base ValueType
Implements
IEquatable<OfficeImageFrameTransform>
Modifiers sealed

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

Inheritance

  • ValueType
  • OfficeImageFrameTransform

Usage

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

Accepted by parameters

Constructors

public OfficeImageFrameTransform(Double rotationDegrees, Double centerX, Double centerY, Boolean flipHorizontal = false, Boolean flipVertical = false) #

Creates a destination-space image frame transform.

Parameters

rotationDegrees System.Double requiredposition: 0
Clockwise rotation in degrees.
centerX System.Double requiredposition: 1
Rotation and mirror center X coordinate.
centerY System.Double requiredposition: 2
Rotation and mirror center Y coordinate.
flipHorizontal System.Boolean = false optionalposition: 3
Whether to mirror horizontally around the center.
flipVertical System.Boolean = false optionalposition: 4
Whether to mirror vertically around the center.

Methods

public OfficeTransform CreateDestinationTransform() #
Returns: OfficeTransform

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

Equals 2 overloads
public virtual Boolean Equals(OfficeImageFrameTransform other) #
Returns: Boolean

Parameters

other OfficeIMO.Drawing.OfficeImageFrameTransform requiredposition: 0
public override Boolean Equals(Object obj) #
Returns: Boolean

Parameters

obj System.Object requiredposition: 0
public override Int32 GetHashCode() #
Returns: Int32
public static Boolean op_Equality(OfficeImageFrameTransform left, OfficeImageFrameTransform right) #
Returns: Boolean

Returns true when two frame transforms are equal.

Parameters

left OfficeIMO.Drawing.OfficeImageFrameTransform requiredposition: 0
right OfficeIMO.Drawing.OfficeImageFrameTransform requiredposition: 1
public static Boolean op_Inequality(OfficeImageFrameTransform left, OfficeImageFrameTransform right) #
Returns: Boolean

Returns true when two frame transforms are not equal.

Parameters

left OfficeIMO.Drawing.OfficeImageFrameTransform requiredposition: 0
right OfficeIMO.Drawing.OfficeImageFrameTransform requiredposition: 1
public ValueTuple<Double, Double, Double, Boolean, Boolean> ToTuple() #
Returns: ValueTuple<Double, Double, Double, Boolean, Boolean>

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

Properties

public Double RotationDegrees { get; } #

Clockwise rotation in degrees.

public Double CenterX { get; } #

Rotation and mirror center X coordinate.

public Double CenterY { get; } #

Rotation and mirror center Y coordinate.

public Boolean FlipHorizontal { get; } #

Whether to mirror horizontally around the center.

public Boolean FlipVertical { get; } #

Whether to mirror vertically around the center.

public Double ScaleX { get; } #

Horizontal frame scale used for mirror transforms.

public Double ScaleY { get; } #

Vertical frame scale used for mirror transforms.

public Boolean HasRotation { get; } #

Whether the frame applies rotation.

public Boolean HasFlip { get; } #

Whether the frame applies any mirror transform.

public Boolean HasTransform { get; } #

Whether the frame applies rotation or mirroring.