Cog3DCoordinateSpaceTree ClassCognex VisionPro
Tree of 3D coordinate spaces and the mappings between them.
Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro3D Cog3DCoordinateSpaceTree

Namespace: Cognex.VisionPro3D
Assembly: Cognex.VisionPro3D.Core (in Cognex.VisionPro3D.Core.dll) Version: 65.1.0.0
Syntax

[SerializableAttribute]
public class Cog3DCoordinateSpaceTree : CogSerializableObjectBase, 
	IDisposable

The Cog3DCoordinateSpaceTree type exposes the following members.

Constructors

  NameDescription
Public methodCog3DCoordinateSpaceTree 
Constructs a new instance of this class.
Public methodCog3DCoordinateSpaceTree(Cog3DCoordinateSpaceTree)
Constructs a new instance of this class as a deep copy of the given instance.
Protected methodCog3DCoordinateSpaceTree(SerializationInfo, StreamingContext)
Constructs a new instance of this object from saved data.
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 methodAddSpaceWithID(String, String, ICog3DTransform,  Byte )
For Cognex internal use only.
Public methodAddSpaceWithID(String, String, ICog3DTransform, Int32, Int32, Int32, Int32)
For Cognex internal use only.
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 includes all the children, grandchildren, great-grandchildren, etc. of the given space. If there are no children, the collection will hold zero items.
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.
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 removed from the tree.
Public methodDispose 
Releases all resources used by this class instance.
Protected methodDispose(Boolean)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
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
Populates the provided SerializationInfo with the data needed to serialize the object.
(Overrides CogSerializableObjectBase GetObjectData(SerializationInfo, StreamingContext).)
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
Looks up the given spaceName in this tree and 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 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 foundChildName output 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 foundName output argument.
Top
Properties

  NameDescription
Public propertyRootName
Returns/sets the name of the root coordinate space in this tree.
Top
Events

  NameDescription
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(String, ICog3DTransform) method, or (2) by a call to the AddSpace(String, String, ICog3DTransform, CogAddSpaceConstants) method that replaces an existing transform.
Public eventTreeAdded
Occurs after a new tree is added to this tree.
Top
Remarks

A 3D coordinate space tree is associated with each VisionPro range image.

In VisionPro, you can define and name your own coordinate spaces. Each user space is defined, relative to an existing space, by a three-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 3D 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 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 first space name argument of the method.

See Also