CogCADToRange Class

Cognex VisionPro 9.8

Class that holds the properties and methods to open a CAD file and render the cad-shape into a range image.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.Implementation CogSerializableChangedEventBase
          Cognex.VisionPro.CAD CogCADToRange

Namespace: Cognex.VisionPro.CAD
Assembly: Cognex.VisionPro.CAD (in Cognex.VisionPro.CAD.dll) Version: 75.1.0.0

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogCADToRange : CogSerializableChangedEventBase, 
	IDisposable

[SerializableAttribute]
public class CogCADToRange : CogSerializableChangedEventBase, 
	IDisposable

<SerializableAttribute>
Public Class CogCADToRange 
	Inherits CogSerializableChangedEventBase 
	Implements IDisposable

<SerializableAttribute>
Public Class CogCADToRange 
	Inherits CogSerializableChangedEventBase 
	Implements IDisposable

[SerializableAttribute]
public ref class CogCADToRange : public CogSerializableChangedEventBase, 
	IDisposable

[SerializableAttribute]
public ref class CogCADToRange : public CogSerializableChangedEventBase, 
	IDisposable

The CogCADToRange type exposes the following members.

Constructors

	Name	Description
	CogCADToRange	Construct a default CogCADToRange object.
	CogCADToRange(CogCADToRange)	Constructs a deep copy of the supplied CogCADToRange object.
	CogCADToRange(SerializationInfo, StreamingContext)	Serialization constructor for CogCADToRange object.

Top

Methods

	Name	Description
	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	Destruct this CogCADToRange.
	Dispose(Boolean)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Execute	Opens the CAD file and renders a range image.
	Execute(String, Cog3DBox)	Opens the CAD file and renders a range image.
	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.)
	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.)
	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.)
	SetProjection3DZAxisToNegativeCAD3DXAxis	This method replaces the Projection3DFromCAD3DTransform held by this operator. Projection3D z-axis will be in the same direction as CAD3D x-axis. The CAD3D coordinate space in the range image is described as follows: z-axis goes to the left, y-axis goes up, and x-axis comes out of the yz-plane towards the viewer.
	SetProjection3DZAxisToNegativeCAD3DYAxis	This method replaces the Projection3DFromCAD3DTransform held by this operator. Projection3D z-axis will be in the opposite direction of CAD3D y-axis. The CAD3D coordinate space in the range image is described as follows: x-axis goes to the right, z-axis goes down, and y-axis comes out of the xz-plane towards the viewer.
	SetProjection3DZAxisToNegativeCAD3DZAxis	This method replaces the Projection3DFromCAD3DTransform held by this operator. The Projection3D z-axis will be in the opposite direction of CAD3D z-axis. The CAD3D coordinate space in the range image is described as follows: x-axis goes to the left, y-axis goes up, and z-axis goes into the xy-plane away from the viewer.
	SetProjection3DZAxisToPositiveCAD3DXAxis	This method replaces the Projection3DFromCAD3DTransform held by this operator. Projection3D z-axis will be in the same direction as CAD3D x-axis. The CAD3D coordinate space in the range image is described as follows: z-axis goes to the right, y-axis goes up, and x-axis goes into the yz-plane away from the viewer.
	SetProjection3DZAxisToPositiveCAD3DYAxis	This method replaces the Projection3DFromCAD3DTransform held by this operator. Projection3D z-axis will be in the same direction as CAD3D y-axis. The CAD3D coordinate space in the range image is described as follows: x-axis goes to the right, z-axis goes up, and y-axis goes into the xz-plane away from the viewer.
	SetProjection3DZAxisToPositiveCAD3DZAxis	This method replaces the Projection3DFromCAD3DTransform held by this operator. The transform is set to an identity transform, meaning there is no rotation between CAD3D and Projection3D coordinate spaces.
	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	Returns a String that represents the current Object. (Inherited from Object.)

Top

Fields

	Name	Description
	SfFileName	This bit will be set in the EventArgs of a Changed event every time the value returned by FileName may have changed.
	SfNextSf	NextSf state flag.
	SfProjection3DFromCAD3DTransform	This bit will be set in the EventArgs of a Changed event every time the value returned by Projection3DFromCAD3DTransform may have changed.
	SfRegion	This bit will be set in the EventArgs of a Changed event every time the value returned by Region may have changed.
	SfRotationMode	This bit will be set in the EventArgs of a Changed event every time the value returned by RotationMode may have changed.
	SfScaleX	This bit will be set in the EventArgs of a Changed event every time the value returned by ScaleX may have changed.
	SfScaleY	This bit will be set in the EventArgs of a Changed event every time the value returned by ScaleY may have changed.
	SfScaleZ	This bit will be set in the EventArgs of a Changed event every time the value returned by ScaleZ may have changed.
	SfTimeout	This bit will be set in the EventArgs of a Changed event every time the value returned by Timeout may have changed.
	SfTimeoutEnabled	This bit will be set in the EventArgs of a Changed event every time the value returned by TimeoutEnabled may have changed.
	SfViewingDirection	This bit will be set in the EventArgs of a Changed event every time the value returned by ViewingDirection may have changed.

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.)
	FileName	Gets or sets the CAD file name.
	HasChanged	(Inherited from CogSerializableChangedEventBase.)
	Projection3DFromCAD3DTransform	Gets or sets the 3D Rotation transform. The 3D rotation transform that can be used at runtime to map the shape.
	Region	Gets or sets the 3D box region.
	RotationMode	Gets or sets the rotation mode. The rotation mode specifies which property to use at runtime: either use the ViewingDirection or use the explicit Projection3DFromCAD3DTransform.
	ScaleX	Gets or sets the x scale.
	ScaleY	Gets or sets the y scale.
	ScaleZ	Gets or sets the z scale.
	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.)
	Timeout	A maximum execution time allowed for the operator to render the range image. This value only applies if TimeoutEnabled is true.
	TimeoutEnabled	If true, the Timeout property limits the execution time. If false then the Timeout property is ignored.
	ViewingDirection	A Cog3DVect3 that holds the 3D viewing direction specified in CAD3D. The vector points towards the viewer. It provides another way to define the rotation between CAD3D space and Projection3D space. The full rotation is defined as follows: First, construct a plane that passes through the z-axis of CAD3D and the viewing direction. Next, imagine a rotation axis that passes through the origin of CAD3D, perpendicular to the plane. Projection3D space is obtained by rotating CAD3D space - but not the cad-shape itself - around the rotation axis until the original z-axis of CAD3D is coincident with the viewing direction vector.

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