CogCoordinateSpaceTree.ChangeTransform Method

CogCoordinateSpaceTree ChangeTransform Method

Cognex VisionPro

Change the transform which maps points from the given child space into its parent space. The new transform is given by NewParentFromChild.

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

Syntax

C++

Copy to Clipboard Print

public void ChangeTransform(
	string childSpaceName,
	ICogTransform2D newParentFromChild,
	bool copyTransform
)

public void ChangeTransform(
	string childSpaceName,
	ICogTransform2D newParentFromChild,
	bool copyTransform
)

Public Sub ChangeTransform ( 
	childSpaceName As String,
	newParentFromChild As ICogTransform2D,
	copyTransform As Boolean
)

Public Sub ChangeTransform ( 
	childSpaceName As String,
	newParentFromChild As ICogTransform2D,
	copyTransform As Boolean
)

public:
void ChangeTransform(
	String^ childSpaceName, 
	ICogTransform2D^ newParentFromChild, 
	bool copyTransform
)

public:
void ChangeTransform(
	String^ childSpaceName, 
	ICogTransform2D^ newParentFromChild, 
	bool copyTransform
)

Parameters

childSpaceName: Type: System String
A valid nonqualified or fully-qualified space name that indicates the coordinate space to modify.

newParentFromChild: Type: Cognex.VisionPro ICogTransform2D
An ICogTransform2D that maps points from the space you are changing to its parent user space.

copyTransform: Type: System Boolean
If True, ChangeTransform(String, ICogTransform2D, Boolean) saves a copy of the supplied transform. Otherwise, the transform is added by-reference.

Exceptions

Exception	Condition
ArgumentException	newParentFromChild is NULL.
ArgumentException	childSpaceName is the root space.
CogSpaceTreeInvalidNameSyntaxException	childSpaceName value is not a legal space name.
CogSpaceTreeNotUniqueException	childSpaceName is a nonqualified space name and more than one instance of it exists in this tree.

Remarks

Changes the transform that maps points from the given child space name into its parent space.

By default, ChangeTransform(String, ICogTransform2D, Boolean) saves a copy of the supplied transform. You can also add the transform by-reference. Although this is more efficient, it may result in errors for users who unknowingly continue to modify the original transform object.