RectangleAffine ClassCognex VisionPro 9.25 SR1

Class that represents an affine rectangle.

Inheritance Hierarchy

System Object
  Cognex.Vision ShareableBase
    Cognex.Vision ChangedEventShareableBase
      Cognex.Vision GraphicInteractiveBase
        Cognex.Vision RectangleAffine

Namespace: Cognex.Vision
Assembly: Cognex.Vision.Core.Net (in Cognex.Vision.Core.Net.dll) Version: 9.25.1.0
Syntax

public sealed class RectangleAffine : GraphicInteractiveBase, 
	IRegion, IShape, IChangedEvent, IObject, IDiamondGraphicShape

The RectangleAffine type exposes the following members.

Constructors

  NameDescription
Public methodRectangleAffine

Constructs a new instance of this class.

Top
Methods

  NameDescription
Public methodCopy

Create a new shape that copies specified parameters.

Public methodCopyBase

Copy a graphic and its derived parameters.

(Overrides GraphicInteractiveBase CopyBase(CopyShapeConstants).)
Public methodDistanceToPoint

Shortest distance from a boundary of this shape to the given point. Points within closed shapes return a distance less than zero.

Public methodEnclosingRectangle

Minimum enclosing rectangle of this shape.

Public methodEquals
Compares the equality of this object with another.
(Overrides GraphicInteractiveBase Equals(Object).)
Public methodFitToBoundingBox

Adjust the shape's geometric properties so that the shape fits inside passed in rectangle.

Public methodFitToImage

Adjust the shape's geometric properties such that its default size is based on the image and its SelectedSpaceName. XScale and YScale are multipliers where 1.0 designates 100% scaling.

Public methodGetCenterLengthsRotationSkew

Query this affine rectangle for its center, length, rotation and skew parameterization. All angles are in radians.

Public methodGetHashCode
Returns the hash code of this object.
(Overrides GraphicInteractiveBase GetHashCode .)
Public methodGetOriginCornerXCornerY

Query the parameterization of this affine rectangle with respect to the three corner points: Origin, CornerX, and CornerY.

Public methodGetOriginLengthsRotationSkew

Query this affine rectangle for its origin, length, rotation and skew parameterization. All angles are in radians.

Public methodGetParentFromChildTransform

Gets the parent transform from the child transform.

(Overrides GraphicInteractiveBase GetParentFromChildTransform .)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetTypeMeta

Get the TypeMeta that describes the type of this object.

(Overrides ShareableBase GetTypeMeta .)
Public methodMap

Maps this shape through the given transform.

Public methodMapLinear

Create a new affine rectangle by mapping this one through the given transform.

Public methodResumeAndRaiseChangedEvent

Re-enables raising of the ChangedEvent after SuspendChangedEvent has been called, and raises the ChangedEvent if the ChangedEventSuspended count is reduced to zero and any changes were made while events were suspended. Must be called once for each call to SuspendChangedEvent.

(Overrides ChangedEventShareableBase ResumeAndRaiseChangedEvent .)
Public methodSetCenterLengthsRotationSkew

Initialize this affine rectangle from its center point, SideXLength, SideYLength, Rotation (in radians) and Skew.

Public methodSetFromRectangle

Set parameters of this affine rectangle from the given rectangle and transformation.

Public methodSetOriginCornerXCornerY

Initialize this affine rectangle from the three corner points: Origin, CornerX, and CornerY.

Public methodSetOriginLengthsRotationSkew

Initialize this affine rectangle from its origin point, SideXLength, SideYLength, Rotation and Skew. All angles are in radians.

Public methodSuspendChangedEvent

Temporarily suspends the raising of the ChangedEvent. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent.

(Overrides ChangedEventShareableBase SuspendChangedEvent .)
Public methodToString

Returns a human readable string that represents the object.

(Overrides Object ToString .)
Top
Operators

  NameDescription
Public operatorStatic memberEquality
Compares the equality of two RectangleAffine objects.
Public operatorStatic memberInequality
Compares the inequality of two RectangleAffine objects.
Top
Fields

  NameDescription
Public fieldStatic memberSfArea
Public fieldStatic memberSfCenterX
Public fieldStatic memberSfCenterY
Public fieldStatic memberSfCornerOppositeX
Public fieldStatic memberSfCornerOppositeY
Public fieldStatic memberSfCornerOriginX
Public fieldStatic memberSfCornerOriginY
Public fieldStatic memberSfCornerXX
Public fieldStatic memberSfCornerXY
Public fieldStatic memberSfCornerYX
Public fieldStatic memberSfCornerYY
Public fieldStatic memberSfPerimeter
Public fieldStatic memberSfRotation
Public fieldStatic memberSfSideXLength
Public fieldStatic memberSfSideYLength
Public fieldStatic memberSfSkew
Public fieldStatic memberSfXDirectionAdornment
Public fieldStatic memberSfYDirectionAdornment
Top
Properties

  NameDescription
Public propertyArea

Area of this RectangleAffine.

Public propertyCenterX
Get

Center point (X coordinate) of this affine rectangle.

Public propertyCenterY
Get

Center point (Y coordinate) of this affine rectangle.

Public propertyChangedEventSuspended

Indicates if raising the ChangedEvent has been suspended.

(Overrides ChangedEventShareableBase ChangedEventSuspended.)
Public propertyChildren

Children of this graphic.

(Overrides GraphicInteractiveBase Children.)
Public propertyColor

