Cog3DPlane Class

Cognex VisionPro

This class encapsulates a plane. Planes have 3 parameterizations: 3 points, point-in-the-plane plus normal, normal plus offset-from-origin. The offset-from-origin is the translation from the origin along the normal direction.

Inheritance Hierarchy

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

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 Cog3DPlane : Cog3DShapeBase, ICog3DShape, 
	ICog3DSurface, IDisposable

[SerializableAttribute]
public class Cog3DPlane : Cog3DShapeBase, ICog3DShape, 
	ICog3DSurface, IDisposable

<SerializableAttribute>
Public Class Cog3DPlane 
	Inherits Cog3DShapeBase 
	Implements ICog3DShape, ICog3DSurface, IDisposable

<SerializableAttribute>
Public Class Cog3DPlane 
	Inherits Cog3DShapeBase 
	Implements ICog3DShape, ICog3DSurface, IDisposable

[SerializableAttribute]
public ref class Cog3DPlane : public Cog3DShapeBase, 
	ICog3DShape, ICog3DSurface, IDisposable

[SerializableAttribute]
public ref class Cog3DPlane : public Cog3DShapeBase, 
	ICog3DShape, ICog3DSurface, IDisposable

The Cog3DPlane type exposes the following members.

Constructors

	Name	Description
	Cog3DPlane	Constructs a degenerate plane consistent with Cog3DPlane(Cog3DVect3(), Cog3DVect3(), Cog3DVect3()).
	Cog3DPlane(Cog3DPlane)	Construct this object by making a deep copy of the supplied object.
	Cog3DPlane(SerializationInfo, StreamingContext)	Serialization constructor.
	Cog3DPlane(Cog3DVect3, Cog3DVect3)	Constructs a plane using the specified point (a point in the plane) and the specified normal. The specified normal is normalized to a unit vector.
	Cog3DPlane(Cog3DVect3, Double)	Constructs a plane using the specified normal and an offset. The offset is the translation of the plane from the origin along the normal direction. The specified normal is normalized to a unit vector. Note that the following point is on the plane: offset * normal3D / normal3D.Length
	Cog3DPlane(Cog3DVect3, Cog3DVect3, Cog3DVect3)	Constructs a plane using the specified 3 points. If the 3 points are collinear or coincident, then the plane is degenerate, else constructs a plane with a normal determined by (pointB3D - pointA3D) crossProduct (pointC3D - pointA3D).

Top

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.
	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.
	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.
	ComputeSignedDistance	Computes the signed distance from this plane to the specified point. The distance is positive if the point is on the same side of the plane as the normal.
	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.)
	GetRotation	Computes the rotation of this plane, where "rotation" is defined as the angle (in radians) between the projection of the plane Normal on the XY-plane and the X-axis, and normalized to the range [0, Math.PI * 2).
	GetTilt	Computes the tilt of this plane, where "tilt" is defined as the angle (in radians) between the plane Normal and the Z-axis, and normalized to the range [0, Math.PI].
	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 plane through the specified rigid transform and returns a Cog3DPlane.
	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.)
	ProjectVectorOntoPlane	Computes the vector resulting from projecting the specified vector onto this plane.
	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.)
	SetNormalAndOffset	Sets this plane using the specified normal and an offset. The offset is the translation of the plane from the origin along the normal direction. The specified normal is normalized to a unit vector. Note that the following point is on the plane: offset * normal3D / normal3D.Length
	SetPointAndNormal	Sets this plane using the specified point (a point in the plane) and the specified normal. The specified normal is normalized to a unit vector.
	SetPoints	Sets this plane according to the specified 3 points. If the 3 points are collinear or coincident, then the plane is degenerate, else constructs a plane with a normal determined by (pB - pA) crossProduct (pC - pA).
	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
	SfGetRotation
	SfGetTilt
	SfNextSf
	SfNormal
	SfOffset

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.)
	HasChanged	(Inherited from CogSerializableChangedEventBase.)
	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 for this plane. The getter returns a unit vector.
	Offset	Gets/sets the offset for this plane. The offset is the translation from the origin along the normal direction.
	SelectedSpaceName3D	The 3D coordinate space in which this shape is to be interpreted.
	ShapeState	Get/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