CogCoordinateSpaceTree ClassCognex VisionPro 9.21
Tree of user coordinate spaces and the mappings between them.
Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro CogCoordinateSpaceTree

Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 83.0.0.0
Syntax

[SerializableAttribute]
public class CogCoordinateSpaceTree : CogObjectBase, 
	ICogNetInternal, IDisposable, ICogChangedEvent, ICloneable, ISerializable, 
	ICogHasChanged

The CogCoordinateSpaceTree type exposes the following members.

Constructors

  NameDescription
Public methodCogCoordinateSpaceTree 
Constructs a new instance of this class.
Public methodCogCoordinateSpaceTree(IntPtr)
Constructs a new instance of this class using com pointer.
Public methodCogCoordinateSpaceTree(CogCoordinateSpaceTree)
Constructs a new instance of this class as a deep copy of the given instance.
Top
Methods

  NameDescription
Public methodAddSpace
Add a new coordinate space, with the given name and transform, to this tree. Attach it to the specified pre-existing parent space.
Public methodAddTree
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.
Public methodAllChildNames
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.
Protected methodattachCom
Public methodChangeName
Change the given space name to NewSpaceName.
Public methodChangeTransform
Change the transform which maps points from the given child space into its parent space. The new transform is given by NewParentFromChild.
Public methodChildNames
Returns a collection of names containing the given space's immediate children. If there are no children, the collection will hold zero items.
Protected methodClone
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
Public methodCopySubtree
Return a copy of the subtree rooted at SpaceName.
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Public methodDeleteSubtree
Delete the subtree rooted at SpaceName. SpaceName and all of its children will be recursively removed from tree.
Public methodDispose 
Protected methodDispose(Boolean)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize (Overrides Object Finalize .)
Public methodFindNames
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.
Protected methodGetAttributes
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetClassName
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetComponentName
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetConverter
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetDefaultEvent
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetDefaultProperty
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetEditor
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetEvents 
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetEvents( Attribute )
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Protected methodGetObjectData
Protected methodGetProperties 
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetProperties( Attribute )
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetPropertyOwner
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Public methodGetTransform
Return a composed transform which can map points from the 'From' coordinate space to the 'To' space.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodLookUpName
Look up the given SpaceName in this tree and, if found, returns an appropriately formatted copy of the name.
Protected methodMemberwiseClone 
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodMemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
Public methodMoveSubtree
Move the subtree rooted at SpaceName and attach it to the NewParentSpaceName, using SpaceName's existing parent transform.
Public methodParentName
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.
Public methodResolvePartialName
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.
Public methodResumeAndRaiseChangedEvent
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.
Public methodSuspendChangedEvent
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.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodVerifyChild
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.
Public methodVerifyName
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.
Top
Fields

  NameDescription
Protected field__com
Protected field__disposed
Protected fieldStatic member__factory
Protected fieldStatic memberCreator
Top
Properties

  NameDescription
Public propertyChangedEventSuspended
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.
Public propertyHasChanged
If true, the serializable state of this object has changed since the last time it was serialized.
Public propertyRootName
Returns/sets the name of the root coordinate space in this tree.
Top
Events

  NameDescription
Public eventChanged
Occurs when one or more parts of the object's state may have changed.
Public eventNameChanged
Occurs after a space name is changed in this tree.
Public eventSpaceAdded
Occurs after a new space is added to this tree.
Public eventSubtreeDeleted
Occurs after a subtree is deleted from this tree.
Public eventSubtreeMoved
Occurs after a subtree is moved within this tree.
Public eventTransformChanged
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).
Public eventTreeAdded
Occurs after a new tree is added to this tree.
Top
Remarks

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.

See Also