This is the shape class for representing an oriented 3D circle.
A Cog3DCircle can be defined by a radius (Radius), a center (Center), and a normal
direction (Normal). It can also be defined by a radius and a 3D rigid transform:
the radius defines
a circle on the XY plane whose center is at the origin ((0,0,0)) and
has the specified radius, the rigid transform (ShapeFromScaledUnitCircle) is used
to transform the above circle on the XY plane to the expected pose in
3D space.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro3D Cog3DShapeBase
Cognex.VisionPro3D Cog3DCircle
Namespace: Cognex.VisionPro3D
Assembly: Cognex.VisionPro3D.Core (in Cognex.VisionPro3D.Core.dll) Version: 73.0.0.0
Syntax
The Cog3DCircle type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | Cog3DCircle |
Constructs a degenerate circle on the XY
plane and whose center is at the origin. Radius is 0,
ShapeFromScaledUnitCircle is identity transform,
and ShapeState is Cog3DShapeStateConstants.Surface.
|
| Cog3DCircle(Cog3DCircle) |
Construct this object by making a deep copy of the supplied
object.
|
 | Cog3DCircle(SerializationInfo, StreamingContext) |
Serialization constructor.
|
| Cog3DCircle(Double, Cog3DTransformRigid, Cog3DShapeStateConstants) |
Constructs a circle using the specified radius, transform, and Cog3DShapeStateConstants.
|
| Cog3DCircle(Double, Cog3DVect3, Cog3DVect3, Cog3DShapeStateConstants) |
Constructs a circle using the specified radius, center, normal direction, and
Cog3DShapeStateConstants.
|
Methods
| Name | Description | |
|---|---|---|
| Clone |
Creates a deep copy of this shape.
|
| ComputeArea |
Determines the area of this shape.
For an infinite shape, like Cog3DPlane, the area is 0.
|
| ComputeBoundingBox |
Computes the axis-aligned bounding box for this shape.
|
| ComputeDistance |
Computes the distance from this shape to the specified point.
The point on this shape used to compute the distance is a function of ShapeState.
|
| ComputeDistanceCurve |
Determines the distance from ComputeNearestPointCurve(point3D)
to the specified point point3D.
|
| ComputeDistanceSurface |
Determines the distance from ComputeNearestPointSurface(point3D)
to the specified point point3D.
|
| ComputeNearestPoint |
Computes the point on this shape that is nearest to the specified point.
The nearest point on this shape to the specified point is a function of ShapeState.
If the nearest point is not unique, returns one of the nearest points.
|
| ComputeNearestPointCurve |
Determines the point on this curve shape that is nearest to the specified point.
If the nearest point on this curve shape is not unique, returns one of the nearest points.
|
| ComputeNearestPointSurface |
Determines the point on this surface shape that is nearest to the specified point.
If the nearest point on this surface shape is not unique, returns one of the nearest points.
|
| ComputePerimeter |
Determines the perimeter of this shape. For a wireframe shape, the
perimeter is the total length of all the wires. For an infinite shape, like Cog3DLine,
the perimeter is 0.
|
| 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.) |
| Dispose |
Dispose this object.
|
| Dispose(Boolean) | |
| Equals | (Inherited from Object.) |
| Finalize |
Finalize this object.
(Overrides Object Finalize .) |
| 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.) |
| GetObjectData |
Serializer for this object.
(Overrides CogSerializableObjectBase GetObjectData(SerializationInfo, StreamingContext).) |
| 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.) |
| GetShapeFromScaledUnitCircle |
Get the ShapeFromScaledUnitCircle transform of this circle.
|
| 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.) |
| MapRigid |
Maps this circle through the specified rigid transform and
returns a Cog3DCircle.
|
| MapShape |
Creates a new shape by mapping this shape through the specified 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.) |
| 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.) |
 | RealEqual |
Compares the internal state of the specified instances and returns
true if the internal state is within epsilon.
|
| 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.) |
| SetShapeFromScaledUnitCircle |
Set the ShapeFromScaledUnitCircle transform of this circle.
It may change the
value of Center. It does not change the value of Radius.
|
| 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 |
Override of ToString method to get a string for describing this object.
(Overrides Object ToString .) |
Fields
| Name | Description | |
|---|---|---|
 | SfCenter | |
| SfGetShapeFromScaledUnitCircle | |
 | SfNextSf | |
| SfNormal | |
| SfRadius |
Properties
| Name | Description | |
|---|---|---|
 | Center |
Gets/sets the center position of this circle.
|
| 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.) |
| HasChanged | (Inherited from CogSerializableChangedEventBase.) |
| IsDegenerateCurve |
Determines whether or not this curve shape is degenerate. This occurs
when curve shapes have a perimeter of 0.
|
| IsDegenerateSurface |
Determines whether or not this surface shape is degenerate. This occurs
when surface shapes have an area of 0.
|
| IsEmpty |
Indicates if the set of points lying on the boundary of this shape is empty.
|
| IsFinite |
Indicates if this shape has finite extents.
|
| Normal |
Gets/sets the normal direction of this circle.
|
| Radius |
Gets/sets the radius of this circle.
|
| SelectedSpaceName3D |
The 3D coordinate space in which this shape is to be interpreted.
|
| ShapeState |
Gets/sets the ShapeState for this shape.
|
| 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.) |
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