DATAKIT API  V2025.1
Dtk_feat_translate Class Reference

Data Structures

union  dtk_translate_type
 

Public Member Functions

 Dtk_feat_translate ()
 Constructor of a generic translate Feature
More...
 
int get_coordinates_translate (Dtk_feat_translate_coordinates **)
 Returns Coordinates translate entity
More...
 
int get_direction_translate (Dtk_feat_translate_direction **)
 Returns Direction translate entity
More...
 
int get_is_surface_translate (bool *)
 Returns the boolean value that indicates if the translate feature is a surface feature. More...
 
int get_point_to_point_translate (Dtk_feat_translate_point **)
 Returns Point_to_point translate entity
More...
 
int get_surface_translate (Dtk_feat_surface_transfo **)
 Returns the surface translate entity, the translate should be surface to be able to call this function
More...
 
int get_type (TRANSLATE_TYPE *)
 Returns the type of the translate feature. More...
 
 ~Dtk_feat_translate ()
 Destructor a generic translate Feature
More...
 

Data Fields

union Dtk_feat_translate::dtk_translate_type entity
 
bool isSurfaceTranslate
 
Dtk_feat_surface_transfosurfaceTranslate
 
TRANSLATE_TYPE type
 

Constructor & Destructor Documentation

◆ Dtk_feat_translate()

Dtk_feat_translate::Dtk_feat_translate ( )

Constructor of a generic translate Feature

Parameters
[in]<br>
[in/out]
[out]Allocatedgeneric translate feature
Returns

Remarks

◆ ~Dtk_feat_translate()

Dtk_feat_translate::~Dtk_feat_translate ( )

Destructor a generic translate Feature

Parameters
[in]generictranslate feature to destruct
[in/out]
[out]<br>
Returns
Free generic translate Feature
Remarks

Member Function Documentation

◆ get_coordinates_translate()

int Dtk_feat_translate::get_coordinates_translate ( Dtk_feat_translate_coordinates **  )

Returns Coordinates translate entity

Parameters
[in]GenericTranslate Feature
[in/out]
[out]Dtk_feat_translate_direction
Returns
NOTOK if error, ISOK if ok
Remarks

◆ get_direction_translate()

int Dtk_feat_translate::get_direction_translate ( Dtk_feat_translate_direction **  )

Returns Direction translate entity

Parameters
[in]GenericTranslate Feature
[in/out]
[out]Dtk_feat_translate_direction
Returns
NOTOK if error, ISOK if ok
Remarks

◆ get_is_surface_translate()

int Dtk_feat_translate::get_is_surface_translate ( bool *  )

Returns the boolean value that indicates if the translate feature is a surface feature.

Parameters
[in]GenericTranslate Feature
[in/out]
[out]bool
Returns
NOTOK if error, ISOK if ok
Remarks

◆ get_point_to_point_translate()

int Dtk_feat_translate::get_point_to_point_translate ( Dtk_feat_translate_point **  )

Returns Point_to_point translate entity

Parameters
[in]GenericTranslate Feature
[in/out]
[out]Dtk_feat_translate_point
Returns
NOTOK if error, ISOK if ok
Remarks

◆ get_surface_translate()

int Dtk_feat_translate::get_surface_translate ( Dtk_feat_surface_transfo **  )

Returns the surface translate entity, the translate should be surface to be able to call this function

Parameters
[in]GenericTranslate Feature
[in/out]
[out]Dtk_feat_surface_transfo
Returns
NOTOK if error, ISOK if ok
Remarks

◆ get_type()

int Dtk_feat_translate::get_type ( TRANSLATE_TYPE )

Returns the type of the translate feature.

Parameters
[in]GenericTranslate Feature
[in/out]TRANSLATE_TYPE
[out]<br>
Returns
NOTOK if error, ISOK if ok
Remarks

Field Documentation

◆ entity

union Dtk_feat_translate::dtk_translate_type Dtk_feat_translate::entity

◆ isSurfaceTranslate

bool Dtk_feat_translate::isSurfaceTranslate

◆ surfaceTranslate

Dtk_feat_surface_transfo* Dtk_feat_translate::surfaceTranslate

◆ type

TRANSLATE_TYPE Dtk_feat_translate::type