CogRectangleAffine Class

Cognex VisionPro 9.5

Class that represents an affine rectangle.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro CogRectangleAffine

Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 69.0.0.0

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogRectangleAffine : CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable, ICogHasChanged, 
	ICogChangedEvent, ICogShape, ICogRegion, ICogGraphic, ICogGraphicInteractive, 
	ICogGraphicParentChild

[SerializableAttribute]
public class CogRectangleAffine : CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable, ICogHasChanged, 
	ICogChangedEvent, ICogShape, ICogRegion, ICogGraphic, ICogGraphicInteractive, 
	ICogGraphicParentChild

<SerializableAttribute>
Public Class CogRectangleAffine 
	Inherits CogObjectBase 
	Implements ICogNetInternal, IDisposable, ICloneable, ISerializable, 
	ICogHasChanged, ICogChangedEvent, ICogShape, ICogRegion, ICogGraphic, 
	ICogGraphicInteractive, ICogGraphicParentChild

<SerializableAttribute>
Public Class CogRectangleAffine 
	Inherits CogObjectBase 
	Implements ICogNetInternal, IDisposable, ICloneable, ISerializable, 
	ICogHasChanged, ICogChangedEvent, ICogShape, ICogRegion, ICogGraphic, 
	ICogGraphicInteractive, ICogGraphicParentChild

[SerializableAttribute]
public ref class CogRectangleAffine : public CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable, ICogHasChanged, 
	ICogChangedEvent, ICogShape, ICogRegion, ICogGraphic, ICogGraphicInteractive, 
	ICogGraphicParentChild

[SerializableAttribute]
public ref class CogRectangleAffine : public CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable, ICogHasChanged, 
	ICogChangedEvent, ICogShape, ICogRegion, ICogGraphic, ICogGraphicInteractive, 
	ICogGraphicParentChild

The CogRectangleAffine type exposes the following members.

Constructors

	Name	Description
	CogRectangleAffine	Constructs a new instance of this class.
	CogRectangleAffine(IntPtr)	Constructs a new instance of this class using com pointer.
	CogRectangleAffine(CogRectangleAffine)	Constructs a new instance of this class as a deep copy of the given instance.

Top

