The Cross Section operator base class.
The class holds common properties across operators.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro3D Cog3DRangeImageCrossSectionOperatorBase
Cognex.VisionPro3D Cog3DRangeImageCrossSectionAngleLineLine
Cognex.VisionPro3D Cog3DRangeImageCrossSectionAreaOperatorBase
Cognex.VisionPro3D Cog3DRangeImageCrossSectionDistancePointLine
Cognex.VisionPro3D Cog3DRangeImageCrossSectionDistancePointPoint
Cognex.VisionPro3D Cog3DRangeImageCrossSectionExtractCircleFit
Cognex.VisionPro3D Cog3DRangeImageCrossSectionExtractCorner
Cognex.VisionPro3D Cog3DRangeImageCrossSectionExtractCornerV2
Cognex.VisionPro3D Cog3DRangeImageCrossSectionExtractLineSegment
Cognex.VisionPro3D Cog3DRangeImageCrossSectionExtractPoint
Cognex.VisionPro3D Cog3DRangeImageCrossSectionIntersectLineLine
Cognex.VisionPro3D Cog3DRangeImageCrossSectionLineSegmentPointPoint
Cognex.VisionPro3D Cog3DRangeImageCrossSectionMidpointPointPoint
Cognex.VisionPro3D Cog3DRangeImageCrossSectionNearestPoint
Cognex.VisionPro3D Cog3DRangeImageCrossSectionPointAreaResult
Cognex.VisionPro3D Cog3DRangeImageCrossSectionPointCircle
Cognex.VisionPro3D Cog3DRangeImageCrossSectionPointLineSegment
Namespace: Cognex.VisionPro3D
Assembly: Cognex.VisionPro3D (in Cognex.VisionPro3D.dll) Version: 73.0.0.0
Syntax
The Cog3DRangeImageCrossSectionOperatorBase type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | Cog3DRangeImageCrossSectionOperatorBase(Cog3DRangeImageCrossSectionOperatorBase) |
Construct a deep copy of the supplied
Cog3DRangeImageCrossSectionOperatorBase object.
|
| Cog3DRangeImageCrossSectionOperatorBase(Cog3DRangeImageCrossSectionOutputTypeConstants) |
Construct a default Cog3DRangeImageCrossSectionOperatorBase object.
|
| Cog3DRangeImageCrossSectionOperatorBase(SerializationInfo, StreamingContext) |
Serialization constructor for Cog3DRangeImageCrossSectionOperatorBase
object.
|
Methods
| Name | Description | |
|---|---|---|
 | AddDefaultRegion |