Color of this graphic. Can be any OLE_COLOR.

(Overrides GraphicInteractiveBase Color.)
Public propertyCornerOppositeX

Corner point Opposite (X coordinate) of this affine rectangle.

Public propertyCornerOppositeY

Corner point Opposite (Y coordinate) of this affine rectangle.

Public propertyCornerOriginX

Corner point origin (X coordinate) of this affine rectangle.

Public propertyCornerOriginY

Corner point origin (Y coordinate) of this affine rectangle.

Public propertyCornerXX

Corner point X (X coordinate) of this affine rectangle.

Public propertyCornerXY

Corner point X (Y coordinate) of this affine rectangle.

Public propertyCornerYX

Corner point Y (X coordinate) of this affine rectangle.

Public propertyCornerYY

Corner point Y (Y coordinate) of this affine rectangle.

Public propertyDragColor

Color of this graphic when dragged.

(Overrides GraphicInteractiveBase DragColor.)
Public propertyDragLineStyle

Line style of the graphic when dragged.

(Overrides GraphicInteractiveBase DragLineStyle.)
Public propertyDragLineWidthInScreenPixels

Line width of this graphic when dragged.

(Overrides GraphicInteractiveBase DragLineWidthInScreenPixels.)
Public propertyFillColor

The fill color of this graphic.

(Overrides GraphicInteractiveBase FillColor.)
Public propertyGraphicDOFEnable
Get

Interactive Degree of freedom for this graphic object. Provides the ability to govern interactive manipulation of an object; for example could be used to prevent an object from being resized.

Public propertyGraphicDOFEnableBase

Interactive Degree of freedom for a graphic object. Allows access to each graphic's GraphicDOFEnable property without knowing the specific graphic type.

(Overrides GraphicInteractiveBase GraphicDOFEnableBase.)
Public propertyHandle (Overrides GraphicInteractiveBase Handle.)
Public propertyInteractive

Interactive property allow this graphic object to be selected. See GraphicDOFEnable for information on governing interactive manipulation of an object.

(Overrides GraphicInteractiveBase Interactive.)
Public propertyLineStyle

Line style of this graphic.

(Overrides GraphicInteractiveBase LineStyle.)
Public propertyLineWidthInScreenPixels

Line width (in screen pixels) of this graphic.

(Overrides GraphicInteractiveBase LineWidthInScreenPixels.)
Public propertyMouseCursor

Mouse cursor to be displayed when the mouse is over the graphic. The cursor will be visible only if the graphic is interactive.

(Overrides GraphicInteractiveBase MouseCursor.)
Public propertyParent

Return a reference to the containing tracking collection. May be null.

(Overrides GraphicInteractiveBase Parent.)
Public propertyPerimeter

Perimeter length of this CogRectangleAffine.

Public propertyRotation
Get

The angle (in radians, from the x-axis) of the directed vector which starts at CornerOrigin and ends at CornerX.

Public propertySelected

True when the shape is selected in a display.

(Overrides GraphicInteractiveBase Selected.)
Public propertySelectedColor

Color of this graphic when selected.

(Overrides GraphicInteractiveBase SelectedColor.)
Public propertySelectedLineStyle

Line style of this graphic when selected.

(Overrides GraphicInteractiveBase SelectedLineStyle.)
Public propertySelectedLineWidthInScreenPixels

Line width of this graphic when selected.

(Overrides GraphicInteractiveBase SelectedLineWidthInScreenPixels.)
Public propertySelectedSpaceName
Get

Coordinate space in which this shape is to be interpreted.

(Overrides GraphicInteractiveBase SelectedSpaceName.)
Public propertySideXLength
Get

The Length of this affine rectangle from CornerOrigin to CornerX.

Public propertySideYLength
Get

The Length of this affine rectangle from CornerOrigin to CornerY.

Public propertySkew
Get

The skew (in radians) of this affine rectangle.

Public propertyTipText

Text to describe this graphic in a tool tip. Newline characters can be used to create multi-line tip text.

(Overrides GraphicInteractiveBase TipText.)
Public propertyVisible

Visible property of this graphic.

(Overrides GraphicInteractiveBase Visible.)
Public propertyXDirectionAdornment
Get

The X direction adornment of this affine rectangle.

Public propertyYDirectionAdornment
Get

The Y direction adornment of this affine rectangle.

Top
Events

  NameDescription
Public eventChanged

The actual event.

(Overrides ChangedEventShareableBase Changed.)
Public eventDragging

Raised when an interactive graphic is being dragged.

(Overrides GraphicInteractiveBase Dragging.)
Public eventDraggingStopped

Raised after the drag operation of an interactive graphic is complete.

(Overrides GraphicInteractiveBase DraggingStopped.)
Top
Remarks

Interface that describes an affine rectangle. An affine rectangle is a quadrilateral where the opposite sides are parallel. An affine rectangle can be specified by the locations of three of its vertices; by its center point, width, height, rotation, and skew angle; or by its origin point, width, height, rotation, and skew angle. The vertices of an affine rectangle are labeled as shown in the following figure:

 Py Popp ---------------- / / / / ---------------- Po Px 
Po is at the Corner point origin.Popp is the Corner point opposite.Px is the Corner point X.Py is the Corner point Y. Note that the corner points Px and Py denote the points that lie along the x- and y-axes. Each of these points has its own x- and y-coordinates.

See Also