documentation

VLSimilarityTransformWrapper Class Reference

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

Inherits IDisposable.

Public Member Functions

 VLSimilarityTransformWrapper (IntPtr handle, bool owner)
 Constructor of VLSimilarityTransformWrapper. More...
 
 VLSimilarityTransformWrapper (Quaternion q, Vector3 t, float s)
 
VLSimilarityTransformWrapper 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 VLSimilarityTransformWrapper is a wrapper for aSimilarityTransform object. SimilarityTransform objects represent a transformation (position, orientation and scaling).

See also
VLDataSetWrapper.GetSimilarityTransform

Constructor & Destructor Documentation

◆ VLSimilarityTransformWrapper()

VLSimilarityTransformWrapper.VLSimilarityTransformWrapper ( IntPtr  handle,
bool  owner 
)
inline

Constructor of VLSimilarityTransformWrapper.

Don't call this constructor directly. Use VLSimilarityTransformWrapper.VLSimilarityTransformWrapper instead.

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

Member Function Documentation

◆ Clone()

VLSimilarityTransformWrapper VLSimilarityTransformWrapper.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 VLSimilarityTransformWrapper.Dispose ( )
inline

Explicitly releases references to unmanaged resources.

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

◆ GetR()

Quaternion VLSimilarityTransformWrapper.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 VLSimilarityTransformWrapper.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 VLSimilarityTransformWrapper.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 VLSimilarityTransformWrapper.GetValid ( )
inline

Returns whether the SimilarityTransform is valid.

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

◆ SetR()

void VLSimilarityTransformWrapper.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 VLSimilarityTransformWrapper.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 VLSimilarityTransformWrapper.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$.