System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro CogCoordinateSpaceTree
Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 73.0.0.0
The CogCoordinateSpaceTree type exposes the following members.
| Name | Description | |
|---|---|---|
| CogCoordinateSpaceTree | Constructs a new instance of this class. | |
| CogCoordinateSpaceTree(IntPtr) | Constructs a new instance of this class using com pointer. | |
| CogCoordinateSpaceTree(CogCoordinateSpaceTree) | Constructs a new instance of this class as a deep copy of the given instance. |
| Name | Description | |
|---|---|---|
| AddSpace | Add a new coordinate space, with the given name and transform, to this tree. Attach it to the specified pre-existing parent space. | |
| AddTree | Add a tree of coordinate spaces to the given ParentSpaceName of this tree using the supplied ParentFromTreeRoot transform. The tree is added by reference, so any changes to it will be visible to clients of both trees. | |
| AllChildNames | Returns a collection of names that recursively includes all the children, grandchildren, great-grandchildren, etc. of the given space. If there are no children, the collection will hold zero items. | |
| ChangeName | Change the given space name to NewSpaceName. | |
| ChangeTransform | Change the transform which maps points from the given child space into its parent space. The new transform is given by NewParentFromChild. | |
| ChildNames | Returns a collection of names containing the given space's immediate children. If there are no children, the collection will hold zero items. | |
| Clone | Returns a deep copy of this class instance. Derived classes that implement Clone should override this method; other clients who wish to clone this instance should call ICloneable.Clone. See also CogSerializer.DeepCopyObject | |
| CopySubtree | Return a copy of the subtree rooted at SpaceName. | |
| 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.) | |
| DeleteSubtree | Delete the subtree rooted at SpaceName. SpaceName and all of its children will be recursively removed from tree. | |
| Dispose | ||
| Dispose(Boolean) | ||
| Equals | (Inherited from Object.) | |
| Finalize | (Overrides Object Finalize .) | |
| FindNames | Find the given SpaceName in this tree and return a collection containing the fully-qualified pathname(s) that are found. The collection may contain zero, one, or more items. | |
| 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 | ||
| 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.) | |
| GetTransform | Return a composed transform which can map points from the 'From' coordinate space to the 'To' space. | |
| 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.) | |
| LookUpName | Look up the given SpaceName in this tree and, if found, returns an appropriately formatted copy of the name. | |
| 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.) | |
| MoveSubtree | Move the subtree rooted at SpaceName and attach it to the NewParentSpaceName, using SpaceName's existing parent transform. | |
| ParentName | Returns the name of the given space's parent. The parent name for the root space is the empty name ("") because the root space has no parent. | |
| ResolvePartialName | Use the given StartingSpaceName to resolve any ambiguity in NameToResolve, and return a name suitable for lookup in this tree. Note that a partial name, like ".", is ambiguous without a specified starting space. | |
| ResumeAndRaiseChangedEvent | Re-enables raising of the Changed event after SuspendChangedEvent has been called. Also 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. | |
| 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. | |
| ToString | (Inherited from Object.) | |
| VerifyChild | Return true if the given ChildSpaceName is a direct or indirect child of ParentSpaceName. Otherwise, return false. The formatted child name, or "", can be obtained through the optional FoundChildName argument. | |
| VerifyName | Return true if the given SpaceName is a unique name in this tree. Return false if SpaceName cannot be found. The formatted name, or "", can be obtained through the optional FoundName argument. |
| 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. | |
| HasChanged | If true, the serializable state of this object has changed since the last time it was serialized. | |
| RootName | Returns/sets the name of the root coordinate space in this tree. |
| Name | Description | |
|---|---|---|
| Changed | Occurs when one or more parts of the object's state may have changed. | |
| NameChanged | Occurs after a space name is changed in this tree. | |
| SpaceAdded | Occurs after a new space is added to this tree. | |
| SubtreeDeleted | Occurs after a subtree is deleted from this tree. | |
| SubtreeMoved | Occurs after a subtree is moved within this tree. | |
| TransformChanged | Occurs after a transform is changed in this tree. Note that the meaning of any spaces descending from the changed transform will also be altered. This event can be fired in a variety of ways. For example: (1) by a call to the ChangeTransform method, (2) by call to the AddSpace method that replaces an existing transform, (3) by modifying a transform that was added to the tree by reference (not copied). | |
| TreeAdded | Occurs after a new tree is added to this tree. |
CogCoordinateSpaceTree, the primary interface for a CogCoordinateSpaceTree object, implements functionality related to the coordinate space tree associated with each VisionPro image.
In VisionPro, you can define and name your own coordinate spaces. Each time you calibrate an image or create a fixture, VisionPro creates a new, named user space. Each user space is defined, relative to an existing space, by a two-dimensional transform. The coordinate space tree contains a node for each coordinate space associated with an image, and maintains information about the transform that produced it. VisionPro also maintains a root space based on the pixels in the acquired image.
The methods and properties in this interface let you obtain the transformations that map points between any pair of coordinate spaces in the space tree. They also allow you to examine, add to, or rearrange the space tree.
Many of the CogCoordinateSpaceTree methods use a client-specified coordinate space name to find a coordinate space within the tree. You can supply any valid nonqualified (NQ) or fully-qualified (FQ) pathname. If you supply a NQ name, the method searches the coordinate space tree for instances of that name. The NQ name must occur exactly once within the tree.
In addition, several methods return one or more coordinate space names. You can control the format (nonqualified, partially-qualified, or fully-qualified) of the returned names by supplying a CogSpaceTreePathnameConstants value. If a partially-qualified (PQ) name is returned, it begins with either "." or "..", and specifies a space relative to the given space name.