Adds a new region to the operator with a default location
|
| ClearResults |
Clear the results' properties.
|
| 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.) |
| CreateResultGraphics |
Create the graphics and add them to the graphicCollection provided..
|
| Dispose |
Destruct this Cog3DRangeImageCrossSectionOperatorBase.
|
| Dispose(Boolean) | |
| Equals | (Inherited from Object.) |
| Execute |
Runs the operator.
|
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetAttributes |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| 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.) |
| GetNamesOfOperatorsByType |
Gets the names of the operators by output type from the OperatorsParams
collection.
It returns only the operators that are listed prior to this operator
in the OperatorsParams collection.
Returns null if no operator was found.
|
| GetObjectData |
Implements the GetObjectData method of the ISerializable interface.
(Inherited from CogSerializableObjectBase.) |
| 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.) |
| InitializeName | |
| InitializeRegions | |
| InitializeToleranceCollection | |
| 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.) |
| OnChanged(Int64) |
This method should be called internally whenever the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
| OnChanged(CogChangedEventArgs) |
This method may be called internally whenever a derived object's state
may have changed and the derived object expresses this change via a
derived CogChangedEventArgs class.
(Inherited from CogSerializableChangedEventBase.) |
| ResumeAndRaiseChangedEvent |
Re-enables raising of the Changed event after SuspendChangedEvent
has been called, and 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.
(Inherited from CogSerializableChangedEventBase.) |
| SetRegionToDefaultLocation |
Sets the region with the given index to the default region location
Cognex Internal Use Only.
|
| 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.
(Inherited from CogSerializableChangedEventBase.) |
| ToString | (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
  | SfCombineGraphicsEnabled |
This bit will be set in the EventArgs of a Changed event every time
the value returned by CombinedGraphicsEnabled may have changed.
|
| SfFeatureInImage |
This bit will be set in the EventArgs of a Changed event every time
the value returned by FeatureInImage may have changed.
|
| SfFeatureInImage3D |
This bit will be set in the EventArgs of a Changed event every time
the value returned by FeatureInImage3D may have changed.
|
| SfInputGraphicsEnabled |
This bit will be set in the EventArgs of a Changed event every time
the value returned by InputGraphicsEnabled may have changed.
|
| SfName |
This bit will be set in the EventArgs of a Changed event every time
the value returned by Name may have changed.
|
 | SfNextSf |
NextSf state flag.
|
| SfOutputGraphicsEnabled |
This bit will be set in the EventArgs of a Changed event every time
the value returned by OutputGraphicsEnabled may have changed.
|
| SfRegions |
This bit will be set in the EventArgs of a Changed event every time
the value returned by Regions may have changed.
|
| SfResultObject |
This bit will be set in the EventArgs of a Changed event every time
the value returned by ResultObject may have changed.
|
| SfSelectedRegionIndex |
This bit will be set in the EventArgs of a Changed event every time
the value returned by SelectedRegionIndex may have changed.
|
| SfStatus |
This bit will be set in the EventArgs of a Changed event every time
the value returned by Status may have changed.
|
| SfToleranceCollection |
This bit will be set in the EventArgs of a Changed event every time
the value returned by ToleranceCollection may have changed.
|
Properties
| Name | Description | |
|---|---|---|
 | 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.
(Inherited from CogSerializableChangedEventBase.) |
| CombineGraphicsEnabled |
Gets or sets the CombineGraphicsEnabled.
When true, the combined graphics will be displayed in the last run record.
Combined graphics usually are the features or measurements produced by an
operator.
|
| FeatureInImage |
If the operator produces a feature, the feature is returned
in the range image SelectedSpaceName stored in the profile.
The FeatureInImage is available after the operator was run.
The FeatureInImage is set to null at the beginning of the tool run.
|
| FeatureInImage3D |
If the operator produces a feature, the feature is returned
in the range image SelectedSpaceName3D stored in the profile.
The FeatureInImage3D is available after the operator was run.
The FeatureInImage3D is set to null at the beginning of the tool run.
|
| HasChanged | (Inherited from CogSerializableChangedEventBase.) |
| ImageUsedForProfileDisplay |
Cognex Internal Use Only.
|
| InputGraphicsEnabled |
Gets or sets the InputGraphicsEnabled.
When true, the input graphics will be displayed in the current record.
Input graphics usually are the regions.
|
| Name |
Gets or sets the name of the operator.
When the operator is within a collection, the name is checked for uniqueness.
|
| OutputGraphicsEnabled |
Gets or sets the OutputGraphicsEnabled.
When true, the output graphics will be displayed in the current record.
Output graphics usually are the features or measurements produced by an
operator.
|
| OutputType |
Gets the OutputType of the operator.
|
| Regions |
Gets the Regions. The regions property is a collection of ICogRegion.
|
| ResultObject |
Gets the ResultObject of the operator.
The ResultObject is available after the operator was run.
The ResultObject is set to null at the beginning of the tool run.
|
| SelectedRegionIndex |
Cognex Internal Use Only.
|
| StateFlags |
Returns the complete set of state flags supported on this object. The
flags may be indexed by name as shown in the following C# code snippet:
if (changedObject.StateFlags["Color"] & eventArgs.StateFlags) { ... }
(Inherited from CogSerializableChangedEventBase.) |
| Status |
Gets the status.
|
| ToleranceCollection |
Gets the ToleranceCollection. The ToleranceCollection is initialiazed by the operator and the user
will not be able to delete or add to it. Each operator adds a pre-defined set based on the operator
result object. By default, all tolerances are disabled.
|
| Tolerances |
Gets the Tolerance object of an item specified by name.
if name is not found, the return is null.
|
Events
| Name | Description | |
|---|---|---|
 | Changed |
This event is raised when one or more parts of the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
See Also