Tree of user coordinate spaces and the mappings between them.
Cognex.Vision ShareableBase
Cognex.Vision ChangedEventShareableBase
Cognex.Vision CoordinateSpaceTree
Namespace: Cognex.Vision
Assembly: Cognex.Vision.Core.Net (in Cognex.Vision.Core.Net.dll) Version: 9.22.2.0
The CoordinateSpaceTree type exposes the following members.
| Name | Description | |
|---|---|---|
 | CoordinateSpaceTree | Constructs a new instance of this class. |
| 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. |
| CopySubtree | Return a copy of the subtree rooted at SpaceName. |
| CopyTree | Return a copy of this entire tree. |
| DeleteSubtree | Delete the subtree rooted at SpaceName. SpaceName and all of its children will be recursively removed from tree. |
| Equals | Compares the equality of this object with another. (Overrides ChangedEventShareableBase Equals(Object).) |
| 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. |
| GetHashCode | Returns the hash code of this object. (Overrides ChangedEventShareableBase GetHashCode .) |
| 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.) |
| GetTypeMeta | Get the TypeMeta that describes the type of this object. |
| LookUpName | Look up the given SpaceName in this tree and, if found, returns an appropriately formatted copy of the name. |
| 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 ChangedEvent after SuspendChangedEvent has been called, and raises the ChangedEvent 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 ChangedEvent. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent. |
| ToString | Returns a human readable string that represents the 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 | |
|---|---|---|
  | Equality | Compares the equality of two CoordinateSpaceTree objects. |
| Inequality | Compares the inequality of two CoordinateSpaceTree objects. |
| Name | Description | |
|---|---|---|
 | ChangedEventSuspended | Indicates if raising the ChangedEvent has been suspended. |
| Handle | (Overrides ChangedEventShareableBase Handle.) |
| RootName | Get Returns/sets the name of the root coordinate space in this tree. |
| Name | Description | |
|---|---|---|
 | Changed | The actual event. |
| 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 raised in a variety of ways. For example: (1) by a call to ChangeTransform, (2) by a 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. |
CoordinateSpaceTree, the primary interface for a CoordinateSpaceTree object, implements functionality related to the coordinate space tree associated with each Vision image. In Vision, you can define and name your own coordinate spaces. Each time you calibrate an image or create a fixture, Vision creates a new, named user spaces. 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. Vision 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 CoordinateSpaceTree 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 SpaceTreePathnameConstants value. If a partially-qualified (PQ) name is returned, it begins with either "." or "..", and specifies a space relative to the given space name.