Methods

	Name	Description
	Clone	Returns a deep copy of this class instance. Derived classes that implement Clone should override this method; other clients who wish to clone this instance should call ICloneable.Clone. See also CogSerializer.DeepCopyObject
	Copy	Create a new shape that copies specified parameters.
	CopyBase	Copy a graphic and its derived parameters.
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
	CreateRLE	Create an RLE representation of this Region.
	Dispose
	Dispose(Boolean)
	DistanceToPoint	Shortest distance from a boundary of this shape to the given point. Points within closed shapes return a distance less than zero.
	EnclosingRectangle	Minimum enclosing rectangle of this shape.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	(Overrides Object Finalize .)
	FitToBoundingBox	Adjust the shape's geometric properties so that the shape fits inside passed in rectangle.
	FitToImage	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.
	GetAttributes	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetCenterLengthsRotationSkew	Query this affine rectangle for its center, length, rotation and skew parameterization. All angles are in radians.
	GetClassName	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetComponentName	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetConverter	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetDefaultEvent	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetDefaultProperty	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEditor	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEvents	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEvents( Attribute )	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetObjectData
	GetOriginCornerXCornerY	Query the parameterization of this affine rectangle with respect to the three corner points: Origin, CornerX, and CornerY.
	GetOriginLengthsRotationSkew	Query this affine rectangle for its origin, length, rotation and skew parameterization. All angles are in radians.
	GetParentFromChildTransform
	GetProperties	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetProperties( Attribute )	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetPropertyOwner	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	MakeShapeModel	Returns a newly created shape model with the given weight and polarity. The 'Shape' property of the returned shape model will refer to this shape, or a copy of this shape, as specified by the CopyShape argument.
	Map	Maps this shape through the given transform.
	MapLinear	Create a new affine rectangle by mapping this one through the given transform.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	ResumeAndRaiseChangedEvent	Re-enables raising of the Changed event after SuspendChangedEvent has been called. Also raises the Changed event 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.
	SetCenterLengthsRotationSkew	Initialize this affine rectangle from its center point, SideXLength, SideYLength, Rotation (in radians) and Skew.
	SetFromRectangle	Set parameters of this affine rectangle from the given rectangle and transformation.
	SetOriginCornerXCornerY	Initialize this affine rectangle from the three corner points: Origin, CornerX, and CornerY.
	SetOriginLengthsRotationSkew	Initialize this affine rectangle from its origin point, SideXLength, SideYLength, Rotation and Skew. All angles are in radians.
	SuspendChangedEvent	Temporarily suspends the raising of the Changed event. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent.
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Fields

	Name	Description
	SfArea	This bit will be set in the EventArgs of a Changed event every time the value returned by Area may have changed.
	SfCenterX	This bit will be set in the EventArgs of a Changed event every time the value returned by CenterX may have changed.
	SfCenterY	This bit will be set in the EventArgs of a Changed event every time the value returned by CenterY may have changed.
	SfChildren	This bit will be set in the EventArgs of a Changed event every time the value returned by Children may have changed.
	SfColor	This bit will be set in the EventArgs of a Changed event every time the value returned by Color may have changed.
	SfCornerOppositeX	This bit will be set in the EventArgs of a Changed event every time the value returned by CornerOppositeX may have changed.
	SfCornerOppositeY	This bit will be set in the EventArgs of a Changed event every time the value returned by CornerOppositeY may have changed.
	SfCornerOriginX	This bit will be set in the EventArgs of a Changed event every time the value returned by CornerOriginX may have changed.
	SfCornerOriginY	This bit will be set in the EventArgs of a Changed event every time the value returned by CornerOriginY may have changed.
	SfCornerXX	This bit will be set in the EventArgs of a Changed event every time the value returned by CornerXX may have changed.
	SfCornerXY	This bit will be set in the EventArgs of a Changed event every time the value returned by CornerXY may have changed.
	SfCornerYX	This bit will be set in the EventArgs of a Changed event every time the value returned by CornerYX may have changed.
	SfCornerYY	This bit will be set in the EventArgs of a Changed event every time the value returned by CornerYY may have changed.
	SfCreateRLE	This bit will be set in the EventArgs of a Changed event every time the value returned by CreateRLE may have changed.
	SfDragColor	This bit will be set in the EventArgs of a Changed event every time the value returned by DragColor may have changed.
	SfDragLineStyle	This bit will be set in the EventArgs of a Changed event every time the value returned by DragLineStyle may have changed.
	SfDragLineWidthInScreenPixels	This bit will be set in the EventArgs of a Changed event every time the value returned by DragLineWidthInScreenPixels may have changed.
	SfEnclosingRectangle	This bit will be set in the EventArgs of a Changed event every time the value returned by EnclosingRectangle may have changed.
	SfGraphicDOFEnable	This bit will be set in the EventArgs of a Changed event every time the value returned by GraphicDOFEnable may have changed.
	SfGraphicDOFEnableBase	This bit will be set in the EventArgs of a Changed event every time the value returned by GraphicDOFEnableBase may have changed.
	SfInteractive	This bit will be set in the EventArgs of a Changed event every time the value returned by Interactive may have changed.
	SfLineStyle	This bit will be set in the EventArgs of a Changed event every time the value returned by LineStyle may have changed.
	SfLineWidthInScreenPixels	This bit will be set in the EventArgs of a Changed event every time the value returned by LineWidthInScreenPixels may have changed.
	SfMouseCursor	This bit will be set in the EventArgs of a Changed event every time the value returned by MouseCursor may have changed.
	SfParent	This bit will be set in the EventArgs of a Changed event every time the value returned by Parent may have changed.
	SfPerimeter	This bit will be set in the EventArgs of a Changed event every time the value returned by Perimeter may have changed.
	SfRotation	This bit will be set in the EventArgs of a Changed event every time the value returned by Rotation may have changed.
	SfSelected	This bit will be set in the EventArgs of a Changed event every time the value returned by Selected may have changed.
	SfSelectedColor	This bit will be set in the EventArgs of a Changed event every time the value returned by SelectedColor may have changed.
	SfSelectedLineStyle	This bit will be set in the EventArgs of a Changed event every time the value returned by SelectedLineStyle may have changed.
	SfSelectedLineWidthInScreenPixels	This bit will be set in the EventArgs of a Changed event every time the value returned by SelectedLineWidthInScreenPixels may have changed.
	SfSelectedSpaceName	This bit will be set in the EventArgs of a Changed event every time the value returned by SelectedSpaceName may have changed.
	SfSideXLength	This bit will be set in the EventArgs of a Changed event every time the value returned by SideXLength may have changed.
	SfSideYLength	This bit will be set in the EventArgs of a Changed event every time the value returned by SideYLength may have changed.
	SfSkew	This bit will be set in the EventArgs of a Changed event every time the value returned by Skew may have changed.
	SfTipText	This bit will be set in the EventArgs of a Changed event every time the value returned by TipText may have changed.
	SfVisible	This bit will be set in the EventArgs of a Changed event every time the value returned by Visible may have changed.
	SfXDirectionAdornment	This bit will be set in the EventArgs of a Changed event every time the value returned by XDirectionAdornment may have changed.
	SfYDirectionAdornment	This bit will be set in the EventArgs of a Changed event every time the value returned by YDirectionAdornment may have changed.

