This class encapsulates an infinite, directed 3D line.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro3D Cog3DShapeBase
Cognex.VisionPro3D Cog3DLine
Namespace: Cognex.VisionPro3D
Assembly: Cognex.VisionPro3D.Core (in Cognex.VisionPro3D.Core.dll) Version: 75.1.0.0
Syntax
The Cog3DLine type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | Cog3DLine |
Default constructor. Constructs a degenerate Cog3DLine consistent with
Cog3DLine(Cog3DVect3(), Cog3DVect3(), ParameterizationType.Points).
|
| Cog3DLine(Cog3DLine) |
Construct this object by making a deep copy of the supplied
object.
|
| Cog3DLine(Cog3DLineSeg) |
Constructs a Cog3DLine from the specified lineSeg.
The direction of the line is the same as the lineSeg's direction.
|
 | Cog3DLine(SerializationInfo, StreamingContext) |
Serialization constructor.
|
| Cog3DLine(Cog3DVect3, Cog3DVect3, Cog3DLine ParameterizationType) |
Constructs a Cog3DLine using parameterizationType to interpret v1 and v2.
If parameterizationType is Points and v1 is equal to v2, then the line is degenerate.
|
Methods
| Name | Description | |
|---|---|---|
| Clone |
Creates a deep copy of this shape.
|
| 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.
|
| 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.
|
| 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.) |
| 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 line through the specified rigid transform and
returns a Cog3DLine.
|
| 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.) |
| SetPointAndDirection |
Sets this line according to the specified point and direction.
|
| SetPoints |
Sets this line according to the specified 2 points. If the 2 points are
coincident, then the line is degenerate, else constructs
a line with a direction from pointA3D to pointB3D.
|
| 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 | |
|---|---|---|
 | SfDirection | |
 | SfNextSf | |
| SfPointNearestOrigin |
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.) |
| Direction |
Gets the direction of this line. It returns a unit vector.
|
| HasChanged | (Inherited from CogSerializableChangedEventBase.) |
| IsDegenerateCurve |
Determines whether or not this curve shape is degenerate. This occurs
when curve shapes have a perimeter 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.
|
| PointNearestOrigin |
Gets the point on this line nearest to the origin.
|
| 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