DATAKIT API  V2025.1
Dtk_feat_prism Class Reference

Prism Feature : A Prism extrudes a profile along a specific direction. A Pad adds material, a Pocket removes material. More...

Public Member Functions

 Dtk_feat_prism ()
 Constructor of Prism Feature
More...
 
int get_axis (Dtk_feat_axis **)
 Returns the extrusion direction.
More...
 
int get_direction_reversed (Bool *)
 Tests whether the direction is opposite to the reference or not.
More...
 
int get_end_limit (Dtk_feat_limit **)
 Returns the first limit feature.
More...
 
int get_inner_side (int *)
 Returns the closing side of the open profile (side flag).
More...
 
int get_profiles (Dtk_feat_geometry **)
 Returns the profile internal component.
More...
 
int get_start_limit (Dtk_feat_limit **)
 Returns the second limit feature.
More...
 
int get_sym (Bool *)
 Tests whether the symmetrical extension is set or not.
More...
 
int get_thickness (Dtk_feat_thickness **)
 Returns thickness of a prism.
More...
 
int get_type (DTK_PRISM_TYPE *)
 Returns Prism type
More...
 
 ~Dtk_feat_prism ()
 Destructor of a prism feature. More...
 

Data Fields

Cartesian_point ** anchor
 
char ** annotation
 
Dtk_feat_axisaxis
 
Dtk_feat_limitfirst_limit
 
int nb_anchors
 
Bool normal_to_surface
 
Dtk_feat_geometry * profiles
 
Dtk_feat_limitsecond_limit
 
int side
 
Bool sym
 
Dtk_feat_thicknessthickness
 
DTK_PRISM_TYPE type
 

Detailed Description

Prism Feature : A Prism extrudes a profile along a specific direction. A Pad adds material, a Pocket removes material.

Constructor & Destructor Documentation

◆ Dtk_feat_prism()

Dtk_feat_prism::Dtk_feat_prism ( )

Constructor of Prism Feature

Parameters
[in/out]
[out]Allocatedprism feature
Returns
NOTOK if error, ISOK if ok
Remarks

◆ ~Dtk_feat_prism()

Dtk_feat_prism::~Dtk_feat_prism ( )

Destructor of a prism feature.

Parameters
[in]Prismfeature to destruct
[in/out]
[out]<br>
Returns
Free Prism Feature
Remarks

Member Function Documentation

◆ get_axis()

int Dtk_feat_prism::get_axis ( Dtk_feat_axis **  )

Returns the extrusion direction.

Parameters
[in]PrismFeature
[in/out]
[out]DTKAxis
Returns
NOTOK if error, ISOK if ok
Remarks

◆ get_direction_reversed()

int Dtk_feat_prism::get_direction_reversed ( Bool )

Tests whether the direction is opposite to the reference or not.

Parameters
[in]PrismFeature
[in/out]
[out]Boolean
Returns
NOTOK if error, ISOK if ok
Remarks

◆ get_end_limit()

int Dtk_feat_prism::get_end_limit ( Dtk_feat_limit **  )

Returns the first limit feature.

Parameters
[in]PrismFeature
[in/out]
[out]SecondLimit Feature
Returns
NOTOK if error, ISOK if ok
Remarks

◆ get_inner_side()

int Dtk_feat_prism::get_inner_side ( int *  )

Returns the closing side of the open profile (side flag).

Parameters
[in]PrismFeature
[in/out]
[out]Flag
Returns
NOTOK if error, ISOK if ok
Remarks
When the profile is open, specifies which side of the profile will be used for closing (legal values = 1 for direct axis, -1 for indirect)

◆ get_profiles()

int Dtk_feat_prism::get_profiles ( Dtk_feat_geometry **  )

Returns the profile internal component.

Parameters
[in]PrismFeature
[in/out]
[out]Profilegeometry
Returns
NOTOK if error, ISOK if ok
Remarks

◆ get_start_limit()

int Dtk_feat_prism::get_start_limit ( Dtk_feat_limit **  )

Returns the second limit feature.

Parameters
[in]PrismFeature
[in/out]
[out]SecondLimit Feature
Returns
NOTOK if error, ISOK if ok
Remarks

◆ get_sym()

int Dtk_feat_prism::get_sym ( Bool )

Tests whether the symmetrical extension is set or not.

Parameters
[in]PrismFeature
[in/out]
[out]Boolean
Returns
NOTOK if error, ISOK if ok
Remarks

◆ get_thickness()

int Dtk_feat_prism::get_thickness ( Dtk_feat_thickness **  )

Returns thickness of a prism.

Parameters
[in]PrismFeature
[in/out]
[out]Dtk_feat_thickness(the internal and external thickness)
Returns
NOTOK if error, ISOK if ok
Remarks

◆ get_type()

int Dtk_feat_prism::get_type ( DTK_PRISM_TYPE )

Returns Prism type

Parameters
[in]PrismFeature
[in/out]
[out]DTK_PRISM_TYPE
Returns
NOTOK if error, ISOK if ok
Remarks

Field Documentation

◆ anchor

Cartesian_point** Dtk_feat_prism::anchor

◆ annotation

char** Dtk_feat_prism::annotation

◆ axis

Dtk_feat_axis* Dtk_feat_prism::axis

◆ first_limit

Dtk_feat_limit* Dtk_feat_prism::first_limit

◆ nb_anchors

int Dtk_feat_prism::nb_anchors

◆ normal_to_surface

Bool Dtk_feat_prism::normal_to_surface

◆ profiles

Dtk_feat_geometry* Dtk_feat_prism::profiles

◆ second_limit

Dtk_feat_limit* Dtk_feat_prism::second_limit

◆ side

int Dtk_feat_prism::side

◆ sym

Bool Dtk_feat_prism::sym

◆ thickness

Dtk_feat_thickness* Dtk_feat_prism::thickness

◆ type

DTK_PRISM_TYPE Dtk_feat_prism::type