Top

Properties

	Name	Description
	Area	Area of this CogRectangleAffine.
	CenterX	Center point (X coordinate) of this affine rectangle.
	CenterY	Center point (Y coordinate) of this affine rectangle.
	ChangedEventSuspended	If nonzero, indicates that the raising of the Changed event has been suspended. This value is incremented when SuspendChangedEvent is called and decremented when ResumeAndRaiseChangedEvent is called.
	Children	Children of this graphic.
	Color	Color of this graphic. Can be any OLE_COLOR.
	CornerOppositeX	Corner point Opposite (X coordinate) of this affine rectangle.
	CornerOppositeY	Corner point Opposite (Y coordinate) of this affine rectangle.
	CornerOriginX	Corner point origin (X coordinate) of this affine rectangle.
	CornerOriginY	Corner point origin (Y coordinate) of this affine rectangle.
	CornerXX	Corner point X (X coordinate) of this affine rectangle.
	CornerXY	Corner point X (Y coordinate) of this affine rectangle.
	CornerYX	Corner point Y (X coordinate) of this affine rectangle.
	CornerYY	Corner point Y (Y coordinate) of this affine rectangle.
	DragColor	Color of this graphic when dragged.
	DragLineStyle	Line style of this graphic when dragged.
	DragLineWidthInScreenPixels	Line width of this graphic when dragged.
	GraphicDOFEnable	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.
	GraphicDOFEnableBase	Interactive Degree of freedom for a graphic object. Allows access to each graphic's GraphicDOFEnable property without knowing the specific graphic type.
	HasChanged	If true, the serializable state of this object has changed since the last time it was serialized.
	Interactive	Interactive property allow this graphic object to be selected. See GraphicDOFEnable for information on governing interactive manipulation of an object.
	LineStyle	Line style of this graphic.
	LineWidthInScreenPixels	Line width (in screen pixels) of this graphic.
	MouseCursor	Mouse cursor to be displayed when the mouse is over the graphic. The cursor will be visible only if the graphic is interactive.
	Parent	Parent of this graphic.
	Perimeter	Perimeter length of this CogRectangleAffine.
	Rotation	The angle (in radians, from the x-axis) of the directed vector which starts at CornerOrigin and ends at CornerX.
	Selected	True when the shape is selected in a display.
	SelectedColor	Color of this graphic when selected.
	SelectedLineStyle	Line style of this graphic when selected.
	SelectedLineWidthInScreenPixels	Line width of this graphic when selected.
	SelectedSpaceName	Coordinate space in which this shape is to be interpreted.
	SideXLength	The Length of this affine rectangle from CornerOrigin to CornerX.
	SideYLength	The Length of this affine rectangle from CornerOrigin to CornerY.
	Skew	The skew (in radians) of this affine rectangle.
	TipText	Text to describe this graphic in a tool tip.
	Visible	Visible property of this graphic.
	XDirectionAdornment	The X direction adornment of this affine rectangle.
	YDirectionAdornment	The Y direction adornment of this affine rectangle.

Top

Events

	Name	Description
	Changed	Occurs when one or more parts of the object's state may have changed.
	Dragging	Occurs when an interactive graphic is being dragged.
	DraggingStopped	Occurs after the drag operation of an interactive graphic is complete.

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:

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.