CompositeShape ClassCognex VisionPro 9.20

Class that represents a composite shape : a shape made up of many child shapes.

Inheritance Hierarchy

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

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

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

The CompositeShape type exposes the following members.

Constructors

  NameDescription
Public methodCompositeShape

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 methodGetHashCode
Returns the hash code of this object.
(Overrides GraphicInteractiveBase GetHashCode .)
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

Map through a linear 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 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 CompositeShape objects.
Public operatorStatic memberInequality
Compares the inequality of two CompositeShape objects.
Top
Fields

  NameDescription
Public fieldStatic memberSfCompositionMode
Public fieldStatic memberSfID
Public fieldStatic memberSfPaddingInScreenPixels
Public fieldStatic memberSfParentFromChildTransform
Public fieldStatic memberSfSelectionGraphicColor
Public fieldStatic memberSfSelectionGraphicLineStyle
Public fieldStatic memberSfSelectionGraphicLineWidthInScreenPixels
Public fieldStatic memberSfSelectionGraphicMouseCursor
Public fieldStatic memberSfShapes
Public fieldStatic memberSfXDirectionAdornment
Public fieldStatic memberSfYDirectionAdornment
Top
Properties

  NameDescription
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 propertyCompositionMode
Get

Controls how this shape composes itself from its sub-shapes. Uniform mode propagates all composite graphic properties to sub shapes, making them act as if they were all one graphic. Freeform mode does not.

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 propertyID
Get

Property for identifying this graphic.

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 propertyPaddingInScreenPixels
Get

Selection rectangle padding around child shapes.

Public propertyParent

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

(Overrides GraphicInteractiveBase Parent.)
Public propertyParentFromChildTransform
Get

Transform from the child shape space to this shape's SelectedSpaceName.

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 propertySelectionGraphicColor
Get

Controls color of selection graphic when it appears.

Public propertySelectionGraphicLineStyle
Get

Controls line style of selection graphic when it appears.

Public propertySelectionGraphicLineWidthInScreenPixels
Get

Controls line width of selection graphic when it appears.

Public propertySelectionGraphicMouseCursor
Get

Gets the mouse cursor used with the selection rectangle that encloses the composite shape.

Public propertyShapes

Child shapes that make up this composite shape.

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 composite shape.

Public propertyYDirectionAdornment
Get

The Y direction adornment of this composite shape.

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 a composite shape. A composite shape is a made up of one or more shapes that can behave as a single graphic entity.

See Also