documentation

Visometry.VisionLib.SDK.Core.API.Native.SimilarityTransform Class Reference

The SimilarityTransform is a wrapper for a SimilarityTransform object. SimilarityTransform objects represent a transformation (position, orientation and scaling). More...

Inherits IDisposable.

Public Member Functions

 SimilarityTransform (IntPtr handle, bool owner)
 Internal constructor of SimilarityTransform. More...
 
 SimilarityTransform (Quaternion q, Vector3 t, float s)
 
SimilarityTransform Clone ()
 Creates a copy of this object and returns a Wrapper of it. More...
 
void Dispose ()
 Explicitly releases references to unmanaged resources. More...
 
IntPtr getHandle ()
 
Quaternion GetR ()
 Returns the rotation $R$ of the given SimilarityTransform. More...
 
float GetS ()
 Returns the scale factor $s$ of the given SimilarityTransform. More...
 
Vector3 GetT ()
 Returns the translation $t$ of the given SimilarityTransform. More...
 
bool GetValid ()
 Returns whether the SimilarityTransform is valid. More...
 
void SetR (Quaternion rotation)
 Sets the rotation $R$ of the given SimilarityTransform. More...
 
void SetS (float s)
 Sets the scale factor $s$ of the given SimilarityTransform. More...
 
void SetT (Vector3 translation)
 Sets the translation $t$ of the given SimilarityTransform. More...
 
void SetValid (bool value)
 

Detailed Description

The SimilarityTransform is a wrapper for a SimilarityTransform object. SimilarityTransform objects represent a transformation (position, orientation and scaling).

Constructor & Destructor Documentation

◆ SimilarityTransform()

Visometry.VisionLib.SDK.Core.API.Native.SimilarityTransform.SimilarityTransform ( IntPtr  handle,
bool  owner 
)
inline

Internal constructor of SimilarityTransform.

This constructor is used internally by the VisionLib.

Parameters
handleHandle to the native object.
ownertrue, if the SimilarityTransform is the owner of the native object; false, otherwise.

Member Function Documentation

◆ Clone()

SimilarityTransform Visometry.VisionLib.SDK.Core.API.Native.SimilarityTransform.Clone ( )
inline

Creates a copy of this object and returns a Wrapper of it.

Returns
A wrapper of a copy of this object.

◆ Dispose()

void Visometry.VisionLib.SDK.Core.API.Native.SimilarityTransform.Dispose ( )
inline

Explicitly releases references to unmanaged resources.

Call Dispose when you are finished using the SimilarityTransform. The Dispose method leaves the SimilarityTransform in an unusable state. After calling Dispose, you must release all references to the SimilarityTransform so the garbage collector can reclaim the memory that the SimilarityTransform was occupying.

◆ GetR()

Quaternion Visometry.VisionLib.SDK.Core.API.Native.SimilarityTransform.GetR ( )
inline

Returns the rotation $R$ of the given SimilarityTransform.

Please notice, that $(s,R,t)$ represents the transformation of a 3D point as follows: $y = s* Rx + t$.

Returns
Rotation of the SimilarityTransform as Quaternion

◆ GetS()

float Visometry.VisionLib.SDK.Core.API.Native.SimilarityTransform.GetS ( )
inline

Returns the scale factor $s$ of the given SimilarityTransform.

Please notice, that $(s,R,t)$ represents the transformation of a 3D point as follows: $y = s* Rx + t$.

Returns
Float which contains the scale factor.

◆ GetT()

Vector3 Visometry.VisionLib.SDK.Core.API.Native.SimilarityTransform.GetT ( )
inline

Returns the translation $t$ of the given SimilarityTransform.

Please notice, that $(s,R,t)$ represents the transformation of a 3D point as follows: $y = s* Rx + t$.

Returns
Translation of the SimilarityTransform

◆ GetValid()

bool Visometry.VisionLib.SDK.Core.API.Native.SimilarityTransform.GetValid ( )
inline

Returns whether the SimilarityTransform is valid.

Returns
true, if the SimilarityTransform is valid; false otherwise.

◆ SetR()

void Visometry.VisionLib.SDK.Core.API.Native.SimilarityTransform.SetR ( Quaternion  rotation)
inline

Sets the rotation $R$ of the given SimilarityTransform.

Please notice, that $(s,R,t)$ represents the transformation of a 3D point as follows: $y = s* Rx + t$.

◆ SetS()

void Visometry.VisionLib.SDK.Core.API.Native.SimilarityTransform.SetS ( float  s)
inline

Sets the scale factor $s$ of the given SimilarityTransform.

Please notice, that $(s,R,t)$ represents the transformation of a 3D point as follows: $y = s* Rx + t$.

Parameters
sFloat which contains the scale factor.

◆ SetT()

void Visometry.VisionLib.SDK.Core.API.Native.SimilarityTransform.SetT ( Vector3  translation)
inline

Sets the translation $t$ of the given SimilarityTransform.

Please notice, that $(s,R,t)$ represents the transformation of a 3D point as follows: $y = s* Rx + t$.