Cog3DRay Class

Cognex VisionPro

This class encapsulates a directed 3D ray. It is parameterized as a start point (represented using P1) and a direction (represented using Direction). A ray is infinite like a line, but only extends in one direction.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.Implementation CogSerializableChangedEventBase
          Cognex.VisionPro3D Cog3DShapeBase
            Cognex.VisionPro3D Cog3DRay

Namespace: Cognex.VisionPro3D
Assembly: Cognex.VisionPro3D.Core (in Cognex.VisionPro3D.Core.dll) Version: 65.1.0.0

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class Cog3DRay : Cog3DShapeBase, ICog3DShape, 
	ICog3DVertex, ICog3DCurve, IDisposable

[SerializableAttribute]
public class Cog3DRay : Cog3DShapeBase, ICog3DShape, 
	ICog3DVertex, ICog3DCurve, IDisposable

<SerializableAttribute>
Public Class Cog3DRay 
	Inherits Cog3DShapeBase 
	Implements ICog3DShape, ICog3DVertex, ICog3DCurve, IDisposable

<SerializableAttribute>
Public Class Cog3DRay 
	Inherits Cog3DShapeBase 
	Implements ICog3DShape, ICog3DVertex, ICog3DCurve, IDisposable

[SerializableAttribute]
public ref class Cog3DRay : public Cog3DShapeBase, 
	ICog3DShape, ICog3DVertex, ICog3DCurve, IDisposable

[SerializableAttribute]
public ref class Cog3DRay : public Cog3DShapeBase, 
	ICog3DShape, ICog3DVertex, ICog3DCurve, IDisposable

The Cog3DRay type exposes the following members.

Constructors

	Name	Description
	Cog3DRay	Constructs a degenerate Cog3DRay consistent with Cog3DRay(Cog3DVect3(), Cog3DVect3(), Cog3DShapeStateConstants.Points, Cog3DShapeStateConstants.Curve).
	Cog3DRay(Cog3DRay)	Construct this object by making a deep copy of the supplied object.
	Cog3DRay(SerializationInfo, StreamingContext)	Serialization constructor.
	Cog3DRay(Cog3DVect3, Cog3DVect3, Cog3DRay ParameterizationType, Cog3DShapeStateConstants)	Constructs a Cog3DRay using parameterizationType to interpret v1 and v2.

Top

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.
	ComputeDistanceVertex	Determines the distance from ComputeNearestPointVertex(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.
	ComputeNearestPointVertex	Determines the vertex on this shape that is nearest to the specified point. If the nearest vertex is not unique, returns one of the nearest vertices.
	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.
	CreateLine	Creates the Cog3DLine coincident with this ray.
	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	Determines whether the specified Object is equal to the current Object. (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 ray through the specified rigid transform and return a Cog3DRay.
	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.)
	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 .)

Top

Fields

	Name	Description
	SfDirection
	SfNextSf
	SfP1

Top

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/sets the direction of this ray. The getter 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.
	P1	Gets/sets the start point of the ray.
	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.)

Top

Events

	Name	Description
	Changed	This event is raised when one or more parts of the object's state may have changed. (Inherited from CogSerializableChangedEventBase.)

Top